CustomerAccountShare Data Object - Campaign Management

Defines a customer or account that can use the shared audience or UET tag.

Tip

For an overview of sharing audiences and UET tags in an account hierarchy, see the Share Audiences and UET Tags technical guide.

XML

<xs:complexType name="CustomerAccountShare" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="AccountId" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="Associations" nillable="true" type="tns:ArrayOfCustomerAccountShareAssociation" />
    <xs:element minOccurs="0" name="CustomerId" nillable="true" type="xs:long" />
  </xs:sequence>
</xs:complexType>

JSON

{
  "AccountId": "LongValueHere",
  "Associations": [
    {
      "AssociationCount": "LongValueHere",
      "UsageType": "ValueHere"
    }
  ],
  "CustomerId": "LongValueHere"
}

Elements

The CustomerAccountShare object has the following elements: AccountId, Associations, CustomerId.

Element	Description	Data Type
AccountId	The identifier of an advertiser account that can use the shared audience. This element is not applicable for UET tags since you cannot restrict UET tags to a subset of advertiser accounts. You can only create and share UET tags at the CustomerId level. If this element is not set, then all accounts under the CustomerId can use the shared audience or UET tag. One CustomerAccountShare object per advertiser account must be present in the CustomerShare for an audience that is shared with a subset of advertiser accounts, whether or not the advertiser accounts are under the same customer. Add: Optional. You must set the AccountId or CustomerId, but you cannot set both. Update: Optional. You must set the AccountId or CustomerId, but you cannot set both. If no value is set for the update, this setting is not changed.	long
Associations	Provides details about whether and how the shared audience or UET tag is being used. Each list item contains the association count for the corresponding usage type. Add: Read-only Update: Read-only	CustomerAccountShareAssociation array
CustomerId	The identifier of a customer that can use the shared audience or UET tag. If this element is not set, then the audience is only shared with a subset of advertiser accounts under this customer. Please see AccountId for details about sharing audiences with advertiser accounts. Add: Optional. You must set the AccountId or CustomerId, but you cannot set both. Update: Optional. If no value is set for the update, this setting is not changed.	long

Requirements

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

Used By

CustomerShare