Audience Data Object - Campaign Management

Article
03/20/2023

Defines the base object of an audience.

Do not try to instantiate an Audience. You can create one or more of the following objects that derive from it.

Note

Microsoft Advertising will automatically generate similar audiences for remarketing lists for pilot participants i.e., GetCustomerPilotFeatures returns feature identifier 317.

Syntax

<xs:complexType name="Audience" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="AudienceNetworkSize" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="CustomerShare" nillable="true" type="tns:CustomerShare" />
    <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
    <xs:element xmlns:q123="http://schemas.datacontract.org/2004/07/System.Collections.Generic" minOccurs="0" name="ForwardCompatibilityMap" nillable="true" type="q123:ArrayOfKeyValuePairOfstringstring" />
    <xs:element minOccurs="0" name="Id" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="MembershipDuration" nillable="true" type="xs:int" />
    <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="ParentId" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="Scope" nillable="true" type="tns:EntityScope" />
    <xs:element minOccurs="0" name="SearchSize" nillable="true" type="xs:long" />
    <xs:element xmlns:q124="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="SupportedCampaignTypes" nillable="true" type="q124:ArrayOfstring" />
    <xs:element minOccurs="0" name="Type" type="tns:AudienceType" />
  </xs:sequence>
</xs:complexType>

Elements

The Audience object has the following elements: AudienceNetworkSize, CustomerShare, Description, ForwardCompatibilityMap, Id, MembershipDuration, Name, ParentId, Scope, SearchSize, SupportedCampaignTypes, Type.

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. Please see more details in documentation for the objects that inherit this element e.g., RemarketingList.	long
CustomerShare	Determines the list of customers and accounts that share the audience. Details include audience association counts. This element is only supported with a RemarketingList. Audiences of other types cannot be shared in the customer hierarchy.	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.	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 this object.	KeyValuePairOfstringstring array
Id	The Microsoft Advertising identifier of the audience.	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 180 days.	int
Name	The name of the audience. The name can contain a maximum of 128 characters.	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.	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.	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. Please see more details in documentation for the objects that inherit this element e.g., RemarketingList.	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.	string array
Type	The type of the audience. For more information about audience types, see the Remarks.	AudienceType

Remarks

For Java and the .NET languages, do not set the Type element because the value is determined by whether you instantiate a custom audience or another type of audience. If you generate the SOAP manually, use the type attribute of the Audience node as shown in the following example.

<Audiences xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Audience i:type="CustomAudience">
    <Description i:nil="false">Custom Audience Description</Description>
    <ForwardCompatibilityMap xmlns:e43="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
      <e43:KeyValuePairOfstringstring>
        <e43:key i:nil="false"></e43:key>
        <e43:value i:nil="false"></e43:value>
      </e43:KeyValuePairOfstringstring>
    </ForwardCompatibilityMap>
    <Id i:nil="true" />
    <MembershipDuration i:nil="false">30</MembershipDuration>
    <Name i:nil="false">Custom Audience Name</Name>
    <ParentId i:nil="false">ParentIdHere</ParentId>
    <Scope>Customer</Scope>
  </Audience>
</Audiences>

Requirements

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

Used By

AddAudiences
GetAudiencesByIds
UpdateAudiences

Share via