TikTok Ads Cloud Mode Integration

Send events to TikTok Ads using RudderStack cloud mode.

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

info

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

warning
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:

List of supported TikTok standard events
  • Add Payment Info
  • Add to Cart
  • Add to Wishlist
  • Click Button
  • Complete Payment
  • Complete Registration
  • Contact
  • Customize Product
  • Download
  • Find Location
  • Initiate Checkout
  • Lead (Beta)
  • Place an Order
  • Purchase (Beta)
  • Schedule
  • Search
  • Submit Form
  • Subscribe
  • View Content

warning

TikTok has recently updated the following standard events:

  • Submit Form is renamed to Lead.
  • Complete Payment is renamed to Purchase.

Although TikTok still supports the old events (Submit Form and Complete Payment), RudderStack recommends using the new events (Lead and Purchase) to avoid any issues.

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

RudderStack eventTikTok Ads event
Product Added to WishlistAdd to Wishlist
Product AddedAdd to Cart
Checkout StartedInitiate Checkout
Payment Info EnteredAdd Payment Info
Checkout Step CompletedComplete Payment
Order CompletedPlace an Order

Property mapping

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

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.



Questions? Contact us by email or on Slack