SharedEntity Data Object - Campaign Management

Article
02/13/2024

Defines the base class of a shared entity.

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

The NegativeKeywordList, AccountNegativeKeywordList, and PlacementExclusionList are each derived from the SharedList, which derives from the SharedEntity object.

Syntax

<xs:complexType name="SharedEntity" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="AssociationCount" nillable="true" type="xs:int" />
    <xs:element xmlns:q92="http://schemas.datacontract.org/2004/07/System.Collections.Generic" minOccurs="0" name="ForwardCompatibilityMap" nillable="true" type="q92:ArrayOfKeyValuePairOfstringstring" />
    <xs:element minOccurs="0" name="Id" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Type" nillable="true" type="xs:string" />
  </xs:sequence>
</xs:complexType>

Elements

The SharedEntity object has the following elements: AssociationCount, ForwardCompatibilityMap, Id, Name, Type.

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

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 <SharedEntity> node as shown in the following example, to specify whether the shared entity is a negative keyword list or a website exclusion list.

<SharedEntity i:type="NegativeKeywordList" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AssociationCount i:nil="true" />
  <ForwardCompatibilityMap i:nil="true" xmlns:a="http://schemas.datacontract.org/2004/07/System.Collections.Generic" />
  <Id i:nil="true" />
  <Name>My Negative Keyword List</Name>
  <ItemCount i:nil="true" />
</SharedEntity>

Requirements

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

Used By

AddSharedEntity
DeleteSharedEntities
GetSharedEntities
GetSharedEntitiesByAccountId
UpdateSharedEntities

Share via