Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Precise the filename and extension (CSV by default).
Precise if you want to compress the file (GZIP by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Precise the filename and extension (CSV by default).
Precise if you want to compress the file (GZIP by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Precise the filename and extension (CSV by default).
Precise if you want to compress the file (GZIP by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
Adobe is an multinational computer software and web analytics company (See Adobe Experience Cloud).
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Precise the filename and extension (CSV by default).
Precise if you want to compress the file (GZIP by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
Affilae provides complete affiliate marketing solutions to manage your partnership strategies. Using this destination you can enable server-side tracking.
The Affilae destination provides the following key features:
Events structure: our Events reference matches Affilae conversion tracking, 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.
Support for multi-item data: information included in the item array is dispatched to Affilae.
Key
Required
Your key as provided by Affilae on the "conversion code" page through your affiliate program configuration dashboard.
Click Id
Required
The click identifier is automatically generated by Affilae when users click on affiliate links: it's set in the landing URL through the aecid
parameter.
Revenue Share Id
Your client identifier if the Revenue Share
option is activated. Please use an identifier that will not change over time, the best being the identifier number used in your database. Leave this empty if you do not use the Revenue Share
option.
[Any Event]
[1]
[Any Conversion]
[1] Use Destination filters to specify your matching events.
Most properties can be remapped using our "Smart Mapping" feature.
Key
key
[*]
Click Id
cids
[*]
id
id
[*]
currency
currency
[*]
revenue
amount
payment_method
[1]
type
[2]
payment
Revenue Share Id
customer
partners.affilae.cv
cv
coupon
voucher
items.X.id
product
[3]
[*] Mandatory property.
[1] Supported values: by_bank_transfer_in_advance
and online_payment_system
.
[2] Supported values: online
, offline
and call
.
[3] product identifiers are separated by semicolons (;).
Alphalyr helps you boosting your omnichannel commerce with the data that matters. Using this destination you can connect your activities and events with Alphalyr Marketing Studio.
The Alphalyr Marketing Studio destination provides the following key features:
Events structure: our Events reference supports Alphalyr's page types, 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.
Automatic hashing: information is automatically hashed matching partner specifications.
Smart mapping: data mapping can be readjusted using your datalayer defined fields.
Support for multi-item data: information included in the item array is bridged to Rakuten Advertising.
Client Public Key
Required
Your unique public key as given by Alphalyr Marketing Studio. This setting supports dynamic values [1].
Customer Type
Defines your customer type. Takes the value 0
when it is an old client and 1
when it is a new one. This setting supports dynamic values [1].
User Unique Identifier (UUID)
UUID value of the user's cookie. Following the latest updates to the ITP protocol on Safari / iOS, Alphalyr strongly recommends that you use a "server" cookie coming directly from your first party domain. This setting supports dynamic values [1].
Custom Data
Additional data that can be added for custom data processing. This setting supports dynamic values [1].
Is SPA
Whether your website is a Single Page Application.
GDPR Consent
GDPR consent. It takes the value 1
when GDPR applies or 0
otherwise. This setting supports dynamic values [1].
Consent Status for Ads & Marketing
Consent status for ads & marketing. It takes the value 1
if the user has consented to the use of his data for targeting and marketing or 0
otherwise. This parameter is transmitted to Alphalyr's partners. This setting supports dynamic values [1].
Consent Status for Performance
Consent status for performance. It takes the value 1
if the user has consented to the use of his data for the measurement of performance measurement or 0
otherwise. This parameter is transmitted to Alphalyr's partners. This setting supports dynamic values [1].
[1] This feature allows you to set an event property holding a dynamic value by adding two open braces ({{
) in front of your property name and two close braces (}}
) at the end (E.g. {{myEventPropertyPathAndName}}
).
Use Destination filters to specify your matching events.
purchase
purchase
view_cart
cart
view_item
product
view_item_list
category
[Any Other Event]
home
Most properties can be remapped using our "Smart Mapping" feature.
(event_name)
page
[1]
Client Public Key
aid
user.email_md5
cid
User Unique Identifier (UUID)
user.consistent_anonymous_id
uuid
[2]
context.page.referrer
referrer
context.device.ip
ip_address
[3]
context.device.user_agent
user_agent
(eventModel.app.name)
deviceType
[4]
context.page.url
path
[5]
items.X.id
prodId
[6]
items.X.product.name
prodDescription
[6]
items.X.product.price
prodPrice
[6]
item_list_id
catId
[7]
item_list_name
catDescription
[7]
items.X.id
:items.X.quantity
:items.X.product.price
products
[8][9]
currency
currency
[9]
revenue
value
totalPrice
[9][10]
value
totalPriceWithTax
[11]
shipping_amount
shippingPrice
[11]
id
reference
[11]
Customer Type
new
[11]
coupon
discountCode
[11]
items.X.discount
discountAmount
[8][11]
Custom Data
customData
[11]
GDPR Consent
gdpr_consent
Consent Status for Ads & Marketing
consent_ads
Consent Status for Performance
consent_performance
context.device.lifecycle.session_id
gaSessionId
[12]
[1] See Quick reference for more details.
[2] Field automatically hashed with SHA256 if passed in clear. Priority order is provided on the left column.
[3] Field anonymized.
[4] This is either m
or d
depending if eventModel.app.name
is set or not.
[5] The pathname
part of context.page.url
is set: additional parameter are added to the request based on searchParams
(See URL object for more details).
[6] For Alphalyr product
page type only.
[7] For Alphalyr category
page type only.
[8] All items are taken into account.
[9] For Alphalyr purchase
and cart
page type only.
[10] Depending if Alphalyr page type is purchase
or cart
then revenue
or value
is used respectively.
[11] For Alphalyr purchase
page type only.
[12] When Is SPA
is flagged only.
Find here the list of all plug&play destinations.
Destinations are sorted per categories (Advertising, Emailing, Analytics, Push notifications...).
The destination's catalog homepage show an overview of 3 destinations per categories, click on the categories menu or on 'View all' to display the full destinations list. You didn't find the destination you were looking for? Do not hesitate to fill the request form to ask our team to add a new destination on the list, or use the Destination Builder
Newly added destinations are summarized on the New tab.
Flags meanings:
"New": the destination was just released
"Closed alpha": the destination is not open publicly, the backend is still in QA on our side (Commanders Act tests) and/or the partner.
"Beta" : the destination is usable by everybody, but it has to be validated with one ore more first (beta) customers
You need more information about a destination? Simply click on it, and you will have access to all details and requested settings for this destination.
Amazon is a multinational technology company focusing on e-commerce, cloud computing, online advertising, digital streaming, and artificial intelligence.
Select 1 or many segment(s) you want to export.
Variables are automatically added:
Adition user ID (ID coming from the cookie sync with Adition)
Segment public IDs (IDs of segments to which selected users belongings)
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Network ID: ID coming from Adition account
Define the running frequency for the export (every 10 minutes, day, week...)
This destination is currently under final review and will be available soon.
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Precise the filename and extension (CSV by default).
Precise if you want to compress the file (GZIP by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
Documentation in progress.
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Precise the filename and extension (CSV by default).
Precise if you want to compress the file (GZIP by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Precise the filename and extension (CSV by default).
Precise if you want to compress the file (GZIP by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
API Audience destination
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Precise the filename and extension (CSV by default).
Precise if you want to compress the file (GZIP by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Precise the filename and extension (CSV by default).
Precise if you want to compress the file (GZIP by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
Adform is a global digital media advertising technology company specializing in real-time programmatic marketing automation technologies. Using this destination you can implement server-side tracking.
The Adform destination provides the following key features:
Events structure: our Events reference covers Adform server-side tracking, 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.
Support for multi-item data: information included in the item array is bridged to Partnerize.
A client-side tag template named "Adform - Get 3rd Party Cookie ID" is available in our library to help you retrieve the Adform Third-Party Identifier. Use Destination filters to refine events and/or other properties matching your specific needs.
Tracking Domain
Tracking Setup Id
Required
Your client tracking ID, which can be found under "Site Tracking" in Adform UI (E.g. "1257163", without quotes). This setting supports dynamic values [1][2].
Tracking Point Name Property
Your property holding the tracking point name. In case it's not set, Page URL (pageUrl)
will be used.
Select your Adform third-party holder
This can be either Cookie
or Event property
, depending on how you provide Adform third-party identifier value. A client-side tag template named "Adform - Get 3rd Party Cookie ID" is available in our library to help you retrieve this value.
Third-Party Id Cookie Name
If you select Cookie
in Select your Adform third-party holder
, you can set your Adform third-party cookie name here.
Third-Party Id Property
If you select Event property
in Select your Adform third-party holder
, you can set your Adform third-party property name here.
Select your Adform first-party holder
This can be either Cookie
or Event property
, depending on how you provide Adform first-party identifier value.
First-Party Id Cookie Name
If you select Cookie
in Select your Adform first-party holder
, you can set your Adform first-party cookie name here. Only use for hybrid setups, where part of site tracking is implemented client-side to be able to pass its value that Adform has set previously.
First-Party Id Cookie Domain
If you select Cookie
in Select your Adform first-party holder
, you can set your Adform first-party cookie domain here. Only use for hybrid setups, where part of site tracking is implemented client-side to be able to pass its value that Adform has set previously.
First-Party Id Property
If you select Event property
in Select your Adform first-party holder
, you can set your Adform first-party property name here.
Custom Event Properties
Map your custom event properties by setting their field names in Adform property name
and adding the field name holding the value in Your event property
. E.g. if you inputsize
in the Partnerize property name
and items.0.product.size
in Your event property
, you'll have a custom event property in Adform calledsize
with a value based on the content of the field items.0.product.size
[2].
[1] This feature allows you to set an event property holding a dynamic value by adding two open braces ({{
) in front of your property name and two close braces (}}
) at the end (E.g. {{myEventPropertyPathAndName}}
).
[2] Using "dots" (".") you can navigate deeper to the specific field you want to get the value of. See Events reference for more details on the standard field names by event. You can also freely set custom fields: there are no boundaries.
[Any Event]
[1]
[Tracking Point Names]
[1] Ensure to apply Destination filters configuring your relevant events for this destination. Custom events are also supported.
Most properties can be remapped using our "Smart Mapping" feature.
For audience building and retargeting, make sure to pass a user identifier.
Geo and device information come from the provided user ip and agent.
Adform standard attribution works only if identity.cookieId
(Adform 3rd party cookie) or identity.advertisingId
(mobile advertising ID) is passed correctly.
Adform Cookieless Insights reporting is enabled by passing values in both userContext.userAgent
and userContext.userIp
.
Third-Party Id Cookie Name
Third-Party Id Property
identity.cookieId
[1]
First-Party Id Cookie Name
First-Party Id Property
identity.firstPartyId.id
[1]
First-Party Id Cookie Domain
(context.page.url)
identity.firstPartyId.domain
[2]
Tracking Point Name Property
name
context.page.url
pageUrl
context.page.referrer
refererUrl
context.device.advertising_id
identity.advertisingId
partners.adform.provider_id
identity.eids.0.source
user.id
identity.eids.0.uids.0.id
context.device.user_agent
userContext.userAgent
context.device.ip
userContext.userIp
value
variables.sales
id
variables.orderid
items.X.id
variables.subVariables.X.productid
items.X.product.price
variables.subVariables.X.productsales
partners.adform.consent_string
compliance.gdprConsent
[3]
[1] Cookie name or property is used based on your Configuration. [2] Priority order is listed in the left column. [3] IAB TCF consent string.
Amazon is a multinational technology company focusing on e-commerce, cloud computing, online advertising, digital streaming, and artificial intelligence. Using this destination you can import conversion event data in Amazon DSP.
The Amazon Ads Conversions API destination provides the following key features:
Events structure: our Events reference model matches Amazon's conversion definitions/types, 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.
Automatic hashing: information is automatically hashed matching partner specifications.
Smart mapping: data mapping can be readjusted using your datalayer defined fields.
Authentication
Required
Your credentials with Amazon Ads as set in the Commanders Act interface following: Administration
➜ Connector Credentials
➜ Add connector credentials
➜ AmazonAds
API Base Url
Advertiser Id
Required
Your account identifier you use to access the DSP. This is your DSP Advertiser ID. DSP Entity ID is not supported.
Profile Id
Required
Select your profile identifier.
Conversion Definition Id
Required
Select your conversion definition identifier.
Country
[Any Event]
[1]
[Any Conversion Definitions/Types]
[2]
[1] Use Destination filters to specify your matching events.
[2] See Conversion Definition Id
in Configuration for more details.
Most properties can be remapped using our "Smart Mapping" feature.
All Amazon properties are include in eventData.0
.
At least one identifier must be provided in matchKeys
.
Country
countryCode
[*]
event_name
name
[*]
context.event_timestamp
timestamp
[*]
Conversion Definition Id
conversionDefinitionId
[*]
user.email_sha256
user.phone
user.firstname
user.lastname
user.street
user.city
user.state
user.zipcode
context.device.advertising_id
matchKeys.X.values[0]
[1]
(user.email_sha256
user.phone
user.firstname
user.lastname
user.street
user.city
user.state
user.zipcode
context.device.advertising_id)
matchKeys.X.type
[2]
items.length
unitsSold
value
value
currency
currencyCode
context.event_id
clientDedupeId
[3]
partners.amazon.data_processing
dataProcessingOptions
[4]
[*] Mandatory property.
[1] At least one identifier must be provided.
[2] Depending on the value provided in matchKeys.X.values[0]
, this is one of the following values: EMAIL
, PHONE
, FIRST_NAME
, LAST_NAME
, ADDRESS
, CITY
, STATE
, POSTAL
or MAID
.
[3] The client specified id for the conversion event. For events with the same clientDedupeId
only the latest event will be kept.
[4] This is set with with LIMITED_DATA_USE
when partners.amazon.data_processing
is a non-empty string, non-false (boolean), non-zero (number) value.
Branch (formerly known as Branch Metrics) is a mobile software company focused on mobile deep linking and attribution. This integration allows server-side event tracking.
The Branch Events destination provides the following key features:
Events structure: our Events reference matches Branch standard and custom events, 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.
Refined data: you can freely push additional information based on your specific needs (E.g. adding custom events and custom event properties).
Smart mapping: data mapping can be readjusted using your datalayer defined fields.
Event mapping: change standard mapping between your partners' events and yours or add new mappings.
Support for multi-item data: information included in the item array is dispatched to Branch.
Before configuring this destination, you need to create a Branch Dashboard.
Branch Key
Content Schema
Category/Schema for the included content.
Custom Event Properties
Map your custom event properties by setting their field names in Branch property name
and adding the field name holding the value in Your event property
.
Event Mapping
achieve_level
ACHIEVE_LEVEL
add_payment_info
ADD_PAYMENT_INFO
add_to_cart
ADD_TO_CART
add_to_wishlist
ADD_TO_WISHLIST
begin_checkout
INITIATE_PURCHASE
click_ad
CLICK_AD
complete_stream
COMPLETE_STREAM
complete_tutorial
COMPLETE_TUTORIAL
generate_lead
COMPLETE_REGISTRATION
initiate_stream
INITIATE_STREAM
invite
INVITE
login
LOGIN
purchase
PURCHASE
rate
RATE
search
SEARCH
share
SHARE
start_trial
START_TRIAL
spend_credits
SPEND_CREDITS
subscribe
SUBSCRIBE
unlock_achievement
UNLOCK_ACHIEVEMENT
view_ad
VIEW_AD
view_cart
VIEW_CART
view_item
VIEW_ITEM
view_items
VIEW_ITEMS
[Any Event]
[1]
[Any Event]
[1]
[1] See Event Mapping
in Configuration for more details.
At least one of the following must be included:
• developer_identity
• browser_fingerprint_id
• idfa
OR idfv
(IF os
= iOS
)
• aaid
OR android_id
(IF os
= Android
)
Most properties can be remapped using our "Smart Mapping" feature.
Branch Key
branch_key
partners.branch.event_alias
customer_event_alias
context.device.os.name
os
[1]
context.device.os.version
os_version
[1]
partners.branch.env
environment
[1]
context.device.advertising_id
idfa
[1][5]
aaid
[1][6]
partners.branch.hardware_id
android_id
[1]
context.device.idfv
idfv
[1]
context.device.ad_tracking_enabled
limit_ad_tracking
[1][7]
context.device.user_agent
user_agent
[1]
partners.branch.fingerprint_id
browser_fingerprint_id
[1]
context.page.url
http_origin
[1]
context.page.referrer
http_referrer
[1]
user.id
developer_identity
[1]
user.country
country
[1]
context.page.lang
language
[1]
context.device.ip
ip
[1]
partners.branch.local_ip
local_ip
[1]
context.device.manufacturer
brand
[1]
partners.branch.device_token
randomized_device_token
[1]
context.app.version
app_version
[1]
context.device.model
model
[1]
context.device.screen.density
screen_dpi
[1]
context.device.screen.width
screen_width
[1]
context.device.screen.height
screen_height
[1]
partners.branch.dma_eea
dma_eea
[1]
partners.branch.dma_ad_pers
dma_ad_personalization
[1]
partners.branch.dma_ad_user_data
dma_ad_user_data
[1]
id
transaction_id
[2]
revenue
revenue
[2]
currency
currency
[2]
shipping_amount
shipping
[2]
tax_amount
tax
[2]
coupon
coupon
[2]
type
affiliation
[2]
event_name
description
[2]
search_query
search_term
[2]
Content Schema
$content_schema
[3]
item_title
[4]
$og_title
[3]
product.image_url
[4]
$og_image_url
[3]
product.canonical_identifier
[4]
$canonical_identifier
[3]
product.publicly_indexable
[4]
$publicly_indexable
[3]
product.locally_indexable
[4]
$locally_indexable
[3]
product.price
[4]
$price
[3]
quantity
[4]
$quantity
[3]
id
[4]
$sku
[3]
product.name
[4]
$product_name
[3]
product.brand
[4]
$product_brand
[3]
product.category_1
[4]
$product_category
[3]
variant
[4]
$product_variant
[3]
product.rating_average
[4]
$rating_average
[3]
product.rating_count
[4]
$rating_count
[3]
product.rating_max
[4]
$rating_max
[3]
product.creation_timestamp
[4]
$creation_timestamp
[3]
product.exp_date
[4]
$exp_date
[3]
product.keywords
[4]
$keywords
[3]
product.address_street
[4]
$address_street
[3]
product.address_city
[4]
$address_city
[3]
product.address_region
[4]
$address_region
[3]
product.address_country
[4]
$address_country
[3]
product.address_postal_code
[4]
$address_postal_code
[3]
product.latitude
[4]
$latitude
[3]
product.longitude
[4]
$longitude
[3]
product.image_captions
[4]
$image_captions
[3]
product.condition
[4]
$condition
[3]
[1] in user_data
.
[2] in event_data
.
[3] in content_items.X
.
[4] in items.X
.
[5] property set when context.device.os.name
is iOS
(case insensitive).
[6] property set when context.device.os.name
is Android
(case insensitive).
[7] boolean opposite of context.device.ad_tracking_enabled
.
Adobe is an multinational computer software and web analytics company (See Adobe Experience Cloud). Using this destination you can implement server-side tracking, by sending events to Adobe Analytics.
Please note that we use the Adobe Bulk Data Insertion API.
We use the Oauth2 authentication process.
Only the server-to-server oauth is supported
Go to Administration / Connector Credentials and click on Add connector credentials. Select Adobe Analytics.
Enter the Client ID and Client Secret that you can find on your Adobe Developer Console.
In case you haven’t selected the server-to-server oauth (if it is an old project, and you don’t want to configure it again for example), it is possible to change the authentication, click on “Connect another credential” on Adobe Analytics interface.
Click on Destinations / Add destination and select Adobe Analytics on the catalog.
Select sources, give a name to the destination and select the environment.
Select the authentication you've just created previously.
Fill the Adobe Group ID and Customer ID Type coming from your Adobe Analytics account.
This parameter is mandatory:
userAgent
You can map corresponding properties or directly enter values.
At least one of these fields should be filled to identify users.
visitorID
marketingCloudVisitorId
IP address
CustomerID (CustomerIDType)
Adobe web page identifier. You can set several, but at least one is needed for the export. If you set either linkName, linkURL or linkType the other two must be set as well.
You can map here all your event properties to Adobe Analytics properties, especially eVars.
This step is optional, you can transform your properties before to send it.
This destination is currently under final review and will be available soon.
Batch lets CRM Teams design, test and automate their customer engagement strategies to keep users engaged and grow revenue. Using this destination you can share audiences with Batch by leveraging the .
Audiences are synchronized using their names as identifier. Avoid renaming to maintain consistency.
The Batch Audience destination provides the following key features:
Audience sharing: our model drives audience sharing with Batch, meaning that you can synchronize your existing user segments, with your partner, in a seamless way.
Created segments include the following properties:
is an advertising company that provides online display advertisements.
is an advertising company that provides online display advertisements. Using the you can track web events you are used to report via . This is normally required for technical and legal reasons.
The Criteo (events) destination provides the following key features:
Events structure: our suits , 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.
Refined data: you can freely push additional information based on your specific needs (E.g. adding custom events, custom event and user properties).
Support for multi-item data: information included in the array is brought to Criteo.
The is required: this value must be passed to this destination by including the cookie crto_mapped_user_id
.
The easiest way to manage this cookie is to use this client-side tags in our tag library : Criteo - User Identification in your web container.
[1] If page.type
is home
then viewHome
is also sent with viewPage
, otherwise, just viewPage
is forwarded.
is an advertising company that provides online display advertisements. Create a segment on DataCommander to build your audience. Then, you can push this audience to Criteo through our connector Criteo (audiences).
You need first to accept a consent link send by our consultants. This link is needed to authorize our DataCommander Criteo App to have access to your Criteo account to push audiences.
Then you can configure the connector, select the segment you created just before and simply enter your Criteo Advertiser ID (you can find it on your Criteo account).
Click on SAVE and it will automatically create a new audience (user list) on Criteo side.
Only for Campaign Analysis Module (ex Mix Commander) customers
This destination allows you to collect events and map it for the module Campaign Analysis It can also turns events from Normalized Datalayer into touchpoints for Campaign Analysis module.
With this destination, you can use 4 standard events. To receive events in this destination, it requires as event name the 'Standard event name' described in the following array. Here's the list of Campaign Analytics touch points names vs Standard events names:
If you need more information about these events, check the section
This destination will do an automatic mapping between the Campaign dimensions and the Standard properties. Here's the list of the automatic configuration done by this destination:
If you use custom properties, or if you want to modify one or some of theses campaign dimensions with another property then the ones listed above, you will have to use the mapping table.
In all cases, a hand mapping is possible (between dimensions and properties). It will take the priority and override native mapping. Use the mapping table menu to make your own correspondence table:
If you add a new custom dimension in your Campaign Analytics, you must to declare it manually also in this table of the destination's settings
If you do not want to use automatic mapping of dimensions with event properties, you can check the option "disable automatic configuration"
This action will block all automatic mapping between Campaign dimensions and Standard properties
Before to send your events to this destination you can, if needed, transform them to rename or remove some properties. Enter on the left the property name you want to add, delete or modify. Then enter on the right the property name where the value stands (or leave empty to remove the property)
You have to specify which event is concerned by this destination. Here's an example for a purchase (orders)
Don't forget to setup a consent filter to be RGPD compliant as well
ts_override property can be used to change the timestamp of an event
Example:
https://collect.commander1.com/events?tc_s={site_id}}&token={token}&medium=seo&source=google&ts_override=1716888588&event_name=ad_click&campaign=sales_2024
is an advertising company that provides online display advertisements. Push your offline conversions, like purchases made in physical stores, directly to Criteo.
You must specify the Store ID variable, the variable corresponding to the store identifier on your conversions.
By default, we apply a filter on conversion_type = 'offline' to push only offline conversions. However, if you have a specific setup, you can change this value if needed.
Enter your Criteo Account ID, you can find it directly on Criteo interface.
(CJ) provides a global affiliation network connecting businesses with customers. Using this destination you can implement server-side tracking.
The Commission Junction destination provides the following key features:
Events structure: our covers Commission Junction server-side tracking, 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.
Refined data: you can freely push additional information based on your specific needs.
Support for multi-item data: information included in the array is bridged to Awin.
[1] This feature allows you to set an event property holding a dynamic value by adding two open braces ({{
) in front of your property name and two close braces (}}
) at the end (E.g. {{myEventPropertyPathAndName}}
).
[2] Using "dots" (".") you can navigate deeper to the specific property you want to get the value of. See for more details on the standard field names by event. You can also freely set custom fields: there are no boundaries.
provides a global affiliation network connecting businesses with customers. Using this destination you can implement using the same .
Awin no longer support the use of pixel only implementations due to various browser constraints and limitations.
The Awin destination provides the following key features:
Events structure: our covers , 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.
Support for multi-item data: information included in the array is bridged to Awin.
Commission group: remunerate different products based on your .
The parameter is appended to the landing page URL by Awin to identify the source of the click. This value is mandatory and is retrieved by getting the value of either the Click Id
(See ) or the cookie, in this priority order.
[1] This feature allows you to set an event property holding a dynamic value by adding two open braces ({{
) in front of your property name and two close braces (}}
) at the end (E.g. {{myEventPropertyPathAndName}}
).
Most properties can be remapped using our "Smart Mapping" feature.
The following fields are mandatory to properly set commission groups:
- items.X.affiliation
- items.X.product.price
- items.X.quantity
Accepted characters for the commission group codes are alphanumerics and letter in upper case, underscore (_) , point (.) and minus (-).
Only for advanced users
This destination is temporary, it is the first step of the migration to support events format in Data Activation module
Map events collected to Data Activation format (previously called Data Commander format). The goal is to collect events and map it to Data Activation format to be able to use the segmentation, audience connectors, augmented user attributes...
Select Data Activation Legacy on the destination catalog.
On the settings page, you can find the mapping:
Select on the left a Data Activation variable (user_email ; user_id...) and map it to the corresponding event's property (user.email ; value...).
You can use a static value, please enter it between quotation marks “ “.
This mapping is dedicated for env_template variable.
On the left, enter the env_template variable corresponding to the page type and map it to the event name (ex: funnel_confirmation ⇒ purchase).
Only for page view event, map the env_template variable corresponding to the page type to the page type in page view event (ex: productpage ⇒ product).
If you check the box, purchase events will be stored on Data activation conversion storage.
If you check the box, you can define the mapping between product variables and items properties in event.
First, select the variable corresponding to the product list. Then, map the product variable to the item property in the event.
helps businesses deliver digital customer experiences that are personalized, optimized, and synchronized. This destination leverages the to track , so you can use the information for behavioral targeting, reporting, setting optimization goals, recommendations, and audience building.
The Dynamic Yield destination provides the following key features:
Events structure: our covers , 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.
Refined data: you can freely push additional information based on your specific needs (E.g. adding custom events and custom event properties).
Automatic hashing: information is automatically hashed matching partner specifications.
Smart mapping: data mapping can be readjusted using your datalayer defined fields.
Send all properties: send all your event properties to Dynamic Yield with a single click.
Use to refine events and/or other properties matching your specific needs.
Most properties can be remapped using our "Smart Mapping" feature.
is an online social media and social networking service owned by .
is an online social media and social networking service owned by . An API based Facebook Connector can be set up with the following procedure. The connector will send users data of all the users belonging to a given segment. The audience sent can contain both FB subscribers and non subscribers.
More information you send to Facebook, better is the matching with Facebook. You can choose to send email, phone number or any other information to increase the matching with Facebook.
If users don't have enough information, we will reject them (example: if a user only have a zip code, Facebook will not be able to match this user with only this information).
It takes up to 24 hours for Facebook to match users.
You need 2 information for the Facebook connector:
Ad Account ID
Access Token
Then you have to go to ‘Ad Account settings’:
And you will find the Ad Account ID:
Copy and paste it on our Facebook connector.
Create a new app
Add the product ‘Marketing API’.
Go on ‘Settings’ and ‘Advanced’ section
Link your app to your Business Manager account and add your Ad Account ID in the ‘Authorized Ad Account ID’ section:
Then click on 'App Review' and 'Permissions and features'. Find the 'Ads Management Standard Access' component and, if you don't already have it, submit a request:
Wait for the validation of your request.
You should see in your Facebook Business account the new App you created.
You can choose here to generate a token without any expiration date (1st method, recommended) or with an expiration date (60 days - 2nd method, not recommended).
This system user should have admin rights for the ad account and for the app you created.
When it is done, you can Generate New Token:
Select the App you have created before and select the right permission:
Then copy and paste the generated token on our connector:
On the Facebook developers, on your App you created, click on ‘Marketing API’ and ‘Tools’.
On ‘Get Access Token’, tick ‘ads_management’ and click on ‘Get Token’.
You can now copy and paste this token on our Facebook connector.
Be careful: Each time you click on Get Token it will generate a new one that you have to use (the previous one will be not valid anymore)
Before to save the connector, be sure you have accepted Facebook general conditions for custom audiences.
Go on this link and replace the AD_ACCOUNT_ID per your own Ad Account ID:
Be sure you have the admin rights for your Facebook Business account
Save the connector and users who will enter the segment will be pushed to Facebook new custom audience.
Then on Facebook, click on Audiences.
A new custom audience will be created.
The name of the new audience will start with CA_{name}
is an online social media and social networking service owned by . This destination leverages to help you get improved performance in by sharing your CRM data about your leads back to Meta to unlock quality lead optimization.
The Facebook Lead Ads destination provides the following key features:
Events structure: our leverages , 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.
Integrating your CRM is required and documented following the section via Meta documentation: see and for detailed information. This destination covers section in the . Before continuing, you may want to inspect section to see if the optimization model can be beneficial to you. Moreover, you need to review and sections for a checklist of what is needed and current constraints.
Most properties can be remapped using our "Smart Mapping" feature.
Facebook properties are set starting from the path data.0
.
Required
Your tracking domain as set on Adform UI (E.g. "a1.adform.net", without quotes). More details are available following this . This setting supports dynamic values [1][2].
In the column Your event property path
you should keep the default value Default (root)
as it fits most scenarios. In case you select either In "items" {items.X}
or In "product" {items.X.product}
this destination will look for the input event property starting from the or level respectively and add its value as a custom entry in the "subVariables" array. The advanced operation As Adform subVariables Data
can be paired with the property path option Default (root)
so your property value is set as a custom entry in the "subVariables" array for each item. More details on Adform custom variables are available following this (section: "Add Custom Variables").
Required
Your selected Amazon API endpoint. More details are available by following this .
Required
The country where the event originates from. E.g. "US". This value is based on .
Required
Branch Key of the originating app and obtained by accessing your .
Change the standard mapping (See ) between Branch's events and yours or add new mappings.
[1] Automatically converted in the .
[2] This is either m
or d
, depending if app.name
is defined or not.
[3] id.email.sha256_md5
is automatically hashed.
Most properties can be remapped using our "Smart Mapping" feature.
Setting the field CJ Event Cookie Name
is not mandatory if the "Smart Mapping" field Click Id (cjevent)
is set. The latter has precedence over the former.
[1] "Smart Mapping" field.
[2] Click Id (cjevent)
has priority over CJ Event Cookie Name
.
[3] Automatically converted in the .
[4] If are present, this property won't be included.
[5] For each : X
and Y
are incremental numbers, starting from0
and1
respectively.
[6] See Custom Event Properties
in for more details. The signature
CJ optional property can be set using this feature.
[*] Mandatory property.
[1] See for more details.
[2] Default value "aw".
[3] Computed amounts are rounded with two decimals (E.g. "DOWNLOAD:551.18|FIX-NC:15302.67"). For sale
conversion type, when the "Smart Mapping" field Item Affiliation
is not filled with a proper value, the Awin "Commission Group" is set with the value DEFAULT
.
When you select lead
as conversion type, it's set with the static string LEAD:1
.
[4] It takes into account each product.
[1] Custom events are also supported.
[2] Dynamic Yield custom events don't have a type. More details are available following this . See Event Mapping
in for more details.
[1] if no property is provided, the cookie _dyjsession
is used.
[2] This property is set in events[0].properties
.
[3] See for more details.
[4] Included for , and events.
[5] Set with VIDEO_STARTED
, VIDEO_FINISHED
or PREROLL_FINISHED
depending if the event name is , or respectively.
[6] See Custom Event Properties
in for more details on how you can send custom properties to Dynamic Yield.
You have to go on Facebook Business and login to your account.
For this part, you have to go to Facebook Developers and create or login to your account (you need to have a dedicated account for Facebook Developer).
Now you have an App linked to your Facebook Business Manager Account (). Please check this page to be sure that the App is well associated with the Business account:
You have to create a system user on your Facebook Business Account ().
[1] See for more details.
[*] Mandatory property. [1] See for more details. [2] If this field is not provided, the current timestamp is used.
name
context.segment_name
description
context.site_id
_context.segment_id
_context.segment_name
type
custom_ids
nb_ids
(Number of identifiers in segment)
indexing_state
APPLIED
created
(Creation time in the format YYYY-MM-DDTHH:MM:SS)
updated
(Update time in the format YYYY-MM-DDTHH:MM:SS)
event_timestamp
timestamp
[1]
Account Id
account
device.ip
ip
page.location.href
full_url
page.referrer
previous_url
(app.name)
site_type
[2]
device.user_agent
useragent
user.id
retailer_visitor_id
Caller Id
id.mapping_key
user.email
id.email.raw
user.email_md5
id.email.md5
and
id.email.sha256_md5
[3]
user.email_sha256
id.email.sha256
amount
value
Amount
cmp
campaign
Campaign
chn
medium
Channel from medium
cty
user.country
Country
currency
currency
Currency
dev
context.device.terminal_type
Device
e
user.email
fmt
ad_format
Format
kw
keyword
Keyword, will be singular in NDL
med
medium
Medium
n_customer
user.is_new_customer
New Customer
orderid
id
Order id
os
status
Order Status
ot
type
Order Type
p
page_name
Page Name
pt
page_type
Page Type
ref
context.page.referrer
Referrer
src
source
Source
tclid
ad_cost_id
tclid
user_id
user.id
User id
CJ Enterprise Id
CID
CJ Action Id
TYPE
Click Id (cjevent)
[1]
CJ Event Cookie Name
CJEVENT
[2]
event_timestamp
eventTime
[3]
id
OID
currency
currency
revenue
amount
[4]
coupon
coupon
items.X.product.id
ITEMY
[5]
items.X.product.price
AMTY
[5]
items.X.quantity
QTYY
[5]
items.X.discount
DCNTY
[5]
Commanders Act event property or static value
Event property name
[6]
generate_lead
lead
purchase
sale
Advertiser Id
merchant
[*]
Click Id
cks
[1][*]
revenue
amount
channel
ch
[2]
items.X.affiliation
:items.X.product.price
*items.X.quantity
parts
[3]
coupon
vc
currency
cr
id
ref
Test Mode
testmode
AW:P|Advertiser Id
|id
|items.X.product.id
|items.X.product.name
|items.X.product.price
|items.X.quantity
|items.X.product.price
|items.X.id
|items.X.affiliation
|items.X.product.category_1
.
bd[X]
[4]
add_to_cart
add-to-cart-v1
add_to_wishlist
add-to-wishlist-v1
generate_lead
newsletter-subscription-v1
login
login-v1
purchase
purchase-v1
remove_from_cart
remove-from-cart-v1
search
keyword-search-v1
sign_up
signup-v1
video_start
video_complete
video_ad_complete
video-watch-v1
[Any Other Event]
[1]
[Not Set]
[2]
User Identifier
user.dyid
user.dyid_server
partners.dy.session_id
session.dy
[1]
context.device.ip
context.device.ip
event_name
events[0].name
(event_name)
dyType
[2][3]
value
value
[2]
currency
currency
[2]
items.0.id
productId
[2][4]
items.0.quantity
quantity
[2][4]
items.X.id
cart.X.productId
[2]
items.X.quantity
cart.X.quantity
[2]
items.X.product.price
cart.X.itemPrice
[2]
id
uniqueTransactionId
[2]
user.email
hashedEmail
[2]
(event_name)
progress
[2][5]
search_term
keywords
[2]
Your event property
Dynamic Yield property name
[6]
[Any Event]
[1]
[Any Event]
[1]
Facebook event name
event_name
[*][1]
context.event_timestamp
event_time
[*][2]
Lead Id
user_data.lead_id
[*]
Lead Event Source
custom_data.lead_event_source
[*]
Batch API Key
Required
The Batch API Key
value is either your Live or Dev Batch API key from the settings page of your app within the Batch dashboard following Settings
→ General
.
REST API Key
Required
The REST API Key
value is available in the settings page of your app within the Batch dashboard following Settings
→ General
.
Custom User Id
Required
Set the property value you want to use as Custom User Id
. More details are available by following this LINK.
Custom Audience Properties
Mapping
Send custom properties related to audiences as Batch attributes. Set Batch attribute name
with the attribute name to be set in Batch and Your value
with the value you want to set. They can be used in message personalization.
Custom Audience Properties
Tags
Send custom properties related to audiences as Batch tags. Set Your value
with the tag value you want to use, one per line. See Batch "Trigger Events API" for more details.
Account Id
Required
The retailer’s Criteo Account Id can be found in the Management Center.
Caller Id
The Caller Id is used for identifying the user and it's provided by Criteo upon request.
add_payment_info
addPaymentInfo
add_to_cart
addToCart
begin_checkout
beginCheckout
login
login
page_view
viewHome
and/or
viewPage
[1]
purchase
trackTransaction
search
view_item_list
viewList
view_cart
viewBasket
view_item
viewItem
CJ Enterprise Id
Required
Your "Enterprise ID" as provided by Commission Junction. This setting supports dynamic values [1][2].
Mapping
Required
Map your Commanders Act event(s) with CJ ActionId(s) by setting a Your Event Name
and a CJ Action Id
. At least one entry is required.
CJ Event Cookie Name
Enter a cookie name holding CJ Event value. This value is passed by Commission Junction in landings (E.g. https://www.example.com/?cjevent=656e8fa049ec11ea8237023d0a240612). This is required if the "Smart Mapping" field Click Id (cjevent)
is empty. The field Click Id (cjevent)
has priority over this field.
Custom Event Properties
Map your custom event properties by setting their field names in CJ property name
and adding the field name holding the value in Your event property
. E.g. if you inputsize
in the CJ property name
and items.0.product.size
in Your event property
, you'll have a custom event property in CJ calledsize
with a value based on the content of the field items.0.product.size
[2].
Advertiser Id
Required
Your advertiser programme ID. Consult your Awin account contact or assigned integrator for more information on this value. This setting supports dynamic values [1].
Conversion Type
Required
The conversion type that is bound with your activity. This can be either Sale
or Lead
. If conversion type is Sale
, only purchase
events are sent to the partner, if it's Lead
, only generate_lead
events are forwarded to Awin.
Click Id
Awin click identifier (awc). If it's not set the cookie "awc" is used. More details are available following this LINK. This setting supports dynamic values [1].
Test Mode
This field is available when flagging the Advanced Settings
. It's either 0
(default value) for live production or 1
for UAT/test environment: when setting to the latter, the incoming tracking requests will not be processed by Awin. This setting supports dynamic values [1].
Custom Event Properties
Map your custom event properties by setting their field names in Awin property name
and adding the field name holding the value in Your event property
. E.g. if you input size
in the Awin property name
and items.0.product.size
in Your event property
, you will have a custom event property in Awin called size
with a value based on the content of the field items.0.product.size
.
Endpoint
Required
Select your endpoint data center: EU or US.
API Key
Required
Your API key as generated in Dynamic Yield interface. More details are available by following this LINK.
User Identifier
User identifier generated by Dynamic Yield and managed, with their client-side tags, via cookies. More details are available by following this LINK (See cookies _dyid
and _dyid_server
). When keeping "Default", the above two cookies are used to retrieve a value. Selecting "[Custom Property]", you can specify a property holding the related value. Regardless of the chosen option, If no value is available our standard property user.consistent_anonymous_id
is used.
Custom Property
When selecting "[Custom Property]" with the above User Identifier
, you can Input your custom property name holding the user identifier (E.g. user.mycustomid
).
Send All Properties
When activating this option all properties included in the root of your Commanders Act events are also sent to Dynamic Yield in the properties
object. Properties with child/sub properties are converted into a single one using the underscore character "_" as separator (E.g. device_lifecycle_last_session_start).
Custom Event Properties
Map your custom event properties by setting their field names in Dynamic Yield property name
and adding its value in Your value
.
Event Mapping
Change the standard mapping (See Quick reference) between Dynamic Yield's events and yours or add new mappings.
Pixel Id
Required
Your pixel identifier associated with your Conversions API event(s). You can retrieve your pixel identifier by accessing the Events Manager.
Access Token
Required
You can generate an access token by entering the Events Manager, selecting your pixel, and clicking the "Settings" tab. In the "Conversions API" section, you can click the button "Generate access token".
Lead Id
Required
The 15 or 16 digit Facebook generated lead identifier from your downloaded leads. More details are available by following this LINK.
Lead Event Source
Required
Set this to the name of the CRM/tool where the leads are coming from (E.g. "Hubspot", "SAP", "Oracle", "Dynamics", "In-house CRM", etc...).
Mapping
Required
Your mapping between Facebook's events and yours. In Facebook event name
, you can set either a standard event or a custom event name. At least one entry is required. More details are available by following this LINK.
Select 1 or many segment(s) you want to export.
Variables are automatically added.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Enter information coming from Gamned account:
Segment ID
Gamned data lifetime (in seconds)
The filename is automatically generated, this is the format expected by Gamned.
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Define the running frequency for the export (every 10 minutes, day, week...)
Equativ is an advertising technology company. Using this destination you can share audiences with Equativ using the Audience data - API integration.
The Equativ Audience destination provides the following key features:
Audience sharing: our Events reference model drives audience sharing with Equativ, meaning that you can synchronize your existing user segments, with your partner, in a seamless way.
Select your audiences/user segments to be shared and synchronized with Equativ.
Authentication
Required
Your credentials with Equativ as set in the Commanders Act interface following: Administration
➜ Connector Credentials
➜ Add connector credentials
➜ Equativ
Created segments using Equativ Segment API hold the following properties:
active
true
description
context.segment_name
name
context.segment_name
price
0
segmentId
ca_context.site_id
_context.segment_id
selectable
true
ttl
2147483646
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Enter to which email addresses you want to send the raw data export. Multiple e-mails can be filled out, separated by commas.
Precise the filename and extension (CSV by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Precise the filename and extension (CSV by default).
Precise if you want to compress the file (GZIP by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
Select 1 or many segment(s) you want to export.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Enter information coming from Jellyfish account:
Segment ID
The filename is automatically generated, this is the format expected by Jellyfish.
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Define the running frequency for the export (every 10 minutes, day, week...)
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Precise the filename and extension (CSV by default).
Precise if you want to compress the file (GZIP by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
Google Analytics 4 (GA4) is the latest iteration of Google's analytics tool that helps you measure the traffic and engagement across your websites and apps. Using this destination, you can enhance your existing tracking implementation to match your data collection needs with GA4. Your data will be sent server-side taking advantage of the Google Measurement Protocol API and in form of events.
Google designed the Measurement Protocol with some limitations, especially it does not allow to manage session.
For session handling, you should currently setup a gtag config tag that will fire on the first page (only) of the user's session.
For this purpose you can use on your website the tag template "gtag - Config with options" as it comes with the additional configuration option to send the Google reserved event session_start
while avoid firing the event page_view
:
The Google Analytics 4 destination provides the following key features:
Events structure: our Events reference model fits Google's one, 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.
Refined data: you can freely push additional information based on your specific needs (E.g. adding custom events, custom event and user properties).
Support for multi-item data: information included in the item array is dispatched to GA4.
Send all properties option: send all your event properties to GA4 with a single click.
Before you get started with this destination, make sure you have a GA4 property in your Google Analytics account. You can find more information on this topic following these detailed articles:
App related fields are enabled by flagging Enable App Tracking
.
The properties context.app.name
and context.device.type
are required for app tracking. More details on these fields are available by following this LINK.
The user identifier should be passed in both the client-side gtag and server-side. For more information, you can follow these links: [GA4] Measure activity across platforms with User-ID and [GA4] Reporting: deduplicate user counts.
When Google Signals is enabled, same device remarketing is supported. For cross-device remarketing, the user identifier is additionally required.
Web API Secret
Measurement Id
Android API Secret
Android Firebase App ID
iOS API Secret
iOS Firebase App ID
App Instance ID Field
Send All Properties
Custom Event Properties
Custom User Properties
Enable Enhanced Conversions
Enable Proxy Mode
Client Id Cookie Name
The "Client Id" is the right most string in the cookie, including a single dot. E.g. see the following blue highlighted string "GA1.1.XXXXXXXXXX.XXXXXXXXXX".
Engagement Time in
Milliseconds
Enable debug mode
Send events for
validation only
[1] Field available after flagging the Enable App Tracking
checkbox.
When providing a Measurement Id
, the session identifier is retrieved from the cookie named _ga_<Measurement Id>
(E.g. "_ga_SE92QCQ4Q1", without quotes and the initial string "G-"). If the cookie is not provided or with App "Data streams", the default property context.device.lifecycle.session_id
is used. More details on how sessions work in Google Analytics 4 are available following this LINK.
This destination provides automatic mapping between our Events reference model and GA4 events. In this section, you will learn what properties are set so you can expect to see those details in GA4 reporting.
More details on GA4 standard events are available following this LINK. To ensure that custom event properties are picked up by GA4, you must create event-scoped dimensions. You can find more details by following this link: [GA4] Custom dimensions and metrics.
Currency
Required
Type: String
Currency, in 3-letter ISO 4217 format.
currency
currency
Value
Required
Type: Number
The value of the event.
value
value
Coupon
Type: String
Coupon code applied.
coupon
coupon
Payment Method
Type: String
The payment method.
payment_type
payment_method
Revenue
Type: Number
The revenue of the event.
revenue
revenue
Items
Required
Type: Array
The list of products of the event.
items
items
Item Id
Required
Type: String
The ID of the item.
item_id
items.X.id
Item Name
Required
Type: String
The name of the item.
item_name
items.X.product.name
Affiliation
Type: String
A product affiliation to designate a supplying company or brick and mortar store location.
affiliation
items.X.product.affiliation
Coupon
Type: String
The coupon name/code associated with the item.
coupon
items.X.coupon
Currency
Type: String
Currency, in 3-letter ISO 4217 format.
currency
items.X.product.currency
Discount
Type: Number
The monetary discount value associated with the item.
discount
items.X.discount
Index
Type: Number
The index/position of the item in a list.
index
items.X.list_position
Item Brand
Type: String
The brand of the item.
item_brand
items.X.product.brand
Item Category
Type: String
The category of the item.
item_category
items.X.product.category_1
Item Category 2
Type: String
The second category hierarchy or additional taxonomy for the item.
item_category2
items.X.product.category_2
Item Category 3
Type: String
The third category hierarchy or additional taxonomy for the item.
item_category3
items.X.product.category_3
Item Category 4
Type: String
The fourth category hierarchy or additional taxonomy for the item.
item_category4
items.X.product.category_4
Item Category 5
Type: String
The fifth category hierarchy or additional taxonomy for the item.
item_category5
items.X.product.category_5
Item List Id
Type: String
The ID of the list in which the item was presented to the user.
item_list_id
items.X.product.list_id
Item List Name
Type: String
The name of the list in which the item was presented to the user.
item_list_name
items.X.product.list_name
Item Variant
Type: String
The item variant or unique code or description for additional item details/options.
item_variant
items.X.variant
Location Id
Type: String
The location associated with the item.
location_id
items.X.product.location_id
Price
Type: Number
The monetary price of the item, in units of the specified currency parameter.
price
items.X.product.price
Quantity
Type: Number
Item quantity.
quantity
items.X.quantity
Currency
Required
Type: String
Currency, in 3-letter ISO 4217 format.
currency
currency
Value
Required
Type: Number
The value of the event.
value
value
Coupon
Type: String
Coupon code applied.
coupon
coupon
Shipping Tier
Type: String
The shipping tier (E.g. Next-day
) selected for delivery of the item.
shipping_tier
shipping_tier
Items
Required
Type: Array
The list of products of the event.
items
items
Item Id
Required
Type: String
The ID of the item.
item_id
items.X.id
Item Name
Required
Type: String
The name of the item.
item_name
items.X.product.name
Affiliation
Type: String
A product affiliation to designate a supplying company or brick and mortar store location.
affiliation
items.X.product.affiliation
Coupon
Type: String
The coupon name/code associated with the item.
coupon
items.X.coupon
Currency
Type: String
Currency, in 3-letter ISO 4217 format.
currency
items.X.product.currency
Discount
Type: Number
The monetary discount value associated with the item.
discount
items.X.discount
Index
Type: Number
The index/position of the item in a list.
index
items.X.list_position
Item Brand
Type: String
The brand of the item.
item_brand
items.X.product.brand
Item Category
Type: String
The category of the item.
item_category
items.X.product.category_1
Item Category 2
Type: String
The second category hierarchy or additional taxonomy for the item.
item_category2
items.X.product.category_2
Item Category 3
Type: String
The third category hierarchy or additional taxonomy for the item.
item_category3
items.X.product.category_3
Item Category 4
Type: String
The fourth category hierarchy or additional taxonomy for the item.
item_category4
items.X.product.category_4
Item Category 5
Type: String
The fifth category hierarchy or additional taxonomy for the item.
item_category5
items.X.product.category_5
Item List Id
Type: String
The ID of the list in which the item was presented to the user.
item_list_id
items.X.product.list_id
Item List Name
Type: String
The name of the list in which the item was presented to the user.
item_list_name
items.X.product.list_name
Item Variant
Type: String
The item variant or unique code or description for additional item details/options.
item_variant
items.X.variant
Location Id
Type: String
The location associated with the item.
location_id
items.X.product.location_id
Price
Type: Number
The monetary price of the item, in units of the specified currency parameter.
price
items.X.product.price
Quantity
Type: Number
Item quantity.
quantity
items.X.quantity
Currency
Required
Type: String
Currency, in 3-letter ISO 4217 format.
currency
currency
Value
Required
Type: Number
The value of the event.
value
value
Items
Required
Type: Array
The list of products of the event.
items
items
Item Id
Required
Type: String
The ID of the item.
item_id
items.X.id
Item Name
Required
Type: String
The name of the item.
item_name
items.X.product.name
Affiliation
Type: String
A product affiliation to designate a supplying company or brick and mortar store location.
affiliation
items.X.product.affiliation
Coupon
Type: String
The coupon name/code associated with the item.
coupon
items.X.coupon
Currency
Type: String
Currency, in 3-letter ISO 4217 format.
currency
items.X.product.currency
Discount
Type: Number
The monetary discount value associated with the item.
discount
items.X.discount
Index
Type: Number
The index/position of the item in a list.
index
items.X.list_position
Item Brand
Type: String
The brand of the item.
item_brand
items.X.product.brand
Item Category
Type: String
The category of the item.
item_category
items.X.product.category_1
Item Category 2
Type: String
The second category hierarchy or additional taxonomy for the item.
item_category2
items.X.product.category_2
Item Category 3
Type: String
The third category hierarchy or additional taxonomy for the item.
item_category3
items.X.product.category_3
Item Category 4
Type: String
The fourth category hierarchy or additional taxonomy for the item.
item_category4
items.X.product.category_4
Item Category 5
Type: String
The fifth category hierarchy or additional taxonomy for the item.
item_category5
items.X.product.category_5
Item List Id
Type: String
The ID of the list in which the item was presented to the user.
item_list_id
items.X.product.list_id
Item List Name
Type: String
The name of the list in which the item was presented to the user.
item_list_name
items.X.product.list_name
Item Variant
Type: String
The item variant or unique code or description for additional item details/options.
item_variant
items.X.variant
Location Id
Type: String
The location associated with the item.
location_id
items.X.product.location_id
Price
Type: Number
The monetary price of the item, in units of the specified currency parameter.
price
items.X.product.price
Quantity
Type: Number
Item quantity.
quantity
items.X.quantity
Currency
Required
Type: String
Currency, in 3-letter ISO 4217 format.
currency
currency
Value
Required
Type: Number
The value of the event.
value
value
Items
Required
Type: Array
The list of products of the event.
items
items
Item Id
Required
Type: String
The ID of the item.
item_id
items.X.id
Item Name
Required
Type: String
The name of the item.
item_name
items.X.product.name
Affiliation
Type: String
A product affiliation to designate a supplying company or brick and mortar store location.
affiliation
items.X.product.affiliation
Coupon
Type: String
The coupon name/code associated with the item.
coupon
items.X.coupon
Currency
Type: String
Currency, in 3-letter ISO 4217 format.
currency
items.X.product.currency
Discount
Type: Number
The monetary discount value associated with the item.
discount
items.X.discount
Index
Type: Number
The index/position of the item in a list.
index
items.X.list_position
Item Brand
Type: String
The brand of the item.
item_brand
items.X.product.brand
Item Category
Type: String
The category of the item.
item_category
items.X.product.category_1
Item Category 2
Type: String
The second category hierarchy or additional taxonomy for the item.
item_category2
items.X.product.category_2
Item Category 3
Type: String
The third category hierarchy or additional taxonomy for the item.
item_category3
items.X.product.category_3
Item Category 4
Type: String
The fourth category hierarchy or additional taxonomy for the item.
item_category4
items.X.product.category_4
Item Category 5
Type: String
The fifth category hierarchy or additional taxonomy for the item.
item_category5
items.X.product.category_5
Item List Id
Type: String
The ID of the list in which the item was presented to the user.
item_list_id
items.X.product.list_id
Item List Name
Type: String
The name of the list in which the item was presented to the user.
item_list_name
items.X.product.list_name
Item Variant
Type: String
The item variant or unique code or description for additional item details/options.
item_variant
items.X.variant
Location Id
Type: String
The location associated with the item.
location_id
items.X.product.location_id
Price
Type: Number
The monetary price of the item, in units of the specified currency parameter.
price
items.X.product.price
Quantity
Type: Number
Item quantity.
quantity
items.X.quantity
Currency
Required
Type: String
Currency, in 3-letter ISO 4217 format.
currency
currency
Value
Required
Type: Number
The value of the event.
value
value
Coupon
Type: String
Coupon code applied.
coupon
coupon
Revenue
Type: Number
The revenue of the event.
revenue
revenue
Items
Required
Type: Array
The list of products of the event.
items
items
Item Id
Required
Type: String
The ID of the item.
item_id
items.X.id
Item Name
Required
Type: String
The name of the item.
item_name
items.X.product.name
Affiliation
Type: String
A product affiliation to designate a supplying company or brick and mortar store location.
affiliation
items.X.product.affiliation
Coupon
Type: String
The coupon name/code associated with the item.
coupon
items.X.coupon
Currency
Type: String
Currency, in 3-letter ISO 4217 format.
currency
items.X.product.currency
Discount
Type: Number
The monetary discount value associated with the item.
discount
items.X.discount
Index
Type: Number
The index/position of the item in a list.
index
items.X.list_position
Item Brand
Type: String
The brand of the item.
item_brand
items.X.product.brand
Item Category
Type: String
The category of the item.
item_category
items.X.product.category_1
Item Category 2
Type: String
The second category hierarchy or additional taxonomy for the item.
item_category2
items.X.product.category_2
Item Category 3
Type: String
The third category hierarchy or additional taxonomy for the item.
item_category3
items.X.product.category_3
Item Category 4
Type: String
The fourth category hierarchy or additional taxonomy for the item.
item_category4
items.X.product.category_4
Item Category 5
Type: String
The fifth category hierarchy or additional taxonomy for the item.
item_category5
items.X.product.category_5
Item List Id
Type: String
The ID of the list in which the item was presented to the user.
item_list_id
items.X.product.list_id
Item List Name
Type: String
The name of the list in which the item was presented to the user.
item_list_name
items.X.product.list_name
Item Variant
Type: String
The item variant or unique code or description for additional item details/options.
item_variant
items.X.variant
Location Id
Type: String
The location associated with the item.
location_id
items.X.product.location_id
Price
Type: Number
The monetary price of the item, in units of the specified currency parameter.
price
items.X.product.price
Quantity
Type: Number
Item quantity.
quantity
items.X.quantity
Currency
Required
Type: String
Currency, in 3-letter ISO 4217 format.
currency
currency
Value
Required
Type: Number
The value of the event.
value
value
Transaction Id
Type: String
The transaction identifier.
id
id
Method
Type: String
The login method.
method
method
Page Location
Type: String
The current page URL.
page_location
url
Page Referrer
Type: String
The previous page URL.
page_referrer
referrer
Page Title
Type: String
The current page title.
page_title
title
Page Name
Type: String
The current page name.
page_name
page_name
Page Type
Type: String
The current page type.
page_type
page_type
Page Path
Type: String
The current page path.
page_path
path
Currency
Required
Type: String
Currency, in 3-letter ISO 4217 format.
currency
currency
Value
Required
Type: Number
The value of the event.
value
value
Transaction Id
Required
Type: String
The transaction identifier.
id
id
Affiliation
Type: String
Affiliation information.
affiliation
affiliation
Coupon
Type: String
Coupon code applied.
coupon
coupon
Shipping
Type: Number
Shipping cost.
shipping
shipping_amount
Tax
Type: Number
Tax amount.
tax
tax_amount
Revenue
Type: Number
The revenue of the event.
revenue
revenue
Conversion Type
Type: String
The conversion type.
conversion_type
type
Conversion Status
Type: String
The conversion status.
conversion_status
status
Conversion Url
Type: String
The conversion status.
conversion_url
url
Payment Method
Type: String
The payment method.
payment_type
payment_method
Items
Required
Type: Array
The list of products of the event.
items
items
Item Id
Required
Type: String
The ID of the item.
item_id
items.X.id
Item Name
Required
Type: String
The name of the item.
item_name
items.X.product.name
Affiliation
Type: String
A product affiliation to designate a supplying company or brick and mortar store location.
affiliation
items.X.product.affiliation
Coupon
Type: String
The coupon name/code associated with the item.
coupon
items.X.coupon
Currency
Type: String
Currency, in 3-letter ISO 4217 format.
currency
items.X.product.currency
Discount
Type: Number
The monetary discount value associated with the item.
discount
items.X.discount
Index
Type: Number
The index/position of the item in a list.
index
items.X.list_position
Item Brand
Type: String
The brand of the item.
item_brand
items.X.product.brand
Item Category
Type: String
The category of the item.
item_category
items.X.product.category_1
Item Category 2
Type: String
The second category hierarchy or additional taxonomy for the item.
item_category2
items.X.product.category_2
Item Category 3
Type: String
The third category hierarchy or additional taxonomy for the item.
item_category3
items.X.product.category_3
Item Category 4
Type: String
The fourth category hierarchy or additional taxonomy for the item.
item_category4
items.X.product.category_4
Item Category 5
Type: String
The fifth category hierarchy or additional taxonomy for the item.
item_category5
items.X.product.category_5
Item List Id
Type: String
The ID of the list in which the item was presented to the user.
item_list_id
items.X.product.list_id
Item List Name
Type: String
The name of the list in which the item was presented to the user.
item_list_name
items.X.product.list_name
Item Variant
Type: String
The item variant or unique code or description for additional item details/options.
item_variant
items.X.variant
Location Id
Type: String
The location associated with the item.
location_id
items.X.product.location_id
Price
Type: Number
The monetary price of the item, in units of the specified currency parameter.
price
items.X.product.price
Quantity
Type: Number
Item quantity.
quantity
items.X.quantity
Currency
Required
Type: String
Currency, in 3-letter ISO 4217 format.
currency
currency
Value
Required
Type: Number
The value of the event.
value
value
Transaction Id
Required
Type: String
The transaction identifier.
id
id
Affiliation
Type: String
Affiliation information.
affiliation
affiliation
Coupon
Type: String
Coupon code applied.
coupon
coupon
Shipping
Type: Number
Shipping cost.
shipping
shipping_amount
Tax
Type: Number
Tax amount.
tax
tax_amount
Revenue
Type: Number
The revenue of the event.
revenue
revenue
Conversion Type
Type: String
The conversion type.
conversion_type
type
Conversion Status
Type: String
The conversion status.
conversion_status
status
Conversion Url
Type: String
The conversion url.
conversion_url
url
Payment Method
Type: String
The payment method.
payment_type
payment_method
Items
Required
for partial refunds
Type: Array
The list of products of the event.
items
items
Item Id
Required
Type: String
The ID of the item.
item_id
items.X.id
Item Name
Required
Type: String
The name of the item.
item_name
items.X.product.name
Affiliation
Type: String
A product affiliation to designate a supplying company or brick and mortar store location.
affiliation
items.X.product.affiliation
Coupon
Type: String
The coupon name/code associated with the item.
coupon
items.X.coupon
Currency
Type: String
Currency, in 3-letter ISO 4217 format.
currency
items.X.product.currency
Discount
Type: Number
The monetary discount value associated with the item.
discount
items.X.discount
Index
Type: Number
The index/position of the item in a list.
index
items.X.list_position
Item Brand
Type: String
The brand of the item.
item_brand
items.X.product.brand
Item Category
Type: String
The category of the item.
item_category
items.X.product.category_1
Item Category 2
Type: String
The second category hierarchy or additional taxonomy for the item.
item_category2
items.X.product.category_2
Item Category 3
Type: String
The third category hierarchy or additional taxonomy for the item.
item_category3
items.X.product.category_3
Item Category 4
Type: String
The fourth category hierarchy or additional taxonomy for the item.
item_category4
items.X.product.category_4
Item Category 5
Type: String
The fifth category hierarchy or additional taxonomy for the item.
item_category5
items.X.product.category_5
Item List Id
Type: String
The ID of the list in which the item was presented to the user.
item_list_id
items.X.product.list_id
Item List Name
Type: String
The name of the list in which the item was presented to the user.
item_list_name
items.X.product.list_name
Item Variant
Type: String
The item variant or unique code or description for additional item details/options.
item_variant
items.X.variant
Location Id
Type: String
The location associated with the item.
location_id
items.X.product.location_id
Price
Type: Number
The monetary price of the item, in units of the specified currency parameter.
price
items.X.product.price
Quantity
Type: Number
Item quantity.
quantity
items.X.quantity
Currency
Required
Type: String
Currency, in 3-letter ISO 4217 format.
currency
currency
Value
Required
Type: Number
The value of the event.
value
value
Items
Required
Type: Array
The list of products of the event.
items
items
Item Id
Required
Type: String
The ID of the item.
item_id
items.X.id
Item Name
Required
Type: String
The name of the item.
item_name
items.X.product.name
Affiliation
Type: String
A product affiliation to designate a supplying company or brick and mortar store location.
affiliation
items.X.product.affiliation
Coupon
Type: String
The coupon name/code associated with the item.
coupon
items.X.coupon
Currency
Type: String
Currency, in 3-letter ISO 4217 format.
currency
items.X.product.currency
Discount
Type: Number
The monetary discount value associated with the item.
discount
items.X.discount
Index
Type: Number
The index/position of the item in a list.
index
items.X.list_position
Item Brand
Type: String
The brand of the item.
item_brand
items.X.product.brand
Item Category
Type: String
The category of the item.
item_category
items.X.product.category_1
Item Category 2
Type: String
The second category hierarchy or additional taxonomy for the item.
item_category2
items.X.product.category_2
Item Category 3
Type: String
The third category hierarchy or additional taxonomy for the item.
item_category3
items.X.product.category_3
Item Category 4
Type: String
The fourth category hierarchy or additional taxonomy for the item.
item_category4
items.X.product.category_4
Item Category 5
Type: String
The fifth category hierarchy or additional taxonomy for the item.
item_category5
items.X.product.category_5
Item List Id
Type: String
The ID of the list in which the item was presented to the user.
item_list_id
items.X.product.list_id
Item List Name
Type: String
The name of the list in which the item was presented to the user.
item_list_name
items.X.product.list_name
Item Variant
Type: String
The item variant or unique code or description for additional item details/options.
item_variant
items.X.variant
Location Id
Type: String
The location associated with the item.
location_id
items.X.product.location_id
Price
Type: Number
The monetary price of the item, in units of the specified currency parameter.
price
items.X.product.price
Quantity
Type: Number
Item quantity.
quantity
items.X.quantity
Search Term
Required
Type: String
The term that was searched for.
search_term
search_term
Content Type
Type: String
The term that was searched for.
content_type
content_type
Item Id
Type: String
An identifier for the item that was selected.
item_id
item_id
Item List Name
Type: String
The name of the list in which the item was presented to the user.
item_list_name
item_list_name
Items
Required
Type: Array
The list of products of the event.
items
items
Item Id
Required
Type: String
The ID of the item.
item_id
items.X.id
Item Name
Required
Type: String
The name of the item.
item_name
items.X.product.name
Affiliation
Type: String
A product affiliation to designate a supplying company or brick and mortar store location.
affiliation
items.X.product.affiliation
Coupon
Type: String
The coupon name/code associated with the item.
coupon
items.X.coupon
Currency
Type: String
Currency, in 3-letter ISO 4217 format.
currency
items.X.product.currency
Discount
Type: Number
The monetary discount value associated with the item.
discount
items.X.discount
Index
Type: Number
The index/position of the item in a list.
index
items.X.list_position
Item Brand
Type: String
The brand of the item.
item_brand
items.X.product.brand
Item Category
Type: String
The category of the item.
item_category
items.X.product.category_1
Item Category 2
Type: String
The second category hierarchy or additional taxonomy for the item.
item_category2
items.X.product.category_2
Item Category 3
Type: String
The third category hierarchy or additional taxonomy for the item.
item_category3
items.X.product.category_3
Item Category 4
Type: String
The fourth category hierarchy or additional taxonomy for the item.
item_category4
items.X.product.category_4
Item Category 5
Type: String
The fifth category hierarchy or additional taxonomy for the item.
item_category5
items.X.product.category_5
Item List Id
Type: String
The ID of the list in which the item was presented to the user.
item_list_id
items.X.product.list_id
Item List Name
Type: String
The name of the list in which the item was presented to the user.
item_list_name
items.X.product.list_name
Item Variant
Type: String
The item variant or unique code or description for additional item details/options.
item_variant
items.X.variant
Location Id
Type: String
The location associated with the item.
location_id
items.X.product.location_id
Price
Type: Number
The monetary price of the item, in units of the specified currency parameter.
price
items.X.product.price
Quantity
Type: Number
Item quantity.
quantity
items.X.quantity
Method
Type: String
The method used for sign up.
method
method
Currency
Required
Type: String
Currency, in 3-letter ISO 4217 format.
currency
currency
Value
Required
Type: Number
The value of the event.
value
value
Items
Required
Type: Array
The list of products of the event.
items
items
Item Id
Required
Type: String
The ID of the item.
item_id
items.X.id
Item Name
Required
Type: String
The name of the item.
item_name
items.X.product.name
Affiliation
Type: String
A product affiliation to designate a supplying company or brick and mortar store location.
affiliation
items.X.product.affiliation
Coupon
Type: String
The coupon name/code associated with the item.
coupon
items.X.coupon
Currency
Type: String
Currency, in 3-letter ISO 4217 format.
currency
items.X.product.currency
Discount
Type: Number
The monetary discount value associated with the item.
discount
items.X.discount
Index
Type: Number
The index/position of the item in a list.
index
items.X.list_position
Item Brand
Type: String
The brand of the item.
item_brand
items.X.product.brand
Item Category
Type: String
The category of the item.
item_category
items.X.product.category_1
Item Category 2
Type: String
The second category hierarchy or additional taxonomy for the item.
item_category2
items.X.product.category_2
Item Category 3
Type: String
The third category hierarchy or additional taxonomy for the item.
item_category3
items.X.product.category_3
Item Category 4
Type: String
The fourth category hierarchy or additional taxonomy for the item.
item_category4
items.X.product.category_4
Item Category 5
Type: String
The fifth category hierarchy or additional taxonomy for the item.
item_category5
items.X.product.category_5
Item List Id
Type: String
The ID of the list in which the item was presented to the user.
item_list_id
items.X.product.list_id
Item List Name
Type: String
The name of the list in which the item was presented to the user.
item_list_name
items.X.product.list_name
Item Variant
Type: String
The item variant or unique code or description for additional item details/options.
item_variant
items.X.variant
Location Id
Type: String
The location associated with the item.
location_id
items.X.product.location_id
Price
Type: Number
The monetary price of the item, in units of the specified currency parameter.
price
items.X.product.price
Quantity
Type: Number
Item quantity.
quantity
items.X.quantity
Currency
Required
Type: String
Currency, in 3-letter ISO 4217 format.
currency
currency
Value
Required
Type: Number
The value of the event.
value
value
Items
Required
Type: Array
The list of products of the event.
items
items
Item Id
Required
Type: String
The ID of the item.
item_id
items.X.id
Item Name
Required
Type: String
The name of the item.
item_name
items.X.product.name
Affiliation
Type: String
A product affiliation to designate a supplying company or brick and mortar store location.
affiliation
items.X.product.affiliation
Coupon
Type: String
The coupon name/code associated with the item.
coupon
items.X.coupon
Currency
Type: String
Currency, in 3-letter ISO 4217 format.
currency
items.X.product.currency
Discount
Type: Number
The monetary discount value associated with the item.
discount
items.X.discount
Index
Type: Number
The index/position of the item in a list.
index
items.X.list_position
Item Brand
Type: String
The brand of the item.
item_brand
items.X.product.brand
Item Category
Type: String
The category of the item.
item_category
items.X.product.category_1
Item Category 2
Type: String
The second category hierarchy or additional taxonomy for the item.
item_category2
items.X.product.category_2
Item Category 3
Type: String
The third category hierarchy or additional taxonomy for the item.
item_category3
items.X.product.category_3
Item Category 4
Type: String
The fourth category hierarchy or additional taxonomy for the item.
item_category4
items.X.product.category_4
Item Category 5
Type: String
The fifth category hierarchy or additional taxonomy for the item.
item_category5
items.X.product.category_5
Item List Id
Type: String
The ID of the list in which the item was presented to the user.
item_list_id
items.X.product.list_id
Item List Name
Type: String
The name of the list in which the item was presented to the user.
item_list_name
items.X.product.list_name
Item Variant
Type: String
The item variant or unique code or description for additional item details/options.
item_variant
items.X.variant
Location Id
Type: String
The location associated with the item.
location_id
items.X.product.location_id
Price
Type: Number
The monetary price of the item, in units of the specified currency parameter.
price
items.X.product.price
Quantity
Type: Number
Item quantity.
quantity
items.X.quantity
Item List Name
Type: String
The name of the list in which the item was presented to the user.
item_list_name
item_list_name
Items
Required
Type: Array
The list of products of the event.
items
items
Item Id
Required
Type: String
The ID of the item.
item_id
items.X.id
Item Name
Required
Type: String
The name of the item.
item_name
items.X.product.name
Affiliation
Type: String
A product affiliation to designate a supplying company or brick and mortar store location.
affiliation
items.X.product.affiliation
Coupon
Type: String
The coupon name/code associated with the item.
coupon
items.X.coupon
Currency
Type: String
Currency, in 3-letter ISO 4217 format.
currency
items.X.product.currency
Discount
Type: Number
The monetary discount value associated with the item.
discount
items.X.discount
Index
Type: Number
The index/position of the item in a list.
index
items.X.list_position
Item Brand
Type: String
The brand of the item.
item_brand
items.X.product.brand
Item Category
Type: String
The category of the item.
item_category
items.X.product.category_1
Item Category 2
Type: String
The second category hierarchy or additional taxonomy for the item.
item_category2
items.X.product.category_2
Item Category 3
Type: String
The third category hierarchy or additional taxonomy for the item.
item_category3
items.X.product.category_3
Item Category 4
Type: String
The fourth category hierarchy or additional taxonomy for the item.
item_category4
items.X.product.category_4
Item Category 5
Type: String
The fifth category hierarchy or additional taxonomy for the item.
item_category5
items.X.product.category_5
Item List Id
Type: String
The ID of the list in which the item was presented to the user.
item_list_id
items.X.product.list_id
Item List Name
Type: String
The name of the list in which the item was presented to the user.
item_list_name
items.X.product.list_name
Item Variant
Type: String
The item variant or unique code or description for additional item details/options.
item_variant
items.X.variant
Location Id
Type: String
The location associated with the item.
location_id
items.X.product.location_id
Price
Type: Number
The monetary price of the item, in units of the specified currency parameter.
price
items.X.product.price
Quantity
Type: Number
Item quantity.
quantity
items.X.quantity
You can send custom events to better fit your specific needs.
More details on how you can create and manage custom events are available following this link: [GA4] Modify and create events via the user interface. The following properties are automatically attached to the event.
Currency
Type: String
Currency, in 3-letter ISO 4217 format.
currency
currency
Value
Type: Number
The value of the event.
value
value
Transaction Id
Type: String
The transaction identifier.
id
id
Content Type
Type: String
The transaction identifier.
content_type
content_type
Conversion Type
Type: String
The conversion type.
conversion_type
type
Conversion Status
Type: String
The conversion status.
conversion_status
status
Conversion Url
Type: String
The conversion url.
conversion_url
url
Coupon
Type: String
Coupon code applied.
coupon
coupon
Item Id
Type: String
An identifier for the item that was selected.
item_id
item_id
Item List Name
Type: String
The name of the list in which the item was presented to the user.
item_list_name
item_list_name
Method
Type: String
Method used.
method
method
Page Location
Type: String
The current page URL.
page_location
url
Page Referrer
Type: String
The previous page URL.
page_referrer
referrer
Page Title
Type: String
The current page title.
page_title
title
Page Name
Type: String
The current page name.
page_name
page_name
Page Type
Type: String
The current page type.
page_type
page_type
Page Path
Type: String
The current page type.
page_path
path
Payment Method
Type: String
The payment method.
payment_type
payment_method
Revenue
Type: Number
The revenue of the event.
revenue
revenue
Search Term
Type: String
The term that was searched for.
search_term
search_term
Shipping Tier
Type: String
The shipping tier (E.g. Next-day
) selected for delivery of the item.
shipping_tier
shipping_tier
Shipping
Type: Number
Shipping cost.
shipping
shipping_amount
Tax
Type: Number
Tax amount.
tax
tax_amount
Items
Type: Array
The list of products of the event.
items
items
Item Id
Type: String
The ID of the item.
item_id
items.X.id
Item Name
Type: String
The name of the item.
item_name
items.X.product.name
Affiliation
Type: String
A product affiliation to designate a supplying company or brick and mortar store location.
affiliation
items.X.product.affiliation
Coupon
Type: String
The coupon name/code associated with the item.
coupon
items.X.coupon
Currency
Type: String
Currency, in 3-letter ISO 4217 format.
currency
items.X.product.currency
Discount
Type: Number
The monetary discount value associated with the item.
discount
items.X.discount
Index
Type: Number
The index/position of the item in a list.
index
items.X.list_position
Item Brand
Type: String
The brand of the item.
item_brand
items.X.product.brand
Item Category
Type: String
The category of the item.
item_category
items.X.product.category_1
Item Category 2
Type: String
The second category hierarchy or additional taxonomy for the item.
item_category2
items.X.product.category_2
Item Category 3
Type: String
The third category hierarchy or additional taxonomy for the item.
item_category3
items.X.product.category_3
Item Category 4
Type: String
The fourth category hierarchy or additional taxonomy for the item.
item_category4
items.X.product.category_4
Item Category 5
Type: String
The fifth category hierarchy or additional taxonomy for the item.
item_category5
items.X.product.category_5
Item List Id
Type: String
The ID of the list in which the item was presented to the user.
item_list_id
items.X.product.list_id
Item List Name
Type: String
The name of the list in which the item was presented to the user.
item_list_name
items.X.product.list_name
Item Variant
Type: String
The item variant or unique code or description for additional item details/options.
item_variant
items.X.variant
Location Id
Type: String
The location associated with the item.
location_id
items.X.product.location_id
Price
Type: Number
The monetary price of the item, in units of the specified currency parameter.
price
items.X.product.price
Quantity
Type: Number
Item quantity.
quantity
items.X.quantity
add_payment_info
add_payment_info
add_shipping_info
add_shipping_info
add_to_cart
add_to_cart
add_to_wishlist
add_to_wishlist
begin_checkout
begin_checkout
generate_lead
generate_lead
login
login
page_view
page_view
purchase
purchase
refund
refund
remove_from_cart
remove_from_cart
search
search
select_content
select_content
select_item
select_item
sign_up
sign_up
view_cart
view_cart
view_item
view_item
view_item_list
view_item_list
[Custom Event]
[Custom Event]
When enabling this feature, you can send user-related data together with the user identifier. This can be used to improve behavior and conversion measurement. More details are available following this LINK.
When Proxy Mode is enabled, ensure the User Id
field is set to None
as its value must be present.
Google properties are set starting from the path user_data
. The property user_id
is set in the base path.
user.id
user_id
[*]
user.email_sha256
sha256_email_address
[1]
user.phone
sha256_phone_number
[1]
user.firstname
sha256_first_name
[1][2]
user.lastname
sha256_last_name
[1][2]
user.street
sha256_street
[1][2]
user.city
city
[2][3]
user.state
region
[2][3]
user.zipcode
postal_code
[2][3]
user.country
country
[2]
[*] Mandatory property.
[1] Automatically normalized and hashed, if provided in clear text.
[2] Property set starting from the path user_data.address
.
[3] Automatically normalized.
Depending on your licence (standard or 360), sending events to GA4 has some different limitations: https://support.google.com/analytics/answer/11202874?sjid=10370297212042052180-EU
Google is a multinational technology company focusing on online advertising, search engine technology, cloud computing, and computer software. This destination let you improve the accuracy of your offline conversion measurement by uploading click conversions that contain hashed user identifiers and some optional additional details that help Google Ads match the conversion to the ad that initiated the lead.
The Google Enhanced Conversions for Leads destination provides the following key features:
Events structure: our Events reference covers Google method uploadClickConversions, 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.
Automatic hashing: information is automatically hashed matching partner specifications.
Smart mapping: data mapping can be readjusted using your datalayer defined fields.
Support for multi-item data: information included in the item array is dispatched to the partner.
Before configuring this destination, you need to fullfil the following Google prerequisites:
Login into Google Ads and:
Click Goals
Click the Conversion drop down in the menu section.
Click Summary
Click New conversion action.
Select Import in the "New conversion action” page.
Select CRMs, files, or other data sources and then Track conversions from clicks.
In the “Data Source” section, you can select Connect a new data source: this can be done at a later stage.
Click Continue.
Enter the settings for this conversion action. For details on the settings, check out Set up offline conversion imports.
Click Save and continue. The next page will confirm your new conversion action.
Click Done.
Check the box to turn on enhanced conversions for leads or you can do it, after creating your conversion action, by clicking Summary and open the enhanced conversions for leads drop down to check the same box.
To accept the customer data terms click on Summary, select Settings and click the Customer data terms drop down.
Authentication
Required
Your credentials with Google Ads as set in the Commanders Act interface following: Administration
➜ Connector Credentials
➜ Add connector credentials
➜ Google Ads
Mapping
Conversion Names
Required
Map your Google Ads conversion names, where enhanced conversions are applied, with your events by setting the fields Conversion name
and Your event name
. At least one line is required. Conversion names can be found in the Google Ads interface following: Goals
➜ Summary
➜ Conversion actions
(column).
Mapping
Custom Variables
Google Analytics
Measurement Id
You can add the Google Analytics "Measurement Id", which is a string like "SE23QCQ1Q8" without the intial "G-" part. It's used as an additional method to retrieve your gclid
from available cookies.
Validate Only
If flagged, the request is validated but not executed!. Only errors are returned, not results, in the tab Event Inspector
.
Debug Enabled
[Any Event]
[1]
customers.uploadClickConversions
[1] See Mapping Conversion Names in Configuration for more details.
At least one of the following identifiers must be provided:
User email
User phone
Most properties can be remapped using our "Smart Mapping" feature.
Google properties are set starting from the path conversions[0]
.
id
orderId
partners.google.gclid
Google Analytics Measurement Id
gclid
[1]
partners.google.gbraid
gbraid
[2]
partners.google.wbraid
wbraid
[3]
partners.google.email_source
partners.google.phone_source
userIdentifierSource
[4]
user.email_sha256
hashedEmail
[4][5]
user.phone
hashedPhoneNumber
[4][5]
partners.google.aduserdata
consent.adUserData
[6]
partners.google.adpers
consent.adPersonalization
[6]
partners.google.merchant_id
cartData.merchantId
partners.google.feed_country_code
cartData.feedCountryCode
partners.google.feed_language_code
cartData.feedLanguageCode
partners.google.local_transaction_cost
cartData.localTransactionCost
items.X.id
cartData.items.X.productId
items.X.product.price
cartData.items.X.unitPrice
tems.X.quantity
cartData.items.X.quantity
Mapping Conversion Names
conversionAction
[7]
value
conversionValue
currency
currencyCode
Custom variable name
conversionCustomVariable
[8][9]
Your value
value
[8][10]
Validate Only
validateOnly
[11]
Debug Enabled
debugEnabled
[11]
[1] See Google Analytics Measurement Id in Configuration for more details.
[2] Google click identifier for clicks associated with app conversions and originating from iOS devices starting with iOS14.
[3] Google click identifier for clicks associated with web conversions and originating from iOS devices starting with iOS14.
[4] Set in the userIdentifiers.X
. Accepted values: FIRST_PARTY
, THIRD_PARTY
or UNSPECIFIED
. Default value: FIRST_PARTY
.
[5] Automatically hashed if provided in clear text.
[6] Accepted values: true
, 1
or granted
when user granted the consent or false
, 0
or denied
otherwise. If consent is not specified use unspecified
. All string values are case insensitive. Default value granted
.
[7] Conversion resource name in the following format: customers/[CUSTOMER_ID]/conversionActions/[CONVESION_ACTION_ID]
[8] Set in the path customVariables.X
.
[9] Resource name of the custom variable in the following format:
customers/[CUSTOMER_ID]/conversionCustomVariables/[VARIABLE_ID]
[10] Your value for the custom variable. See Mapping Custom Variables in Configuration for more details.
[11] Set in the base path. See Configuration for more details.
Google is a multinational technology company focusing on online advertising, search engine technology, cloud computing, and computer software. Taking advantage of the Google Ads API, you can leverage the enhanced conversions feature to send first-party data in the form of conversion adjustments. Google uses this additional data to improve the reporting of your online conversions driven by ad interactions. The enhanced conversions supplement your existing conversion tags by sending hashed first-party conversion data from your website to Google in a privacy-safe way.
You must complete the setup and configuration steps before you can bridge enhanced conversions via the Google Ads API.
The Google Enhanced Conversions destination provides the following key features:
Events structure: our Events reference covers Google method uploadConversionAdjustments, 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.
Automatic hashing: information is automatically hashed matching partner specifications.
Smart mapping: data mapping can be readjusted using your datalayer defined fields.
Your user account needs admin rights in the Google Ads Manager Accounts where the conversion action is located. When available, this destination will also include the gclid
value by looking for the following cookies in this priority order:
_gcl_aw
_gcl_dc
_gac_[GA_PROPERTY_ID]
Authentication
Required
Your credentials with Google Ads as set in the Commanders Act interface following: Administration
➜ Connector Credentials
➜ Add connector credentials
➜ Google Ads
Mapping
Required
Map your Google Ads conversion names, where enhanced conversions are applied, with your events by setting the fields Google Ads Conversion Name
and Your event name
. At least one line is required. Conversion names can be found in the Google Ads interface following:
Goals
➜ Summary
➜ Conversion action
(column) [1]
If a conversion action is not found the event will be discarded.
Google Analytics Property Id
[1] Enhanced conversions must be enabled for your conversion action. This is done in the Google Ads interface following these steps: click on the conversion action ➜ expand Enhanced conversions
➜ flag Turn on enhanced conversions
➜ select API
.
[Any Event]
[1]
customers.uploadConversionAdjustments
[1] See Mapping for more details.
At least one of the following identifiers must be provided:
User email
User phone
User first name
User last name
User street address
User city
User state
User country
User zip code
Most properties can be remapped using our "Smart Mapping" feature.
Google properties are set starting from the path conversionAdjustments.0
or conversionAdjustments.0.userIdentifiers.X
with the latter for user properties.
id
orderId
[*]
context.device.user_agent
userAgent
event_timestamp
gclidDateTimePair.conversionDateTime
[1]
adjustmentDateTime
[1]
value
restatementValue.adjustedValue
currency
restatementValue.currencyCode
user.email
user.email_sha256
hashedEmail
[2]
user.phone
hashedPhoneNumber
[3]
user.firstname
addressInfo.hashedFirstName
[3]
user.lastname
addressInfo.hashedLastName
[3]
user.streetAddress
addressInfo.hashedStreetAddress
[3]
user.city
addressInfo.city
user.state
addressInfo.state
user.country
addressInfo.countryCode
user.zipcode
addressInfo.postalCode
Cookie _gcl_aw
Cookie _gcl_dc
Cookie _gac_[GA_PROPERTY_ID]
gclidDateTimePair.gclid
[4]
[*] Mandatory property.
[1] This value is automatically adjusted. See GclidDateTimePair for more details.
[2] If user.email
is provided, it's hashed using SHA256, otherwise , user.email_sha256
is used.
[3] Normalized and hashed via SHA256.
[4] See Destination setup for more details.
This destination is currently under final review and will be available soon.
Google is a multinational technology company focusing on online advertising, search engine technology, cloud computing, and computer software. Taking advantage of the Google Ads API Upload Conversion Adjustments, you can amend conversions values initially reported by other means (E.g. via client-side tags).
To adjust a conversion, you must first have a conversion action set up, and conversions must have been reported in Google Ads interface.
Google recommends waiting 24 hours after a conversion is reported before sending adjustments. This will avoidCONVERSION_NOT_FOUND
orTOO_RECENT_CONVERSION
upload errors. Also, wait 4-6 hours after creating a conversion action before adjusting its conversions to avoid a TOO_RECENT_CONVERSION_ACTION
upload error.
To identify the conversion and when a transaction identifier is not provided, this destination will try to include the gclid
if its value is provided in the Google Click Id
field (See Configuration for more details). If this is not set, the following cookies, in the presented priority order, are used to retrieve a proper value:
_gcl_aw
_gcl_dc
_gac_[GA_PROPERTY_ID]
On the other hand, when a transaction identifier is present both the gclid
and conversionDateTime
are removed from the hit to prevent the GCLID_DATE_TIME_PAIR_AND_ORDER_ID_BOTH_SET
upload error. More details on all upload errors are available following this LINK.
Conversion adjustments don't work with conversion actions whose type is UNKNOWN
. In addition, adjustments for a conversion whose click has a gbraid
or wbraid
instead of a gclid
will fail with a CONVERSION_NOT_FOUND
upload error.
Authentication
Required
Your credentials with Google Ads as set in the Commanders Act interface following: Administration
➜ Connector Credentials
➜ Add connector credentials
➜ Google Ads
Mapping
Required
Map your Google Ads Conversion Name(s), where conversion value adjustments are applied, with Commanders Act event(s) by setting your Google Ads Conversion Name
and Your event name
. At least one line is required. Conversion names can be found in the Google Ads interface following: TOOLS & SETTINGS
➜ Measurement
➜ Conversions
➜ Conversion action
.
If a conversion action is not found the event will be discarded.
Google Click Id
Google click Id (gclid) associated with the original conversion. This field has priority over related cookies.
Google Analytics Property Id
The transaction identifier (id
) is required in any of the following conditions:
The type of the conversion action is equal to Website
/ WEBPAGE
.
The original conversion you are adjusting was assigned a transaction identifier.
If Transaction Adjusted Timestamp (adjustmentDateTime)
"Smart Mapping" field is not set, this destination will use the current timestamp to set the Google property conversionAdjustments.0.adjustmentDateTime
.
Google properties are set starting from the path conversionAdjustments.0
.
value
restatementValue.adjustedValue
[*]
id
orderId
[1]
currency
restatementValue.currencyCode
context.event_timestamp
gclidDateTimePair.conversionDateTime
Google Click Id
Cookie _gcl_aw
Cookie _gcl_dc
Cookie _gac_[GA_PROPERTY_ID]
gclidDateTimePair.gclid
[2]
[*] Mandatory property. [1] This is required when specific conditions are verified. See Field mappings for details. [2] See Destination setup for more details.
This destination is currently under final review and will be available soon.
Floodlight provides you insight into the actions that users take after they view or click on ads. Using this destination you can track installs of your app or activities that take place in the app.
The Google Floodlight Mobile App Conversion destination provides the following key features:
Events structure: our Events reference covers Floodlight ability to track in-app actions, 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.
Refined data: you can freely push additional custom event properties based on your specific needs.
Smart mapping: data mapping can be readjusted using your datalayer defined fields.
Support for multi-item data: information included in the item array is dispatched to Floodlight.
Some setup is required on the Floodlight side before configuring this destination. See more details by following this LINK (See section Set up Floodlight in apps
→ Ensure ad tags pass proper values from publishers
).
Advertiser Id
Group Tag String
Activity Tag String
Custom Event Properties
Send custom properties ( u
, tran
, num
, u1
, u2
, etc...) related to events.
[Any Event]
[1]
[Any Conversion]
[1]
[1] Use Destination filters to refine events matching your specific needs.
Advertiser Id
src
[*]
Group Tag String
cat
[*]
Activity Tag String
type
[*]
context.device.advertising_id
dc_rdid
[*]
partners.google.cdt
tag_for_child_directed_treatment
context.device.ad_tracking_enabled
dc_lat
items.X.quantity
qty
[1]
revenue
cost
id
ord
[2]
items.X.product.id
items.X.product.price
items.X.quantity
prd
Your value
[3]
Floodlight property name
[3]
[*] Mandatory property.
[1] Sum of each product quantity.
[2] If no property is provided, a random generated number is used.
[3] See Custom Event Properties
in Configuration for more details on how you can add custom properties.
impressions
ad_view
clicks
ad_click
sites
page_view
orders
purchase
Aka Facebook CAPI
Facebook is an online social media and social networking service owned by Meta. This destination allows you to push every kind of event directly to Facebook through API: by sending online and offline conversions to you can increase the reach and accuracy of your campaigns.
You can, for example, not send campaigns related to a specific product to users who already bought it, or you can also send campaigns to users who bought a specific product in cross-sell logic.
Facebook developed an API called 'Facebook Conversions API' https://developers.facebook.com/docs/marketing-api/conversions-api
You need a Facebook Business Manager account https://business.facebook.com/
Then on the menu, click on 'Events Manager':
Here you have to create a new Web Pixel:
Select Conversions API and give a name to your connection:
Now your pixel is created and you will have access to the IDs needed on our connector.
You need to fill the pixel ID on our connector, it is the ID of the pixel you just created on steps above.
You can find this ID when you click on the pixel's name and on the right of the graph activities. You can find it also on the settings tab.
You can now copy and paste this ID on our connector.
Then you need the Access Token
Click on the settings tab.
Scroll until the section 'Conversions API'
Click on the button 'Create Access Token':
If you are not able to click on the button 'Create access token', that mean you don't have enough rights to do it. You should be administrator on your Facebook Business account to create it.
Then you can copy and paste the Access Token on our connector.
Only events with a consent will be sent to Facebook
Only conversions with personal information (email and/or phone number...) will be sent to Facebook
TRUST Commander is our Consent Management Platform. (More information: https://www.commandersact.com/en/solutions/trustcommander/)
On the connector, the consent is managed with the field 'User Consent Category'. You should enter a category ID, the one corresponding to Facebook (advertising) on Trust consent categories.
We should distinguish 3 cases:
Your online events are collected through our Commanders Act event's tag: You have to provide, in the event tags, the list of category ids consented by the user, through the consent_categories
property.
You are pushing your events to us through API or CSV file: a field consent_categories
must be added on the JSON or CSV to precise the consent category IDs of the user. Then inside the connector setting, use the field 'User Consent Category' to enter a category ID, the one corresponding to Facebook (advertising)
You already manage consents on your side and you only send us, from your server,
events that obtained the consent for the category advertising. In this case, do not fill the field ‘User Consent Category’ in the connector.
Using both the pixel and server is recommended per Facebook as it could avoid losing data.
To make it works, you should have the same configuration for both the pixel and server, using same Facebook parameters.
event_id should be the same
On the pixel, event_id
is automatically generated by our Commanders Act Tag and we retrieve the same value for the server on integrations.facebook.event_id
. As a result, these 2 values should be the same.
Event_name
should be the same also.
Fbp
parameter is automatically retrieved to keep the same value between pixel and server.
Deduplication works when the same event is sent first from the browser and then from the server, otherwise it creates a duplicate. Events are pushed in real-time.
On pixel:
eventID: tC.uniqueEventId
is automatically generated.
On server:
integrations.facebook.event_id
automatically retrieves the eventID value coming from the pixel (eventID: tC.uniqueEventId
) for standard events.
The Facebook CAPI Destination will turn the Commanders Act event like...
...into Facebook CAPI events like :
The following mappings are fully automated and do not require any additional configuration by default. You can still customize each as follows.
Most properties can be remapped using our "Smart Mapping" feature.
event_id
[2][3]
event_id
[1]
event_name
event_name
[4]
context.event_timestamp
event_time
[5]
context.page.url
event_source_url
context.page.referrer
referrer_url
Enable App tracking
type
action_source
[6]
opt_out
[3]
opt_out
[7]
data_processing_options
[3]
data_processing_options
[7]
data_processing_options_country
[3]
data_processing_options_country
[7]
data_processing_options_state
[3]
data_processing_options_state
[7]
[1] Set based on available properties, in the reported order on the left. Default to a random generated value based on the timestamp.
[2] In the base path/root of your event.
[3] In integrations.facebook
of your event.
[4] See Mapping: event_name for more details.
[5] If no value is provided the current timestamp is used.
[6] See Mapping: action_source for more details.
[7] See more details following this LINK.
event_name
Facebook Pixel specifies Standard Events whose semantics correspond to events in the Commanders Act Standard
If the destination receives a Commanders Act Event with event_name
matching the list, it will automatically be sent under the associated Facebook Standard Event name. Otherwise, it will be sent without any transformation
begin_checkout
InitiateCheckout
purchase
Purchase
add_to_cart
AddToCart
view_item
ViewContent
view_item_list
ViewContent
search
Search
add_payment_info
AddPaymentInfo
add_to_wishlist
AddToWishlist
generate_lead
Lead
page_view
PageView
sign_up
CompleteRegistration
contact
Contact
customize_product
CustomizeProduct
donate
Donate
find_location
FindLocation
schedule
Schedule
search
Search
start_trial
StartTrial
submit_application
SubmitApplication
subscribe
Subscribe
Examples:
If the destinations sees a add_to_cart
event (IN the list), it will send an AddToCart
to Facebook CAPI
If the destinations sees a custom_name
event (NOT IN the list), it will send an custom_name
to Facebook CAPI (no transformation)
Remark: You can customise the event_name using Properties Transformations in Destination settings.
action_source
By default, action_source
will be set to 'website'
(most events relate to online activity).
IF
Enable App tracking
is checked THEN action_source='app'
IF
your event has the property type='offline'
THEN
the Facebook Event will have action_source='physical_store'
ELSE
the Facebook Event will have action_source='website'
Example :
If you need to overwrite this value, you currently can use Properties Transformation to set the integrations.facebook.action_source
.
user_data
Most properties can be remapped using our "Smart Mapping" feature.
user.id
(hashed)
context.device.sdk_id
user.tcId
, user.tcid
or user.tc_id
user_data.external_id
[1]
user.email
user_data.em
(email, hashed)
user.phone
user_data.ph
(phone, hashed)
user.gender
user_data.ge
(gender, hashed)
user.birthdate
user_data.db
(birthdate, hashed)
user.lastname
user_data.ln
(last name, hashed)
user.firstname
user_data.fn
(first name, hashed)
user.city
user_data.ct
(city, hashed)
user.state
user_data.st
(state, hashed)
user.zipcode
user_data.zp
(zip code, hashed)
user.country
user_data.country
(hashed)
ip
[3][4]
user_data.client_ip_address
user_agent
[3][4]
user_data.client_user_agent
fbc
[2]
The cookie "_fbc"
[5]
user_data.fbc
(Click ID)
fbp
[2]
The cookie "_fbp"
[5]
user_data.fbp
(Browser ID)
advertising_id
[3]
user_data.anon_id
[6]
user_data.madid
[6]
user_data[Property Name]
[7]
user_data[Property Name]
[1] Comma-separated string: values in the order provided on the left.
[2] In integrations.facebook
or in the root of your events with the first having priority.
[3] In context.device
of your event.
[4] Automatically set if generated by Commanders Act OneTag.
[5] Automatically created by the Facebook Pixel client-side tag.
[6] Only for app events.
[7] In integrations.facebook
of your event.
Every property can be overridden using integrations.facebook.user_data.<property>
Events can only be used if there is enough information to match a user. Facebook expects at least one user_data
property, but strongly advises sending as many properties as possible.
Here are our conditions to send the events :
at least 1 of those fields: em
, ph
, external_id
, fbp
, fbc
at least 3 of the other fields
Note : external_id, fbp, fbc will allow matching event with other events. But to match a user, one of those events shall contain additional information (em
and ph
are best suited for matching)
custom_data
Most properties can be remapped using our "Smart Mapping" feature.
value
custom_data.value
currency
items.0.currency
custom_data.currency
id
custom_data.order_id
search_term
custom_data.search_string
items.X.id
custom_data.contents.X.id
items.X.quantity
custom_data.contents.X.quantity
items.X.product.price
custom_data.contents.X.item_price
items.0.product.name
custom_data.content_name
items.0.product.category_1
custom_data.content_category
items.X.id
custom_data.content_ids
[1]
Content type value
custom_data.content_type
[2]
status
custom_data.status
items.length
custom_data.num_items
Send all your event properties as custom data
custom_data[Property Name]
[3]
custom_data[Propery Name]
[4]
custom_data[Property Name]
[1] Array containing all product identifiers.
[2] Depending on the selected value for Content type value
, which can be found under Advanced Settings
, this is either product
or not set.
[3] When Send all your event properties as custom data
is checked all properties in your event with type "string", "number" and "boolean" will be included in custom_data
with the same property name.
[4] In integrations.facebook
in your event.
Facebook specifies rules for standard properties. The rest is completely free.
By default, we fill custom_data
as follows :
We copy all CommandersAct Event properties into custom_data
(except some context fields like source_key
)
Then we map the standard properties according to the table above (can overwrite 1. values)
Finally, we overwrite with integrations.facebook.custom_data.<property>
if exists
custom_data
Best choice would be to use Properties Transformation to modify your event properties which will be copied into custom_data
.
But you can override the final value using integrations.facebook.custom_data.<property>
.
Example :
app_data
Most properties can be remapped using our "Smart Mapping" feature.
ad_tracking_enabled
[1]
advertiser_tracking_enabled
application_tracking_enabled
[1]
application_tracking_enabled
context.campaign.name
campaign_ids
install_referrer
[2]
install_referrer
installer_package
[2]
installer_package
url_schemes
[2]
url_schemes
windows_attribution_id
[2]
windows_attribution_id
type
[1]
extinfo[0]
[3]
app.namespace
[1]
extinfo[1]
app.build
[1]
extinfo[2]
app.version
[1]
extinfo[3]
os.version
[1]
extinfo[4]
model
[1]
extinfo[5]
language
[1]
extinfo[6]
[No default field]
[4]
extinfo[7]
network.carrier
[1]
extinfo[8]
screen.width
[1]
extinfo[9]
screen.height
[1]
extinfo[10]
screen.density
[1]
extinfo[11]
[No default field]
[5]
extinfo[12]
[No default field]
[6]
extinfo[13]
[No default field]
[7]
extinfo[14]
timezone
[1]
extinfo[15]
[1] In context.device
of your event.
[2] In integrations.facebook
or in the root of your events with the first having priority.
[3] When context.device.type
is set with Android
or iOS
(case insensitive), this is set with a2
or i
2
respectively.
[4] Can be set in Smart Mapping
→ App Data
→ Device Abbreviated Timezone
.
[5] Can be set in Smart Mapping
→ App Data
→ CPU Cores
.
[6] Can be set in Smart Mapping
→ App Data
→ External Storage Size
.
[7] Can be set in Smart Mapping
→ App Data
→ Available Storage Size
.
integrations.facebook.*
deprecationintegrations.facebook.*
usage will be deprecated.
The feature is still working, but it is recommended to use the destination settings instead for maintenance and reliability purpose.
To view quality matching on Facebook interface, go here: Events manager > select the event > View Details > Event Matching > Rating Background
The recommanded way is to use the HTTP Tracking API source to send your offline events from your servers (or any other emmiter).
You just need to send a purchase event with the type
property equals to offline
More details on the automatic mapping here: Mapping action_source
Commanders Act provides a GTM template to connect your existing GTM implementation to our serverside endpoint, enabling "Facebook CAPI" in a secured environment.
Add our bridge tag
Update your Facebook tags
First, access GTM and then add our template "Commanders Act | Serverside events bridge" You can follow our dedicated guide:
If you're planning to keep running your existing Facebook pixels while using "Facebook CAPI" through GTM, it's really important that you update them following these guidelines. This will allow to deduplicate and keep consistent measurements of your events.
The process is straightforward as for every event you're sending via pixel tags you just need to add the event identifier - On GTM, open your "Facebook Pixel" tag and expand (14) "More Settings" to locate the "Event ID" and click (15) its icon on the right.
A new window will slide-in. Click on (16)
the plus on the top right.
Click on (17)
the "Variable Configuration".
Click (18)
the "JavaScript Variable".
Rename your (19)
variable as window.tC.uniqueEventId and set the same name in (20)
the "Global Variable Name" then click (21)
the "Save" button.
Back on the tag configuration, expand (22)
"Advanced Settings" and (23)
"Tag Sequencing" to check (24)
the option "Fire a tag before Facebook Pixel fires". In "Set-up Tag", select (25)
"Commanders Act | Serverside events bridge" and save your tag.
Repeat this configuration for each active "Facebook Pixel" in GTM.
See Facebook documentation for more details: Deduplicate Pixel and Server Event
Contact your reference consultant or our Support team in case you need assistance.
Anonymize data before to send it to Google
The protection of user privacy has become a necessity with the implementation of the GDPR. In accordance with this regulation, you should delete any personally identifiable information from user data before transferring it to a tool owned by a US entity, owing to the invalidation of Privacy Shield.
The CNIL recommended on June 7, 2022 that proxification should be implemented along with other specific measures to ensure the validity of the use of GA4.
The proxy mode option in the GA4 destination allows you to anonymize data before to send it to Google.
When enabled, the proxy mode gives you access to a number of options that allow you to choose granularly how each parameter should be anonymized.
You can find below the CNIL recommandation, and for each parameter the proxy mode give you a userfriendly way to manage anonymisation:
the absence of transfer of the IP address to the servers of the analytics tool. If a location is transmitted to the servers of the measurement tool, it must be carried out by the proxy server and the level of precision must ensure that this information does not allow the person to be re-identified (for example, by using a geographical mesh ensuring a minimum number of Internet users per cell); Solution: You can choose to obfusctate the IP (the last octet (the last portion) of the IP address is replaced by 0) or to delete it completly. Obfuscation is often preferred because it allows to remove the identifying character of the IP while keeping the geolocation features of the country
the replacement of the user identifier by the proxy server. To ensure effective pseudonymisation, the algorithm performing the replacement should ensure a sufficient level of collision (i.e. a sufficient probability that two different identifiers will give an identical result after a hash) and include a time-varying component (adding a value to the hashed data that evolves over time so that the hash result is not always the same for the same identifier) ; Solution: You can choose to pseudonymize the client id (cid) and user id (uid). This pseudonymization option consist to replace the id by a hash of id plus a salt. The id will be first concatened with a salt that changes every 3h approximately and then be hased using SHA256. This allows to create anonymous ids that are identical within a session but different from session to session. This will prevent GA4 from tracking a user over time.
the removal of external referrer information from the site; Solution: You can choose to delete it or keep only internal domains.
the removal of any parameters contained in the collected URLs (e.g. UTMs, but also URL parameters allowing internal routing of the site); Solution: You can choose to delete all url parameters, keep only specific parameters and/or keep UTMs in some case
reprocessing of information that can be used to generate a fingerprint, such as user-agents, to remove the rarest configurations that can lead to re-identification; Solution: Choosing to delete completly the user-agent seems to be the best option.
the absence of collection of cross-site or lasting identifiers (CRM ID, unique ID); Solution: Use the Properties Transformation feature or the Data Cleansing feature to treat on a case by case basis by deleting/hashing/transforming your properties (see Manage custom PII data below) It is often easier to completly delete the user id.
the deletion of any other data that could lead to re-identification. Solution: Use the Properties Transformation feature or the Data Cleansing feature to treat on a case by case basis by deleting/hashing/transforming your properties (see Manage custom PII data below)
In addition to the GA4 proxy mode, you can also use on each destination, the Properties Transformation feature or the Data Cleansing feature to transform/delete/hash any event property before to send it to the partner.
Absence of IP address transfer to measurement tool servers
This point is normal and standard.
Anonymize IPs by removing the last 3 characters. Impact: This may result in a loss of location precision, going from a measurement at the city level to that of the region.
Replacement of user identifier by the proxy server
The CNIL doubts that Google does not use this data in conjunction with other third-party data.
Add pseudonymisation before sending the ID. No impact.
Removal of external referrer information (or "referrer") from the site
Complete removal of the referrer is a surprising proposition, while just reducing it to the domain name is common in other tools (Safari, Adblockers, ...)
Reduce the referrer to the domain name, which is a simple statistical measure of audience. If this suggestion is followed, there will be no impact. (If the CNIL recommendation is followed, the tool will become useless or almost useless) You can also choose to only authorize internal domains, in this case the impact can be important, especially on source traffic reports.
Removal of any parameters contained in collected URLs
It is legitimate to remove URL parameters containing personal information, but maybe not general information like utm_campaigns.
Remove URL parameters on a case-by-case basis if they contain personally identifiable data. Utm_campaigns can be kept if they are properly managed, but the question arises for advertising click IDs such as fbclid and gclid. If the CNIL recommendation is followed, the tool will become useless or almost useless, while if our recommendation is followed, there will be little impact. In case of gclid removal, utms will need to be used to tag Google Ads campaigns.
Retreatment of information that could contribute to generating a fingerprint
This request is legitimate and common and will be implemented in browsers in the future.
Remove unnecessary information from the user agent to minimize loss of granular information such as the phone model. Choosing to delete completly the user-agent seems to be the easiest option. Impact: not that low. Application of this measure no longer distinguishes device type (device _category)
Absence of any cross-site or deterministic (CRM, unique ID) identifier collection
This request is considered irrelevant as long as consent is obtained. These IDs cannot be used by Google for other data cross-referencing.
It is recommended to request consent for the use of these IDs and to treat them securely if consent is given. But you may want to hash all this ids before to send it to Google (in that case you can use Properties transformation)
As with classical GA4 server-side setups, you need to setup a single initial client-side Gtag tag which will only be triggered once per visit and will send an empty initialization event. This is necessary due to current limitations of Google's protocol.
your first party subdomain set in domain management
In this case the transpor_url
has to be set to:
https://
YOUR_1ST_TRACKING_DOMAIN
.com
/
cdp
/
events?tc_s=
YOURSITEID
&token=
YOURSOURCEKEY
&event_name=ga_session_start&ga_url_param=
or our third party collection domain collect.commander1.com
In this case the transpor_url
has to be set to:
https://collect.commander1.com/events?tc_s=
YOURSITEID
&token=
YOURSOURCEKEY
&event_name=ga_session_start&ga_url_param=
Consequently, this first hit is no longer sent to Google, but to Commanders Act server, which transforms it into a CA event. This event will then be sent to your GA4 destination where it will be processed (pseudonymized, etc. depending on the chosen settings) before being sent back to Google.
Apart from this first client-side hit, all other events from the website should be sent from any source, for instance through our function cact('trigger', 'myEventName', ...). These events will also, of course, reach your GA4 destination where the data will be pseudonymized according to the settings of the destination.
- In the settings tab, check the "Enable proxy mode" option and choose wich pseudonymisation/treatment you want to apply. - If needed hash your custom PII data through the smart mapping, properties transformation or Data Cleansing
Go through Event Inspector and inspect outgoing events.
This destination is currently under final review and will be available soon.
BigQuery is Google's data warehouse that enables scalable analysis over data. This integration allows pushing all your event properties to BigQuery.
The Google BigQuery destination provides the following key features:
Events structure: our Events reference feeds BigQuery, meaning that your data is properly bridged to the expected fields in an optimized way.
Universal schema: store events data without adjusting BigQuery's schema.
Ensure BigQuery API is enabled. More details are available following this LINK. Use Destination filters to refine events and/or other properties matching your specific needs.
First, you need to create a BigQuery table, with a specific schema, for storing raw data into it. See the following two subsections for a complete walkthrough.
Access BigQuery console to locate your (1)
project identifier and click (2)
the three dots
on the right. Select (3)
Create dataset
from the menu or, alternatively, you can use an existing dataset and jump to the next subsection.
Input a (4)
dataset identifier (E.g. "myDatasetId"), select a (5)
location type and click (6)
CREATE DATASET
.
Create a table with the following structure:
rawDataCa
String
Required
createdAt
Timestamp
Required
The esiest way to create it is to click (7)
the plus
button:
copy and paste the following query in (8)
the input area:
Replace [PROJECT_ID]
, [DATASET_ID]
and [TABLE_ID]
with your project, dataset and table identifier respectively. You set your table identifier at this step.
and then click the (9)
RUN
button.
Project Id
Dataset Id
Table Id
[1] This feature allows you to set an event property holding a dynamic value by adding two open braces ({{
) in front of your property name and two close braces (}}
) at the end (E.g. {{myEventPropertyPathAndName}}
).
[Any events]
[1]
rawDataCa
, createdAt
[2]
[1] Use Destination filters to specify your matching events.
[2] Two columns: rawDataCa
contains all your event properties, while createdAt
is the creation timestamp.
Google is a multinational technology company focusing on online advertising, search engine technology, cloud computing, and computer software. Google Display & Video 360 and Google Search Ads 360 are paid products part of Google Marketing Platform.
Ensure that you already have a Google Marketing Platform account (360).
Contact your Google Account Manager to whitelist our DMP + get your Client ID (Client Customer ID: Your DoubleClick Client Customer ID)
We are listed as "TagCommander" and not as "Commanders Act".
You have to ask for the whitelisting of the advertiser ID, as we don't currently use the Partner ID on our connector.
This connector is only for Google DV360 accounts (including Google Ads for DV360) but not for Google Ads accounts (without a DV360 account).
If you have a Google Ads account, you can use the Customer Match connector or RLSA (Remarketing Lists for Search Ads).
Example of answer from dv360-support@google.com:
“You just have to tell your Google account manager to raise a DMP whitelisting request and once we receive that request it would be a new ticket altogether. So, one of our agents would be able to look into that and process your request.”
References:
Google Ads : https://developers.google.com/third-party-ads/googleads-vendors (look for "Fjord Technologies SAS")
Ad Manager : https://developers.google.com/third-party-ads/adx-vendors (look for "Fjord Technologies SAS")
Ad Manager & Ad Exchange: https://support.google.com/admanager/answer/9012903 ("look for Commanders Act")
Youtube : the partners' program has been closed
Wait for Google to whitelist our DMP.
Display & Video 360 was previously DoubleClick Bid Manager.
If you had a DoubleClick Bid Manager account or if you have a Display & Video 360 account, please use our connector 'Google Display & Video 360 Bid Manager'
Search Ads 360 was previously DoubleClick Search.
If you had a DoubleClick Search account or if you have a Search Ads 360 account, please use our connector 'Google Search Ads 360'
Display & Video 360 can be also used with an Adexchange account
If you had an Adexchange account, please use our connector 'Google Display & Video 360 Adex'
[Google DDP API][2473] Could not fetch lists: [AuthorizationError.USER_PERMISSION_DENIED @ clientCustomerId]
→ Trouble with the whitelisting: be sure you are using the right name (TagCommander) and the right ID (advertiser ID).
[Google DDP API][3206] Could not fetch lists: [DmpUserListServiceError.INVALID_CLIENT_CUSTOMER_ID @ clientCustomerId]
→ You don't have a Google DV360 account. Please use the Customer Match connector or RLSA (Remarketing Lists for Search Ads)
Pick your segment and create your stream
+ Put Google Client ID, if you do not have it, then it fails
Segments will be directly created by Commanders Act, and will appear in the Audience list in Google Ads.
Interface of DV360 where you are supposed to find the segments:
The sharing is based on a cookie synchronization between Commanders Act and Google. If you see less data than expected in the data stream, check your cookie-sync ratio.
Google is a multinational technology company focusing on online advertising, search engine technology, cloud computing, and computer software. Taking advantage of the Campaign Manager 360 offline conversion API, you can leverage the "Enhanced Conversions" feature to send first-party data, while also giving the option to modify quantity and value, in the form of conversion batch updates.
The "Enhanced Conversions" (EC) in Campaign Manager 360 (CM360) API is a hybrid solution with API, which is covered by this destination, and client-side tag: See our template tag gtag - Google SA360 - Floodlight for server-side Enhanced Conversions for more details. Google still requires Floodlight tags to get conversion info from advertisers' websites.
Google recommends triggering conversion batch updates between 90 minutes and 24 hours, with the latter being the upper time limit, after the client-side Floodlight tag is fired to maximize EC matching. After 30 minutes has passed since the client-side Floodlight is fired, you can already trigger conversion batch updates, but it's suggested to follow Google recommendation as reported above. More details are available following this LINK.
The Google Search Ads 360 Enhanced Conversions destination provides the following key features:
Events structure: our Events reference covers Google method batchupdate, 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.
Automatic hashing: information is automatically hashed matching partner specifications.
Smart mapping: data mapping can be readjusted using your datalayer defined fields.
Before configuring this destination, you need to fullfil the following requirements:
Log in to the CM360 account and choose the advertiser you want to implement EC with. On the left, open the menu Floodlight
➜ Configuration
, and flag the checkbox under the Enhanced conversions
section:
CM360 users of agency admin and DC account manager roles should be able to accept the ToS. Note that accepting the ToS can also be done in the previous version of Search Ads 360 (SA360), but only if the CM360 advertiser controlling the floodlight configuration is linked to a SA360 advertiser. In that case, the ToS can be accepted in the linked advertiser under Advertiser Settings
➜ Advertiser Details
➜ Enhanced conversions
:
Ensure that both match_id and transaction_id fields are properly set. If you're setting up your client-side tag for the first time, you may want to use our template tag gtag - Google SA360 - Floodlight for server-side Enhanced Conversions.
Floodlight Configuration Id
Floodlight Activity Id
Match Id
Total Quantity
Flag this option to consider the total quantity instead of the number of unique products.
[1] To find both values you can log into the CM360 account, and select the advertiser, then locate the Floodlight
tab in the left panel. Open Floodlight
➜ Activities
and find/create the activity you are using to receive the EC data. Values being shown, highlighted in green below, are (1)
Floodlight Configuration Id
(2)
Floodlight Activity Id
:
[Any Event]
[1]
conversions.batchupdate
[1] Use Destination filters to specify your matching events.
Most properties can be remapped using our "Smart Mapping" feature.
Google properties are set starting from the path conversions.0
or conversions.0.userIdentifiers.0
with the latter for user properties.
Floodlight Configuration Id
floodlightConfigurationId
[*][1]
Floodlight Activity Id
floodlightActivityId
[*][1]
Match Id
matchId
[*][1]
context.event_timestamp
timestampMicros
[*][2]
id
ordinal
[*]
value
value
[*]
items.length
items.X.quantity
quantity
[*][3]
user.email_sha256
hashedEmail
[4]
user.phone
hashedPhoneNumber
[4]
user.firstname
addressInfo.hashedFirstName
[4]
user.lastname
addressInfo.hashedLastName
[4]
user.street
addressInfo.hashedStreetAddress
[4]
user.city
addressInfo.city
user.state
addressInfo.state
user.country
addressInfo.countryCode
user.zipcode
addressInfo.postalCode
partners.google.non_personalized_ad
nonPersonalizedAd
partners.google.child_directed_treatment
childDirectedTreatment
partners.google.limit_ad_tracking
limitAdTracking
[*] Mandatory property.
[1] See Configuration for more details on these mandatory properties.
[2] Milliseconds timestamp is automatically converted to microseconds.
[3] See Configuration (Total Quantity
) for more details.
[4] Automatically normalized and hashed if passed in clear.
Google is a multinational technology company focusing on online advertising, search engine technology, cloud computing, and computer software. Google Customer Match allows you to push users to Google Ads. Matching keys are email, phone or address (SHA-256 or in clear only).
You can create an audience segment, push it to Google Ads and activate it. Users matched could be then activated on Google services (Search, Display network, Gmail, Youtube, Google Shopping...).
Audience size: minimum 1000 matched users (otherwise it will be rejected for privacy purpose)
Data collection: it is only allowed to import first party data (collected via your website/app/point of sale)
Available for accounts with good history of policy compliance, good payment history, at least 90 days history, more than USD 50,000 total lifetime spend (https://support.google.com/google-ads/answer/6299717)
Google indicates that it takes 6 to 12 hours for a list to be populated with members
A list may appear to be smaller than expected when viewed in the Audience Manager in the Google Ads UI. This view shows the number of active users in the list. A user is considered active if they have recently logged into their Google account.
On the new platform, select Google Customer Match on the destinations catalog.
Select All users or one or many segments.
Connect directly to your Google Ads account. Select your existing account if you have already configured it, or configure a new one.
Click on the link and a new tab will be opened (Connector Credentials).
Only admin users have access to the Connector Credentials menu (also available in the Administration menu)
On the Connector Credentials page, click on 'Add connector credentials' and select Google Ads.
Login to your Google Ads account and the authentication is done.
Then go back to the connector configuration page and select the account previously configured.
Segments selected will appear in the segment mappings section. You can map here selected segments to a customer list previously created in Google Ads interface (this is where the audience from segments will be sent).
If you haven't created a customer list yet, you can do it on Google Ads interface:
On your Google Ads account, click on ‘Tools and settings’ and ‘Audience manager’.
Then in ‘Audience lists’, click on the + and select ‘Customer list’ (or user list).
In this section, you can define matching keys:
At least:
Email address: in SHA-256 or plain (we hash it in SHA-256 before to send it)
and/or Phone number: in SHA-256 or plain (we hash it in SHA-256 before to send it)
Complementary information (optional):
First name: in SHA-256 or plain (we hash it in SHA-256 before to send it)
Last name: in SHA-256 or plain (we hash it in SHA-256 before to send it)
Country code (2 letters): in SHA-256 or plain (we hash it in SHA-256 before to send it)
Postal code: in SHA-256 or plain (we hash it in SHA-256 before to send it)
Postal address: in SHA-256 or plain (we hash it in SHA-256 before to send it)
Last step, simply define a running period and click on Save. The destination will start to send users as soon as they enter in selected segments.
----------------------------------------------------------------------------------------------------
Method available only on the old platform, if you haven't migrated yet. Please note this version only support email (SHA-256 or plain) as matching key.
First, you need to enter your Google Ads customer ID:
Then, there are 2 ways to configure it:
It is the fastest and easiest way to configure the connector. Simply ask our consultants or customer representative that you want to use this option and provide them your Google Ads Customer ID. Then they will link your account with our Google Ads account in order to be able to push audiences.
We recommend using the first option, as the second option is much more complex and requires access to Google Developer Console. You have to enter the Developer Token, Client ID, Client Secret and generate a refresh token.
All details here:
Last step, create a user list on Google side.
On your Google Ads account, click on ‘Tools and settings’ and ‘Audience manager’.
Then in ‘Audience lists’, click on the + and select ‘Customer list’ (or user list).
Create the list, save it, open it and find the List ID
Paste the List ID in the segment mappings on the Data Commander Google Customer Match connector interface (it allows you to map a segment in DataCommander to a user list on Google Ads)
Your connector is ready, click save
After 12 to 24 hours, go back to Google Ads, click on your customer list you created just before, and it will be filled with users selected.
Google is a multinational technology company focusing on online advertising, search engine technology, cloud computing, and computer software. The connector Google Store Sales Direct allows you to send conversions to Google Ads.
Store sales measurement allows you to use your sales data in a privacy-safe way to understand how much value your ads are truly driving for in-store purchases. By uploading and matching transaction data from your business, you can see how your ads translate into offline purchases.
More information
From your Data Commander account, you can send your conversions through our connector. https://support.google.com/google-ads/answer/10018944?hl=en&ref_topic=9941533#zippy=%2Cbenefits-of-uploading-store-sales-data-in-google-ads
We send conversions to your FTP, and then you have to push these conversions from the FTP to Google Ads: https://support.google.com/google-ads/answer/10018944?hl=en&ref_topic=9941533#zippy=%2Cbenefits-of-uploading-store-sales-data-in-google-ads%2Cschedule-an-upload
DataCommander ⇒ Customer FTP (Connector Google Store Sales Direct)
Customer FTP ⇒ Google Ads (you should configure the file exchange between your FTP and your Google Ads account like described on the documentation above)
On the connector setup interface, select all users or select a segment you want to use.
For example, you can send only conversions that belong to specific users that you selected in your segment (users living in Germany only, for example).
You should select all the variables requested by Google: Conversion Time, Conversion Value, Conversion Currency, and at least one Email variable.
Full list and format here.
All personal data (email, first name, phone number...) are hashed in SHA-256.
There are also 3 variables specific to that connector:
Loyalty Rate:
The percent of overall sales in your data file that you can associate with a customer
The Loyalty Rate needs to be between “0” and “1” (excluding “0”)
For example:
0.5
0.2
0.8
Transaction Upload Rate:
The ratio of sales you’re uploading to the overall sales that you can associate with a customer
While the Transaction Upload Rate can be between “0” and “1,” we recommend uploading all customer associated sales and setting the Transaction Upload Rate to “1”.
For example:
0.5
0.2
0.8
Conversion name:
The name of the conversion action that you’d like to import
Must match the same spelling and capitalization of the conversion action in your Google Ads account
For example:
SS_customer_signups
SS_customer_purchases
More details
is an AI personalization and A/B testing SaaS platform for product managers and marketing teams who want to personalize the customer journey to maximize engagement, conversion and online revenue.
is an AI personalization and A/B testing SaaS platform for product managers and marketing teams who want to personalize the customer journey to maximize engagement, conversion and online revenue.
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Precise the filename and extension (CSV by default).
Precise if you want to compress the file (GZIP by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
Define the running frequency for the export (every 10 minutes, day, week...)
is a price comparison service. Using this destination you can activate server-side tracking as a fallback method to increase coverage.
The Kelkoo destination provides the following key features:
Events structure: our matches , 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.
Support for multi-item data: information included in the array is dispatched to Kelkoo.
[1] Use to refine events matching your specific needs.
Most properties can be remapped using our "Smart Mapping" feature.
is an AI personalization and A/B testing SaaS platform for product managers and marketing teams who want to personalize the customer journey to maximize engagement, conversion and online revenue. Using this destination you can implement Kameleoon which can be used, after triggering an experiment, to measure performance characteristics according to the goals that make sense for your business.
The "Kameleoon Events" destination provides the following key features:
Events structure: our fits , 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.
[*] Only these events will be bridged to Kameleoon.
[1] The cookie content is set as value for the parameteruserID
.
[2] This is set for Commanders Actpurchase
andrefund
events only.
is a multinational technology company focusing on online advertising, search engine technology, cloud computing, and computer software. Google Universal Analytics (UA) is a web analytics service that tracks and reports website traffic. Using this destination, you can take advantage of the by sending data via server-side. This version is related to the previous generation of Google Analytics. See destination for the newest and recommended version.
Google Universal Analytics will be deprecated on July 1, 2023, meaning it will stop processing data. Analytics 360 properties will stop working on October 1, 2023.
The Google Universal Analytics destination provides the following key features:
Events structure: our model covers , 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.
Refined data: you can freely push additional information based on your specific needs (E.g. adding custom events and custom properties).
Support for multi-item data: information included in the array is dispatched to UA.
[1] Using "dots" (".") you can navigate deeper to the specific field you want to get the value of. See for more details on the standard field names by event. You can also freely set custom fields: there are no boundaries.
[1] This is either pageview
or screenview
, depending if the "Smart Mapping" field App Name (an)
is set with an empty value or a non-empty one.
[2] You can specify a custom social event by setting the "Smart Mapping" field Social Event
.
Most properties can be remapped using our "Smart Mapping" feature.
Required for Web Data Streams
An that is generated through the Google Analytics UI for a "Web Data Stream". To create this value, navigate in the Google Analytics interface following:
Admin
➜ Data Streams
➜ Choose your stream ➜ Measurement Protocol API secret
➜ Create
.
Required for Web Data Streams
The for a "Web Data Stream". Found in the Google Analytics interface following:
Admin
➜ Data Streams
➜ Choose your stream ➜ Measurement Id
. E.g. "G-XXXXXXXXXX".
Required for App Android Data Streams
An that is generated through the Google Analytics UI for an "App Android Data Stream". To create this value, navigate in the Google Analytics interface following:
Admin
➜ Data Streams
➜ Choose your stream ➜ Measurement Protocol API secrets
➜ Create
. [1]
Required for App Android Data Streams
The for a "App Android Data Stream". Found in the Google Analytics interface following:
Admin
➜ Data Streams
➜ Choose your stream ➜ FIREBASE APP ID
, or in Firebase console following: Project Settings
➜ General
➜ Your Apps
➜ App ID
. [1]
Required for App iOS Data Streams
An that is generated through the Google Analytics UI for an "App Android Data Stream". To create this value, navigate in the Google Analytics interface following:
Admin
➜ Data Streams
➜ Choose your stream ➜ Measurement Protocol API secrets
➜ Create
. [1]
Required for App iOS Data Streams
The for an "App iOS Data Stream". Found in the Google Analytics interface following:
Admin
➜ Data Streams
➜ Choose your stream ➜ FIREBASE APP ID
, or in Firebase console following: Project Settings
➜ General
➜ Your Apps
➜ App ID
. [1]
Your property field holding the for your "App Data Streams". If this is not provided, the first 32 characters of the following SHA256 hashed standard properties are used: device.sdk_id
or user.tcId
, in this order. [1]
When activating this option all your custom properties are also sent to GA4 in the params
object. Properties with child/sub properties are converted into a single one using the underscore character "_" as separator (E.g. device_lifecycle_last_session_start). More details are available following this .
Map your custom event properties by setting their field names in GA4 property name
and adding the field name holding the value in Your event property
. E.g. if you inputsize
in the GA4 property name
anditems.0.product.size
in Your event property
, you will have a custom event property in GA4 called size
with a value based on the content of the field items.0.product.size
.
In the column Your event property path
you should keep the default value Default (root)
as it better fits most scenarios. In case you select either In "items" {items.X}
or In "product" {items.X.product}
this destination will look for the input event property starting from the or level respectively and add its values as a custom item property.
To ensure that custom event properties are picked up by GA4, you must create event-scoped dimensions first. You can find more details by following this link: .
Map your by setting their field names in GA4 property name
and adding the field name holding the value in Your event property
.
E.g. if you input customer_zipcode
in GA4 property name
and user.zipcode
in Your event property
, you will have a custom user property in GA4 called customer_zipcode
with a value based on the content of the field user.zipcode
.
To ensure that custom user properties are picked up by GA4, you must create user-scoped dimensions first. You can find more details by following this link: .
Flag this option to enable . See our dedicated section following this .
Flag this option to anonymize data before sending it to Google. See our dedicated page following this .
Cookie name holding the Google Analytics that uniquely identifies a user instance of a web client. You can change its default value _ga
. If this cookie is not found, user.consistent_anonymous_id
is used.
GA4 reports only show active users who engage with your site for a non-zero amount of time. To ensure users are included in reports, you can keep the default value to 1. If you track the actual engagement time with your events, you can set the with a proper value.
Following Advanced settings
→ Debug
, you can flag this option to enable GA4 monitoring feature, sending the field debug_mode
set to true
on each event.
Following Advanced settings
→ Debug
, you can flag this option to send your events to the and inspect properties through our . Important: when this is flagged, events ARE NOT tracked by GA4.
Custom variables add richer data to your conversions so that you can further segment your reports. You can map your custom variable names with your values by setting the fields Custom variable name
and Your value
.
More details are available by following this .
If flagged, Google endpoint will perform all upload checks and return errors if any are found. If false
, it will perform only basic input validation, skip subsequent upload checks, and return success even if no click was found for the provided user identifiers. More details are available by following this .
The GA Tracking Id is a string like "UA-XXXXXX-Y" or "G-XXXXXXXXXX" for Google Analytics 4. It's used as an alternative method to retrieve the from cookies. See for more details.
The GA Tracking Id is a string like "UA-XXXXXX-Y" or "G-XXXXXXXXXX" for Google Analytics 4. It's used as an alternative method to retrieve the from cookies. See for more details.
Required
This is the value of the src
parameter. More details are available following this .
Required
This is the value of the type
parameter. More details are available following this .
Required
This is the value of the cat
parameter. More details are available following this .
Then the particularity with the proxy mode is that you have to alter the GA4 hit URL, replacing google-analytics.com with the Commanders Act server-side collection URL. This is done via the native GA parameter: transport_url
(Example code provided below).
The transport_url
has to be set to your tracking url.
Your tracking domain is either:
Required
Your project identifier as reported in BigQuery console. More details are available following this . This setting supports dynamic values [1].
Required
Your dataset identifier as reported in BigQuery console. More details are available following this . This setting supports dynamic values [1].
Required
Your table identifier as reported in BigQuery console. More details are available following this . This setting supports dynamic values [1].
Required
Floodlight configuration identifier of the related conversion. More details are available following this . [1]
Required
Floodlight activity identifier of the related conversion. More details are available following this . [1]
Required
A unique advertiser created identifier also to be passed in the client-side Floodlight. This can only contain letters, numbers, underscores, hyphens and periods and is case sensitive. Max 100 characters. More details are available following this (See field name "match_id").
[1] Automatically encoded in base64url. More details are available by following this .
[2] Supported values: New
or Existing
(case insensitive).
As recommended by Google, hits are used in place of hits. See more details on UA "Hit Types" following this .
[1] partners.ga.client_id
has priority over Client Id Cookie Name
and user.tcId
.
[2] Always anonymized just as though aip
() is used.
[3] Retrieved by parsing the provided "Smart Mapping" field Document Location (dl)
.
[4] If items
is not set, then this property won't be present.
If partners.ga.product_action
is not set, depending on the incoming event, the following values are used as default: detail
( event or if your event is not one of the following being listed), purchase
( event), click
(, , , , , , , and events), refund
( event), checkout
(, and events), add
( event), remove
(event).
[5] If partners.ga.event_category
is not set, since this property is required for "event" hit types, this gets the default value: UX
.
[6] If partners.ga.event_action
is not set, then your event name is used.
[7] If partners.ga.event_label
is not set, depending on the incoming event, the following fields are used as default: search_term
( event), item_id
( event) and method
( and events).
[8] If partners.ga.event_npa
is set with one of the following values: 1
(string or integer) or true
(boolean), then npa
is set with 1
.
[9] If partners.ga.non_iteration
is set with one of the following values: 1
(string or integer) or true
(boolean), then npa
is set with 1
.
[10] See Custom Event Properties
in for more details on how you can bridge custom properties to UA.
Country
country
Shop Id
comId
id
orderId
items.X.product.name
items.X.id
items.X.product.price
items.X.quantity
productsInfos
[1]
partners.kelkoo.id
kelkooId
partners.kelkoo.gclid
gclid
partners.kelkoo.msclkid
msclkid
user.status
[2]
returningUser
add_payment_info
add_shipping_info
begin_checkout
page_view
purchase
pageview
[1]
screenview
[1]
add_to_cart
add_to_wishlist
generate_lead
login
refund
remove_from_cart
search
select_content
select_item
sign_up
view_cart
view_item
view_item_list
[Custom Event]
event
[Custom Event]
social
[2]
Tracking ID
tid
partners.ga.client_id
Client Id Cookie Name
user.tcId
cid
[1]
user.id
uid
context.device.ip
uip
[2]
partners.ga.ad_id
gclid
context.page.url
dl
context.page.title
dt
context.page.referrer
dr
context.page.url
dh
[3]
context.page.url
dp
[3]
id
ti
value
tr
shipping_amount
ts
tax_amount
tt
coupon
tcc
partners.ga.affiliation
ta
currency
cu
partners.ga.product_action
[Default Value]
pa
[4]
partners.ga.event_category
ec
[5]
partners.ga.event_action
event_name
ea
[6]
partners.ga.event_label
search_term
item_id
method
el
[7]
items.X.id
pr(X+1)id
items.X.product.name
pr(X+1)nm
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
pr(X+1)ca
items.X.product.brand
pr(X+1)br
items.X.variant
pr(X+1)va
items.X.list_position
pr(X+1)ps
items.X.product.price
pr(X+1)pr
items.X.quantity
pr(X+1)qt
items.X.coupon
pr(X+1)cc
items_impression.X.0.list_name
il(X+1)nm
items_impression.X.Y.id
il(X+1)pi(Y+1)id
items_impression.X.Y.name
il(X+1)pi(Y+1)nm
items_impression.X.Y.brand
il(X+1)pi(Y+1)br
items_impression.X.Y.category_1
il(X+1)pi(Y+1)ca
items_impression.X.Y.variant
il(X+1)pi(Y+1)va
items_impression.X.Y.list_position
il(X+1)pi(Y+1)ps
items_impression.X.Y.price
il(X+1)pi(Y+1)pr
items_promotion.X.id
promo(X+1)id
items_promotion.X.name
promo(X+1)nm
items_promotion.X.creative
promo(X+1)cr
items_promotion.X.position
promo(X+1)ps
items_promotion.X.action
promoa
partners.ga.campaign_name
cn
partners.ga.campaign_source
cs
partners.ga.campaign_medium
cm
partners.ga.campaign_keyword
ck
partners.ga.campaign_content
cc
partners.ga.campaign_id
ci
partners.ga.queue_time
qt
context.app.name
an
context.app.namespace
aid
context.app.namespace
aiid
context.app.version
av
context.page.title
cd
(partners.ga.event_npa)
npa
[8]
(partners.ga.non_iteration)
ni
[9]
partners.ga.checkout_step
cos
partners.ga.checkout_step_option
col
partners.ga.social_name
sn
partners.ga.social_action
sa
partners.ga.social_action_target
st
Custom Event Properties
[Custom Property Name]
[10]
Shop Id
Required
Your unique shop identifier within the Kelkoo Group system (comId
).
Country
Required
The 2-letter country code for the country on which your products are listed on Kelkoo Group (E.g. fr
).
[Any Event]
[1]
[Any Conversion]
Site Code
Required
Your Site Code as provided by Kameleoon.
Visitor Cookie Name
Required
Cookie name holding the visitor code. This can be set using the Kameleoon (Builder) template which is available in our library following these steps: INTEGRATION ➜ Sources➜ Web Containers.
Commanders Act EventName
Required
Map your Commanders Act events by adding their related names. They need to match valid Kameleoon Goal Ids. [*]
Kameleoon GoalId
Required
Map your Kameleoon Goal Ids by adding their related identifiers. They need to match valid Commanders Act events.
Site Code
siteCode
Visitor Cookie Name
userID
[1]
Kameleoon GoalId
goalID
revenue
revenue
[2]
Tracking ID
Required
The tracking identifier is a string like "UA-XXXXXX-Y". It must be included in your tracking code to tell Analytics which account and property to send data to.
Custom Event Properties
Map your custom event properties by setting their field names in Event property name
and adding the field name holding the value in Commanders Act event property or static value
. E.g. if you inputsize
in the Event property name
anditems.0.product.size
[1] in Commanders Act event property or static value
, you will have a custom event property in GA4 calledsize
with a value based on the content of the fielditems.0.product.size
. You also have the option to set a static string/numeric value in Commanders Act event property or static value
.
In the column Commanders Act event property position
you should keep the value Default
as it better fits most scenarios. E.g. this can be used to set Custom Dimensions and Metrics and/or Content Groups. In case you select either In "Item List" (E.g. {items.X})
or In "Item List" Product (E.g. {items.X.product})
this destination will look for the input event property starting from the items or product level respectively and add Product Custom Dimensions and/or Product Custom Metrics depending on your input Event property name
.
If you select In "Item Impression List" (E.g. {items_impression.X})
, you will add Product Impression Custom Dimensions and/or Product Impression Custom Metrics still depending on your input Event property name
.
Client Id Cookie Name
Cookie name holding the Google Analytics "Client Id" that uniquely identifies a user instance of a web client. Default value: "_ga".
The "Client Id" is the right most string in the cookie, including a single dot. E.g. see the following blue highlighted string "GA1.1.XXXXXXXXXX.XXXXXXXXXX".
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Precise the filename and extension (CSV by default).
Precise if you want to compress the file (GZIP by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
Kwanko provides a global affiliation network connecting businesses with customers. Using this destination you can implement server-side lead and sale tracking.
The Kwanko destination provides the following key features:
Events structure: our Events reference covers Kwanko lead and sale tracking, 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.
Custom properties: you can freely push custom properties based on your specific needs.
Collection Server Base Url
Required
Your collection server base URL (E.g. "http://server.client.fr") as provided by Kwanko. Default value: "https://action.metaffiliation.com/trk.php".
Tracking Id
Required
Your tracking identifier as provided by Kwanko. It's used to identify your campaigns.
Conversion Type
Required
The conversion type that is bound with your activity. This can be either sale
or lead
. If conversion type is lead
, only generate_lead
events are forwarded to Kwanko. If conversion type is sale
, only purchase
events are sent to the partner.
Cookie Click Id
Required
For each click on Kwanko links a new "Click Id" is automatically generated. This can be found as value for the parameter kwks2s
in landings. Input the cookie name holding this value.
Custom Event Properties
Map your custom event properties by setting their field names in Event property name
and adding the field name holding the value in Commanders Act event property or static value
. E.g. if you inputsize
in the Event property name
and items.0.product.size
in Commanders Act event property or static value
, you'll have a custom event property in Kwanko calledsize
with a value based on the content of the field items.0.product.size
[1]. You also have the option to set a static string/numeric value in Commanders Act event property or static value
.
[1] Using "dots" (".") you can navigate deeper to the specific field you want to get the value of. See Events reference for more details on the standard field names by event. You can also freely set custom fields: there are no boundaries.
generate_lead
lead
purchase
sale
Most properties can be remapped using our "Smart Mapping" feature.
The Kwanko propertygdpr_kwk
is always set to1
. Manage your consent settings using the filter tab of this destination.
Tracking Id
mclic
[1]
revenue
argmon
id
argann
coupon
argmodp
currency
nacur
Cookie Click Id
cible
coupon
argbr
[1] IfCollection Server Base Url
is not the default value, theTracking Id
is appended as part of base URL and themclic
is not set.
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Precise the filename and extension (CSV by default).
Precise if you want to compress the file (GZIP by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Precise the filename and extension (CSV by default).
Precise if you want to compress the file (GZIP by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
Microsoft Advertising (formerly Bing Ads, Microsoft adCenter and MSN adCenter) is an online advertising platform developed by Microsoft. Using this destination, you can leverage UET framework to send events via server-side.
The Microsoft Advertising Universal Event Tracking destination provides the following key features:
Events structure: our Events reference model covers Microsoft events, 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.
Support for multi-item data: information included in the item array is dispatched to Microsoft.
Reach out to our team for a complete integration guide.
Microsoft UET framework requires a client-side tag to operate: see tag Bing - Client-side id-sync and data capture
in our template library.
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Precise the filename and extension (CSV by default).
Precise if you want to compress the file (GZIP by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Precise the filename and extension (CSV by default).
Precise if you want to compress the file (GZIP by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Precise the filename and extension (CSV by default).
Precise if you want to compress the file (GZIP by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
Piano Analytics is the successor of AT Internet Analytics Suite 2 (AS2). It's a user-centric tool that simplifies product & marketing analytics, while ensuring data quality.
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Precise the filename and extension (CSV by default).
Precise if you want to compress the file (GZIP by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Precise the filename and extension (CSV by default).
Precise if you want to compress the file (GZIP by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Precise the filename and extension (CSV by default).
Precise if you want to compress the file (GZIP by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Precise the filename and extension (CSV by default).
Precise if you want to compress the file (GZIP by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
Select 1 or many segment(s) you want to export.
Variables are automatically added:
RhytmOne ID (ID coming from the cookie sync with RhythmOne)
Be sure that variable 'partner.radiumone_id
' is created
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Define the running frequency for the export (every 10 minutes, day, week...)
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Precise the filename and extension (CSV by default).
Precise if you want to compress the file (GZIP by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
Matomo, formerly Piwik, is an open source web analytics application to track online visits to one or more websites and display reports on these visits for analysis. Using this destination you can implement server-side tracking using Matomo Tracking HTTP API.
The Matomo destination provides the following key features:
Events structure: our Events reference covers Matomo's request structure, 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.
Automatic hashing: information is automatically hashed matching partner specifications.
Custom events and properties: you can freely push custom events and properties based on your specific needs.
Support for multi-item data: information included in the item array is bridged to Matomo.
Matomo recommends using custom parameters instead of custom variables as the latter are deprecated. The data for some Matomo optional fields will not be available in your app / technical layer which is expected, but you should provide as much information as you can.
Server Domain
Required
Your server domain as provided by Matomo. (E.g. for https://your-matomo-domain.example
/matomo.php, include the blue string only).
Site Id
Required
Visitor Id Cookie Name
Visitor Id Value
The unique visitor identifier value if you need to pass it without a cookie.
User Identifier
Matomo Custom Variables
Matomo Custom Parameters
Matomo Goals
Authorization Token
[1] Using "dots" (".") you can navigate deeper to the specific field you want to get the value of. See Events reference for more details on the standard field names by event. You can also freely set custom fields: there are no boundaries.
Matomo propertye_c
is statically set withca_event
.
Ecommerce parameters are passed for incoming purchase events.
Site Id
idsite
event_name
action_name
e_a
e_n
value
e_v
revenue
page.location
url
device.user_agent
ua
Visitor Id Cookie Name
Visitor Id Value
_id
[1]
page.referrer
urlref
Matomo Custom Variables
_cvars
user.id
user.email
user.email_md5
user.email_sha256
[custom_property]
uid
[2]
search_term
search
Matomo Goals
idgoal
[3]
id
ec_id
[[items.0.id
,items.0.product.name
,items.0.product.category_1
,items.0.product.price
,items.0.quantity
],...
,[items.N.id
,items.N.product.name
,items.N.product.category_1
,items.N.product.price
,items.N.quantity
]]
ec_items
[4]
revenue
ec_st
tax_amount
ec_tx
shipping_amount
ec_sh
Authorization Token
token_auth
device.ip
cip
event_timestamp
cdt
[1] If a cookie is not provided, this destination searches for a cookie name containing the string_pk_id
to retrieve the visitor identifier from it. Alternatively, you can pass the value using a datalayer property. See Configuration for more details.
[2] Depending on the drop-down selection (SeeUser Identifier
inConfiguration
), a specific Commanders Act property is used.
[3] Based on your configuration (SeeMatomo Goals
in theConfiguration
), a specific identifier is set in this field. Withpurchase
events,0
is bridged as identifier.
[4] The resulting array is encoded.
Mapp, formerly Webtrekk, generates actionable insights for brands to engage with their customers and deliver cross-channel marketing campaigns. Using this destination you can implement Mapp server-side tracking.
The Mapp destination provides the following key features:
Events structure: our Events reference covers Mapp request types, 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.
Custom events and properties: you can freely push custom events and properties based on your specific needs.
Support for multi-item data: information included in the item array is dispatched to Mapp.
This destination supports Mapp independent parameters by detecting them inCustom Event Properties
. See Configuration for more details.
Use Destination filters to refine events and/or other properties matching your specific needs.
Track Domain
Required
Your track domain as provided by Mapp.
Track Id
Required
Your track identifier as provided by Mapp.
Custom Event Properties
Map your custom event properties by setting their field names in Event property name
and adding the field name holding the value in Commanders Act event property
. E.g. if you inputsize
in the Event property name
and items.0.product.size
in Commanders Act event property
, you'll have a custom event property in Mapp calledsize
with a value based on the content of the field items.0.product.size
[1].
Exclude Mapp "ct" Parameter
[1] Using "dots" (".") you can navigate deeper to the specific field you want to get the value of. See Events reference for more details on the standard field names by event. You can also freely set custom fields: there are no boundaries.
[Any Event]
page
or event
or media
or form
[1]
[1] Custom events are also supported. More details on Mapp request types are available following this LINK.
Session handling is done by Mapp using the ever id. If this information is not available, the session is recognized by the user agent and the IP address. More details are available following this LINK. Depending on Mapp request types you're sending, some properties may not be tracked by Mapp. More details are available following this LINK.
partners.mapp.version
,page.title
,0,device.screen.width
xdevice.screen.height
,device.density
,0,event_timestamp
,page.referrer
,device.screen.width
xdevice.screen.height
,0
p
[1]
partners.mapp.ceid
device.sdk_id
user.tcId
ceid
[2]
partners.mapp.eid
eid
[2]
device.ip
X-WT-IP
device.user_agent
X-WT-UA
[3]
page.url
page.location
X-WT-RQ
[2][3]
page.lang
la
partners.mapp.event_name
or
event_name
ct
[2][4]
currency
cr
id
oi
value
ov
(event_name)
st
[5]
items.X.product.name
ba
[6]
items.X.product.price
*items.X.quantity
co
[6]
items.X.quantity
qn
[6]
items.X.list_position
plp
[6]
Custom Event Properties
[Custom Property Name]
[7]
[1] Default value: 300,0,0,0,0,0,event_timestamp,0,0,0
.
[2] Priority order is listed in the left column.
[3] Encoded property.
[4] Property excluded with page_view event.
[5] If the items array is filled and depending on incoming events, this is set with:
•add
, for add_to_cart event.
•conf
, for purchase event.
•view
, as default value.
[6] Product information separated by semicolon and computed amounts are rounded with two decimals.
[7] SeeCustom Event Properties
in Configuration for more details on how you can bridge custom properties to Mapp.
This destination is currently under final review and will be available soon.
Moebel helps users find modern furniture across multiple stores. Using this destination you can leverage Moebel server-side specifications
The Moebel destination provides the following key features:
Events structure: our Events reference model covers Moebel sales tracking, 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.
The click identifier (moeclid
) is required. You can set it using the field Click Identifier Cookie Name
or through the "Smart Mapping" section: see field Click Identifier (moeclid)
.
Partner Key
Required
Your partner key as provided by Moebel.
Portal
Required
Choose the portal you want to send the sale request to. Available entries: moebel.de
, meubles.fr
, meubelo.nl
, moebel24.at
and moebel24.ch
.
Click Identifier Cookie Name
[Any Event]
[1]
sale
[1] Use Destination filters to specify your matching events.
Most properties can be remapped using our "Smart Mapping" feature.
Click Identifier Cookie Name
Click Identifier (moeclid)
moeclid
[*][1]
shipping_amount
shipping
[*][2]
(value
- shipping_amount
)
value
[*]
currency
currency
[*]
id
order_id
items.X.id
items.X.item_id
[*]
items.X.quantity
items.X.quantity
[*]
items.X.product.price
items.X.price
[*]
items.X.product.category_1
items.X.item_category
[*]
[*] Mandatory property.
[1] See Destination setup for more details.
[2] Default value: 0
.
Outbrain is a web recommendation platform. Using this destination you can implement server-side tracking.
The Outbrain destination provides the following key features:
Events structure: our Events reference covers Outbrain unique events, 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.
Custom events: you can freely push custom events based on your specific needs.
Ensure you added the "Click Parameter" to your Outbrain campaign's tracking code: see the following LINK for more details (See "Add a Click Parameter to Your Campaign’s Tracking Code" section). Moreover, create at least one Outbrain event by following this LINK (See "Create a Unique Event Name" section): you need to set the Outbrain event name in the related field in Mapping
: see Configuration for more details.
Outbrain Click Id
Mapping
[Any Event]
[1]
[Any Event]
[1]
[1] See Mapping
in Configuration for more details.
Most properties can be remapped using our "Smart Mapping" feature.
Outbrain Click Id
ob_click_id
[*]
Outbrain event name
name
[1]
id
orderId
value
orderValue
currency
currency
context.event_timestamp
timestamp
[2]
[1] See Mapping
in Configuration for more details.
[2] Automatically converted from timestamp (mills) in format: yyyy-mm-ddThh:mm:ssZ.
Pinterest is an image sharing and social media service designed to enable saving and discovery of information on the internet using images, animated GIFs and videos, in the form of pinboards. Using this destination, you can leverage Pinterest API to send events via server-side hits. More technical details are available following this LINK.
The Pinterest destination provides the following key features:
Events structure: our Events reference model covers Pinterest's events, 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.
Automatic hashing: information is automatically hashed matching partner specifications.
Smart mapping: data mapping can be readjusted using your datalayer defined fields.
Support for multi-item data: information included in the item array is dispatched to Pinterest.
Ensure you have access to a Pinterest Ads account before configuring this destination.
Advertiser ID
API Access Token
Click Id Cookie Name
Send as a test-request
page_view
view_item
page_visit
purchase
buy
pay
payment
checkout
add_to_cart
addtocart
add_to_cart
search
find_location
search
generate_lead
submit_application
contact
lead
sign_up
signup
completeregistration
signup
view_item_list
viewcategory
viewcontent
view_category
watch_video
watchvideo
watch_video
add_payment_info
add_shipping_info
add_to_wishlist
begin_checkout
login
refund
remove_from_cart
select_content
select_item
view_cart
select_promotion
view_promotion
custom
Most properties can be remapped using our "Smart Mapping" feature.
At least one of the following statement must be fulfilled:
• user_data.em
is set.
• user_data.hashed_maids
is set.
• user_data.client_ip_address
and user_data.client_user_agent
are set.
The property event_id
is required and used for deduplication. More information are available following this LINK (See section "How deduplication works").
partners.pinterest.event_id
event_id
[*]
partners.pinterest.action_source
action_source
[1]
context.event_timestamp
event_time
context.page.url
event_source_url
[2]
partners.pinterest.opt_out
opt_out
[3]
context.app.namespace
app_id
context.app.name
app_name
context.app.version
app_version
context.device.manufacturer
device_brand
context.device.network.carrier
device_carrier
context.device.model
device_model
context.device.type
device_type
context.device.os.version
os_version
context.device.network.wifi
wifi
[3]
context.device.lang
language
user.email_sha256
user_data.em
[4]
user.phone
user_data.ph
[4]
user.gender
user_data.ge
[4]
user.birthdate
user_data.db
[4]
user.lastname
user_data.ln
[4]
user.firstname
user_data.fn
[4]
user.city
user_data.ct
[4]
user.state_short
user_data.st
[4]
user.zipcode
user_data.zp
[4]
user.country
user_data.country
[4]
user.id
user_data.external_id
[4]
context.device.advertising_id
user_data.hashed_maids
[4]
context.device.ip
user_data.client_ip_address
context.device.user_agent
user_data.client_user_agent
context.page.url
Click Id Cookie Name
user_data.click_id
[5]
id
custom_data.order_id
currency
custom_data.currency
value
custom_data.value
items.X.id
custom_data.content_ids
[6]
items.X.product.price
custom_data.contents.X.item_price
items.X.quantity
custom_data.contents.X.quantity
items.length
custom_data.num_items
search_term
custom_data.search_string
partners.pinterest.opt_out_type
custom_data.opt_out_type
[*] Mandatory property.
[1] If this property is not provided, an action_source
is retrieved using available data. Supported values: app_android
, app_ios
, offline
and web
. Default value: web
.
[2] If this property is not provided, a properevent_source_url
is retrieved using available data.
[3] Boolean or equivalent string value supported.
[4] If it's passed in clear text, it's automatically hashed.
[5] Priority on the left column. If the value can't be retrieved from the URL, the Click Id Cookie Name
or the default cookie name_epik
is used.
[6] All item identifiers are taken into account.
Piano Analytics is the successor of AT Internet Analytics Suite 2 (AS2). It's a user-centric tool that simplifies product & marketing analytics, while ensuring data quality. Your data will be sent server-side getting the most from Piano Analytics' Collection API and in form of events.
The Collection API is only available for Piano Analytics. You can check the following compatibility table to get more insights on supported features by product.
The Piano Analytics Collection API destination provides the following key features:
Events structure: our Events reference matches Piano Analytics' one, 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.
Custom events: you can freely push custom events based on your specific needs.
Support for multi-item data: information included in the item array is dispatched to Piano Analytics.
User identifier: you can openly select a user identifier field for logged users.
Support autopromo events: include pre-prepared autopromo events in your requests. See Autopromo events for more details.
Send all properties: send all your event properties to Piano Analytics with a single click.
Before you get started with this destination, ensure you have access to Piano Analytics.
Side Id
Secured Collection Domain
User Identifier
Custom Property
When selecting "[Custom Property]" as value for the above User Identifier
, this field will show up so you can specify a custom field holding the value for the user identifier [2].
Client Identifier
Custom Property
When selecting "[Custom Property]" as value for the above Client Identifier
, this field will show up so you can specify a custom field holding the value for the client identifier [2].
Custom Event Mapping:
"view_item" matched
with Piano
"product.page_display"
Send Autopromo Events
Send All Properties
Custom Event Properties
Map your custom event properties by setting their field names in Piano Analytics property name
and adding the field name holding the value in Your event property
. E.g. if you input size
in the Piano Analytics property name
and items.0.product.size
in Your event property
, you'll have a custom event property in Piano Analytics called size
with a value based on the content of the field items.0.product.size
[2].
Custom User Properties
Map your custom user properties by setting their field names in User property name
and adding the field name holding the value in Commanders Act event property or static value
.
E.g. if you input customer_zipcode
in User property name
and user.zipcode
[2] in Commanders Act event property or static value
, you will have a custom user property in Piano Analytics called customer_zipcode
with a value based on the content of the field user.zipcode
. You also have the option to set a static string/numeric value in Commanders Act event property or static value
.
[1] This feature allows you to set an event property holding a dynamic value by adding two open braces ( {{
) in front of your property name and two close braces ( }}
) at the end (E.g. {{myEventPropertyPathAndName}}
).
[2] Using "dots" (".") you can navigate deeper to the specific field you want to get the value of. See Events reference for more details on the standard field names by event. You can also freely set custom fields: there are no boundaries.
Piano Analytics video/audio events are supported by our event model.
add_payment_info
cart.payment
add_shipping_info
cart.delivery
add_to_cart
product.add_to_cart
add_to_wishlist
product.add_to_wishlist
[*]
begin_checkout
cart.begin_checkout
[*]
generate_lead
generate_lead
[*]
login
user.login
[*]
page_view
page.display
or product.page_display
[1]
purchase
transaction.confirmation
and product.purchased
[2]
refund
refund
[*]
remove_from_cart
product.remove_from_cart
search
internal_search_result.display
select_content
select_content
[*]
select_item
page.select_item
[*]
sign_up
user.sign_up
[*]
video_ad_complete
video_ad_stop
video_complete
video_content_complete
av.stop
video_ad_click
av.ad.click
video_ad_playing
video_content_playing
video_ad_break_complete
video_content_quarter_reached
av.heartbeat
video_content_start
video_ad_start
video_ad_break_start
av.start
video_ad_skip
av.ad.skip
video_buffer_start
av.buffer.start
video_buffer_complete
av.buffer.heartbeat
video_error
av.error
video_fullscreen_off
av.fullscreen.off
video_fullscreen_on
av.fullscreen.on
video_pause
av.pause
video_quality
av.quality
video_resume
av.resume
video_seek_start
av.seek.start
video_share
av.share
video_speed
av.speed
video_start
av.play
video_subtitle_off
av.subtitle.off
video_subtitle_on
av.subtitle.on
video_volume
av.volume
view_cart
cart.display
view_item
product.display
[3]
product.page_display
[3]
view_item_list
page.view_item_list
[*]
[Any Other Event]
[Custom Event]
[*]
(event_timestamp)
device_timestamp_utc
[1]
context.page.referrer
previous_url
page_name
page
value
generate_lead_value
cart_turnovertaxincluded
currency
generate_lead_currency
cart_currency
id
transaction_id
generate_lead_id
item_list_name
view_item_list_name
method
login_method
sign_up_method
content_type
content_type
item_id
item_id
search_term
ise_keyword
items.X.id
product_id
[2]
items.X.product.name
product
[2]
items.X.variant
product_variant
[2]
items.X.product.brand
product_brand
[2]
(items.X.discount > 0)
product_discount
[2][3]
items.X.product.price
product_pricetaxincluded
[2]
items.X.product.currency
product_currency
[2]
items.X.product.category_1
product_category1
[2]
items.X.product.category_2
product_category2
[2]
items.X.product.category_3
product_category3
[2]
items.X.product.category_4
product_category4
[2]
items.X.quantity
product_quantity
[2]
cart_quantity
[4]
items.X.coupon
product_promocode
[2]
coupon
transaction_promocode
payment_method
payment_mode
shipping_amount
shipping_costtaxincluded
shipping_tier
shipping_delivery
cart_id
cart_id
revenue
cart_turnovertaxfree
items.length
cart_nbdistinctproduct
user.id
user.email
user.email_md5
user.email_sha256
[custom_property]
user_id
[5]
context.device.manufacturer
device_manufacturer
context.device.model
device_model
context.device.screen.height
device_screen_height
context.device.screen.width
device_screen_width
content_asset_id
av_content_id
[6]
(page.url)
or (page.location.href)
src_medium
[7]
(page.url)
or (page.location.href)
src_campaign
[8]
(page.url)
or (page.location.href)
src_variant
[9]
(page.url)
or (page.location.href)
src_format
[10]
video_session_id
av_session_id
cursor_position * 1000
av_position
prev_cursor_position * 1000
av_previous_position
time_prev_event
av_duration
prev_event_name
av_previous_event
video_title
av_content
video_category
av_content_type
total_length * 1000
av_content_duration
content_linked
av_content_linked
airdate
av_publication_date
keywords
av_content_genre
program
av_show
season
av_show_season
episode
av_episode_id
episode_label
av_episode
channel
av_channel
publisher
av_author
content_version
av_content_version
content_duration_range
av_content_duration_range
(livestream)
av_broadcasting_type
[11]
broadcaster_name
av_broadcaster
ad_type
av_ad_type
video_player
av_player
video_player_version
av_player_version
auto_play
av_auto_mode
video_language
av_language
video_subtitles_language
av_subtitles
video_launch_reason
av_launch_reason
interruption_method
av_player_error
seek_position
av_seek_position
bitrate
av_bitrate
framerate
av_framerate
sound
av_sound
full_screen
av_fullscreen
ad_enabled
av_ad_enabled
image_quality
av_image_quality
content_pod_id
ad_pod_id
av_pod_id
[6]
video_description
av_description
full_episode
av_full_episode
[1] In seconds.
[2] Field included for the following events: add_to_cart
, page_view (product.page_display)
, view_item
, purchase (product.purchased)
, remove_from_cart
, add_to_wishlist
, and select_item
.
[3] Boolean value: true
or false
.
[4] Sum all items.X.quantity
.
[5] Depending on the drop-down selection (See User Identifier
in theConfiguration
section), a specific Commanders Act property is used.
[6] Field converted to string.
[7] Parsed from the utm_medium
parameter in the provided url.
[8] Parsed from the utm_campaign
parameter in the provided url.
[9] Parsed from the utm_content
parameter in the provided url.
[10] Parsed from the utm_creative_format
parameter in the provided url.
[11] This is either "Live" or "Recorded Broadcast".
device.user_agent
User-Agent
page.url
page.location.href
Referer
device.ip
X-Forwarded-For
When sending page_view and click.action events, you can add autopromotions, by setting the array field autopromos
. See the following example:
Each position in the array needs to include a valid Piano Analytics event and is forwarded as it's. In the above example, two additional events are included in a single request to Piano Analytics. This feature needs to be activated in the "Advanced Setting" by flagging the "Send Autopromo Events" option - See Configuration for more details.
Piwik PRO "Analytics Suite" is a privacy-focused platform for tracking and analyzing user behavior on websites and other digital products. Their product is an alternative to Google Analytics, geared towards compliance with strict security policies and privacy regulations. Using this destination, you can leverage Piwik PRO Tracking HTTP API to send events. The data sent to this API will be processed and eventually appear in Analytics reports.
The Piwik PRO destination provides the following key features:
Events structure: our Events reference model matches Piwik PRO's event types (See query parameter e_t
), 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.
Event mapping: change standard mapping between your partners' events and yours or add new mappings.
Support for multi-item data: information included in the item array is dispatched to Piwik PRO.
Instance Name
Required
Your instance name as provided by Piwik PRO (E.g. for https://InstanceName.piwik.pro/ppms.php, include the bold string only).
Application Id
Required
Your application identifier (Previously "Website Id") as provided by Piwik PRO.
Goal Identifiers
Map your goal identifiers by setting the ids in Piwik PRO goal identifiers
and adding event names in Your event name
. Goal Id "0" is reserved for E-commerce cart tracking.
Custom Dimensions
Map your custom dimensions by setting their field names in Piwik PRO dimension name
and adding its value in Your value
. E.g. if you inputsize
in the Piwik PRO dimension name
and items.0.product.size
in Your value
, you'll have a custom dimension in Piwik PRO calledsize
with a value based on the content of the field items.0.product.size
[1].
Custom Session Variables
Custom Event Variables
Event Mapping
Change the standard mapping between Piwik PRO's events and yours or add new mappings.
[1] Using "dots" (".") you can navigate deeper to the specific field you want to get the value of. See Events reference for more details on the standard field names by event. You can also freely set custom fields: there are no boundaries.
add_to_cart
add-to-cart
purchase
order
remove_from_cart
remove-from-cart
update_cart
cart-update
[Any Event]
[Any Event]
[1]
[1] See Event Mapping for more details.
Most properties can be remapped using our "Smart Mapping" feature.
It's recommended to include the visitor identifier in your requets - See Piwik Pro property _id
for more details.
Application Id
idsite
[*]
context.page.url
url
link
event_name
action_name
user.id
uid
[1]
partners.piwik_pro.visitor_id
_id
[2]
partners.piwik_pro.config_id
cid
[3]
partners.piwik_pro.anon_tracking
uia
[4]
context.page.referrer
urlref
Custom Session Variables
_cvar
[5]
Custom Event Variables
cvar
[6]
context.device.ip
cip
context.device.screen.width
x
context.device.screen.height
res
[7]
(context.event_timestamp
)
h
, m
, s
[8]
context.device.user_agent
ua
context.device.lang
lang
user.country
country
user.city
city
Custom Dimensions
[Custom Dimension]
[9]
search_term
search
Goal Identifiers
idgoal
[10]
revenue
revenue
ec_st
e_t
id
ec_id
[[items.X.id
,items.X.product.name
,[items.X.product.category_1
, ...
, items.X.product.category_5
], items.X.product.price
,items.X.quantity
,items.X.product.brand
,items.X.variant
, { [Custom Product Dimension Id Y]
: [Custom Product Dimension Value Y]
, ...
, [Custom Product Dimension Id Y+N]
: [Custom Product Dimension Value Y+N]
}]]
ec_products
[11]
tax_amount
ec_tx
shipping_amount
ec_sh
(items.X.discount
)
ec_dt
[12]
partners.piwik_pro.page_view_id
pv_id
[13]
partners.piwik_pro.force_new_visit
new_visit
[14]
partners.piwik_pro.visit_counter
_idvc
[15]
partners.piwik_pro.prev_visit
_viewts
[16]
partners.piwik_pro.first_visit
_idts
[17]
partners.piwik_pro.download_url
download
[18]
partners.piwik_pro.search_categories
search_cats
partners.piwik_pro.search_count
search_count
partners.piwik_pro.last_order_timestamp
_ects
[19]
partners.piwik_pro.custom_event_category
e_c
[20]
partners.piwik_pro.custom_event_action
e_a
[21]
partners.piwik_pro.custom_event_value
e_v
[22]
partners.piwik_pro.content_name
c_n
[23]
partners.piwik_pro.content_piece
c_p
[24]
partners.piwik_pro.content_target
c_t
[25]
partners.piwik_pro.content_interaction
c_i
[26]
[*] Mandatory property.
[1] Can be used to identify visitor by the application (e.g. login name, email address or internal user ID). More details are available following: Recognizing Visitors.
[2] This allows you to use the application identifier of a visitor instead of a default identifier generated by Piwik PRO analytics. More details are available following: Recognizing Visitors. If you don't pass a value, this destination tries to recover it from the cookie named _pk_id.[Application Id].
More details are available following this LINK.
[3] Semi-unique hash generated for the visitor's browser (based on configuration and installed plugins). This parameter overwrites visitor identifier sent with _id
property.
[4] Whether the user should be tracked anonymously: 1
all IP bytes will be masked (0.0.0.0), GeoIP data below country level will be anonymized, 0
available visitor data will be added to the session.
[5] See Custom Session Variables for more details.
[6] See Custom Event Variables for more details.
[7] Screen resolution (E.g. 1920x1080).
[8] Hour, minute and second when the request was made.
[9] See Custom Dimensions for more details.
[10] See Goal Identifiers for more details.
[11] [Custom Product Dimension Id Y]
must be a numeric identifier starting from 1
and must be incremented for every new custom product dimension being set in Custom Dimensions.
[12] Sum of all product discounts.
[13] Unique page view identifier generated when the page is loaded.
[14] Force start of new visit when value is 1
. Allowed values: 0
or 1
.
[15] Visit counter.
[16] Time of previous visit in UNIX timestamp format: number of seconds.
[17] Time of first visit.
[18] URL of downloaded file.
[19] Time of the last ecommerce order in UNIX timestamp format: number of seconds.
[20] Custom event category. More details are available following this LINK.
[21] Custom event action. More details are available following this LINK.
[22] Content event value. More details are available following this LINK.
[23] Content name. More details are available following this LINK.
[24] Content piece. More details are available following this LINK.
[25] Content target. More details are available following this LINK.
[26] Content interaction. More details are available following this LINK.
LinkedIn CAPI
LinkedIn is a business and employment-focused social media platform. Using this destination you can stream conversion events to LinkedIn through their Conversions API. This allows to measure the performance of your LinkedIn marketing campaigns no matter where the conversion happens and use this data to power campaign optimization. This destination can help strengthen performance and decrease cost per action with more complete attribution, improved data reliability, and better optimized delivery.
The LinkedIn destination provides the following key features:
Events structure: our Events reference model matches LinkedIn's conversion rules, 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.
Automatic hashing: information is automatically hashed matching partner specifications.
Smart mapping: data mapping can be readjusted using your datalayer defined fields.
Before using this destination, review your conversion rules and campaigns in LinkedIn:
First, ensure at least one conversion rule is defined in LinkedIn by accessing your Campaign Manager account and select Analyze
(1)
→ Conversion tracking
(2)
from the left menu:
You can also create a new conversion rule by clicking Create conversion
(3)
→
Conversions API or CSV conversion
(4)
:
Lastly, you need to associate your conversion rule with one or more campaigns. From the Conversion tracking
section, click your conversion rule and reach step 3 where you can select the campaigns you want to track with the conversion:
In order to set the optional "Smart Mapping" field Linkedin UUID
or the related cookie li_fat_id
, advertisers need to enable enhanced conversion tracking from Campaign Manager. This activates first party cookies that append a click identifier parameter ("li_fat_id") to the click URLs. Refer Enabling Click Ids for implementation details.
LinkedIn CAPI supports deduplication with your client-side Insight Tag.
Check the "Smart Mapping" field Event Id
, Field Mappings (See property eventId
) or this LINK for more details.
Authentication
Required
Your credentials with LinkedIn Campaign Manager as set in the Commanders Act interface following: Administration
➜ Connector Credentials
➜ Add connector credentials
➜ LinkedinAds
Conversion Rule Name
[Any Event]
[1]
[Any Conversion Rule]
[2]
[1] Use Destination filters to specify your matching events.
[2] See Conversion Rule Name
in Configuration for more details.
Most properties can be remapped using our "Smart Mapping" feature.
At least one of the following statements, related to "Smart Mapping" fields, must be fulfilled:
• The field User Email SHA256
is set.
• The field Linkedin UUID
or the cookie li_fat_id
is set.
• The field LiveRamp ACXIOM Id
is set.
• The field Oracle MOAT Id
is set.
• Both fields User First Name
and User Last Name
are set.
Moreover, If you send any user information via "Smart Mapping" fields (E.g. User Company Name
, User Job Title
, or User Country
), you must set the User First Name
and User Last Name
fields, regardless if you provide other identity values listed above. More details are available following this LINK.
Conversion Rule Id
conversion
[1][*]
context.event_timestamp
conversionHappenedAt
[*]
value
conversionValue.amount
currency
conversionValue.currencyCode
context.event_id
eventId
[2]
user.email_sha256
partners.linkedin.uuid
partners.linkedin.acxiom_id
partners.linkedin.moat_id
user.userIds.X.idValue
[3]
(user.email_sha256
partners.linkedin.uuid
partners.linkedin.acxiom_id
partners.linkedin.moat_id)
user.userIds.X.idType
[4]
user.firstname
user.userInfo.firstName
user.lastname
user.userInfo.lastName
user.country
user.userInfo.countryCode
user.title
user.userInfo.title
user.company_name
user.userInfo.companyName
[*] Mandatory property.
[1] Value includes the static string "urn:lla:llaPartnerConversion:".
[2] The unique id generated by advertisers to indicate each event. This is used for deduplication. More details are available following this LINK.
[3] If a clear text user email is provided, it's automatically hashed via SHA256.
The "Smart Mapping" field Linkedin UUID
has priority over the cookie li_fat_id
.
[4] Depending on the value being set in user.userIds.X.idValue
, this is one of the following strings: SHA256_EMAIL
, LINKEDIN_FIRST_PARTY_ADS_TRACKING_UUID
, ACXIOM_ID
or ORACLE_MOAT_ID
. More details are available following this LINK.
Piano Analytics is the successor of AT Internet Analytics Suite 2 (AS2). It's a user-centric tool that simplifies product & marketing analytics, while ensuring data quality. Using this destination you can update and/or enrich your data using Piano Analytics Enrichment API.
The Piano Analytics Enrichment API destination provides the following key features:
Events structure: our Events reference model covers Piano Analytics's templates, 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 you get started with this destination, ensure your user has administrator or data supervisor rights and you have created and configured an enrichment.
You can create/access enrichments by going to Piano Analytics interface following ➜ SETTINGS
➜ Data Management
➜ Enrichment
.
Organization Id
Required
Enrichment Id
Enrichment Key
Access Key
Secret Key
One Hit for Each Item
This will instruct the destination to send one hit for each item in your "Item list". This is usefull when using the Piano Analytics "E-COMMERCE/product_id" template.
Enrichment Configuration
Map your properties to be enriched. Your Enrichment Key
must me included and mapped.
In Enrichment property name
set your property name in Piano Analytics to be enriched and in Your value
your matching value. In Your value path
you can select the level where Your value
is located. This includes: Default (root)
, In "items" {items.X}
and In "product" {items.X.product}
.
[Any Event]
[Any Template]
[1]
[1] Use Destination filters to match your events with Piano Analytics' templates.
Most properties can be remapped using our "Smart Mapping" feature.
Your selected enrichment/reconciliation key must me included and mapped.
[Any Property]
[Any Property]
[1]
[1] See Enrichment Configuration for more details.
This destination is currently under final review and will be available soon.
is a social Q&A website. Using this destination you can leverage to send events to Quora Ads Manager to improve conversion match, which increases return on ad spend (ROAS) and lowers cost per action (CPA). This helps advertisers optimize targeting, decrease cost per result, and improve measurement reliability.
The Quora Ads Conversion API destination provides the following key features:
Events structure: our matches , 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.
Event mapping: change standard mapping between Quora events and yours or add new mappings.
Before configuring this destination, you need access to .
Most properties can be remapped using our "Smart Mapping" feature.
is an affiliate platform that provide data-driven products and platforms to fuel advertiser and publisher connections at scale, creating relevant matches that activate audiences and accelerate performance. Using this destination you can implement server-side tracking.
The Rakuten Advertising destination provides the following key features:
Events structure: our covers Rakuten Advertising lead and sale tracking, 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.
Support for multi-item data: information included in the array is bridged to Rakuten Advertising.
Rakuten Advertising adds a URL parameter ranSiteID
to your landing page by default. This mandatory values is usually stored in a cookie called rmStore, which needs to be included in your events. Alternatively, you have the option to send its values by providing it in the field Rakuten Affiliate Tracking Id (tr)
[1]. The cookie rmStore is also used to retrieve the mandatory property land
, which can also be sent using the fieldRakuten User Arrival (land)
[1]. See for more details.
[1] "Smart Mapping" field.
[1] Using "dots" (".") you can navigate deeper to the specific field you want to get the value of. See for more details on the standard field names by event. You can also freely set custom fields: there are no boundaries.
[*] Mandatory property.
[1] Priority order is listed in the left column.
[2] partners.rakuten.land
must be in the 24-hour format: yyyymmdd_hhmm
.
[3] if items information are reported in your item list, this is computed using the item price and item quantity, otherwise the revenue
is used. Multiplying by 100 is not applied when currency
is set with JPN
.[totalDiscount]
is set with discount
, items.X.discount
(sum) or 0, in this presented priority order.
[4] Distinct product information is separated with a pipe character ("|").
is an affiliate platform that provide data-driven products and platforms to fuel advertiser and publisher connections at scale, creating relevant matches that activate audiences and accelerate performance.
Select 1 or many segment(s) you want to export.
Rakuten Customer ID: provided by Rakuten
Precise the running period (if needed)
This destination is currently under final review and will be available soon.
is a social news aggregation, content rating, and forum social network. (CAPI) is a server-side solution to share your web conversion data directly with Reddit so you can measure and optimize your performance campaigns.
The Reddit Conversions API destination provides the following key features:
Events structure: our model covers , 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.
Automatic hashing: information is automatically hashed matching partner specifications.
Smart mapping: data mapping can be readjusted using your datalayer defined fields.
Event mapping: change standard mapping between Reddit events and yours or add new mappings.
Support for multi-item data: information included in the array is dispatched to Reddit.
Before configuring this destination, you need access to .
Most properties can be remapped using our "Smart Mapping" feature.
All Reddit properties are set in the path events[0]
.
At least one of the following Reddit properties is required:
• click_id
*
• uuid
*
• email
*
• ip_address
+ user_agent
+ width
+ height
*
• idfa
or aaid
• external_id
Sending more properties will improve attribution accuracy and performance.
* Recommended properties.
is an affiliate platform that provide data-driven products and platforms to fuel advertiser and publisher connections at scale, creating relevant matches that activate audiences and accelerate performance.
This destination is currently under final review and will be available soon.
is an advertising-technology company specialized in target advertising including retargeting and real-time bidding. Using this destination you can share audiences with RTB House by leveraging the .
Audiences are synchronized using their names as identifier. Avoid renaming to maintain consistency.
The RTB House Audience destination provides the following key features:
Audience sharing: our model drives audience sharing with Batch, meaning that you can synchronize your existing user segments, with your partner, in a seamless way.
Created segments include the following properties:
[1] context.segment_name
is converted in lower case with spaces replaced by the underline character ( _
).
Your site identifier as provided by Matomo. More details are available following this .
Cookie name holding a few details about the user such as the unique visitor identifier. It normally starts with the string _pk_id
. This has priority over the following field Visitor Id Value
. More details are available following this . (E.g. value "4e4eb04b31f37eac.1653656637.")
You can bridge your selected user identifier for logged users. More details are available following this .
Map your Matomo custom variables by setting their field names in Custom Variable Name
and adding the field name holding the value in Commanders Act event property or static value
. E.g. if you inputsize
in Custom Variable Name
and items.0.product.size
in Commanders Act event property or static value
, you'll have a custom variable in Matomo calledsize
with a value based on the content of the field items.0.product.size
[1]. You also have the option to set a static string/numeric value in Commanders Act event property or static value
.
More details on custom variables are available following this .
Map your Matomo custom parameters by setting their field names in Custom Parameter Name
and adding the field name holding the value in Commanders Act event property or static value
. E.g. if you inputsize
in Custom Parameter Name
and items.0.product.size
in Commanders Act event property or static value
, you'll have a custom parameter in Matomo calledsize
with a value based on the content of the field items.0.product.size
[1]. You also have the option to set a static string/numeric value in Commanders Act event property or static value
.
More details on custom parameters/dimensions are available following this .
Map your Matomo goals by setting the Commanders Act Event Name
in the related field and the Matomo Goal Id
associated with it.
More details on goals are available following this .
An is required to send additional parameters. Going to Matomo's interface, It's recommend to create a user specifically for accessing the "Tracking API", and give the user only write permission on the website(s). More details on the additional parameters are available following this .
In the column Commanders Act event property position
you should keep the default value Default (root)
as it better fits most scenarios. In case you select either In "items" {items.X}
or In "product" {items.X.product}
this destination will look for the input event property starting from the or level respectively and concatenate values separated by a semicolon (";").
Under the "Advanced Settings", you have the option to exclude the Mapp ct
parameter by flagging this checkbox. More information on this parameter are available in the section.
cookie
Cookie name holding the click identifier (moeclid
) value. More details are available by following this .
Required
Outbrain click identifier. More details are available by following this (See "Add a Click Parameter to Your Campaign’s Tracking Code" section).
Required
Your mapping between Outbrain's events and yours. At least one couple Outbrain event name
and Your event name
is required. More details are available by following this (See "Create a Unique Event Name" section).
Required
Pinterest Advertiser ID. More details are available following this .
Required
The Pinterest Conversions API needs an access token to authenticate your activities. More details are available following this .
Cookie name holding the Pinterest "Click Id" that uniquely identifies a click. This is highly recommend on checkout events at least. It may improve reporting performance such as ROAS/CPA. Default cookie name: _epik
. More details are available by following this .
If checked, the event will not be recorded in Pinterest Ads, but the API will still return the same response messages. Use this mode to verify your requests and if your events are constructed correctly. More details are available following this .
Required
The identifier of the site the data belongs to (E.g. 628087
). This can be found in the Piano Analytics interface following ➜ SETTINGS
➜ Data Collection Portal
➜ Tools
➜ Site Management
and selecting your site. This setting supports dynamic values [1].
Required
The SSL Domain on which information is collected (E.g. logs1412.xiti.com
). This can be found in Piano Analytics interface following ➜ SETTINGS
Data Collection Portal
➜ Tools
➜ Site Management
and selecting your site.
You can set your user identifier for logged users. More details are available following this .
You can set a specific client identifier as our context.device.sdk_id
or a custom property holding its value. When keeping the "Default" value, or the first mentioned options don't result in a valid value, this is your client-side unique visitor identifier from cookies as detailed in the . If no cookie is available, the property user.tcId
is used. More details are available following this .
Flagging this option will match your view_item
event with Piano product.page_display
event. See for more information on event mapping.
This enables autopromo events. See for more details.
When activating this option all properties included in the root of your events are also sent, without any modification, to Piano Analytics in the data
object. More details are available following this .
In the column Your event property path
you should keep the default value Default (root)
as it better fits most scenarios. In case you select either In "items" {items.X}
or In "product" {items.X.product}
this destination will look for the input event property starting from the or level respectively and add its values as a custom item property.
To ensure that custom event properties are picked up by Piano Analytics, you need to create them first by following ➜ SETTINGS
➜ Data Management
➜ Data Model
➜ Properties
.
To ensure that custom user properties are picked up by Piano Analytics, you need to create them first by following ➜ SETTINGS
➜ Data Management
➜ Data Model
➜ Properties
.
[*] Custom events must be added to the Piano Analytics' data model first or they won't be processed. You can add new events by following ➜ SETTINGS
➜ Data Management
➜ Data Model
➜Events
.
[1] If page_type
is equal to product
then product.page_display
is sent, otherwise, page.display
.
[2] A product.purchased
will be sent for each product being purchased.
[3] Flagging Custom Event Mapping: "view_item" matched with Piano "product.page_display"
(See Destination setup) maps your view_item
with Piano product.page_display
, otherwise your event will be matched with Piano product.display
.
In the column Your value path
you should keep the default value Default (root)
as this will add a custom dimension at the base request level which better fits most scenarios. In case you select either In "items" {items.X}
or In "product" {items.X.product}
this destination will look for the input event property starting from the or level respectively and add it as a custom product dimension. In this scenario, Piwik PRO dimension name
must be a numeric string identifier (E.g. 1
, 2
, ..., N
). More details are available following this (See query parameter named ec_products
).
Map your custom session variables by setting their field names in Piwik PRO variable name
and adding its value in Your value
. E.g. if you inputsize
in the Piwik PRO variable name
and items.0.product.size
in Your value
, you'll have a custom session variable in Piwik PRO calledsize
with a value based on the content of the field items.0.product.size
[1]. More details are available following this (See query parameter named _cvar
).
Map your custom event variables by setting their field names in Piwik PRO variable name
and adding its value in Your value
. E.g. if you inputsize
in the Piwik PRO variable name
and items.0.product.size
in Your value
, you'll have a custom event variable in Piwik PRO calledsize
with a value based on the content of the field items.0.product.size
[1]. More details are available following this (See query parameter named cvar
).
See
Required
Select your conversion rule name from the drop-down menu. You can create/edit a conversion rule by accessing your account and select "Analyze" → "Conversion tracking" from the left menu.
Your organization identifier. This can be found in Piano Analytics interface following ➜ SETTINGS
➜ Data Management
➜ Enrichment
➜ Edit your enrichment ➜ Import Data
then look for the bold string in your URL: https://import.atinternet.io/[ORGANIZATION ID]/[ENRICHMENT ID]/[ENRICHMENT KEY]
Required
Your enrichment identifier. This can be found in Piano Analytics interface following ➜ SETTINGS
➜ Data Management
➜ Enrichment
➜ Edit your enrichment ➜ Import Data
then look for the bold string in your URL: https://import.atinternet.io/[ORGANIZATION ID]/[ENRICHMENT ID]/[ENRICHMENT KEY]
Required
Your enrichment key. This can be found in "Piano Analytics" interface following ➜ SETTINGS
➜ Data Management
➜ Enrichment
➜ Edit your enrichment ➜ Import Data
then look for the bold string in your URL: https://import.atinternet.io/[ORGANIZATION ID]/[ENRICHMENT ID]/[ENRICHMENT KEY]
Required
Your access key. This can be found or created by following this .
Required
Your secret key. This can be created by following this and it's only shown at creation time.
[1] See Event Mapping
in for more details.
Quora strongly recommends using both the Quora client-side pixel and Conversion API. These are located in two different tabs of your .
To deduplicate conversions between this destination and Quora pixel tag you need to set the same value for the mandatory field event_id
. More details are available by following this .
[*] Mandatory property. [1] Automatically converted in microseconds. [2] See for more details.
Most properties can be remapped using our "Smart Mapping" feature.
Rakuten Advertising has two different endpoints: default "ep" commissionable and "eventnvppixel" media optimization pixel. Using the "Smart Mapping" field Rakuten Tracking Endpoint
you can select which one you want to use: set "mop" for the "eventnvppixel" media optimization or "ep" for the standard endpoint. Please note that there are limitations in terms of parameters you can send when selecting the "eventnvppixel" media optimization pixel.
For the Lead
conversion type, if you don't provide item information such as identifier, quantity and name, the following fixed values are set skulist=Lead
, qlist=1
and namelist=Lead
. Moreover, if amtlist
can't be valorized with the provided information, it will be statically set as follow: amtlist=1
.
More details on Rakuten properties are available following this .
[1] See Event Mapping
in for more details.
[1] Timestamp is converted to the format.
[2] If a value is not provided, this is retrieved from the page URL by parsing the parameter rdt_cid
.
[3] Set in the event_metadata
field.
[4] Based on the length of the provided "Smart Mapping" field Item List
.
[5] All provided categories are separated by the "greater than" character ( >
).
[6] Set in the user
field.
[7] These properties require a proper value, iOS
or Android
, for the "Smart Mapping" field Device Platform
.
[8] Automatically hashed via SHA256 when provided in clear text.
[9] Set in the user.data_processing_options
field.
[10] Supported value: LDU
.
[11] Set in the user.screen_dimensions
field.
[12] Set in the base path.
generic
Generic
app_install
AppInstall
purchase
Purchase
generate_lead
GenerateLead
sign_up
CompleteRegistration
add_payment_info
AddPaymentInfo
add_to_cart
AddToCart
add_to_wishlist
AddToWishlist
begin_checkout
InitiateCheckout
search
Search
[Any Event]
[Any Allowed Event]
[1]
Account Id
account_id
[*]
Click Id
conversion.click_id
[*]
context.event_id
conversion.event_id
[*]
context.event_timestamp
conversion.timestamp
[1]
value
conversion.value
(event_name)
conversion.event_name
[2]
user.email
user.email
user.firstname
user.lastname
user.name
context.device.ip
user.ip
user.country
user.country
user.state
user.region
user.city
user.city
user.zipcode
user.postal_code
context.device.advertising_id
device.mobile_device_id
context.device.user_agent
device.user_agent
context.device.language
device.language
[All events]
Sale
or Lead
Rakuten Affiliate Merchant Id (mid)
Affiliate Merchant Id
mid
[*][1]
partners.rakuten.land
Gateway Cookie Name
land
[*][1][2]
partners.rakuten.tr
Gateway Cookie Name
tr
[*][1]
currency
cur
[*]
((items.X.product.price
* items.X.quantity
) - ([totalDiscount]
* (items.X.product.price
* items.X.quantity
)) / [totalOrderFromItems]
) * 100
amtlist
[*][3][4]
items.X.id
skulist
[*][4]
items.X.quantity
qlist
[*][4]
items.X.product.brand
brandlist
[4]
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
catlist
[4]
items.X.coupon
couponlist
[4]
items.X.product.name
namelist
[4]
id
ord
id_variant
altord
context.device.advertising_id
did
discount
discount
discount
disamt
user.id
custid
user.status
custstatus
coupon
coupon
status
ordstatus
add_to_cart
AddToCart
add_to_wishlist
AddToWishlist
generate_lead
Lead
page_view
PageVisit
purchase
Purchase
search
Search
sign_up
SignUp
view_item
ViewContent
[Any Event]
[Any Event]
[1]
context.event_timestamp
event_at
[1]
Event Mapping
event_type.custom_event_name
partners.reddit.click_id
click_id
[2]
id
conversion_id
[3]
value
value_decimal
[3]
currency
currency
[3]
items
item_count
[3][4]
items.X.id
products.X.id
[3]
items.X.product.name
products.X.name
[3]
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
products.X.category
[3][5]
context.device.advertising_id
idfa
[6][7][8]
aaid
[6][7][8]
user.email
email
[6][8]
user.id
external_id
[6][8]
context.device.ip
ip_address
[6][8]
context.device.user_agent
user_agent
[6]
parters.reddit.uuid
uuid
[6]
context.device.ad_tracking_enabled
opt_out
[6]
user.country
country
[9]
user.region
region
[9]
parters.reddit.data_proc_mode
modes[0]
[9][10]
context.device.screen.width
width
[11]
context.device.screen.height
height
[11]
Test Mode
test_mode
[12]
Access Token
Required
Your access key as generated by accessing the Conversion API tab in Quora Ads Manager and selecting "Generate Token". More details are available by following this LINK.
Account Id
Required
Your account identifier as reported in Quora Ads Manager account settings. More details are available by following this LINK.
Click Id
Required
Click identifier added as parameter "qclid" to the landing page URL of Quora ads. Landing page URL of Quora ads includes the "qclid" parameter if a conversion API access token has been generated for the ad account. This is used to attribute conversions to Quora ads and users who clicked on the ad. If a user has clicked on more than one ad, the most recent click id should be passed back. More details are available by following this LINK.
Event Mapping
Change the standard mapping between Quora's events and yours or add new mappings. Quora event names must be one of the following: Generic
, AppInstall
, Purchase
, GenerateLead
, CompleteRegistration
, AddPaymentInfo
, AddToCart
, AddToWishlist
, InitiateCheckout
and Search
.
Affiliate Merchant Id
Required if
Rakuten Affiliate Merchant Id (mid) is not set
Your unique "Affiliate Merchant Id" as provided by Rakuten.
Mapping
Required
Map "Rakuten Conversion Types" with your "Commanders Act events" by setting at least a Rakuten Conversion Type
and a Commanders Act Event Name
. One entry is required.
Custom Event Properties
Map your custom event properties by setting their field names in Event property name
and adding the field name holding the value in Commanders Act event property
. E.g. if you inputsize
in the Event property name
and items.0.product.size
in Commanders Act event property
, you'll have a custom event property in Rakuten Advertising calledsize
with a value based on the content of the field items.0.product.size
[1].
In the column Commanders Act event property position
you should keep the default value Default
as it better fits most scenarios. In case you select either In "items" {items.X}
or In "product" {items.X.product}
this destination will look for the input event property starting from the items or product level respectively and concatenate values separated by a pipe character ("|"). In this scenario, the property name used will be the one set in the Event property name
plus the string "list" appended in the end.
Gateway Cookie Name
Your publisher links in Rakuten Advertising will direct users to a gateway page that sets a cookie holding key values. If you're not using the default cookie name ("rmStore"), enter its new name here.
Authentication
Required
Your credentials with Reddit Campaign Manager as set in the Commanders Act interface following: Administration
➜ Connector Credentials
➜ Add connector credentials
➜ RedditAds
Access Token
Required
Your access token identifier as generated by accessing Nextdoor Ads Manager. More details are available by following this LINK.
Event Mapping
Change the standard mapping between Reddit's events and yours or add new mappings.
Test Mode
Enable this only while testing your settings. Disable in production!
Account Id
Required
Your account identifier as provided by RTB House.
API Key
Required
Your API key as provided by RTB House.
audience_id
[rtb_identifer] _context.segment_name
[1]
audience_name
context.segment_name
audience_compact_id
context.segment_name
[1]
size
(number of overall users)
user_types.X.user_type
user_types.X.size
(number of user of the specific type)
Adobe is an multinational computer software and web analytics company (See Adobe Experience Cloud).
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Precise the filename and extension (CSV by default).
Precise if you want to compress the file (GZIP by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
You can easily export your destination's raw logs using the Destination Logs Exporter. This destination will allow you to export to an SFTP all outgoing requests issued by the destinations you choose, and to analyze in these logs all the details, including the originating events that led to the outgoing requests.
Select one or more destinations from which you'd like to export your data.
Name your destination and pick the environment you'd like to work in.
Select a storage connector. This can be set up in Administration > Connector Credentials. Only FTP, Amazon S3 & Google Cloud Storage are currently supported
Specify the file name and extension (default is CSV).
By default, your export file will not be compressed. If needed, you can compress your file to GZIP format.
Set the data separator, like commas for CSV files (e.g., value1,value2).
Enable your destination to start exporting!
Modify the timezone if necessary.
Adjust the export frequency and time window to suit your needs.
Effinity is a digital acquisition agency. Using Effinity server-side tracking you can track lead and sale conversions.
Events structure: our Events reference suits Effinity lead and sale tracking, 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.
Advertiser Id
Required
Your unique advertiser identifier as provided by Effinity.
Conversion Type
Required
The conversion type that is bound with your activity. This can be either sale
or lead
. If conversion type is lead
, only generate_lead
events are forwarded to Awn. If conversion type is sale
, only purchase
events are sent to the partner.
Effinity Cookie Name
Enter a cookie name holding Effinity key landing values. Expected cookie structure: "[ID_COMPTEUR],[PROD_ID],[EFFI_ID],[EFFI_ID2]" (E.g. "01010101,1234,567890,098765", without quotes). [1]
[1] If you don't provide a cookie name for effinity landing values, it's mandatory that you provide them usingpartners.effinity
fields. See Field Mappings for more details.
generate_lead
lead
purchase
sale
The Effinity property consent_performance
is always set to 1
. Manage your consent settings using the filter tab of this destination.
Advertiser Id
id
currency
monnaie
revenue
montant
id
ref
partners.effinity.id_compteur
Effinity Cookie Name
id_compteur
[1]
partners.effinity.prod_id
Effinity Cookie Name
prod_id
[1]
partners.effinity.effi_id
Effinity Cookie Name
effi_id
[1]
partners.effinity.effi_id2
Effinity Cookie Name
effi_id2
[1]
payment_method
payment
coupon
voucher
[1] partners.effinity
fields have priority over Effinity Cookie Name
.
Google is a multinational technology company focusing on online advertising, search engine technology, cloud computing, and computer software.
You can export raw data through (S)FTP.
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Precise the filename and extension (CSV by default).
Precise if you want to compress the file (GZIP by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
The Performance tab can now display Event Match Quality insights, coming from Facebook. It represents the matching quality, referring to the quality of events sent (completeness of data, like events with email, phone, fbp, fbc...). More identifiers are present on events sent, better is the score.
First, select (or login) the Facebook account to which belongs the pixel defined in the Settings step.
Facebook accounts can be managed on Administration / Connector credentials
You can click on a specific event to get more details about the score.
For each event, you can get the details of matching keys and the corresponding volume (%).
This information is also available on Facebook Business Manager interface (Events Manager).
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Precise the filename and extension (CSV by default).
Precise if you want to compress the file (GZIP by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
Select 1 or many segment(s) you want to export.
Select what kind of data you want to export:
Users
Page views
Conversions
Products
Views (only available for Campaign Analytics customers)
Clicks (only available for Campaign Analytics customers)
Select properties you want to export.
You can add also a static column, meaning you can set a value, and it will be exported as you entered it.
Select the data range:
All: all stored data corresponding to what you selected
Pick up where last export left off: differential export, you can export only records which were not exported on the last export
Last... / Between...: select a precise period for the data range
Select the storage connector (a storage connector can be configured on Administration / Connector credentials).
Precise the filename and extension (CSV by default).
Precise if you want to compress the file (GZIP by default).
Precise if you want to include headers at the top of the file.
Precise the main separator and separator inside a variable (ex: value1,value2;value2a;value2b,value3)
Partnerize provides a global affiliation network connecting businesses with customers. Using this destination you can implement server-side tracking.
The Partnerize destination provides the following key features:
Events structure: our Events reference leverages Partnerize lead and sale tracking, 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.
Support for multi-item data: information included in the item array is bridged to Partnerize.
Commission group: remunerate different products based on your categories.
Campaign Id
Required
A unique identifier assigned to the campaign and provided by Partnerize. This setting supports dynamic values [1].
Select your click ref holder
This can be either Cookie
or Event property
, depending on how you provide CJ "Click Reference" value.
Cookie Name for Click Tracking
If you select Cookie
in Select your click ref holder
, you can set your cookie name here.
Event property containing click ref
If you select Event property
in Select your click ref holder
, you can set your event property here. [2]
Custom Conversion URL String
Optional: Partnerize Device (device)
Optional: Partnerize Context (context)
Custom Event Properties
Map your custom event properties by setting their field names in Partnerize property name
and adding the field name holding the value in Your event property
. E.g. if you inputsize
in the Partnerize property name
and items.0.product.size
in Your event property
, you'll have a custom event property in Partnerize calledsize
with a value based on the content of the field items.0.product.size
[2].
[1] This feature allows you to set an event property holding a dynamic value by adding two open braces ({{
) in front of your property name and two close braces (}}
) at the end (E.g. {{myEventPropertyPathAndName}}
).
[2] Using "dots" (".") you can navigate deeper to the specific field you want to get the value of. See Events reference for more details on the standard field names by event. You can also freely set custom fields: there are no boundaries.
generate_lead
lead
purchase
sale
Most properties can be remapped using our "Smart Mapping" feature.
Both parametersclickref
andconversionref
are mandatory.
The two Basket Data parameterscategory
andquantity
are required, whilevalue
is needed if you intend to award commission based on percentage basis.
Campaign Id
campaign
[*]
Cookie Name for Click Tracking
or
Event property containing click ref
clickref
[*][1]
id
conversionref
[*]
currency
currency
[*]
items.X.affiliation
category
[*]
items.X.quantity
quantity
[*]
partners.partnerize.device
device
[2]
partners.partnerize.context
context
[2]
user.type
customertype
coupon
voucher
country
country
[3]
items.X.id
sku
items.X.product.price
value
Your event property
conversion_time
[4]
Your event property
Partnerize property name
[5]
[*] Mandatory property.
[1] See Configuration for more details. if no value is provided, the default cookie named clickref is used.
[2] See valid values.
[3] Standard ISO 3166.
[4] This needs to be set in theCustom Event Properties
by adding the field conversion_time
asPartnerize property name
and setting a field holding a Unix epoch timestamp (10 or 13 digits) inYour event property
.
[5] SeeCustom Event Properties
in Configuration for more details on how you can bridge custom properties to Partnerize.
This destination is currently under final review and will be available soon.
Nextdoor operates a hyperlocal social networking service for neighborhoods. Using this destination you can send marketing data in the form of events or conversions to Nextdoor and get a more complete picture of their advertising outcomes on Nextdoor. This is based on Nextdoor Conversion API.
The Nextdoor Conversion API destination provides the following key features:
Events structure: our Events reference matches Nextdoor events, 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.
Automatic hashing: information is automatically hashed matching partner specifications.
Smart mapping: data mapping can be readjusted using your datalayer defined fields.
Event mapping: change standard mapping between Nextdoor events and yours or add new mappings.
Support for multi-item data: information included in the item array is dispatched to Nextdoor.
Before configuring this destination, you need access to Nextdoor Ads Manager.
Advertiser Id
Access Token
Event Mapping
Change the standard mapping between Nextdoor's events and yours or add new mappings. Nextdoor event names must be one of the following: conversion
, lead
, purchase
, sign_up
and custom_conversion_X
, where X
is a number from 1 to 10.
purchase
purchase
generate_lead
lead
sign_up
sign_up
[Any Event]
[Any Allowed Event]
[1]
[1] See Event Mapping
in Configuration for more details.
Most properties can be remapped using our "Smart Mapping" feature.
Advertiser Id
client_id
(event_name
)
event_name
[1]
context.event_id
event_id
context.event_timestamp
event_time
[2]
partners.nextdoor.event_timezone
event_timezone
partners.nextdoor.action_source
action_source
[3]
context.page.url
action_source_url
partners.nextdoor.delivery_optimization
delivery_optimization
partners.nextdoor.test_event
test_event
user.email
email
[4][5][6]
user.phone
phone_number
[4][6][7]
user.firstname
first_name
[4][5][6]
user.lastname
last_name
[4][5][6]
user.birthdate
date_of_birth
[4][6][8]
user.street
street_address
[4][6]
user.city
city
[4][6][9]
user.state_short
state
[4][6][10]
user.zipcode
zip_code
[4][6][11]
user.country
country
[4][6][12]
context.device.ip
client_ip_address
[4]
partners.nextdoor.pixel_id
pixel_id
[4][13]
partners.nextdoor.click_id
click_id
[4][14]
id
order_id
[15]
currency
+ value
order_value
[15]
partners.nextdoor.delivery_category
delivery_category
[15]
items.X.id
id
[16]
items.X.product.name
content_name
[16]
items.X.product.price
item_price
[16]
items.X.quantity
quantity
[16]
context.app.namespace
app_id
[17]
context.device.ad_tracking_enabled
app_tracking_enabled
[17]
context.device.os.name
platform
[17]
context.app.version
app_version
[17]
[1] See Event Mapping
in Configuration for more details.
[2] Automatically converted in ISO 8601 format.
[3] When Smart Mapping Action Source is not set, this value is automatically set by using the following information in the presented priority order: 1. Smart Mapping field Experience Type
2. property context.app
3. Smart Mapping field Conversion Type
.
[4] Set in customer
object.
[5] Pre-hashed format in lower case.
[6] Automatically hashed via SHA256 when provided in clear text.
[7] Pre-hashed format should consist of exactly ten digits, devoid of any special characters or international country codes.
[8] Pre-hashed format YYYYMMDD
.
[9] Pre-hashed format in lower case, no special characters.
[10] Pre-hashed format in lowercase and as two letter ANSI abbreviation code.
[11] Pre-hashed format with five digits for US.
[12] Pre-hashed format as two-character ISO 3166-1 alpha-2 code.
[13] Allows Nextdoor to deduplicate events for an advertiser that sends events via both the CAPI and the pixel making it soft required for multiple pixel implementation.
[14] This is the same as ndclid
parameter attached to clickthrough URL.
[15] Set in custom
.
[16] Set in custom.product_context.X
.
[17] Set in app
.
The Partnerize "Conversion URL" may differ based on your specific requirements. Using this setting, you can add a custom string before the parameter (E.g. https://prf.hn/conversion/tracking_mode:api/[CUSTOM_STRING]campaign:...).
You can set a property holding the following allowed values: "bot", "desktop", "mobile", "tablet" and "Other". More details are available following this . [2]
You can set a property holding the following allowed values: "web", "m_web", "m_app", "in_app", "cd_d", "cd_p", "other" and "offline". More details are available following this . [2]
In the column Your event property path
you should keep the default value Default (root)
as this will add a custom parameter at the (E.g. see ) which better fits most scenarios. In case you select either In "items" {items.X}
or In "product" {items.X.product}
this destination will look for the input event property starting from the or level respectively and add it as a custom parameter.
The advanced operation As Partnerize Basket Data
can be paired with the property path option Default (root)
so your property value is set as a custom entry in the Partnerize "Basket Data" for each item.
Required
Your NAM advertiser identifier in . More details are available by following this (See client_id
).
Required
Your access token identifier as generated by accessing . More details are available by following this .