# TikTok Ads (v1) Information note **TikTok Ads extraction is supported by Stitch** This integration is powered by [Singer's](https://www.singer.io/) tiktok-ads tap and certified by Stitch. [Check out and contribute to the repo on GitHub](https://github.com/singer-io/tap-tiktok-ads). For support, contact [Support](https://community.qlik.com/t5/Support/ct-p/qlikSupport). ## TikTok Ads integration summary Stitch’s TikTok Ads integration replicates data using the [TikTok Ads API (v1.3)](https://ads.tiktok.com/marketing_api/docs). Refer to the [Schema](https://help.qlik.com/en-US/stitch/integrations/saas/tiktok-ads#schema) section for a list of objects available for replication. ## TikTok Ads feature snapshot A high-level look at Stitch's TikTok Ads (v1) integration, including release status, useful links, and the features supported in Stitch. | **STITCH** | | | | | --- | --- | --- | --- | | **[Release status](https://help.qlik.com/en-US/stitch/integrations/identify-an-integration-version)** | Released on February 9, 2023 | **Supported by**

the Info icon

Indicates if the integration is supported by Stitch or the Singer community. | [Stitch](https://community.qlik.com/t5/Support/ct-p/qlikSupport) | | **Stitch plan**

the Info icon

The type of Stitch plan required to use the integration. | Standard | **[API availability](https://help.qlik.com/en-US/stitch/developers/stitch-connect/guides/source-destination-reference)**

the Info icon

Indicates if the integration is available as a source in Stitch Connect. | the Success icon

This version of the integration is available via the API.

Available | | **Singer GitHub repository** | [singer-io/tap-tiktok-ads](https://github.com/singer-io/tap-tiktok-ads) | | | | **REPLICATION SETTINGS** | | | | | **[Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling)**

the Info icon

A type of replication scheduling where an integration's Replication Frequency is anchored to a time you select. | the Success icon

This feature is supported for this version of the integration.

Supported | **[Advanced Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling)**

the Info icon

A type of replication scheduling that allows you to specify granular start times for data extraction using cron expressions. | the Success icon

This feature is supported for this version of the integration.

Supported | | **Table-level reset**

the Info icon

Indicates if data can be reset at the table level. If unsupported, data can only be reset at the integration level. | the Remove icon

Table-level resets are not supported for this integration. Resets are only supported at the integration level.

Unsupported | **[Configurable Replication Methods](https://help.qlik.com/en-US/stitch/replication/replication-methods)**

the Info icon

Indicates if Replication Methods can be defined by you for tables in the integration. | the Remove icon

Configurable Replication Methods are not supported for this integration. Stitch will use pre-defined replication methods for tables you set to replicate.

Unsupported | | **DATA SELECTION** | | | | | **Table selection**

the Info icon

The ability to select individual tables for replication in the Stitch interface. If table selection is unavailable, all tables and all the columns they contain will be set to replicate by default. | the Success icon

This feature is supported for this version of the integration.

Supported | **Column selection**

the Info icon

The ability to select individual columns for replication in the Stitch interface. If column selection is unavailable, all columns will be set to replicate by default. | the Success icon

This feature is supported for this version of the integration.

Supported | | **Select all**

the Info icon

Indicates if the integration supports selecting all available tables and columns. | the Success icon

Supported

Supported | | | | **TRANSPARENCY** | | | | | **[Extraction Logs](https://help.qlik.com/en-US/stitch/replication/extractions/integration-extraction-logs)**

the Info icon

Logs detailing the Extraction phase of the replication process for a given integration. Includes error info, should an error occur. | the Success icon

This feature is supported for this version of the integration.

Supported | **[Loading Reports](https://help.qlik.com/en-US/stitch/replication/integration-loading-reports)**

the Info icon

Reports detailing the Loading phase of the replication process for a given integration. Includes the number of rows loaded for each table and error info, should an error occur. | the Success icon

This feature is supported for this version of the integration.

Supported | ## Connecting TikTok Ads ### TikTok Ads setup requirements To set up TikTok Ads in Stitch, you need: * **Access to a TikTok Ads account.** This is necessary to login to the Ad Manager account. * **Access to a TikTok Ads Ad Manager account.** Verify that you have access to use the Ad accounts you want to replicate data from. This is necessary to connect to Stitch. ### Step 1: Add TikTok Ads as a Stitch data source 1. [Sign into your Stitch account](https://app.stitchdata.com/). 2. On the Stitch Dashboard page, click the **Add Integration** button. 3. Click the **TikTok Ads** icon. 4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination. For example, the name “Stitch TikTok Ads” would create a schema called `stitch_tiktok_ads` in the destination. **Note**: Schema names cannot be changed after you save the integration. 5. Check the **include\_deleted** box to have Stitch replicate data from deleted campaigns, ads, and adgroups. ### Step 2: Define the historical replication start date The Sync Historical Data setting defines the starting date for your TikTok Ads integration. This means that data **equal to or newer than this date** will be replicated to your data warehouse. Change this setting if you want to replicate data beyond TikTok Ads’s default setting of **1 year**. For a detailed look at historical replication jobs, check out the [Syncing Historical SaaS Data](https://help.qlik.com/en-US/stitch/replication/syncing-historical-saas-data-resetting-replication-keys) guide. ### Step 3: Create a replication schedule Information note Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the [Replication Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling) documentation for more information. In the **Replication Frequency** section, you’ll create the integration’s [replication schedule](https://help.qlik.com/en-US/stitch/replication/replication-scheduling). An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins. TikTok Ads integrations support the following replication scheduling methods: * [Replication Frequency](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/replication-frequency) * [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling) * [Advanced Scheduling using Cron](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling) (Advanced or Premium plans only) To keep your row usage low, consider setting the integration to replicate less frequently. See the [Understanding and Reducing Your Row Usage guide](https://help.qlik.com/en-US/stitch/getting-started/understanding-stitch-usage) for tips on reducing your usage. ### Step 4: Authorize Stitch 1. Next, you’ll be prompted to log into your TikTok account and approve Stitch’s access to your TikTok Ads data. **Note that we will only ever read your data.** 2. Click **Sign in with TikTok** to connect. 3. Sign in with your TikTok account. 4. After your credentials are validated, you’ll be directed back to Stitch and prompted to select the TikTok Ads accounts you want to for which you want to run extractions. 5. When finished, click **Check and Save**, then click **All Done**. ### Step 5: Set objects to replicate Information note **Is an object missing or not replicating?** Verify that the object meets the requirements for [selection](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#selection-requirements) and [replication](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#replication-requirements). The last step is to select the tables and columns you want to replicate. [Learn about the available tables for this integration.](https://help.qlik.com/en-US/stitch/integrations/saas/tiktok-ads#schema) **Note**: If a replication job is currently in progress, new selections won’t be used until the next job starts. * Selection options * Individual tables and columns * All tables and columns For TikTok Ads integrations, you can select: 1. **Individual tables and columns** 2. **All tables and columns** Click the tabs to view instructions for each selection method. 1. In the integration’s **Tables to Replicate tab**, locate a table you want to replicate. 2. To track a table, click the **checkbox** next to the table’s name. A blue checkmark means the table is set to replicate. 3. To track a column, click the **checkbox** next to the column’s name. A blue checkmark means the column is set to replicate. 4. Repeat this process for all the tables and columns you want to replicate. 5. When finished, click the **Finalize Your Selections** button at the bottom of the screen to save your selections. Information note **Important**: Using the **Select All** feature will overwrite any previous selections. However, selections aren’t final until **Finalize Your Selections** is clicked. Clicking **Cancel** will restore your previous selections. Refer to the [Select All guide](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#set-all-data-to-replicate) for more info about this feature. 1. Click into the integration from the Stitch Dashboard page. 2. Click the **Tables to Replicate** tab. 3. In the list of tables, click the box next to the **Table Names** column. 4. In the menu that displays, click **Track all Tables and Fields**: ![The Track all Tables and Fields menu in the Tables to Replicate tab](https://help.qlik.com/en-US/stitch/images/replication/select-all-tables-menu.png)The Track all Tables and Fields menu in the Tables to Replicate tabThe Track all Tables and Fields menu in the Tables to Replicate tab 5. Click the **Finalize Your Selections** button at the bottom of the page to save your data selections. ### Initial and historical replication jobs After you finish setting up TikTok Ads, its **Sync Status** may show as **Pending** on either the Stitch Dashboard or in the Integration Details page. For a new integration, a **Pending** status indicates that Stitch is in the process of scheduling the initial replication job for the integration. **This may take some time to complete.** Information note **Initial replication jobs with Anchor Scheduling** If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling#job-scheduling-and-anchor-times) documentation for more information. #### Free historical data loads The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota. Information note **Replication will continue after the seven days are over**. If you’re no longer interested in this source, be sure to **pause** or **delete** the integration to prevent unwanted usage. ## TikTok Ads table reference Information note **Schemas and versioning** Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing. The schema and info displayed below is for **version 1** of this integration. This is the latest version of the TikTok Ads integration. Information note **Table and column names in your destination** Depending on your destination, table and column names may not appear as they are outlined below. For example: Object names are lowercased in Redshift (`CusTomERs` > `customers`), while case is maintained in PostgreSQL destinations (`CusTomERs` > `CusTomERs`). Refer to the [Loading Guide](https://help.qlik.com/en-US/stitch/replication/loading/destination-guides) for your destination for more info. ### ad\_insights | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Keys ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | ad\_id

adgroup\_id

advertiser\_id

campaign\_id

stat\_time\_day | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | stat\_time\_day | | **Useful links** | [TikTok Ads documentation](https://ads.tiktok.com/marketing_api/docs?id=1707957200780290 "Opens in new tab: TikTok Ads documentation")

[ad_insights schema on GitHub](https://github.com/singer-io/tap-tiktok-ads/tree/master/tap_tiktok_ads/schemas/ad_insights.json "Opens in new tab: ad_insights schema on GitHub") | ad\_insights table schema | **ad\_id**

STRING | | --- | | **ad\_name**

STRING | | **ad\_text**

STRING | | **adgroup\_id**

STRING | | **adgroup\_name**

STRING | | **advertiser\_id**

STRING | | **app\_promotion\_type**

STRING | | **average\_video\_play**

NUMBER | | **average\_video\_play\_per\_user**

NUMBER | | **bid**

STRING | | **bid\_strategy**

STRING | | **billing\_event**

STRING | | **budget**

STRING | | **call\_to\_action**

STRING | | **campaign\_budget**

STRING | | **campaign\_dedicate\_type**

STRING | | **campaign\_id**

STRING | | **campaign\_name**

STRING | | **clicks**

INTEGER | | **clicks\_on\_music\_disc**

INTEGER | | **comments**

INTEGER | | **conversion**

INTEGER | | **conversion\_rate**

NUMBER | | **conversion\_rate\_v2**

NUMBER | | **cost\_per\_1000\_reached**

STRING | | **cost\_per\_100\_reached**

NUMBER | | **cost\_per\_conversion**

NUMBER | | **cost\_per\_result**

NUMBER | | **cost\_per\_secondary\_goal\_result**

NUMBER | | **cpc**

NUMBER | | **cpm**

NUMBER | | **ctr**

NUMBER | | **dpa\_target\_audience\_type**

STRING | | **follows**

INTEGER | | **frequency**

NUMBER | | **gross\_impressions**

STRING | | **image\_mode**

STRING | | **impressions**

INTEGER | | **is\_smart\_creative**

BOOLEAN | | **likes**

INTEGER | | **mobile\_app\_id**

STRING | | **objective\_type**

STRING | | **opt\_status**

STRING | | **placement\_type**

STRING | | **profile\_visits**

INTEGER | | **profile\_visits\_rate**

NUMBER | | **promotion\_type**

STRING | | **reach**

INTEGER | | **real\_time\_conversion**

INTEGER | | **real\_time\_conversion\_rate**

NUMBER | | **real\_time\_conversion\_rate\_v2**

NUMBER | | **real\_time\_cost\_per\_conversion**

NUMBER | | **real\_time\_cost\_per\_result**

NUMBER | | **real\_time\_result**

INTEGER | | **real\_time\_result\_rate**

NUMBER | | **result**

INTEGER | | **result\_rate**

NUMBER | | **secondary\_goal\_result**

INTEGER | | **secondary\_goal\_result\_rate**

NUMBER | | **shares**

INTEGER | | **smart\_target**

STRING | | **spend**

NUMBER | | **split\_test**

STRING | | **stat\_time\_day**

DATE-TIME | | **tt\_app\_id**

STRING | | **tt\_app\_name**

STRING | | **video\_play\_actions**

INTEGER | | **video\_views\_p100**

INTEGER | | **video\_views\_p25**

INTEGER | | **video\_views\_p50**

INTEGER | | **video\_views\_p75**

INTEGER | | **video\_watched\_2s**

INTEGER | | **video\_watched\_6s**

INTEGER | ### ad\_insights\_by\_age\_and\_gender | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Keys ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | ad\_id

adgroup\_id

advertiser\_id

age

campaign\_id

gender

stat\_time\_day | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | stat\_time\_day | | **Useful links** | [TikTok Ads documentation](https://ads.tiktok.com/marketing_api/docs?id=1707957217727489 "Opens in new tab: TikTok Ads documentation")

[ad_insights_by_age_and_gender schema on GitHub](https://github.com/singer-io/tap-tiktok-ads/tree/master/tap_tiktok_ads/schemas/ad_insights_by_age_and_gender.json "Opens in new tab: ad_insights_by_age_and_gender schema on GitHub") | ad\_insights\_by\_age\_and\_gender table schema | **ad\_id**

STRING | | --- | | **ad\_name**

STRING | | **ad\_text**

STRING | | **adgroup\_id**

STRING | | **adgroup\_name**

STRING | | **advertiser\_id**

STRING | | **age**

STRING | | **bid**

STRING | | **bid\_strategy**

STRING | | **billing\_event**

STRING | | **budget**

STRING | | **call\_to\_action**

STRING | | **campaign\_budget**

STRING | | **campaign\_dedicate\_type**

STRING | | **campaign\_id**

STRING | | **campaign\_name**

STRING | | **clicks**

INTEGER | | **conversion**

INTEGER | | **conversion\_rate**

NUMBER | | **conversion\_rate\_v2**

NUMBER | | **cost\_per\_conversion**

NUMBER | | **cost\_per\_result**

NUMBER | | **cpc**

NUMBER | | **cpm**

NUMBER | | **ctr**

NUMBER | | **dpa\_target\_audience\_type**

STRING | | **gender**

STRING | | **gross\_impressions**

STRING | | **impressions**

INTEGER | | **is\_smart\_creative**

BOOLEAN | | **mobile\_app\_id**

STRING | | **objective\_type**

STRING | | **opt\_status**

STRING | | **promotion\_type**

STRING | | **real\_time\_conversion**

INTEGER | | **real\_time\_conversion\_rate**

NUMBER | | **real\_time\_conversion\_rate\_v2**

NUMBER | | **real\_time\_cost\_per\_conversion**

NUMBER | | **real\_time\_cost\_per\_result**

NUMBER | | **real\_time\_result**

INTEGER | | **real\_time\_result\_rate**

NUMBER | | **result**

INTEGER | | **result\_rate**

NUMBER | | **rf\_campaign\_type**

STRING | | **smart\_target**

STRING | | **spend**

NUMBER | | **split\_test**

STRING | | **stat\_time\_day**

DATE-TIME | | **tt\_app\_id**

STRING | | **tt\_app\_name**

STRING | | **user\_action**

STRING | ### ad\_insights\_by\_country | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Keys ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | ad\_id

adgroup\_id

advertiser\_id

campaign\_id

country\_code

stat\_time\_day | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | stat\_time\_day | | **Useful links** | [TikTok Ads documentation](https://ads.tiktok.com/marketing_api/docs?id=1707957217727489 "Opens in new tab: TikTok Ads documentation")

[ad_insights_by_country schema on GitHub](https://github.com/singer-io/tap-tiktok-ads/tree/master/tap_tiktok_ads/schemas/ad_insights_by_country.json "Opens in new tab: ad_insights_by_country schema on GitHub") | ad\_insights\_by\_country table schema | **ad\_id**

STRING | | --- | | **ad\_name**

STRING | | **ad\_text**

STRING | | **adgroup\_id**

STRING | | **adgroup\_name**

STRING | | **advertiser\_id**

STRING | | **bid**

STRING | | **bid\_strategy**

STRING | | **billing\_event**

STRING | | **budget**

STRING | | **call\_to\_action**

STRING | | **campaign\_budget**

STRING | | **campaign\_dedicate\_type**

STRING | | **campaign\_id**

STRING | | **campaign\_name**

STRING | | **clicks**

INTEGER | | **conversion**

INTEGER | | **conversion\_rate**

NUMBER | | **conversion\_rate\_v2**

NUMBER | | **cost\_per\_conversion**

NUMBER | | **cost\_per\_result**

NUMBER | | **country\_code**

STRING | | **cpc**

NUMBER | | **cpm**

NUMBER | | **ctr**

NUMBER | | **dpa\_target\_audience\_type**

STRING | | **gross\_impressions**

STRING | | **impressions**

INTEGER | | **is\_smart\_creative**

BOOLEAN | | **mobile\_app\_id**

STRING | | **objective\_type**

STRING | | **opt\_status**

STRING | | **promotion\_type**

STRING | | **real\_time\_conversion**

INTEGER | | **real\_time\_conversion\_rate**

NUMBER | | **real\_time\_conversion\_rate\_v2**

NUMBER | | **real\_time\_cost\_per\_conversion**

NUMBER | | **real\_time\_cost\_per\_result**

NUMBER | | **real\_time\_result**

INTEGER | | **real\_time\_result\_rate**

NUMBER | | **result**

INTEGER | | **result\_rate**

NUMBER | | **rf\_campaign\_type**

STRING | | **smart\_target**

STRING | | **spend**

NUMBER | | **split\_test**

STRING | | **stat\_time\_day**

DATE-TIME | | **tt\_app\_id**

STRING | | **tt\_app\_name**

STRING | | **user\_action**

STRING | ### ad\_insights\_by\_platform | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Keys ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | ad\_id

adgroup\_id

campaign\_id

platform

stat\_time\_day | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | stat\_time\_day | | **Useful links** | [TikTok Ads documentation](https://ads.tiktok.com/marketing_api/docs?id=1707957217727489 "Opens in new tab: TikTok Ads documentation")

[ad_insights_by_platform schema on GitHub](https://github.com/singer-io/tap-tiktok-ads/tree/master/tap_tiktok_ads/schemas/ad_insights_by_platform.json "Opens in new tab: ad_insights_by_platform schema on GitHub") | ad\_insights\_by\_platform table schema | **ad\_id**

STRING | | --- | | **ad\_name**

STRING | | **ad\_text**

STRING | | **adgroup\_id**

STRING | | **adgroup\_name**

STRING | | **advertiser\_id**

STRING | | **bid**

STRING | | **bid\_strategy**

STRING | | **billing\_event**

STRING | | **budget**

STRING | | **call\_to\_action**

STRING | | **campaign\_budget**

STRING | | **campaign\_dedicate\_type**

STRING | | **campaign\_id**

STRING | | **campaign\_name**

STRING | | **clicks**

INTEGER | | **conversion**

INTEGER | | **conversion\_rate**

NUMBER | | **conversion\_rate\_v2**

NUMBER | | **cost\_per\_conversion**

NUMBER | | **cost\_per\_result**

NUMBER | | **cpc**

NUMBER | | **cpm**

NUMBER | | **ctr**

NUMBER | | **dpa\_target\_audience\_type**

STRING | | **gross\_impressions**

STRING | | **impressions**

INTEGER | | **is\_smart\_creative**

BOOLEAN | | **mobile\_app\_id**

STRING | | **objective\_type**

STRING | | **opt\_status**

STRING | | **platform**

STRING | | **promotion\_type**

STRING | | **real\_time\_conversion**

INTEGER | | **real\_time\_conversion\_rate**

NUMBER | | **real\_time\_conversion\_rate\_v2**

NUMBER | | **real\_time\_cost\_per\_conversion**

NUMBER | | **real\_time\_cost\_per\_result**

NUMBER | | **real\_time\_result**

INTEGER | | **real\_time\_result\_rate**

NUMBER | | **result**

INTEGER | | **result\_rate**

NUMBER | | **rf\_campaign\_type**

STRING | | **smart\_target**

STRING | | **spend**

NUMBER | | **split\_test**

STRING | | **stat\_time\_day**

DATE-TIME | | **tt\_app\_id**

STRING | | **tt\_app\_name**

STRING | | **user\_action**

STRING | ### adgroups | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Keys ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | adgroup\_id

advertiser\_id

campaign\_id

modify\_time | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | modify\_time | | **Useful links** | [TikTok Ads documentation](https://ads.tiktok.com/marketing_api/docs?id=1708503489590273 "Opens in new tab: TikTok Ads documentation")

[adgroups schema on GitHub](https://github.com/singer-io/tap-tiktok-ads/tree/master/tap_tiktok_ads/schemas/adgroups.json "Opens in new tab: adgroups schema on GitHub") | adgroups table schema | **actions**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand actions

action_category_ids

ARRAY

action_period

NUMBER

action_scene

STRING

video_user_actions

ARRAY

| | --- | | **adgroup\_app\_profile\_page\_state**

STRING | | **adgroup\_id**

STRING | | **adgroup\_name**

STRING | | **advertiser\_id**

STRING | | **age\_groups**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **app\_download\_url**

STRING | | **app\_id**

STRING | | **audience**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **audience\_type**

STRING | | **bid\_price**

NUMBER | | **bid\_type**

STRING | | **billing\_event**

STRING | | **brand\_safety\_partner**

STRING | | **brand\_safety\_type**

STRING | | **budget**

NUMBER | | **budget\_mode**

STRING | | **campaign\_id**

STRING | | **carriers\_v2**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **catalog\_authorized\_bc**

INTEGER | | **catalog\_id**

STRING | | **conversion\_bid\_price**

NUMBER | | **conversion\_window**

STRING | | **cpv\_video\_duration**

STRING | | **create\_time**

DATE-TIME | | **creative\_material\_mode**

STRING | | **current\_status**

STRING | | **dayparting**

STRING | | **deep\_bid\_type**

STRING | | **deep\_cpa\_bid**

NUMBER | | **delivery\_mode**

STRING | | **device\_models**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **device\_price\_ranges**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **excluded\_audience**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **excluded\_custom\_actions**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand excluded\_custom\_actions

code

STRING

days

INTEGER

| | **frequency**

INTEGER | | **frequency\_schedule**

INTEGER | | **gender**

STRING | | **included\_custom\_actions**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand included\_custom\_actions

code

STRING

days

INTEGER

| | **interest\_category\_v2**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **interest\_keywords**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **inventory\_filter\_enabled**

BOOLEAN | | **ios14\_targeting**

STRING | | **ios\_quota\_type**

STRING | | **is\_comment\_disable**

BOOLEAN | | **is\_hfss**

BOOLEAN | | **is\_new\_structure**

BOOLEAN | | **languages**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **location**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **min\_android\_version**

STRING | | **min\_ios\_version**

STRING | | **modify\_time**

DATE-TIME | | **network\_types**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **next\_day\_retention**

NUMBER | | **operating\_systems**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **operation\_status**

STRING | | **optimization\_event**

STRING | | **optimization\_goal**

STRING | | **pacing**

STRING | | **package**

STRING | | **pangle\_audience\_package\_exclude**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **pangle\_audience\_package\_include**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **pangle\_block\_app\_list\_id**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **pixel\_id**

STRING | | **placement\_type**

STRING | | **placements**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **product\_set\_id**

STRING | | **promotion\_type**

STRING | | **promotion\_website\_type**

STRING | | **purchased\_impression**

NUMBER | | **purchased\_reach**

NUMBER | | **rf\_estimated\_cpr**

NUMBER | | **rf\_estimated\_frequency**

NUMBER | | **rf\_purchased\_type**

STRING | | **roas\_bid**

NUMBER | | **schedule\_end\_time**

DATE-TIME | | **schedule\_start\_time**

DATE-TIME | | **schedule\_type**

STRING | | **secondary\_optimization\_event**

STRING | | **secondary\_status**

STRING | | **share\_disabled**

BOOLEAN | | **shopping\_ads\_retargeting\_type**

STRING | | **skip\_learning\_phase**

BOOLEAN | | **statistic\_type**

STRING | | **targeting\_expansion**

OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand targeting\_expansion

expansion_enabled

BOOLEAN

expansion_types

ARRAY

| | **video\_download**

STRING | ### ads | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Keys ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | ad\_id

adgroup\_id

advertiser\_id

campaign\_id

modify\_time | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | modify\_time | | **Useful links** | [TikTok Ads documentation](https://ads.tiktok.com/marketing_api/docs?id=1708572923161602 "Opens in new tab: TikTok Ads documentation")

[ads schema on GitHub](https://github.com/singer-io/tap-tiktok-ads/tree/master/tap_tiktok_ads/schemas/ads.json "Opens in new tab: ads schema on GitHub") | ads table schema | **ad\_format**

STRING | | --- | | **ad\_id**

STRING | | **ad\_name**

STRING | | **ad\_text**

STRING | | **adgroup\_id**

STRING | | **adgroup\_name**

STRING | | **advertiser\_id**

STRING | | **app\_name**

STRING | | **brand\_safety\_vast\_url**

STRING | | **call\_to\_action**

STRING | | **campaign\_id**

STRING | | **campaign\_name**

STRING | | **card\_id**

STRING | | **carousel\_image\_index**

INTEGER | | **catalog\_id**

STRING | | **click\_tracking\_url**

STRING | | **create\_time**

DATE-TIME | | **creative\_authorized**

BOOLEAN | | **current\_status**

STRING | | **deeplink**

STRING | | **deeplink\_type**

STRING | | **display\_name**

STRING | | **dynamic\_destination**

STRING | | **dynamic\_format**

STRING | | **fallback\_type**

STRING | | **image\_ids**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **image\_mode**

STRING | | **impression\_tracking\_url**

STRING | | **is\_aco**

BOOLEAN | | **is\_new\_structure**

BOOLEAN | | **item\_duet\_status**

STRING | | **item\_group\_ids**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **item\_stitch\_status**

STRING | | **landing\_page\_url**

STRING | | **landing\_page\_urls**

STRING | | **modify\_time**

DATE-TIME | | **music\_id**

STRING | | **operation\_status**

STRING | | **page\_id**

NUMBER | | **playable\_url**

STRING | | **product\_set\_id**

STRING | | **product\_specific\_type**

STRING | | **profile\_image\_url**

STRING | | **promotional\_music\_disabled**

BOOLEAN | | **secondary\_status**

STRING | | **shopping\_ads\_fallback\_type**

STRING | | **shopping\_ads\_video\_package\_id**

STRING | | **shopping\_deeplink\_type**

STRING | | **showcase\_products**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand showcase\_products

catalog_id

STRING

item_group_id

STRING

store_id

STRING

| | **sku\_ids**

STRING | | **tiktok\_item\_id**

STRING | | **tracking\_app\_id**

STRING | | **tracking\_offline\_event\_set\_ids**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **utm\_params**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand utm\_params

key

STRING

value

STRING

| | **vast\_moat\_enabled**

BOOLEAN | | **vertical\_video\_strategy**

STRING | | **video\_id**

STRING | | **viewability\_postbid\_partner**

STRING | | **viewability\_vast\_url**

STRING | ### advertisers | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Keys ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | advertiser\_id

create\_time | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | create\_time | | **Useful links** | [TikTok Ads documentation](https://ads.tiktok.com/marketing_api/docs?id=1708503235186689 "Opens in new tab: TikTok Ads documentation")

[advertisers schema on GitHub](https://github.com/singer-io/tap-tiktok-ads/tree/master/tap_tiktok_ads/schemas/advertisers.json "Opens in new tab: advertisers schema on GitHub") | advertisers table schema | **address**

STRING | | --- | | **advertiser\_account\_type**

STRING | | **advertiser\_id**

STRING | | **balance**

NUMBER | | **cellphone\_number**

STRING | | **company**

STRING | | **contacter**

STRING | | **country**

STRING | | **create\_time**

STRING | | **currency**

STRING | | **description**

STRING | | **email**

STRING | | **industry**

STRING | | **language**

STRING | | **license\_no**

STRING | | **license\_url**

STRING | | **name**

STRING | | **promotion\_area**

STRING | | **promotion\_center\_city**

STRING | | **promotion\_center\_province**

STRING | | **rejection\_reason**

STRING | | **role**

STRING | | **status**

STRING | | **telephone\_number**

STRING | | **timezone**

STRING | ### campaign\_insights\_by\_province | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Keys ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | advertiser\_id

campaign\_id

province\_id

stat\_time\_day | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | stat\_time\_day | | **Useful links** | [TikTok Ads documentation](https://help.qlik.com/en-US/stitch/integrations/saas/tiktok-ads "Opens in new tab: TikTok Ads documentation")

[campaign_insights_by_province schema on GitHub](https://github.com/singer-io/tap-tiktok-ads/tree/master/tap_tiktok_ads/schemas/campaign_insights_by_province.json "Opens in new tab: campaign_insights_by_province schema on GitHub") | campaign\_insights\_by\_province table schema | **advertiser\_id**

STRING | | --- | | **campaign\_budget**

STRING | | **campaign\_dedicate\_type**

STRING | | **campaign\_id**

STRING | | **campaign\_name**

STRING | | **clicks**

INTEGER | | **conversion**

INTEGER | | **conversion\_rate**

NUMBER | | **conversion\_rate\_v2**

NUMBER | | **cost\_per\_conversion**

NUMBER | | **cost\_per\_result**

NUMBER | | **cpc**

NUMBER | | **cpm**

NUMBER | | **ctr**

NUMBER | | **gross\_impressions**

STRING | | **impressions**

INTEGER | | **objective\_type**

STRING | | **province\_id**

STRING | | **real\_time\_conversion**

INTEGER | | **real\_time\_conversion\_rate**

NUMBER | | **real\_time\_conversion\_rate\_v2**

NUMBER | | **real\_time\_cost\_per\_conversion**

NUMBER | | **real\_time\_cost\_per\_result**

NUMBER | | **real\_time\_result**

INTEGER | | **real\_time\_result\_rate**

NUMBER | | **result**

INTEGER | | **result\_rate**

NUMBER | | **rf\_campaign\_type**

STRING | | **spend**

NUMBER | | **split\_test**

STRING | | **stat\_time\_day**

DATE-TIME | ### campaigns | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Keys ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | advertiser\_id

campaign\_id

modify\_time | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | modify\_time | | **Useful links** | [TikTok Ads documentation](https://ads.tiktok.com/marketing_api/docs?id=1708582970809346 "Opens in new tab: TikTok Ads documentation")

[campaigns schema on GitHub](https://github.com/singer-io/tap-tiktok-ads/tree/master/tap_tiktok_ads/schemas/campaigns.json "Opens in new tab: campaigns schema on GitHub") | campaigns table schema | **advertiser\_id**

STRING | | --- | | **app\_id**

STRING | | **app\_promotion\_type**

STRING | | **bid\_type**

STRING | | **budget**

NUMBER | | **budget\_mode**

STRING | | **budget\_optimize\_on**

BOOLEAN | | **campaign\_app\_profile\_page\_state**

STRING | | **campaign\_id**

STRING | | **campaign\_name**

STRING | | **campaign\_product\_source**

STRING | | **campaign\_type**

STRING | | **create\_time**

DATE-TIME | | **current\_status**

STRING | | **deep\_bid\_type**

STRING | | **is\_new\_structure**

BOOLEAN | | **is\_smart\_performance\_campaign**

BOOLEAN | | **modify\_time**

DATE-TIME | | **objective**

STRING | | **objective\_type**

STRING | | **operation\_status**

STRING | | **optimization\_goal**

STRING | | **rf\_campaign\_type**

STRING | | **roas\_bid**

NUMBER | | **secondary\_status**

STRING | | **special\_industries**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. |