SharedList Data Object - Campaign Management
Defines the base class of a shared list.
Do not try to instantiate a SharedList. You can create one or more of the following objects that derive from it.
Syntax
<xs:complexType name="SharedList" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexContent mixed="false">
<xs:extension base="tns:SharedEntity">
<xs:sequence>
<xs:element minOccurs="0" name="ItemCount" nillable="true" type="xs:int" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Elements
The SharedList object has the following elements: ItemCount.
Element | Description | Data Type |
---|---|---|
ItemCount | The number of SharedListItem objects that are added to this shared list. Add: Read-only Update: Read-only |
int |
The SharedList object has Inherited Elements.
Inherited Elements
Inherited Elements from SharedEntity
The SharedList object derives from the SharedEntity object, and inherits the following elements: AssociationCount, ForwardCompatibilityMap, Id, Name, Type. The descriptions below are specific to SharedList, and might not apply to other objects that inherit the same elements from the SharedEntity object.
Element | Description | Data Type |
---|---|---|
AssociationCount | The number of active associations between this shared entity and another entity such as campaign or ad account. For a NegativeKeywordList, the maximum number of active associations between the negative keyword list and campaign is 20. For a PlacementExclusionList, the maximum number of active associations between the website exclusion list and ad account is undefined. Add: Read-only Update: Read-only |
int |
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 |
Id | The unique Microsoft Advertising identifier of the shared entity. Add: Read-only Update: Required |
long |
Name | The name of the shared entity. The maximum string length is 255. Add: Optional Update: Optional |
string |
Type | The type of the shared entity. This value is NegativeKeywordList when you retrieve a NegativeKeywordList. This value is PlacementExclusionList when you retrieve a PlacementExclusionList. This value is AccountNegativeKeywordList when you retrieve an AccountNegativeKeywordList. For more information about shared entity types, see SharedEntity Data Object Remarks. Add: Read-only Update: Read-only |
string |
Requirements
Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
Used By
AddListItemsToSharedList
DeleteListItemsFromSharedList
GetListItemsBySharedList