Tiktok Ads Connector

Intro

Tiktok is a social media platform for creating, sharing, and discovering short music videos. It acts like a Karaoke for the digital age. It also has the standard features like direct messages and the option to “like” videos, that you would expect from a social network application. Use Domo’s TikTok Ads connector to get the most out of your TikTok data. To learn more about the TikTok API, visit their page (https://developers.tiktok.com/doc/tiktok-api-v2-introduction/).

You connect to your TikTok account in the Data Center. This topic discusses the fields and menus that are specific to the TikTok Ads connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in Adding a DataSet Using a Data Connector.

Prerequisites

To connect to your TikTok account and create a TikTok Ads DataSet, you must have your TikTok account credentials.

You can select your time zone when you sign up for TikTok Ads Manager and create an account.

Note:

• Once you select your time zone during the account registration process, you cannot change it later. The Daylight saving time is not supported in Ads Manager.
  To find your selected time zone:

  1. On your TikTok Ads Manager dashboard, select your account name on the top-right corner, a drop-down menu appears. The blue card pinned on the top of the drop-down menu is the account you are currently using.
  2. Select the “Ad Account Settings” icon to the right of the account information. Under your Basic Information, you will find your Time Zone. For more information refer, About Time Zone.

• Ensure that the timezone selected on the Tiktok Ads Manager account matches your Domo Account’s Timezone in order to get the real-time updated data.

Connecting to Your TikTok Account

This section enumerates the options in the Credentials and Details panes in the TikTok Ads Connector page. The components of the other panes in this page, Scheduling and Name & Describe Your DataSet, are universal across most connector types and are discussed in greater length in Adding a DataSet Using a Data Connector.

Credentials Pane

The Domo TikTok Ads connector uses OAuth to connect, so there is no need to enter credentials within Domo. Click Connect (or select Add Account if you have existing TikTok accounts in Domo) to open the TikTok OAuth screen where you can enter your TikTok credentials. Once you have entered valid TikTok credentials, you can use the same account any time you go to create a new TikTok Ads DataSet. You can manage connector accounts in the Accounts tab in the Data Center. For more information about this tab, see Managing User Accounts for Connectors.

Note: If you are already logged into TikTok when you connect in Domo, you are authenticated automatically when you click Add account. If you want to connect to an account that is different from the one you are logged into, you must first log out of that TikTok account.

Details Pane

This pane contains a primary Reports menu, along with various other menus which may or may not appear depending on the report type you select.

Note: The following reports are deprecated because a new report/endpoint is created to retrieve the data they were used for:

• Ad Performance
• Ad Group Performance
• Advertiser Performance
• Campaign Performance

The following reports replaced the above reports:

• Performance report
• Ad Audience

Menu	Description
Report	Select the TikTok Ads report you want to run. The following reports are available:
Report Level	Select which level of audience data to retrieve.
Advertisers Selection	Select how you want to input the advertisers.
Ad Service Type	Select the ad service type.
Data Level	Select the data level.
Advertisers Selection	Select how you want to input the advertisers.
Advertiser ID	Select the Advertiser ID(s) for which the data is to be fetched.
Fields	Select the fields to retrieve.
ID Dimension	Select if you would like to group data by ID dimension.
Time Dimension	Select whether daily or hourly data.
Metrics	Select the metrics to retrieve.
Time Granularity	Select whether to get daily or hourly data.
Dimensions	Select the dimensional grouping according to which the data to be retrieved.
Date Selection	Select the date format for your data.
Single Date	Select whether the report data is for a specific date or for a relative number of days back from today.
Specific Date	Select the specific date using the date selector.
Relative Date	Enter the number of days back that you would like to get data for in the Days Back field. Specify either today or 0, yesterday or 1, or today-7 or 7 to get data for 7 days into the past.
Date Range	Select the specific or relative date range.
Start Date - Specific	Select the first date in your date range using the date selector.
End Date - Specific	Select the last date in your date range using the date selector.
Start Date - Relative	Enter the number of days back that you would like to get data from (start day). Combine with End Date to create a range of represented days. For example, if you entered 10 for Start Date and 5 for End Date, the report would contain data for 10 days ago up until 5 days ago.
End Date - Relative	Enter the number of days back that you would like to get data to (end day). Combine with Start Date to create a range of represented days. For example, if you entered 10 for Start Date and 5 for End Date, the report would contain data for 10 days ago up until 5 days ago.
Time Period	Specify the time period that you would like to receive data for.
Starting Day of the Week	Select the day you would like your week to start with.

Other Panes

For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see Adding a DataSet Using a Data Connector.

Troubleshooting

Why there are issues with aliasing the column names associated with the metrics?

The new TikTok API version (v1.3) has renamed multiple metric names that we have been using since v1.1. When both metrics from a pair are used in a dataset, this causes issues with aliasing the column names associated with these metrics. To avoid these problems, if both measures from a pair with the same new name are utilized in the same dataset, the second metric in the pair is ignored.

Metric 1	Metric 2 (metric to be ignored if both metric 1 and metric 2 are used)	Shared New Name
active_register	time_attr_active_register	registration
active_register_cost	time_attr_active_register_cost	cost_per_registration
active_register_rate	time_attr_active_register_rate	registration_rate
active_pay	time_attr_active_pay	purchase
active_pay_cost	time_attr_active_pay_cost	cost_per_purchase
active_pay_rate	time_attr_active_pay_rate	purchase_rate
active_register_show	time_attr_active_register_show	vta_registration
active_register_show_cost	time_attr_active_register_show_cost	cost_per_vta_registration
active_pay_show	time_attr_active_pay_show	vta_purchase
active_pay_show_cost	time_attr_active_pay_show_cost	cost_per_vta_purchase
active_register_click	time_attr_active_register_click	cta_registration
active_register_click_cost	time_attr_active_register_click_cost	cost_per_cta_registration
active_pay_click_cost	time_attr_active_pay_click_cost	cost_per_cta_purchase
active_pay_click	time_attr_active_pay_click	cta_purchase

Customers migrating to the new version of the connector that have a pair of metrics in their dataset that share a new name should expect the column name given by the API for the metric from the Metric 2 column in the table above to be missing after migration.

Customers should also expect if their dataset contains a metric from the table above from the Metric 2 column and doesn’t also contain the corresponding metric from the “Metric 1” column, that the column name that will appear in their data will be the same as the one used for the metric in the “Metric 1” column that it shares a new name with.

Some metrics do not have the same name, yet version 1.2 of the API returns the same column name for them. This affects the column aliasing of legacy datasets that use the BasicPerformance report in particular. If both measures in the pair are utilized in the same dataset, the same problem as described above occurs.

Following are the metrics list:

Metric 1	Metric 2	Shared Returned Column Name
add_billing	total_add_payment_info	Total Add Payment Info
cost_per_registration	cost_per_total_registration	Cost per Registration
total_app_event_add_to_cart_value	total_web_event_add_to_cart_value	Total Add to Cart Value
cost_per_total_app_event_add_to_cart	cost_per_web_event_add_to_cart	Cost per Add to Cart
value_per_total_app_event_add_to_cart	value_per_web_event_add_to_cart	Value per Add to Cart
cost_per_product_details_page_browse	cost_per_total_view_content	Cost per View Content
value_per_product_details_page_browse	value_per_total_view_content	Value per View Content
cost_per_purchase	cost_per_total_purchase	Cost per Purchase
cost_per_search	cost_per_total_search	Cost per Search
product_details_page_browse	total_view_content	Total View Content
total_product_details_page_browse_value	total_view_content_value	Total View Content Value
total_subscribe	on_web_subscribe	Total Subscribe
total_subscribe_value	total_on_web_subscribe_value	Total Subscribe Value
value_per_total_subscribe	value_per_on_web_subscribe	Value per Subscribe
cost_per_total_subscribe	cost_per_on_web_subscribe	Cost per Subscribe

To resolve this issue the metrics in the Metric 2 column will not be aliased. Consequently, the customers migrating to the new version of the connector should expect their column name for these two metrics to change.

I created my datasets and used to have data in the certain columns. Now those columns are blank, and I can’t select them as metrics in the dataset. What happened?

TikTok recently announced that it will only support v1.3 of its API, and will no longer support v1.1 and v1.2. Some metrics that were available in v1.1 and v1.2 are no longer available in v1.3. In order to receive continued support from TikTok when necessary, Domo has upgraded its connector to use v1.3, so any unsupported legacy metrics will no longer be selectable in the connector details section. Additionally, datasets that use some of the legacy metrics will have blank values in the columns corresponding to those metrics.

The following is list of metrics available in v1.1, the corresponding v1.2 metric, and the corresponding column name used in any dataset that pulled these metrics that are no longer available in v1.3 of the API.

Selectable v1 Metric	Selectable v2 Metric	Corresponding column name in Dataset
time_attr_active_register	active_register	registration
time_attr_active_register_cost	active_register_cost	cost_per_registration
time_attr_active_register_rate	active_register_rate	registration_rate
time_attr_active_pay	active_pay	purchase
time_attr_active_pay_cost	active_pay_cost	cost_per_purchase
time_attr_active_pay_rate	active_pay_rate	purchase_rate
time_attr_active_register_show	active_register_show	vta_registration
time_attr_active_register_show_cost	active_register_show_cost	cost_per_vta_registration
time_attr_active_pay_show	active_pay_show	vta_purchase
time_attr_active_pay_show_cost	active_pay_show_cost	cost_per_vta_purchase
time_attr_active_register_click	active_register_click	cta_registration
time_attr_active_register_click_cost	active_register_click_cost	cost_per_cta_registration
time_attr_active_pay_click_cost	active_pay_click_cost	cost_per_cta_purchase
time_attr_active_pay_click	active_pay_click	cta_purchase