AudienceGroup Data Object - Campaign Management

Defines an AudienceGroup data object.

Syntax

XML

<xs:complexType name="AudienceGroup" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="AssociationCount" nillable="true" type="xs:int" />
    <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Dimensions" nillable="true" type="tns:ArrayOfAudienceGroupDimension" />
    <xs:element minOccurs="0" name="Id" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
  </xs:sequence>
</xs:complexType>

JSON

{
  "AssociationCount": IntValueHere,
  "Description": "ValueHere",
  "Dimensions": [
    {
      "Type": "Age",
      "AgeRanges": [
        "ValueHere"
      ]
    }
  ],
  "Id": "LongValueHere",
  "Name": "ValueHere"
}

Elements

The AudienceGroup object has the following elements: AssociationCount, Description, Dimensions, Id, Name.

Element	Description	Data Type
AssociationCount	The number of asset groups that associate with this audience group. Add: Read-only Update: Read-only	int
Description	The description of the audience. Use a description to help you remember what audience you are using. Add: Optional Update: Optional. If no value is set for the update, this setting is not changed.	string
Dimensions	Positive dimensions that specifying the audience composition. It should have at least one dimension. Add: Required, at least one dimension is needed. Update: Optional. For each dimension type (age, gender, audience): - If not present in the array, it's not changed. - If it's present in the array, take Age dimension type as an example:     - If AgeRanges is set to null or empty, it'll remove existing values for this dimension type.     - If AgeRanges has data, it simply replaces existing values. Note: You can't remove all dimension types. An error will be returned and no changes will be made.	AudienceGroupDimension array
Id	The system-generated ID. Add: Read-only Update: Required	long
Name	The name of the audience signal, the name must be unique among all audience groups within the account. The name can contain a maximum of 256 characters. Add: Required Update: Optional	string

Requirements

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

Used By

AddAudienceGroups
GetAudienceGroupsByIds
UpdateAudienceGroups