TikTok Ads (Edge)

Configure TikTok Ads as a Source in your Pipeline

Perform the following steps to configure your TikTok Ads Source:

1. Click Pipelines in the Navigation Bar.

2. Click + Create Pipeline in the Pipelines List View.

3. On the Select Source Type page, select TikTok Ads.

4. On the Select Destination Type page, select the type of Destination you want to use.

5. On the Select Pipeline Type page, click Edge, and then click Continue.

   

   This page appears only if the selected Destination type is supported in Edge and your Team has an existing TikTok Ads Pipeline with the same Destination type. Otherwise, you can proceed to create an Edge Pipeline.

6. In the Configure Source screen, specify the following:

   • In the Connect to your TikTok Ads account section, do the following:

     

     • Click Authenticate Your TikTok Ads Account, log in to your TikTok Ads account, grant Hevo the following permissions to access your account data, and click Confirm:

       • Ad Account Management
         • Ad Account Information
           • Read Ad Account Information
       • Ads Management
         • Campaign
           • Read Campaigns
         • Ad Group
           • Read Ad Groups
         • Ad
           • Read Ads
       • Creative Management
         • Image Management
           • Read Image Library
         • Video Management
           • Read Video Library
       • Pixel Management
         • Pixel Management
           • Read Pixels
           • Pixel Level Reporting
       • Reporting
         • Consolidated Report

     • Historical Sync Duration: From the drop-down, select the duration for which you want to ingest existing data from the Source. This cannot be changed after the Pipeline is created. Default: 12 months.

     • Advertiser Selection: From the drop-down, select whether you want Hevo to sync all advertiser accounts, or only specific ones:

       • Sync All Advertisers: Syncs data for all advertiser accounts that Hevo has access to.

       • Sync Specific Advertisers: Syncs data only for specific advertiser accounts you select. If you select this option, in the Advertisers to sync section, select the specific TikTok advertiser accounts whose data you want to sync.

         

   • (Optional) In the Advanced Options section, do the following:

     

     • Show Advanced Options: Enable this option to configure the following:

       • Rollback Sync: From the drop-down, select the number of days for which Hevo re-fetches previously ingested data to capture delayed conversions. Default: 7 days.

7. Click Test & Continue to test the connection to your TikTok Ads Source. Once the test is successful, you can proceed to set up your Destination.

---

Data Replication

Hevo replicates data for all the objects selected on the Configure Objects page during Pipeline creation. By default, all supported objects and their available fields are selected. However, you can modify this selection while creating or editing the Pipeline.

Hevo ingests the following types of data from your Source objects:

• Historical Data: The first run of the Pipeline ingests historical data for the selected objects, based on the Historical Sync Duration specified when configuring the Source, and loads it into the Destination.

• Incremental Data: Once the historical load is complete, new and updated records for objects are ingested as per the sync frequency.

For the following objects, Hevo ingests only the incremental data in subsequent Pipeline runs:

• Ad Report (Lifetime)
• Ad Group
• Ad Group Report (Lifetime)
• Ad Group Search Keyword
• Advertiser
• Campaign
• Campaign Report (Lifetime)
• GMV Max Campaign
• Image
• Location
• Pixel
• Pixel Event
• Pixel Event Rule
• Pixel Statistic
• Smart Creative Material Ad Title
• Smart Creative Material
• Smart Creative Material Media Info
• Smart Plus Ad Creative Info
• Smart Plus Ad Deeplink UTM Param
• Smart Plus Ad
• Smart Plus Ad UTM Param
• Video

For Reports, Hevo also re-fetches data from the number of days specified in the Rollback Sync field during each sync. This captures any updates made to previously ingested report data and keeps your Destination up to date. Events ingested through a rollback window are not billable.

For all other objects, Hevo ingests the entire data during each Pipeline run.

Note: You can create a Pipeline with this Source only using the Merge load mode. The Append mode is not supported for this Source.

TikTok’s Business API enforces rate limits on the number of calls that can be made to its APIs in a given time period. If this limit is exceeded, a rate limit exception occurs. To understand how Hevo handles such scenarios, read Handling Rate Limit Exceptions.

---

Schema and Primary Keys

Hevo uses the following schema to upload the records to the Destination. For a detailed view of the objects, fields, and relationships, click the ERD.

---

Data Model

The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:

---