SharedEntity Data Object - Campaign Management

Defines the base class of a shared entity.

Do not try to instantiate a SharedEntity. You can create the following object that derives from it.

A NegativeKeywordList is 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 minOccurs="0" name="ForwardCompatibilityMap" nillable="true" type="q68:ArrayOfKeyValuePairOfstringstring" xmlns:q68="http://schemas.datacontract.org/2004/07/System.Collections.Generic" />
    <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

Element Description Data Type
AssociationCount The number of active associations between this object and an entity such as a campaign. 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 Bing Ads identifier of the shared entity. long
Name The name of the shared entity. string
Type The type of the shared entity. For more information about shared entity types, see SharedEntity Data Object 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 <SharedEntity> node as shown in the following example, to specify whether the shared entity is a negative keyword 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 v12
Namespace: https://bingads.microsoft.com/CampaignManagement/v12

Used By

AddSharedEntity
DeleteSharedEntities
GetSharedEntitiesByAccountId
UpdateSharedEntities