Tiktok Events Export Integration

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

Overview

Many businesses are increasingly adopting TikTok as a key component of their advertising strategy. With over a billion active users, TikTok offers a vast audience and a unique, creative platform for brand promotion. Integrating event data with TikTok’s Events API can significantly enhance a brand’s advertising effectiveness and scale on the platform.

The native Tiktok Events Export connector for exporting event data to the TikTok Events API simplifies syncing event data to the TikTok Events Manager, driving data-driven audience targeting, and real-time insights for optimization.

This connector provides versatile data sync capabilities:

• Website Event Data:
  • Enrich your website pixel data with server-side data.
  • Achieve more accurate audience targeting, enhancing your campaign’s effectiveness.
• App Event Data:
  • Sync app event data with server-side data.
  • Improve targeting accuracy and optimize your campaign strategies for better results.
• Offline Conversion Data:
  • Send offline conversion data, such as physical store visits, to the TikTok Events API.
  • Track and measure the impact of online ads on offline sales, allowing for more informed campaign adjustments.
• CRM Lead Conversion Data:
  • Export CRM lead conversion data to TikTok Events API.
  • Enhance B2B lead generation campaigns by targeting users who have shown interest in your products or services, optimizing ad spend for higher quality leads.
• Data Validation:
  • Ensure all event data is accurately formatted and validated according to TikTok’s specifications.
  • Streamline the data integration process, reducing the risk of errors and ensuring smooth data sync operations.

Prerequisites

• Basic knowledge of Treasure Data, including the TD Toolbelt.
• Basic knowledge of TikTok Business.
• TikTok Access Token or TikTok Business account.

Limitations:

• This connector can support creating new event source for Web Events and Offline Event source type only.
• Experimental Event Source Types: App Event and CRM Event source types are experimental and not fully supported, as TD cannot enable these event sources for our test accounts. Please report any issues encountered with these event source types so that TD can address and fix them.

Static IP Address of Treasure Data Integration

If your security policy requires IP whitelisting, you must add Treasure Data's IP addresses to your allowlist to ensure a successful connection.

Please find the complete list of static IP addresses, organized by region, at the following link:
https://api-docs.treasuredata.com/en/overview/ip-addresses-integrations-result-workers/

Use the TD Console

Before running your query, you must create and configure the data connection in Treasure Data. As part of the data connection, you provide authentication to access the integration.

Create Authentication

Your first step is to create a new authentication with a set of credentials.

1. Select Integrations Hub.
2. Select Catalog.

3. Search for your Integration in the Catalog; hover over the icon and select Create Authentication.

4. Ensure that the Credentials tab is selected, and then enter credential information for the integration. Choose one of the following:

• OAuth Authentication Workflow

Select the link "Click here" to start the OAuth authentication flow. After completing the authentication, a new OAuth connection will be created and available in the dropdown box

Select Continue to create a new connection.

• Access Token Workflow

Obtain the access token from the TikTok Events Manager and input it in the TikTok Access Token field.

New Authentication Fields

1. Select Continue.
2. Enter a name for your authentication, and select Done.

Define your Query

1. Navigate to Data Workbench > Queries.
2. Select New Query.
3. Run the query to validate the result set.

Specify the Result Export Target

1. Select Export Results.

You can select an existing authentication or create a new authentication for the external service to be used for output. Choose one of the following:

• Use Existing Integration

• Create a New Integration

The connection does not support creating a new connection in the result export. So, you need to have already created the connection.

Configuration guide

1. Specifying the target event source in the Tiktok Event Managers for upload event data.

2. Other configuration options for data sync operations:
   

   Field	Description
   Test Event Code	The TikTok Test Event Code for debug purposes.
   Thread Count Number	Number of parallel requests to TikTok Events. Min: 1, Max: 10, Default: 5.
   Enabled Limited Data Processing	The boolean value to enable/disable a limited data processing option. See Events API 2.0 - Limited Data Use for more details
   Skip on invalid record?	The flag to continue or stop the job when the job handles an invalid record.

(Optional) Other configurations

• You can create an activation in the Audience Studio to export segment data to this integration.
• You can use Scheduled Job with Result Export to periodically upload data to a target destination.

(Optional) Export Integration Using the CLI

You can also use CLI(Toolbelt) to export results to TikTok Events.

You need to specify the information for export to your SFTP server as *--result option of td query* command. About td query command, you can refer to this article.

The format of the option is JSON and the general structure is as follows.

{
  "type": "tiktok_events",
  "auth_method": "oauth",
  "access_token": "78cdexxxen",
  "event_data_source": "WEB",
  "target_event_source_method": "NAME",
  "event_source_name": "Test",
  "advertiser_id": "7373xxx",
  "event_source_id": "CPUI2xxx",
  "test_event_code": "TESTXXX",
  "thread_count": 5,
  "limited_data_use": true,
  "skip_invalid_record": true
}

Parameters

Example for Usage

OAuth authentication

td query \
  --result '{
    "type": "tiktok_events",
    "auth_method": "oauth",
    "access_token": "373xxx",
    "event_data_source": "WEB",
    "target_event_source_method": "NAME",
    "event_source_name": "Test",
    "advertiser_id": "737xxx",
    "event_source_id": "738xxx",
    "thread_count": 5,
    "limited_data_use": false,
    "skip_invalid_record": false
  }' \
  -d sample_datasets \
  "SELECT * FROM www_access" \
  -T presto

Access token authentication

td query \
  --result '{
    "type": "tiktok_events",
    "auth_method": "access_token",
    "access_token": "373xxx",
    "event_data_source": "WEB",
    "target_event_source_method": "ID",
    "event_source_name": "Test",
    "advertiser_id": "737xxx",
    "event_source_id": "738xxx",
    "thread_count": 5,
    "limited_data_use": false,
    "skip_invalid_record": false
  }' \
  -d sample_datasets \
  "SELECT * FROM www_access" \
  -T presto

External references

• Tiktok Events List of Standard Paramaters