SharedListItem Data Object - Campaign Management

Article
03/20/2023

Defines the base class of a shared list item.

Do not try to instantiate a SharedListItem. You can create one or more of the following objects that derive from it.

Syntax

<xs:complexType name="SharedListItem" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element xmlns:q89="http://schemas.datacontract.org/2004/07/System.Collections.Generic" minOccurs="0" name="ForwardCompatibilityMap" nillable="true" type="q89:ArrayOfKeyValuePairOfstringstring" />
    <xs:element minOccurs="0" name="Type" nillable="true" type="xs:string" />
  </xs:sequence>
</xs:complexType>

Elements

The SharedListItem object has the following elements: ForwardCompatibilityMap, Type.

Element	Description	Data Type
ForwardCompatibilityMap	The list of key and value strings for forward compatibility to avoid otherwise breaking changes when new elements are added in the current API version. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.	KeyValuePairOfstringstring array
Type	The type of the shared list item. For more information about shared list item types, see Remarks.	string

Remarks

For Java and the .NET languages, do not set the Type element because the value is determined by the object instance.

If you generate the SOAP manually, use the Type attribute of the <SharedListItem> node as shown in the following example, to specify whether the shared list item is a negative keyword or negative site.

<SharedListItem i:type="-- specify derived type here with the appropriate prefix --">
  <ForwardCompatibilityMap xmlns:e6="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
    <e6:KeyValuePairOfstringstring>
      <e6:key i:nil="false"></e6:key>
      <e6:value i:nil="false"></e6:value>
    </e6:KeyValuePairOfstringstring>
  </ForwardCompatibilityMap>
  <Type i:nil="false"></Type>
  <!--Keep these fields if you set the i:type attribute to NegativeKeyword-->
  <Id i:nil="false"></Id>
  <MatchType></MatchType>
  <Text i:nil="false"></Text>
</SharedListItem>

Requirements

Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

Used By

AddListItemsToSharedList
AddSharedEntity
GetListItemsBySharedList

Share via