API parameters
These parameters are valid for all event types and should be included in all ad requests wherever applicable
Global Criteo parameters
criteo-partner-id
criteo-partner-idExample: 12345
Description: The key that corresponds with your specific partner ID within Criteo. This ID will be provided by your technical account manager.
Required: Yes
retailer-visitor-id
retailer-visitor-idExample: 39573958738533503
Description: A unique unauthenticated UserID that is persistent across sessions on the same device. For Android apps, we recommend using the AdvertisingIdClient API, and for iOS, the advertisingIdentifier.
If it is set as a first party cookie, it should be set as a cookie with an expiration date (maximum 13 months) and not as a session cookie. The lifetime of the cookie must be at least 30 days with longer lifetimes being more effective for attribution.
Required: Yes
Why it matters?
This identifier represents the Retailer's first party ID which helps Criteo in mapping user activities across sessions, on same device, even when users are not logged in. It should have a certain minimum lifetime and it is used for tracking and targeting purposes on the Retailer's website - it doesn't bring value on the open Internet.
customer-id
customer-idExample: 9445678
Description: The ID of the authenticated user that is consistent in all logged sessions. It is important that the ID is the same across sessions and devices. The customer ID allows for cross-device attribution by connecting sessions on different devices. You must continue to include a retailer-visitor-id when adding this parameter.
Required: Yes, if the user is logged in.
Why it matters?
Compared to the Retailer Visitor ID for guest users, the Customer ID is used to identify authenticated/logged-in users. This identifier represents a unique user in a client's CRM and it helps us track activities on different devices and to create links between same domain identifiers.
email
emailExample: eb2ddfd95044b8da411dda8828ce123d52ccbc223a75e4f7e550f7188a758ae6
Description: The user’s email address, in SHA256 hash format. Before hashing, email addresses should be
trimmed (i.e. removal of all spaces before and after the email address), cleaned (i.e. removal of comas, semi-colons, quotes or double quotes), and converted to lowercase.
Required: Yes, if discussed with your Criteo team.
Why it matters?
Hashed emails, even though in our other solutions represent a cross domain identifier, in the context of RM Delivery API Onsite integration are purely used for backup attribution. In order for retailers to monetize on their first-party audiences across the open Internet, our RM Offsite solution needs to be integrated and it requires an additional layer of OneTag integration in order to share HEMs.
page-id
page-idExample: viewCategory_API_desktop
Description: The ID of the page provided by your Criteo team.
Required: Yes
regionId
regionIdExample: 42
Description: Store ID selected by the user when browsing the retailer’s site. It should match the store IDs in the product feed. See more details here.
Required: Yes, if Store IDs are defined in the product feed.
implementation
implementationExample: S2SAPI
Description: The type of API client used. If you are updating an existing implementation, please check with the Criteo team which value to set.
Required: No, this string indicates which implementation was used and is useful for debugging and monitoring purposes.
json
jsonExample: json
Description: Specify the type of response sent back by the Web Service.
Required: No, only if JSONP is needed.
item-whitelist
item-whitelistExample: 123abc|456def|789ghi
Description: Provides a pre-determined list of SKUs for Criteo to include in the auction (only for sponsored products - not display formats). Used to power recommendation engine placements. Provided that the specific page has been enabled for rec engine by your Technical Account Manager, this parameter will force Criteo to only evaluate this list of SKUs in our auction. If the parameter is left empty or removed, the page will function normally, and Criteo will conduct a standard auction on all eligible products.
Required: Yes, if discussed with your Criteo team.
verbosity
verbosityExamples:
minfull
Description: Change the verbosity level of product objects in the API response. See the delivery API introduction page for examples of both levels of verbosity.
Required: No
European parameters
These parameters are specifically for users in Europe and are related to GDPR compliance.
gdpr
gdprExample: 1
Description: Indicates if GDPR applies to this user. (1: yes, the user is in Europe and GDPR applies; 2: no, the user is outside Europe).
Required: Yes, if using TCFv2 standard.
gdpr_consent
gdpr_consentExample: CAGgAagBEADEAIQAfoBAwCEAFXALqAYEAwgBtAEegJiAXmAyQAA.IGSQJwABAALAAeEAE6ALgAY4A0AB-gEDAIQIA2gCPQEvAJiAT-AZAZI
Description: The encoded TCFv2 consent string.
Required: Yes, if using TCFv2 standard.
block
blockExample: 1
Description: Value "1" is for opt-out users. (Value "0" can also be passed for opt-in users.)
Required: No, only when the user is opt-out and not using the TCFv2 standard.
In-app events
These parameters are specifically applicable for in-app events.
device-id
device-idExample: e4dd94d1-d048-4ad3-92b5-d97e688f724f
Description: A unique and anonymised string of numbers and letters that identifies a mobile device. Please provide GAID (Android) or IDFA (iOS).
Required: Yes, if Offsite is activated.
device-id-type
device-id-typeExample: gaid
Description: Value “gaid” if the identifier provided in device-id parameter is a GAID (Android), value “idfa” if the identifier provided in device-id parameter is an IDFA (iOS).
Required: Yes, if Offsite is activated.
Updated 16 days ago