Edit

Campaign Negative Gender Criterion Record - Bulk API

Defines a campaign negative gender criterion that can be uploaded and downloaded in a bulk file.

You can exclude customers by gender so that your ads are not displayed to people of a specified gender. Each negative gender criterion defines a gender to exclude for the campaign.

The maximum number of gender criterions that you can specify per campaign is three, i.e. one for each of the supported genders Female, Male, and Unknown.

Negative gender criterions at the campaign level are only supported for Performance Max campaigns.

Tip For an overview of how to use target criterions, see Show Ads to Your Target Audience.

You can download all Campaign Negative Gender Criterion records in the account by including the DownloadEntity value of CampaignTargetCriterions 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 campaign negative gender criterion if a valid Parent Id value is provided.

Type,Status,Id,Parent Id,Sub Type,Campaign,Client Id,Modified Time,Target,Bid Adjustment,Name,Radius,Unit,From Hour,From Minute,To Hour,To Minute,Latitude,Longitude
Format Version,,,,,,,,,,6.0,,,,,,,,
Campaign Negative Gender Criterion,Active,,-111,,,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 BulkCampaignNegativeGenderCriterion 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 BulkCampaignNegativeGenderCriterion
var bulkCampaignNegativeGenderCriterion = new BulkCampaignNegativeGenderCriterion
{
    // '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
    // NegativeCampaignCriterion object of the Campaign Management service.
    NegativeCampaignCriterion = new NegativeCampaignCriterion
    {
        // 'Parent Id' column header in the Bulk file
        CampaignId = campaignIdKey,

        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 = CampaignCriterionStatus.Active,
    }
};

uploadEntities.Add(bulkCampaignNegativeGenderCriterion);

var entityUploadParameters = new EntityUploadParameters
{
    Entities = uploadEntities,
    ResponseMode = ResponseMode.ErrorsAndResults,
    ResultFileDirectory = FileDirectory,
    ResultFileName = DownloadFileName,
    OverwriteResultFile = true,
};

var uploadResultEntities = (await BulkServiceManager.UploadEntitiesAsync(entityUploadParameters)).ToList();

For a Campaign Negative Gender Criterion record, the following attribute fields are available in the Bulk File Schema.

Campaign

The name of the campaign where this criterion is applied or removed.

Add: 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 Delete: Optional

Id

The Microsoft Advertising unique identifier of the criterion.

Add: Read-only 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 Delete: Read-only

Parent Id

The identifier of the campaign where this criterion is applied or removed.

This bulk field maps to the Id field of the Campaign record.

Add: Read-only and Required. You must either specify an existing campaign identifier, or specify a negative identifier that is equal to the Id field of the parent Campaign record. This is recommended if you are adding new criterions to a new campaign in the same Bulk file. For more information, see Bulk File Schema Reference Keys. Delete: Read-only and Required

Status

Represents the association status between the campaign and the criterion. If the criterion is applied to the campaign, 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. Delete: Required. The Status must be set to Deleted. To delete a specific negative gender criterion, you must upload the Status, Id, and Parent Id.

Target

The gender that you want to exclude.

Supported values are Female, Male, and Unknown. You can also exclude Unknown i.e., people whose gender is not known.

Warning Your reach may be significantly reduced if you exclude the Unknown category for a campaign.

Add: Required Delete: Read-only

  • Last updated on