X Conversions Connector Setup Guide

API Information

This connector uses the following vendor API:

• API Name: X Ads API
• API Version: v12
• API Endpoint: https://ads-api.x.com/
• Rate limit: 60,000 events per account, per 15 minute interval

Prerequisites

• X Ads API access
• X Developer account
• X user account with permissions to send events to desired ad accounts

If you already have an actively used X Ads API application, both the application and existing access tokens may be used for the Conversion API. For more information, see Conversion API Set Up in the X documentation.

How it works

Use the X Conversion API to create a separate server-side application that passes conversion events to X for use in optimization, measurement, and attribution across your campaigns. With this API, you can measure the impact of running ads on X by sending conversion events without the need for a X website pixel.

Currently, there are two primary use cases for measuring ad impact using matching identifiers:

• Click-through conversions for website traffic campaigns using the X Click ID
• View-through and click-through conversions for all X campaigns using email

You can measure one or more of the following website actions with conversion tracking depending on your ad campaign:

• Site visit: User visits a landing page on an advertiser’s site
• Purchase: User completes a purchase of a product or service on the advertiser’s site
• Download: User downloads a file, such as a white paper or software package, from the advertiser’s site
• Sign up: User signs up for the advertiser’s service, newsletter, or email communication
• Custom: This is a catch-all category for a custom action that does not fall into one of the categories above

Using the X Conversion API

To use the X Conversion API, you need to create a new conversion event in the X Ads Manager or use an existing event already created and used with the X Pixel. To deduplicate conversions between X Pixel and X Conversion API requests, use the existing event you created for the Pixel.

Using an Existing Conversion Event in Ads Manager

To use an existing event used with the X Pixel, use the Event ID from that event. If you use both X Pixel and the X Conversion API for the same event, ensure to use the deduplication key in both the X Pixel code snippet and the X Conversion API request (as conversion_id). For more information about deduplication, see the Testing Events and Deduplication section in Conversion API Set Up in the X documentation.

Identifiers for Conversion Events

For a conversion event to be passed in the X Conversion API, there needs to be at least one X Click ID (twclid) or email address set as the as the event identifier.

To successfully setup conversion events to be passed to the X Conversion API, we recommend the following configurations:

• Always parse the twclid value when it is present in the URL query parameters to be passed to Tealium EventStream API Hub.
• Store the data alongside relevant form fields or conversion event information.

Deduplication

For Page View events, including X-defined Site Visit and Landing Page View events, X provides a 30 minute window for deduplication. Other event types, such as Purchase and Lead, are not deduplicated.

Manage event duplication using the conversion_id event parameter, which can be included in Pixel or X Conversion API requests.

Connector Actions

Action Name	AudienceStream	EventStream
Send Conversion Event	✓	✓

Configure Settings

X Conversions requires allowlisting on your X account. For assistance with allowlisting, contact your X representative.

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

After adding the connector, configure the following settings:

• Event ID
  The base-36 ID of a specific event. It matches a pre-configured event contained within this ad account. This is called ID in the corresponding event in Events Manager. This value can be created in the following ways:

  • Within the Single-Event Website tag configuration. Log in to your ads account at ads.x.com and select Events Manager under Tools.
  • Use the API. See Web Event Tags for more details.
  • Contact your X account manager.

• Pixel ID
  The Universal Website Tag (UWT) ID for an ad account. This represents the base36-encoded value for an ad account’s UWT ID.
  To obtain your Pixel ID:

  1. Navigate to ads.x.com.
  2. In the top left corner of the interface, under Tools, click Events Manager.
  3. If you do not have a X Pixel event source on your left sidebar yet, in the top right corner of the page, select Add event source.
  4. The interface displays the Pixel ID and Event ID of this event that is used in the API.

Action Settings — Parameters and Options

Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu.

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

Action — Send Conversion Event

User Data

You must provide at least one of the following parameters:

| Parameter | Type |Description | | — | — | | X Click ID | String | X Click ID as parsed from the click-through URL. Either X Click ID or Email must be specified. Both are preferred in order to increase match rate. | | Email Address (already SHA256 hashed) | String | Provide an email address which has been already whitespace trimmed, lowercased, and SHA256 hashed. | | Email Address (apply SHA256 hash) | String | Provide a plain text email address and the connector whitespaces trim, lowercase, and hash this value using SHA256 hash. | | Phone Number (already SHA256 hashed) | String | Provide a phone number which has been already whitespace trimmed, lowercased, SHA256 hashed, and in E164 format. | | Phone Number (apply SHA256 hash) | String | Provide a plain text phone number and the connector will whitespace trim, lowercase, and hash this value using SHA256 hash. | | ip_address | String | This value is written in dotted-decimal notation, with four numbers separated by periods. | | user_agent | String | This identifier allows the server to identify the application, operating system, vendor, and/or version of the requesting user agent. |

Additional parameters

Parameter	Description
Event Source ID Override	This is called Website Tag ID in the Ads Manager and Ads API and can be found in the Events Manager of the X Ads platform. This parameter is a required field, and this setting overrides Event Source ID used in the configuration section.
Pixel ID Override	The Universal Website Tag (UWT) ID for an ad account. This parameter represents that base36-encoded value for an ad account’s UWT ID. For example: o5h34. This setting overrides the Pixel ID used in the configuration section.
Conversion Time	Required. The time of a conversion event. Specify date-time of event expressed in ISO 8601. If not provided, the time of the event is be used. Example: 2020-11-01T08:00:00.000Z.
Conversion Value	The price value of items being purchased, represented in ‘price_currency’ currency.
Number of Items	The number of items being purchased. Must be a positive number greater than zero. If Number of Items is not provided, the total number of elements in the Contents array is used.
Currency	The type of a currency to filter results by, identified using ISO 4217. This is a three-letter string such as ‘USD’.
Conversion ID	For deduplication between pixel and conversion API conversions. An identifier for a conversion event that can be used for de-duplication between Web Pixel and Conversion API conversions in the same event tag. See the Conversions Guide for more information.
Description	Description with any additional information on the conversions.
Search String	Text that was searched for on the advertiser’s website.
Content ID	A SKU or GTIN identifier that represents the content.
Content Group ID	The ID associated with a group of product variants.
Content Name	The name of the product or service.
Content Price	The price of the product or service.
Content Type	The category for the product that was purchased.
Number of Items	The number of products purchased.

Send Mobile Measurement Conversion Event

Parameters

Parameter	Description
Conversion Type	The type of conversion event. Possible values: PURCHASE, SIGN_UP, INSTALL, RE_ENGAGE, UPDATE, TUTORIAL_COMPLETE, RESERVATION, ADD_TO_CART, ADD_TO_WISHLIST, LOGIN, CHECKOUT_INITIATED, SEARCH, LEVEL_ACHIEVED, ACHIEVEMENT_UNLOCKED, CONTENT_VIEW, SHARE, INVITE, ADDED_PAYMENT_INFO, SPENT_CREDITS, RATED.
APP ID	(Required)
Conversion Time	(Required)
Hashed Device ID	(Required)
Operating System Type	(Required)
Device IP Address	IPv4 or IPv6 address of the device when the conversion event happened.
Click Window	The click window for this event in days. Note: Click Window must be greater than or equal to View Through Window. Default: 14. Possible values: 1, 7, 14, 30.
Level	A level associated with this event.
Non X Engagement Time	The time of the last non-X engagement prior to the conversion.
Non X Engagement Type
Number Items	Number of items associated with this event.
Price Currency	The currency associated with this event in ISO 4217 format.
Price Micro	A price amount associated to this event in micro.
User Payment Info	A boolean value to indicate if the user’s payment information is stored in the app associated with this event.
View Through Window	The view through window for this event in days. Default: 1. Possible values: 0, 1, 7, 14, 30.