Ad Group Custom Audience Association Record - Bulk
Defines an Ad Group Custom Audience Association that can be uploaded and downloaded in a bulk file.
Audience targets cannot be set both campaign and ad group level. If you set any biddable campaign level audience criteria, then you cannot set any biddable ad group level audience criteria. Audience exclusions can be set at both campaign and ad group level. Microsoft Advertising applies a union of both campaign and ad group level exclusions.
Tip
For an overview and more information about audiences, see the Audience APIs technical guide.
You can download all Ad Group Custom Audience Association records in the account by including the DownloadEntity value of AdGroupCustomAudienceAssociations 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.
The following Bulk CSV example would add a new Ad Group Custom Audience Association if a valid Parent Id value is provided.
Type,Status,Id,Parent Id,Campaign,Ad Group,Client Id,Modified Time,Bid Adjustment,Name,Audience Id,Audience
Format Version,,,,,,,,,6.0,,
Ad Group Custom Audience Association,Paused,,-1111,,,ClientIdGoesHere,,10,,CustomAudienceIdHere,My Custom Audience
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 BulkAdGroupCustomAudienceAssociation object, instead of calling the service operations directly and writing custom code to parse each field in the bulk file.
var uploadEntities = new List<BulkEntity>();
// Map properties in the Bulk file to the BulkAdGroupCustomAudienceAssociation
var bulkAdGroupCustomAudienceAssociation = new BulkAdGroupCustomAudienceAssociation
{
// 'Ad Group' column header in the Bulk file
AdGroupName = null,
// Map properties in the Bulk file to the
// BiddableAdGroupCriterion object of the Campaign Management service.
BiddableAdGroupCriterion = new BiddableAdGroupCriterion
{
// 'Parent Id' column header in the Bulk file
AdGroupId = adGroupIdKey,
Criterion = new AudienceCriterion
{
// 'Audience Id' column header in the Bulk file
AudienceId = customAudienceIdKey,
},
// 'Bid Adjustment' column header in the Bulk file
CriterionBid = new BidMultiplier
{
Multiplier = 10
},
// 'Id' column header in the Bulk file
Id = null,
// 'Status' column header in the Bulk file
Status = AdGroupCriterionStatus.Paused
},
// 'Campaign' column header in the Bulk file
CampaignName = null,
// 'Client Id' column header in the Bulk file
ClientId = "ClientIdGoesHere",
// 'Audience' column header in the Bulk file
AudienceName = null,
};
uploadEntities.Add(bulkAdGroupCustomAudienceAssociation);
var entityUploadParameters = new EntityUploadParameters
{
Entities = uploadEntities,
ResponseMode = ResponseMode.ErrorsAndResults,
ResultFileDirectory = FileDirectory,
ResultFileName = DownloadFileName,
OverwriteResultFile = true,
};
var uploadResultEntities = (await BulkServiceManager.UploadEntitiesAsync(entityUploadParameters)).ToList();
For an Ad Group Custom Audience Association record, the following attribute fields are available in the Bulk File Schema.
Ad Group
The name of the ad group that is associated with the custom audience.
Add: Read-only and Required
Update: Read-only and Required
Delete: Read-only and Required
Audience
The name of the custom audience.
This bulk field maps to the Audience field of the Custom Audience record.
Add: Read-only and Required for some use cases. You must either specify the Audience or Audience Id field. If you are adding new Ad Group Custom Audience Associations with new custom audiences in the same Bulk file, and if you do not set the Audience Id field, then this Audience field must be set as a logical key to the same value as the Audience field of the Custom Audience record. For more information, see Bulk File Schema Reference Keys.
Update: Read-only
Delete: Read-only
Audience Id
The Microsoft Advertising identifier of the custom audience associated with the ad group.
This bulk field maps to the Id field of the Custom Audience record.
Add: Read-only and Required for some use cases. You must either specify the Audience or Audience Id field. If you set the Audience Id field, you must either specify an existing custom audience identifier or specify a negative identifier that is equal to the Id field of the parent Custom Audience record. If the Audience Id field is not set, then you must set the Audience field as a logical key to the same value as the Audience field of the Custom Audience record. Any of these options are recommended if you are adding new Ad Group Custom Audience Associations with new custom audiences in the same Bulk file. For more information, see Bulk File Schema Reference Keys.
Update: Read-only
Delete: Read-only
Bid Adjustment
The percentage you want to increase/decrease the bid amount for the custom audience.
Supported values are negative ninety (-90.00) through positive nine hundred (900.00).
Important
If not specified, the default bid adjustment value is 0. The default value is subject to change.
Add: Optional
Update: Optional. If no value is set for the update, this setting is not changed.
Delete: Read-only
Campaign
The name of the campaign that contains the ad group.
Add: Read-only
Update: Read-only
Delete: Read-only
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
Id
The system-generated identifier for the association between an ad group and custom audience.
Add: Read-only
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 system-generated identifier of the ad group that is associated to the custom audience.
This bulk field maps to the Id field of the Ad Group record.
Add: Read-only and Required. You must either specify an existing ad group identifier, or specify a negative identifier that is equal to the Id field of the parent Ad Group record. This is recommended if you are associating custom audiences to a new ad group in the same Bulk file. For more information, see Bulk File Schema Reference Keys.
Update: Read-only and Required
Delete: Read-only and Required
Status
The association status.
Possible values are Active, Paused, or Deleted.
Add: Optional. The default status value is Active.
Update: Optional
Delete: Required. The Status must be set to Deleted.