Edit

Campaign Negative In Market Audience Association Record - Bulk

  • Article

Defines a Campaign Negative In Market Audience Association that can be uploaded and downloaded in a bulk file.

Note

This feature is available in Australia, Canada, France, Germany, United Kingdom, and United States.

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.

You can download all Campaign Negative In Market Audience Association records in the account by including the DownloadEntity value of CampaignNegativeInMarketAudienceAssociations 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 In Market 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,,
Campaign Negative In Market Audience Association,Paused,,-1111,,,ClientIdGoesHere,,,,InMarketAudienceIdHere,My In Market 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 BulkCampaignNegativeInMarketAudienceAssociation 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 BulkCampaignNegativeInMarketAudienceAssociation
var bulkCampaignNegativeInMarketAudienceAssociation = new BulkCampaignNegativeInMarketAudienceAssociation
{
    // 'Campaign' column header in the Bulk file
    CampaignName = null,

    // 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 AudienceCriterion
        {
            // 'Audience Id' column header in the Bulk file
            AudienceId = inMarketAudienceIdKey,
        },
        // 'Id' column header in the Bulk file
        Id = null,
        // 'Status' column header in the Bulk file
        Status = CampaignCriterionStatus.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(bulkCampaignNegativeInMarketAudienceAssociation);

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 In Market Audience Association record, the following attribute fields are available in the Bulk File Schema.

Audience

The name of the in-market audience.

This bulk field maps to the Audience field of the In Market Audience record.

Bulk API download returns all in-market audience associations, whether the in-market audience is active or deleted. If the association is for a deleted in-market audience, then this field will be set to the same value as the Audience Id field.

Add: Read-only and Required for some use cases. You must either specify the Audience or Audience Id field. If you are adding new Campaign Negative In Market Audience Associations with new in-market 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 In Market 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 in-market audience associated with the campaign.

This bulk field maps to the Id field of the In Market 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 in-market audience identifier or specify a negative identifier that is equal to the Id field of the parent In Market 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 In Market Audience record. Any of these options are recommended if you are adding new Campaign Negative In Market Audience Associations with new in-market audiences in the same Bulk file. For more information, see Bulk File Schema Reference Keys.
Update: Read-only
Delete: Read-only

Campaign

The name of the campaign that is associated with the in-market audience.

Add: Read-only and Required
Update: Read-only and Required
Delete: Read-only and Required

Note

For add, update, and delete, you must specify either the Parent Id or Campaign field.

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 a campaign and in-market 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 campaign that is associated to the in-market audience.

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 associating in-market audiences to a new campaign in the same Bulk file. For more information, see Bulk File Schema Reference Keys.
Update: Read-only and Required
Delete: Read-only and Required

Note

For add, update, and delete, you must specify either the Parent Id or Campaign field.

Status

The association status.

Possible values are Active or Deleted.

Add: Optional. The default status value is Active.
Update: Optional
Delete: Required. The Status must be set to Deleted.