Ad Group Negative Gender Criterion Record - Bulk
Defines an Ad Group Negative Gender Criterion that can be uploaded and downloaded in a bulk file.
You can exclude customers by gender so that your ads are displayed more frequently to people who will be interested in them.
If ad group level gender criterions are specified, the campaign level gender criterions are ignored for that ad group. In other words the ad group gender criterions override the campaign gender criterions, and are not applied as a union.
Tip
For an overview of how to use target criterions, see Show Ads to Your Target Audience.
You can download all Ad Group Negative Gender Criterion records in the account by including the DownloadEntity value of AdGroupTargetCriterions 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 Negative Gender Criterion if a valid Parent Id value is provided.
Type,Status,Id,Parent Id,Sub Type,Campaign,Ad Group,Client Id,Modified Time,Target,,Name,OS Names,Radius,Unit,From Hour,From Minute,To Hour,To Minute,Latitude,Longitude
Format Version,,,,,,,,,,,6.0,,,,,,,,,
Ad Group Negative Gender Criterion,Active,,-1111,,,,ClientIdGoesHere,,Female,,,,,,,,,,,
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 BulkAdGroupNegativeGenderCriterion 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 BulkAdGroupNegativeGenderCriterion
var BulkAdGroupNegativeGenderCriterion = new BulkAdGroupNegativeGenderCriterion
{
// 'Ad Group' column header in the Bulk file is read-only
AdGroupName = null,
// 'Campaign' column header in the Bulk file is read-only
CampaignName = null,
// 'Client Id' column header in the Bulk file
ClientId = "ClientIdGoesHere",
// Map properties in the Bulk file to the
// NegativeAdGroupCriterion object of the Campaign Management service.
NegativeAdGroupCriterion = new NegativeAdGroupCriterion
{
// 'Parent Id' column header in the Bulk file
AdGroupId = adGroupIdKey,
Criterion = new GenderCriterion
{
// 'Target' column header in the Bulk file
GenderType = GenderType.Female
},
// 'Id' column header in the Bulk file
Id = null,
// 'Status' column header in the Bulk file
Status = AdGroupCriterionStatus.Active,
}
};
uploadEntities.Add(BulkAdGroupNegativeGenderCriterion);
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 Negative Gender Criterion record, the following attribute fields are available in the Bulk File Schema.
Ad Group
The name of the ad group where this criterion is applied or removed.
Add: Read-only
Update: Read-only
Delete: Read-only
Campaign
The name of the campaign that contains the ad group where this criterion is applied or removed.
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: Optional
Id
The Microsoft Advertising unique identifier of the criterion.
Note
Previously with Campaign Management API version 10 it was possible to associate one target identifier with multiple campaigns and ad groups using the AddTargetsToLibrary, SetTargetToCampaign, and SetTargetToAdGroup operations. After a campaign or ad group had been disassociated from the shared target, the criterion identifier would be set to 0 (zero) in the Bulk download or Bulk upload result file.
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 identifier of the ad group where this criterion is applied or removed.
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 adding new criterions 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
Represents the association status between the ad group and the criterion. If the criterion is applied to the ad group, this field's value is Active. To delete the criterion, set the status to Deleted.
Add: Read-only. The status will always be set to Active when you add criterions. If you upload another value e.g., Foo the result file will contain the same value although the criterion is active.
Update: Optional
Delete: Required. The Status must be set to Deleted. To delete a specific gender criterion, you must upload the Status, Id, and Parent Id.
Target
The gender that you want to exclude.
Supported values are Female and Male. With Audience campaigns you can also exclude Unknown i.e., people whose gender is not known.
Add: Required
Update: Required
Delete: Read-only