X CAPI, Twitter CAPI
This destination is currently under final review and will be available soon. It's also subject to changes.
X, also referred to by its former name Twitter, is a social media website. Using this destination you can share conversion data with X to enable the measurement of campaigns through Conversion API.
The X Conversion API destination provides the following key features:
Events structure: our Events reference model matches X conversion event, meaning that your data is properly bridged to the expected fields in an optimized way.
Prebuilt mappings: data mapping for event-based destinations happens automatically, which simplifies user inputs.
Smart mapping: data mapping can be readjusted using your datalayer defined fields.
Before using this destination, you need to create a new conversion event in Ads Manager or use an existing event already created and used with the Twitter Pixel.
To create a new conversion event, access Ads Manager and navigate toTools
(1)
→Events manager
(2)
:
The resulting identifier is yourPixel Id
: See Configuration for more details.
Now you can create an event by clickingAdd events
(4):
X Conversion API supports deduplication with your client-side Twitter Pixel.
Check the "Smart Mapping" fieldTransaction Id
, Field Mappings (See propertyconversion_id
) or this LINK for more details (See section "Duplication between Pixel and Conversion API").
[1] Use Destination filters to specify your matching events.
[2] SeeEvent Id
in Configuration for more details.
Most properties can be remapped using our "Smart Mapping" feature.
All X properties are set in the objectconversions[0]
. More details are available by following this LINK.
[*] Mandatory property. [1] At least one of these properties must be provided. [2] For deduplication purpose, ensure you use the same value with your Twitter Pixel. More details are available by following this LINK (See section "Duplication between Pixel and Conversion API").
If you do not have a Twitter Pixel event source, create it by selectingAdd event source
(3)
:
The resulting identifier is youEvent Id
: See Configuration for more details.
If you want to use an existing event that you're already using with the Twitter pixel, you can do so by getting itsEvent Id
from the event list in the "Overview" tab.
Settings | Description |
---|---|
Commanders Act Events | X Conversion Events |
---|---|
Commanders Act Properties | X Properties |
---|---|
Authentication
Required
Your credentials with Twitter as set in the Commanders Act interface following: Administration
➜ Connector Credentials
➜ Add connector credentials
➜ Twitter
Pixel Id
Required
Your pixel identifier as created in Ads Manager (E.g. "o8z6j", without quotes). More details are available by following this LINK (See section "Steps" → "Creating the Conversion API event").
Event Id
Required
Your event identifier as created in Ads Manager (E.g. "tw-o8z6j-o8z21", without quotes). More details are available by following this LINK (See section "Steps" → "Creating the Conversion API event").
[Any Event]
[1]
[Any Event]
[2]
context.event_timestamp
conversion_time
[*]
Event Id
event_id
[*]
partners.twitter.twclid
identifiers.X.twclid
[1]
user.email
identifiers.X.hashed_email
[1]
user.phone
identifiers.X.hashed_phone_number
items.length
number_items
currency
price_currency
value
value
id
conversion_id
[2]
type
description
search_term
search_string
items.X.id
contents.X.content_id
items.X.product.group_id
contents.X.content_group_id
items.X.product.name
contents.X.content_name
items.X.product.price
contents.X.content_price
items.X.product.category_1
> items.X.product.category_2
> items.X.product.category_3
> items.X.product.category_4
> items.X.product.category_5
contents.X.content_type
items.X.quantity
contents.X.num_items