CustomerList Data Object - Campaign Management
Defines a CustomerList data object.
Important
Before you create customer list data via Campaign Management API, you must first create one customer list audience and accept the terms and conditions in the Microsoft Advertising UI. The initial customer list doesn't need to contain any customer data, but you must select I ACCEPT. By selecting "I accept" you (1) agree that you are able to lawfully disclose audience details, which is personal data, to Microsoft and (2) accept the Customer Match Terms, the Microsoft Advertising Agreement, and the Microsoft Advertising policies. Microsoft will use the data that you upload in accordance with the Customer Match Terms.
Syntax
<xs:complexType name="CustomerList" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexContent mixed="false">
<xs:extension base="tns:Audience">
<xs:sequence />
</xs:extension>
</xs:complexContent>
</xs:complexType>
Elements
The CustomerList object has Inherited Elements.
Inherited Elements
Inherited Elements from Audience
The CustomerList object derives from the Audience object, and inherits the following elements: AudienceNetworkSize, CustomerShare, Description, ForwardCompatibilityMap, Id, MembershipDuration, Name, ParentId, Scope, SearchSize, SupportedCampaignTypes, Type. The descriptions below are specific to CustomerList, and might not apply to other objects that inherit the same elements from the Audience object.
| Element | Description | Data Type |
|---|---|---|
| AudienceNetworkSize | The total number of people who are active members of this audience in the Audience network. This gives you an idea of how many Audience network users you can target. The audience needs to have at least 300 people before Microsoft Advertising will use it for optimizations. Add: Read-only Update: Read-only |
long |
| CustomerShare | Determines the list of customers and accounts that share the audience. Details include audience association counts. Shared UET tags and audiences are only available for pilot customers. For an overview of sharing audiences and UET tags in a customer hierarchy, see the Share Audiences and UET Tags technical guide. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. Set this element to null or empty to retain any existing customer account shares. To remove all customer account shares, set the CustomerAccountShares element of the CustomerShare object to null or empty. To remove a subset of customer account shares, specify the customer account shares that you want to keep in the CustomerAccountShares element of the CustomerShare object. |
CustomerShare |
| Description | The description of the audience. Use a description to help you remember what audience you are targeting. The description can contain a maximum of 1,024 characters. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed. |
string |
| 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 the Audience object. |
KeyValuePairOfstringstring array |
| Id | The Microsoft Advertising identifier of the audience. Add: Read-only Update: Required and read-only |
long |
| MembershipDuration | When you create an audience, you can specify how far back in time Microsoft Advertising should look for actions that match your audience definition. The minimum duration is 1 day and the maximum duration allowed is 390 days. You can also set the duration to -1 for no expiration. Add: Optional. If not specified, the membership duration will be set to 30 by default. Update: Optional. If no value is set for the update, this setting is not changed. |
int |
| Name | The name of the audience. The name can contain a maximum of 128 characters. Add: Required Update: Optional. If no value is set for the update, this setting is not changed. |
string |
| ParentId | The Microsoft Advertising identifier of the account or customer. If the Scope is set to Account, this is the account ID, and otherwise it is the customer ID. Add: Required Update: Read-only. You cannot change the parent ID. |
long |
| Scope | Scope defines what accounts can use this audience. If scope is set to Account, the audience can only be associated with campaigns and ad groups in one account i.e., via the ParentId. If scope is set to Customer, the audience can be associated with campaigns and ad groups in all of the customer's accounts. Add: Required Update: Optional. You can change the scope from Account to Customer, but you cannot change the scope from Customer to Account. |
EntityScope |
| SearchSize | The total number of people who are active members of this audience in the Search network. This gives you an idea of how many search users you can target. The audience needs to have at least 300 people before Microsoft Advertising will use it for optimizations. This property will be nil or empty for up to 48 hours while the audience is being built, for example if you add or update the customer list membership duration. Add: Read-only Update: Read-only |
long |
| SupportedCampaignTypes | The list of campaign types that support this audience. Supported values are Audience, DynamicSearchAds, Search, and Shopping. New campaign types might be added in the future, so you should not take any dependency on a fixed set of values. Add: Read-only Update: Read-only |
string array |
| Type | The type of the audience. This value is CustomerList when you retrieve a customer list audience. For more information about audience types, see the Audience Data Object Remarks. Add: Read-only Update: Read-only |
AudienceType |
Requirements
Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13