Edit

Campaign Negative Customer List Association Record - Bulk

  • Article

Defines a Campaign Negative Customer List 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 Campaign Negative Customer List Association records in the account by including the DownloadEntity value of CampaignNegativeCustomerListAssociations 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 Customer List 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 Customer List Association,Paused,,-1111,,,ClientIdGoesHere,,,,CustomerListIdHere,My Customer List

For a Campaign Negative Customer List Association record, the following attribute fields are available in the Bulk File Schema.

Audience

The name of the customer list.

This bulk field maps to the Audience field of the Customer List 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 Campaign Negative Customer List Associations with new customer lists 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 Customer List record. For more information, see Bulk File Schema Reference Keys.
Update: Read-only
Delete: Read-only

Audience Id

The Microsoft Advertising identifier of the customer list associated with the campaign.

This bulk field maps to the Id field of the Customer List 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 customer list identifier or specify a negative identifier that is equal to the Id field of the parent Customer List 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 Customer List record. Any of these options are recommended if you are adding new Campaign Negative Customer List Associations with new customer lists 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 customer list.

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 customer list.

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 customer list.

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 customer lists 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.