Parameters are properties that can be paired with any event to impact campaign performance. Certain parameters are required for ad spend reporting or products like Video Shopping Ads and Value Optimization, while others are highly recommended to improve performance.
Refer to the description below to see examples of how parameters can be used. For more information about implementing parameters, please review our developer documentation.
Parameter name | Content Properties | Description | Value type | JavaScript | Required for Return on Ad Spend (ROAS) | Required for Video Shopping Ads | Required for Value-based Optimization (VBO) |
---|---|---|---|---|---|---|---|
content_type | The content_type object property's value must be set to either "product", or "product_group." If you use sku_id as content_id, use "product", if you use item_group_id as content_id, use "product_group". This field is required for VSA. | Must be either 'product' or 'product_group' | { "content_type" : "product" } | ✅ | |||
contents | A list of content objects that represent relevant products in a web event with product information. | Must be an array of objects | { contents: [ { content_id: '301', content_name: 'dress', quantity: 1, price: 8, }, { content_id: '401', content_name: 'dress', quantity: 1, price: 1.2, }], content_type:'product', value: 9.2, currency: 'USD'} | ✅ | ✅ | ||
content_id | Unique ID of the product or content. Recommend using sku id or item_group_id, this should match the sku_id or item_group_id you set up in the catalog (if available) This field is required for VSA | string | { "content_id" : "401" } | ✅ | |||
price | The price of the item. Note: Price is the price for a single item, and value is the total price of the order. For example, if you have two items each sold for $10, the price parameter would pass 10 and the value parameter would pass 20. | number | { "price" : 25 } | ✅ | |||
quantity | The number of the item. | number | { "quantity" : 4 } | ✅ | |||
content_name | Name of the page/product. | string | { "content_name" : "shirt" } | ||||
content_category | Category of the page/product. | string | { "content_category" : "apparel" } | ||||
currency | ISO 4217 code. Examples: "EUR", "USD", "JPY"
List of currencies currently supported: AED, ARS, AUD, BDT, BHD, BIF, BOB, BRL, CAD, CHF, CLP, CNY, COP, CRC, CZK, DKK, DZD, EGP, EUR, GBP, GTQ, HKD, HNL, HUF, IDR, ILS, INR, ISK, JPY, KES, KHR, KRW, KWD, KZT, MAD, MOP, MXN, MYR, NGN, NIO, NOK, NZD, OMR, PEN, PHP, PHP, PKR, PLN, PYG, QAR, RON, RUB, SAR, SEK, SGD, THB, TRY, TWD, UAH, USD, VES, VND, ZAR | enum(string) | { "currency" : "USD" } | ✅ | |||
value | Value of the order or items sold. Note: Price is the price for a single item, and value is the total price of the order. For example, if you have two items each sold for ten dollars, the price parameter would pass 10.00 and the value parameter would pass 20.00. Values should always be formatted as an integer or decimal (ex: 10.00) regardless of the location, currency, etc. It cannot contain any currency signs, special characters, letters, or commas. | number | { "value" : 10.00100} | ✅ | ✅ | ||
query | The text string that was input by a user. For instance, if a person searches for a product on your website, you can forward the keyword being searched. If a person enters a coupon code at check out, you can forward the code. | string | { "query" : "SAVE10COUPON" } | ||||
description | Description of the item or page. | string | { "description" : "Lightweight cotton" } | ||||
status | Status of an order, item, or service. Note: Depending on your use of 'status', Events API may be required in order to share status changes to TikTok. | string | { "status" : "submitted" } |
AED, ARS, AUD, BDT, BHD, BIF, BOB, BRL, CAD, CHF, CLP, CNY, COP, CRC, CZK, DKK, DZD, EGP, EUR, GBP, GTQ, HKD, HNL, HUF, IDR, ILS, INR, ISK, JPY, KES, KHR, KRW, KWD, KZT, MAD, MOP, MXN, MYR, NGN, NIO, NOK, NZD, OMR, PEN, PHP, PKR, PLN, PYG, QAR, RON, RUB, SAR, SEK, SGD, THB, TRY, TWD, UAH, USD, VES, VND, ZAR.
You can set up dynamic values which pass dynamic event-related values to TikTok. Check with your website developer to set up dynamic values for your events in your site code, or you can use TikTok's self-service Event Builder tool to set up dynamic values. By doing so, this dynamic code will automatically determine the correct values of your event, such as the price of purchase, instead of using a set value.
For example, if a visitor lands on your website and adds a book to their cart. Below is what static or set value will look like. For detailed information on how to set up dynamic values with code, see our technical guide.
To make these values dynamic, replace set values with code which will pass correct values like 'book' or '10.0' automatically.
To set up dynamic values with TikTok's self-service Event Builder tool, see our Event Builder guide here.