Edit

Share via

Audience Group Record - Bulk

  • Article

Defines an audience group that can be uploaded and downloaded in a bulk file.

You can download all Audience Group records in the account by including the DownloadEntity value of AudienceGroups in the DownloadCampaignsByAccountIds or DownloadCampaignsByCampaignIds service request. Additionally the download request must include the EntityData scope. For more details about the Bulk service including best practices, see Bulk Download and Upload.

If you are using the Bing Ads SDKs for .NET, Java, or Python, you can save time using the BulkServiceManager to upload and download the BulkAudienceGroup object, instead of calling the service operations directly and writing custom code to parse each field in the bulk file.

For an Audience Group record, the following attribute fields are available in the Bulk File Schema.

Age Ranges

The list of age ranges, delimited by semicolon. Supported values are EighteenToTwentyFour, TwentyFiveToThirtyFour, ThirtyFiveToFourtyNine, FiftyToSixtyFour, and SixtyFiveAndAbove. You can also target Unknown i.e., people whose age is not known.

Add: Optional
Update: Optional.

  • If no value is set for the update, this setting is not changed.
  • To remove all age ranges, set this field to delete_value. The delete_value keyword removes all existing age ranges.
  • To remove a subset of age ranges, specify the age ranges that you want to keep and omit any that you do not want to keep. The new set of age ranges will replace any existing ones.

Audience Group Name

The name of the audience group.

The name must be unique among all active audience groups within the campaign. The name can contain a maximum of 256 characters.

Add: Required
Update: Optional. If no value is set for the update, this setting is not changed.
Delete: Read-only

Audiences

The list of Audience IDs, delimited by semicolon.

Add: Optional
Update: Optional.

  • If no value is set for the update, this setting is not changed.
  • To remove all audiences, set this field to delete_value. The delete_value keyword removes all existing audiences.
  • To remove a subset of audiences, specify the audiences that you want to keep and omit any that you do not want to keep. The new set of audiences will replace any existing ones.

Client Id

Used to associate records in the bulk upload file with records in the results file. The value of this field is not used or stored by the server; it is simply copied from the uploaded record to the corresponding result record. It may be any valid string to up 100 in length.

Add: Optional
Update: Optional
Delete: Read-only

Description

The description of the audience signal.

The description can contain a maximum of 1,024 characters.

Add: Optional.
Update: Optional.

Gender Types

The list of gender types, delimited by semicolon. Supported values are Female and Male. You can also target Unknown i.e., people whose gender is not known.

Add: Optional
Update: Optional.

  • If no value is set for the update, this setting is not changed.
  • To remove all gender types, set this field to delete_value. The delete_value keyword removes all existing gender types.
  • To remove a subset of gender types, specify the gender types that you want to keep and omit any that you do not want to keep. The new set of gender types will replace any existing ones.

Id

The system-generated identifier of the audience group.

Add: Optional. You must either leave this field empty, or specify a negative identifier. A negative identifier set for the audience group can then be referenced in the Parent Id field of dependent record types such as ads, keywords, or criterion. This is recommended if you are adding new audience groups and new dependent records in the same Bulk file. For more information, see Bulk File Schema Reference Keys.
Update: Read-only and Required
Delete: Read-only and Required

Modified Time

The date and time that the entity was last updated. The value is in Coordinated Universal Time (UTC).

Note

The date and time value reflects the date and time at the server, not the client. For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types.

Add: Read-only
Update: Read-only
Delete: Read-only

Parent Id

The account ID.

Add: Optional
Update: Optional
Delete: Optional

Status

The status of the audience group.

Possible values are Active, Deleted.

Add: Optional.
Update: Optional. If no value is set for the update, this setting is not changed.
Delete: Required. The Status must be set to Deleted.