Edit

Share via

Campaign Negative Keyword List Association Record - Bulk

  • Article

Defines an association record between a Campaign and a Negative Keyword List that can be uploaded and downloaded in a bulk file. To upload or download the campaign or negative keyword list, use the Campaign or Negative Keyword List record.

You can download all Campaign Negative Keyword List Association records in the account by including the DownloadEntity value of CampaignNegativeKeywordListAssociations 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 associate a negative keyword list to a campaign if valid Id and Parent Id values are provided.

Type,Status,Id,Parent Id,Campaign,Ad Group,Client Id,Modified Time,Keyword,Match Type,Name
Format Version,,,,,,,,,,6.0
Campaign Negative Keyword List Association,Active,-19,-112,,,ClientIdGoesHere,,,,

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 BulkCampaignNegativeKeywordList 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 BulkCampaignNegativeKeywordList
var bulkCampaignNegativeKeywordList = new BulkCampaignNegativeKeywordList
{
    // 'Client Id' column header in the Bulk file
    ClientId = "ClientIdGoesHere",

    // Map properties in the Bulk file to the 
    // SharedEntityAssociation object of the Campaign Management service.
    SharedEntityAssociation = new SharedEntityAssociation
    {
        // 'Parent Id' column header in the Bulk file
        EntityId = campaignIdKey,
        // 'Id' column header in the Bulk file
        SharedEntityId = negativeKeywordListIdKey,
    },

    // 'Status' column header in the Bulk file
    Status = Status.Active
};

uploadEntities.Add(bulkCampaignNegativeKeywordList);

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

Campaign

The name of the campaign where the negative keyword list is associated or removed.

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

Note

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

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

Id

The identifier of the negative keyword list that is associated or removed from the campaign.

This bulk field maps to the Id field of the Negative Keyword List record.

Add: Read-only and Required. You must either specify an existing negative keyword list identifier, or specify a negative identifier that is equal to the Id field of the parent Negative Keyword List record. This is recommended if you are adding new negative keyword list and associating it with a new campaign in the same Bulk file. For more information, see Bulk File Schema Reference Keys.
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 negative keyword list is associated 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 negative keyword list and associating it with a new campaign in the same Bulk file. For more information, see Bulk File Schema Reference Keys.
Delete: Read-only and Required

Note

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

Status

Represents the association status between the campaign and the negative keyword list. If the negative keyword list is not associated with 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.