TikTok Ads Cloud Mode Integration

RudderStack lets you send your event data to TikTok Ads via cloud mode.

Note that:

• This integration supports both Events 1.0 and Events 2.0 API for sending events to TikTok. RudderStack recommends using the Events 2.0 API to send your events as TikTok will sunset the Events 1.0 API by the second half of 2024.
• To send custom events to TikTok Ads using RudderStack Open Source, use rudder-transformer v1.52.0 or later.

Find the open source transformer code for this destination in the GitHub repository.

Track

Use the track call to capture user events along with the associated properties.

A sample track call is shown below:

rudderanalytics.track("Order Completed", {
  checkout_id: "12345",
  order_id: "1234",
  affiliation: "Apple Store",
  total: 20,
  revenue: 15.0,
  shipping: 22,
  tax: 1,
  discount: 1.5,
  coupon: "ImagePro",
  currency: "USD",
  contentType: "product",
  products: [{
      product_id: "123",
      sku: "G-32",
      name: "Monopoly",
      price: 14,
      quantity: 1,
      category: "Games",
      url: "https://www.website.com/product/path",
      image_url: "https://www.website.com/product/path.jpg",
    },
    {
      product_id: "345",
      sku: "F-32",
      name: "UNO",
      price: 3.45,
      quantity: 2,
      category: "Games",
    },
  ],
})

Event mapping

This destination does not strictly adhere to the RudderStack Ecommerce Event Spec.

You can use the Event mapping settings in the dashboard to map your events to the below TikTok standard events:

Legacy standard events

TikTok has updated its standard events. The RudderStack dashboard marks the following events as (Legacy) in the event mapping dropdown and lists them at the end:

Important considerations

• Existing mappings to legacy events keep working and need no changes. For new mappings, use the replacement events.
• TikTok does not carry historical data for a legacy event over to its replacement event.

Note that RudderStack automatically maps the following standard ecommerce events to the corresponding TikTok standard events:

To send Checkout Step Completed or Order Completed as Purchase, map the event to Purchase in the Event mapping settings. Your mapping takes precedence over the default mapping above.

Property mapping

RudderStack maps the following optional event properties to the corresponding TikTok Ads fields:

For TikTok event matching, context.userAgent must contain the original end-user browser user agent string.

Do not pass a server, proxy, CDN, or other infrastructure user agent, for example, Amazon CloudFront, because these values are not useful for event matching.

FAQ

I see a 40002 response code with ‘No permission to operate pixel code’ error message, what can I do?

This error code is related to the authentication of your TikTok account. For more information, refer to the TikTok documentation.