Microsoft Customer Match Setup Guide | Server-Side Connectors

API Information

This connector uses the following vendor API:

API Name: Bulk API
API Version: v13
API Endpoint: https://bulk.api.bingads.microsoft.com/Api/Advertiser/CampaignManagement/V13/BulkService.svc
Documentation: Bulk API

Batch Limits

This connector uses batched requests to support high-volume data transfers to the vendor. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:

Max number of requests: 100000
Max time since oldest request: 60 minutes
Max size of requests: 100 MB

Connector Actions

Action Name	AudienceStream	EventStream
Add User to Audience	✓	✗
Remove User from Audience	✓	✗

Configure Settings

Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see About Connectors.

After adding the connector, configure the following settings:

Account ID
Required. The identifier of the ad account that owns or is associated with the entities in the request.
It can be found in the URL (for example, AID=) when the advertiser logs into Microsoft Ads UI.
Customer ID
Required. The identifier of the manager account (customer) the user is accessing or operating from.
It can be found in the URL (for example, CID=) when the advertiser logs into Microsoft Ads UI.

After setting Account ID and Customer ID, click Establish Connection to connect to Microsoft’s servers.

Create Customer Match List

Use this option to create customer match lists to add subscribers to target with advertising. The resulting Request ID value can be used to determine if the list creation process has completed.

After you click the Create button, please wait until you receive a confirmation message. If the customer list has successfully uploaded, the interface will display the upload’s Request ID. You can copy the Request ID and use it to check the upload status.

Field	Description
Name	Required. The name of the customer list. This field can contain a maximum of 128 characters.
Description	Optional. The description of the customer list. Use a description to help you remember what audience you are targeting with this customer list. This field can contain a maximum of 1,024 characters.
Parent ID	Optional. The Microsoft Advertising identifier of the customer that contains the customer list.
Client ID	Optional. Used to associate records in the bulk upload file with records in the results file. This field can be any valid string with a maximum of 100 characters.
Membership Duration	Optional. When you create a customer list, you can specify how far back in time Microsoft Advertising should look for actions that match your customer list definition in order to add people to your list. The minimum duration is `1` day and the maximum duration allowed is `180` days. If membership duration is `-1`, there is no expiration. If membership duration is null, the default duration (30 days) is used.

Check Upload Status

Use this option to check the status of your list creation and upload status. This allows you to confirm that customers are being subscribed to the proper lists.

If the upload status is Completed or CompletedWithErrors, the URL of the results file will appear. Use this URL to download the results file. The URL expires five minutes after the Check the Status operation displays the upload status. If you do not start the download within this period of time, you will need to check the status again to get a new URL.

Field	Description
Request ID	The identifier of the upload request.

Actions

Enter a name for the action and select the action type from the drop-down menu.

The following section describes how to set up parameters and options for each action.

Add User to Audience

Parameters

Parameter	Description
Customer Match List ID	Please enter the Customer Match List ID. To find your Customer Match List ID: log into Microsoft Advertising UI and select Tools, then click the Audiences tab. Note: Before you can upload customer list data, you must first accept the terms and conditions in the Microsoft Advertising UI.
Email Address (already SHA256 hashed)	Provide an email address which has been already SHA256 hashed.
Email Address (apply SHA256 hash)	Provide a plain text email address, and the connector will whitespace trim, lowercase, and hash this value using SHA256 hash.

Remove User from Audience

Parameters

Parameter	Description
Customer Match List ID	Please enter the Customer Match List ID. To find your Customer Match List ID: log into Microsoft Advertising UI and select Tools, then click the Audiences tab. Note: Before you can upload customer list data, you must first accept the terms and conditions in the Microsoft Advertising UI.
Email Address (already SHA256 hashed)	Provide an email address which has been already SHA256 hashed.
Email Address (apply SHA256 hash)	Provide a plain text email address, and the connector will whitespace trim, lowercase, and hash this value using SHA256 hash.