Edit

Customer List Item Record - Bulk

  • Article

Defines a customer list item that can be uploaded in a bulk file.

Note

Bulk download of customer list items is not supported.

Important

Before you can upload customer list data via Bulk API, you must first create one customer list audience and accept the terms and conditions in the Microsoft Advertising UI. The initial customer list doesn't need to contain any customer data, but you must select I ACCEPT. By selecting "I accept" you (1) agree that you are able to lawfully disclose audience details, which is personal data, to Microsoft and (2) accept the Customer Match Terms, the Microsoft Advertising Agreement, and the Microsoft Advertising policies. Microsoft will use the data that you upload in accordance with the Customer Match Terms.

A customer list is a set of customer contact information that you have compiled to enable customer match. Each list can include multiple Email items.

You can add or update a Customer List record without any Customer List Item records in the same Bulk upload file; however, you cannot upload any Customer List Item records without the accompanying parent Customer List record.

After 48 hours, check the Audience Size fields e.g., Audience Search Size to see how many of these customers we matched on the Bing Network. At that point, your ads can start showing for this new audience.

Tip

For an overview and more information about audiences, see the Audience APIs technical guide.

You can download all Customer List Item records in the account by including the DownloadEntity value of CustomerLists 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 customer list item.

Type,Status,Id,Parent Id,Client Id,Modified Time,Name,Description,Scope,Audience,Action Type,Sub Type,Text
Format Version,,,,,,6.0,,,,,,
Customer List,Active,-10,,ClientIdGoesHere,,,New customer list description,Customer,New Customer List,Add,,
Customer List Item,,,-10,ClientIdGoesHere,,,,,,,Email,HashedValue

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

Audience

The name of the parent customer list audience.

The name can contain a maximum of 128 characters.

Add: Required. You must specify either the Parent Id or Audience field.
Delete: Required. You must specify either the Parent Id or Audience 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
Delete: Optional

Parent Id

The identifier of the parent customer list audience.

You must specify either the Parent Id or Audience field.

Add: Read-only and Required. 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. This is required if you are adding new customer list items to a new customer list in the same Bulk file. For more information, see Bulk File Schema Reference Keys.
Delete: Required.

Sub Type

Determines whether the Text field represents a hashed Email value.

Currently the only supported value is "Email".

Add: Required
Delete: Required

Text

The hashed Email as text.

If the Sub Type is "Email", this field cannot contain plain text. The string must be hashed using the SHA-256 algorithm. The hashed Email must be a hexadecimal string of length 64. For example, you must upload a hashed string such as "f25ad364d33972379a7a4f4df33db142205f5c40eb19cfdb2fc5aaf117e10101" instead of "test@contoso.com".

Add: Required
Delete: Required