CustomAudience Data Object - Campaign Management

Defines a custom audience.

Note

Only update of the Name and Description are supported. You can delete but cannot add a custom audience using the Bing Ads API. Having said that, you can add and delete custom audience associations and exclusions.

A custom audience is a type of remarketing list that is generated by using your own customer data to create richer user segments. You can use custom audiences in conjunction with your remarketing lists, usually through your data management provider (DMP). When your DMP connects to our custom audience feature, you can then import your custom audiences into Microsoft Advertising for search remarketing. You can use custom audiences separately from remarketing, with no UET required.

Tip

For an overview of custom audiences see the About custom audiences help topic.

Syntax

<xs:complexType name="CustomAudience" 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 CustomAudience object has Inherited Elements.

Inherited Elements

Inherited Elements from Audience

The CustomAudience object derives from the Audience object, and inherits the following elements. The descriptions below are specific to CustomAudience, 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: Not supported
Update: Read-only
long
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: Not supported
Update: Optional. If no value is set for the update, this setting is not changed. To remove the previous setting, set this elemment to an empty string value ("").
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: Not supported
Update: Required and read-only
long
MembershipDuration The membership duration determines how far back in time Microsoft Advertising should look for actions that match your custom audience definition in order to add people to your list. For a custom audience the membership duration is not set in the Microsoft Advertising web application, and Microsoft Advertising defers to your custom audience provider settings.

When you request the custom audience via Bing Ads API, the returned membership duration will be null.

Add: Not supported
Update: Not supported
int
Name The name of the audience. The name can contain a maximum of 128 characters.

Add: Not supported
Update: Optional. If no value is set for the update, this setting is not changed.
string
ParentId The Microsoft Advertising identifier of the customer that contains the custom audience.

Add: Not supported
Update: Not supported
long
Scope Scope defines what accounts can use this audience.

For an custom audience the only supported scope is Customer, and the custom audience can be associated with any ad groups across all of the customer's accounts.

Add: Not supported
Update: Not supported
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 1,000 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 have imported new custom audiences from DMP, it takes 24 hours to build the audience, and in the meantime this property will be nil or empty.

Add: Not supported
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: Not supported
Update: Read-only
string array
Type The type of the audience. This value is Custom when you retrieve a custom audience. For more information about audience types, see the Audience Data Object Remarks.

Add: Not supported
Update: Read-only
AudienceType

Requirements

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