Applicable to SA3.0.5 and above.
This feature is controlled by a separate license. Please contact your account manager if you require it.
If your app is running ad campaigns overseas to acquire new users, and you want to retrieve aggregated ad data (such as impressions, clicks, and cost) from overseas advertising platforms into the Sensors Data platform, you can use this feature.
Overview
It supports integration with Tiktok Ads, enabling the retrieval of ad-level data such as impressions, clicks, and cost via its OpenAPI. The retrieved data is then stored in Sensors Data as events, allowing for analysis within the analytics model. It can also be correlated with downstream user behavior data for further analysis.
|
Interface
|
Data granularity
|
Update frequency
|
Attribution
|
Cost
|
Impressions
|
Clicks
|
Conversions
|
|---|---|---|---|---|---|---|---|
| Marketing API | Aggregated data | Daily | ✅ | ✅ | ✅ | ✅ |
Feature Entry
Channel Tracking > Third-Party Data Integration > Advertising > Tiktok Ads
Instructions
Tiktok Ads Data Explanation
It supports retrieving ad data via the TikTok Ads Marketing API, including data from 5 templates. For API details, please refer to the TikTok Ads API Official Documentation.
The built-in template covers commonly used advertising metrics and dimensions.
- Campaign Template: Ad data at the Campaign level.
| metrics |
|
| group by |
|
- Ad Group Template: Ad data at the Ad Group level.
| metrics |
|
| group by |
|
- Ad Template: Ad data at the Ad level.
| metrics |
|
| group by |
|
- Country Template: Ad data at the Region level.
| metrics |
|
| group by |
|
- Country Template: Ad data at the Region level.
| metrics |
|
| group by |
|
- Keyword Template: Ad data at the Keyword level.
| metrics |
|
| group by |
|
Preparation Before Integration
You need to complete authorization and authentication with Tiktok Ads before you can retrieve ad data through the Tiktok Ads API. For details, please refer to the official documentation: TikTok Ads API Official Documentation.
-
Register a TikTok for Business account
-
Register a TikTok for Business Developers account
-
Complete the developer registration process (business information required; review takes 1-2 business days)
-
In the Developer Portal, click My Apps → Create New
-
Configure app information:
-
Application name: App name (e.g., "Sensors Data Integration")
-
App Description: App description
-
Callback Address: Authorization callback address (you can enter any address initially; replace it later with the data receiving URL provided in the Sensors Analytics product)
-
Scope of Permission: Required permissions include Reporting and Ads Management
-
-
Submit for review and wait for the status to change to Approved (1-2 business days)
-
Obtain the App ID and Secret
-
In the TikTok Business Center, go to the user list, select Grant Permissions, and assign the advertiser accounts from which you intend to pull advertising data to an existing user
-
Record the Advertiser ID of the accounts from which you need to pull data
Configure Meta Ads Integration
The configuration mainly includes the following three parts:
1. Basic Information
2. Authorization Configuration
-
- The fields in this section are primarily used for authentication with Tiktok Ads and to specify the scope of ad accounts to be retrieved. Please refer to the "Preparation Before Integration" section in the previous paragraph to obtain the relevant fields from the Tiktok Ads platform.
- A maximum of 100 Tiktok Ads accounts are supported per integration plan. If you have more than 100 Tiktok Ads accounts, multiple integration plans can be created.
3. Data Retrieval Configuration
After clicking "Confirm Creation," you need to complete the authorization process with Tiktok Ads. The authorization process includes the three steps.
Clicking the blue "Go to Authorization" link to be redirected to the Tiktok Ads authorization page. Log in with your Tiktok account. (Note that you need to log in with the Tiktok account that created your Tiktok Business manager account).
After login with your Tiktok account and confirm authorization, select "Authorization Completed" in the Sensors Data pop-up window. If the authorization fails, an error message will be displayed.
Once the plan is successfully created, Tiktok Ads data will be retrieved daily according to the template content.
Data Retrieval
Data retrieval is supported, you can select a time period of up to 180 days to retrieve ad data.
Data Storage Instructions
The retrieved Tiktok Ads data will be uniformly stored as events. The original fields will be standardized and stored as attributes prefixed with "sensors_ad".
Note:This data will be counted against your event quota.
These events will use a fixed value as their user identifier, effectively representing a virtual user.
The events corresponding to different templates are as follows:
Campaign template: tiktok_ads_campaign
Ad Group template：tiktok_ads_adgroup
Ad template：tiktok_ads_ad
Country template: tiktok_ads_country
Keyword template: tiktok_ads_keyword
The following lists some common raw data and their corresponding event properties:
| Original field | Event properties |
|---|---|
| advertiser_id | sensors_ad_customer_id |
| advertiser_name | sensors_ad_customer_name |
| advertiser_timezone | sensors_ad_customer_timezone |
| campaign_id | sensors_ad_campaign_id |
| campaign_name | sensors_ad_campaign_name |
| adgroup_id | sensors_ad_ad_group_id |
| adgroup_name | sensors_ad_ad_group_name |
| ad_id | sensors_ad_ad_id |
| ad_name | sensors_ad_ad_name |
| search_keyword | sensors_ad_search_keyword |
| country_code | sensors_ad_country_code |
| stat_time_day | sensors_ad_date |
| currency | sensors_ad_currency |
| spend | sensors_ad_metrics_cost |
| impressions | sensors_ad_metrics_impressions |
| clicks | sensors_ad_metrics_clicks |
| ctr | sensors_ad_metrics_ctr |
| conversion | sensors_ad_metrics_conversions |
| app_install | sensors_ad_metrics_installs |
How to Analyze
You can select the corresponding event in Event Analysis to analyze metrics such as Tiktok Ads impressions, clicks, and cost.
Permissions
By default, administrators can configure Tiktok Ads integration plans. They can also assign permissions for configuring and viewing plans to standard users.