Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

If you look at panel below the configuration section, you will find that the conversion code already contains six parameters. These parameters are mandatory and should not be removed from the conversion code.

Name (JS code)

Name (img code)

Explanation

Format

Example

convTarget

ctg

This parameter identifies the conversion target. The value of the parameter corresponds with the target you selected in the configuration panel.

Attention: Uniqueness of conversions is determined by the combination of the convId, convTarget, and trcCat together. This means you can have multiple conversions with the same convId, but different convTarget and trcCat.

Alphanumeric

AddBasket

trcCat

trc

This parameter identifies the tracking category. The value of the parameter corresponds with the category you selected in the configuration panel.

Tracking category default will be used implicitly when none or unknown tracking category is supplied.

Note

In case of basket tracking the value basket should be used.

Attention: Uniqueness of conversions is determined by the combination of the convId, convTarget, and trcCat together. This means you can have multiple conversions with the same convId, but different convTarget and trcCat.

Alphanumeric

default

siteId

sid

For security reasons, this parameter identifies the page on which the conversion is made.

Alphanumeric

checkout_page

convId

cid

This parameter identifies the the conversion and therefore should be unique. In case the ID contains sensitive information such as an email address, it can be replaced by an alternative ID on the platform.

Attention: Uniqueness of conversions is determined by the combination of the convId, convTarget, and trcCat together. This means you can have multiple conversions with the same convId, but different convTarget and trcCat.

Alphanumeric

ORD12345

ordValue

orv

This parameter transmits the value of the conversion. If the conversion does not contain a value, the transmitted value should be 0.00.

Attention: Any other format than ##############.#### (Scale 20, Precision 4) is not allowed.

Numeric: ################.#### (Scale 20, Precision 4)

Max-Value: 9999999999999999.9999

25.00

ordCurr

orc

This parameter transmits the currency following ISO 4217. The currency should always correspond with the currency used on the advertiser's website.

Alphabetic

EUR

locationHref

hrf

The complete Browser-URL on which the tag was fired. Used to prevent accuracy issues in case of strict referrer browser policy. Please don’t change the default value window.location.href

URL

Result of window.location.href call

Adding advanced parameters

...

The advanced parameters are sorted by purpose, let’s go through them one by one.

Name (JS code)

Name (img code)

Explanation

Format

Example

discValue

dsv

This parameter transmits any discount values related to the conversion.

Numeric: #.#

12.34

disCode

dsc

This parameter transmits any discount codes related to the conversion.

Alphanumeric

XMAS2016-4578aved

discOrdValue

ovd

This parameter transmits the order value minus the value of the voucher that was applied to the order. It only needs to be implemented to allow distribution via third party tracking.

Numeric: #.#

98,75

invValue

inv

This parameter transmits the total order value of a conversion, i.e. including shipping costs and VAT.

Numeric: #.#

123.45

confStat

cfs

This parameter transmits the status of the conversion. If it is not used, conversions will be registered with an open status. Therefore, you should only use this parameter when you want to confirm or cancel conversions automatically.

Numeric

1

uniqid

uniqid

This parameter is needed when you want to automate your validation process. For more information, please read this article.

Universally unique identifier (UU ID)

164a9ee7-4b7a-3a2a-802a-1a7a4be79e4a

Name (JS code)

Name (img code)

Explanation

Format

Example

isCustNew

csn

This parameter registers whether the customer was new to the advertiser. Possible values are true (new) or false (recurring).

Alphabetic

True

custId

csi

This parameter transmits any ID given to the customer who placed the conversion. Use this for implementing cross-device tracking.

Alphanumeric

bon78945

custGend

csg

This parameter transmits a value identifying the gender of the customer placing the conversion. Possible values are f (female) and m (male).

Alphabetic

f

custAge

csa

This parameter transmits the age of the customer placing the conversion.

Numeric

45

CustSurv

csr

This parameter transmits questions and answers to surveys held upon placing the order.

Alphanumeric: {"#":"#"}. Please note JSON format is higly recommended.

{"Your favorite movie":"Moonraker","Your favorite actor":"Sean Connery"}

payMethod

pmt

This parameter can transmit the payment method the customer chose when placing the order.*

Alphanumeric

paypal

addData

adt

This parameter can transmit costumer related data, such as the number of orders previously canceled or recommendations.

Alphanumeric: {"#":"#"}. Please note JSON format is highly recommended.

{"number_prev_cancellations":"12","recommended_by":"user_id: 15"}

userVal1

uv1

This parameter can transmit additional information. It can be a string, a JSON or another format.

Alphanumeric

12345

userVal2

uv2

This parameter can transmit additional information. It can be a string, a JSON or another format.

Alphanumeric

Berlin

userVal3

uv3

This parameter can transmit additional information. It can be a string, a JSON or another format.

Alphanumeric

Germany

userVal4

uv4

This parameter can transmit additional information. It can be a string, a JSON or another format.

Alphanumeric

Category: Newspaper Subscription

Custom values

The parameters in this section can transmit custom values related to the conversion or the customer, such as points given for a loyalty program. The content can be alphanumeric.

...

To enable basket tracking, please make sure you add the ‘basket’ parameter to the conversion code. Remember, the tracking category ‘basket’ should be set up. The only requirement for using this parameter is that your advertiser needs to be able to fill it with basket data in JSON format. The individual components of the basket data are discussed in the table below.

Name

Explanation

Format

Example

id

The optional ID of this position Can be submitted to address this position later. Generated automatically if empty

1 or higher

1

uuid

The optional UUID of this position. Can be submitted to address this position later. Generated automatically if empty

Valid UUID

0d5bb776-2d50-4d65-912c-d20e324f66b8

pid

The ID of the product to which the basket position relates.

Numeric

1234

prn

The name of the product to which the basket position relates.

Alphabetic

Green Hoover vacuum cleaner

pri

The price of the product to which the basket position relates.

Numeric: #.#

145.55

brn

The brand name of the product to which the basket position relates.

Alphanumeric

Hoover

qty

The number of ordered products.

Numeric

3

trc

The tracking category of the basket position, not to be confused with the tracking category of the conversion to which the basket position belongs. Any tracking category may be used except basket. If no specific tracking category is intended, please use default.

Never use the trc basket it will cause an error.

Alphanumeric

default

prc

The shop category of the product to which the basket position relates.

Alphanumeric

Household appliance

Name (JS code)

Name (img code)

Explanation

Format

Example

admCode

amc

This parameter transmits the complete ad media code of the click URL via which the conversion was generated.

Numeric: #.#.#

1234.5678.9012

subCode

smc

This parameter replaces any sub IDs added to the click URL via which the conversion was generated.

Alphanumeric

abc1234

clickId

cli

This parameter can transmit the ID of a click and enable attribution even when no cookie was dropped.

Numeric

123456789

(In JS code, use clickIds to transmit this value)

awc

Awin click checksum.

String

1001_1502695821_b670d81e22c9e8a87g423efcf034fbaa

(In JS code, use clickIds to transmit this value)

gclid

Google Ads click ID.

String

CjwKCAjwvZv0BRA8EiwAD9S8msHPVhhwIFhI3jzdnsgc_JZxyhR-RaZGs4j_86cmVljnIn7sgHCelU8AvbEfALw_wcB

(In JS code, use clickIds to transmit this value)

fbclid

Facebook Ads click ID.

String

IwAR1j1yBKErYRyrUR9mLw8lHZssY9GTabc9cyfZ9j_R1H29BjYJSuxbTKUUF

Configuring the on-page code

...

If you look at panel below the configuration section, you will find that the on-page code already contains five parameters, that you may work with. The parameter siteId is mandatory.

Name

Explanation

Format

Example

siteId

Mandatory: This parameter defines the placement of the code. It should be filled with the path of the page or the URL

Alphanumeric

productId

only on product pages: This parameter is the product ID, e.g. EAN or SKU

Alphanumeric

1234567890

userVal1

optional parameter, you are free to put in any additional information that may be needed

Alphanumeric

userVal2

optional parameter, you are free to put in any additional information that may be needed

Alphanumeric

locationHref

The complete Browser-URL on which the tag was fired. Used to prevent accuracy issues in case of strict referrer browser policy. Please don’t change the default value window.location.href

URL

Result of window.location.href call

Implementing the tracking codes

...

(info) More information can be found in the main article about TCFv2.

Name (JS code)

Name (img code)

Explanation

Format

Example

gdpr

gdpr

not set : TCFv2.0 not implemented
0: GDPR does not apply
1: GDPR applies

Numeric: # (0 or 1)

gdpr=1

gdprConsent

gdpr_consent

Only meaningful if gdpr=1. URL-safe base64-encoded TC string obtained from the CMP JS API or OpenRTB. Must contain the consent for Vendor ID of the advertiser or for Vendor ID 871 (Ingenious Vendor ID) as default

Base64-encoded string

gdpr_consent=CO7KqXfO7KqXfCVAAAENAwCMAP_AAH_AAAAAGLtV_T9fb2vj-_Z99_tkeYwf95y3p-wzhheMs-8NyZeH_B4Wv2MyvBX4JiQKGRgksjLBAQdtHGlcTQgBwIlViTLMYk2MjzNKJrJEilsbO2dYGD9Pn8HT3ZCY70-vv__7v3ff_3gYu1X9P19va-P79n33-2R5jB_3nLen7DOGF4yz7w3Jl4f8Hha_YzK8FfgmJAoZGCSyMsEBB20caVxNCAHAiVWJMsxiTYyPM0omskSKWxs7Z1gYP0-fwdPdkJjvT6-___u_d9__eAAA.IGLtV_T9fb2vj-_Z99_tkeYwf95y3p-wzhheMs-8NyZeH_B4Wv2MyvBX4JiQKGRgksjLBAQdtHGlcTQgBwIlViTLMYk2MjzNKJrJEilsbO2dYGD9Pn8HT3ZCY70-vv__7v3ff_3g