CombinedList Data Object - Campaign Management

Article
03/20/2023

A combined list is an audience created from a combination of multiple existing audiences.

You can combine custom audiences, customer lists, product audiences, similar audiences, and remarketing lists. You cannot include other combined lists or in-market audiences in a combined list.

You can create a maximum of 1,000 combined lists per ad account, and up to 5,000 per customer. Each list can include up to 100 combination rules or sets of logical conditions, and each CombinationRule can contain up to 100 audience IDs.

Tip

For an overview and more information about audiences, see the Audience APIs technical guide.

Syntax

<xs:complexType name="CombinedList" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:Audience">
      <xs:sequence>
        <xs:element minOccurs="0" name="CombinationRules" nillable="true" type="tns:ArrayOfCombinationRule" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

The CombinedList object has the following elements: CombinationRules.

Element	Description	Data Type
CombinationRules	Logical conditions used to determine who to add to your combined list. Each list can include up to 100 combination rules or sets of logical conditions, and each CombinationRule can contain up to 100 audience IDs. For details, please see the CombinationRule Remarks. Add: Required Update: Required. If you want to keep any of the previous rules, then you must explicitly set them again during update.	CombinationRule array

The CombinedList object has Inherited Elements.

Inherited Elements

Inherited Elements from Audience

The CombinedList 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 CombinedList, 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	This element is not supported for combined list audiences. Add: Not supported Update: Not supported	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	This element is not supported for combined list audiences. Add: Not supported Update: Not supported	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 24 hours while the audience is being built, for example if you add or update the combined list membership duration, rule, or tag identifier. This property will be nil or empty if the UET tag associated with the combined list has a status of Unverified or Inactive, because the combined list can't receive the customer information from your website that it needs to build the list. 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 CombinedList when you retrieve a combined 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

Share via