Microsoft Bing CAPI Destination
Beta
This feature is in active development and may change before general availability.
Microsoft Bing Conversions API (CAPI) lets you send offline conversion data from Segment to Microsoft Advertising. This enables enhanced customer attribution data and supports cross-device and cross-platform conversion attribution. You can use this destination to track offline actions, such as in-store purchases driven by ad clicks, and attribute them to your Microsoft Ads campaigns.
- From your workspace's destination catalog page, search for "Microsoft Bing CAPI".
- Select Microsoft Bing CAPI and click Add destination.
- Select an existing source to connect to the destination.
- Give the destination a name and click Create destination.
- In Basic Settings, enter the Bing UetTag and ApiToken.
- To find the UET tag, see Microsoft's steps on how to create a UET tag.
- To generate the API token, contact Microsoft support or fill out a request form.
- Toggle Enable Destination on to start sending data to Microsoft Bing CAPI from Segment.
Optional
Ad Storage Consent for GDPR compliance
Your Bing API Token. API token generation is not generally available. To obtain one, you’ll need to contact Microsoft Support, or alternatively, you can fill out this form to request access.
Your Bing UetTag.
Microsoft Bing CAPI has the following presets
| Preset Name | Trigger | Default Action |
|---|---|---|
| Send Purchase Event | Event type = "track" and event = "Order Completed" | Send CAPI Event |
| Send Custom Event | Event type = "track" and event != "Order Completed" and event != "Add to Cart" and event != "Products Searched" | Send CAPI Event |
| Send Pageload | Event type = "page" | Send CAPI Event |
| Send Cart Event | Event type = "track" and event = "Add to Cart" | Send CAPI Event |
| Send Search Results | Event type = "track" and event = "Products Searched" | Send CAPI Event |
| Microsoft Bing CAPI msclkid Plugin | Event type = "track", Event type = "identify", Event type = "group", Event type = "page", Event type = "alias" | Microsoft Bing msclkid Browser Plugin |
Build your own Mappings. Combine supported triggers with the following Microsoft Bing CAPI-supported actions:
Mapping limits per destination
Send a track or page event to Microsoft Bing CAPI.
Send CAPI Event is a Cloud action. The default Trigger is type = "track" or type = "page"
Optional
TODO - description for this field
A list of user identifiers associated with the event.
Optional
Custom data to be sent to the Bing API. This can include additional properties that are not covered by the standard fields.
Optional
The list of items associated with the event. Must contain at least one item.
Optional
Data specific to hotel events.
Optional
Enable batching for this action.
Send a page load event to Microsoft Bing CAPI.
Page Load is a Cloud action. The default Trigger is type = "page"
TODO - description for this field
A list of user identifiers associated with the event.
Optional
Custom data to be sent to the Bing API. This can include additional properties that are not covered by the standard fields.
Generates a MSCLK ID and attaches it to every Amplitude browser based event.
Msclick Id is a Web action.
Optional
The length of the session in days.
Enriches all Segment payloads with the Microsoft Bing msclkid Querystring value
Microsoft Bing msclkid Browser Plugin is a Web action. The default Trigger is type = "track" or type = "identify" or type = "page" or type = "group" or type = "alias"
This action does not have any fields.
You can send computed traits and audiences generated using Engage to this destination as a user property. To learn more about Engage, schedule a demo.
For user-property destinations, an identify call is sent to the destination for each user being added and removed. The property name is the snake_cased version of the audience name, with a true/false value to indicate membership. For example, when a user first completes an order in the last 30 days, Engage sends an Identify call with the property order_completed_last_30days: true. When the user no longer satisfies this condition (for example, it's been more than 30 days since their last order), Engage sets that value to false.
When you first create an audience, Engage sends an Identify call for every user in that audience. Later audience syncs only send updates for users whose membership has changed since the last sync.
Real-time to batch destination sync frequency
Real-time audience syncs to Microsoft Bing CAPI may take six or more hours for the initial sync to complete. Upon completion, a sync frequency of two to three hours is expected.
Segment lets you change these destination settings from the Segment app without having to touch any code.
Optional
Ad Storage Consent for GDPR compliance
GYour Bing API Token. API token generation is not generally available. To obtain one, you’ll need to contact Microsoft Support, or alternatively, you can fill out this form to request access.
Your Bing UetTag.