Skip to content
This repository has been archived by the owner on Oct 28, 2022. It is now read-only.

Latest commit

 

History

History
68 lines (50 loc) · 6.12 KB

tiktok-marketing.md

File metadata and controls

68 lines (50 loc) · 6.12 KB

TikTok Marketing

Overview

The TikTok For Business Marketing API allows you to directly interact with the TikTok Ads Manager platform for automated ad management and analysis.

The TikTok Marketing source supports both Full Refresh and Incremental syncs. You can choose if this connector will copy only the new or updated data, or all rows in the tables and columns you set up for replication, every time a sync is run.

This Source Connector is based on a Airbyte CDK.

Streams information

Stream Environment Granularities Key Incremental Schema
Advertisers Prod,Sandbox LIFETIME,DAY,HOUR id No Link
AdGroups Prod,Sandbox LIFETIME,DAY,HOUR adgroup_id Yes (DAY,HOUR) Link
Ads Prod,Sandbox LIFETIME,DAY,HOUR ad_id Yes (DAY,HOUR) Link
Campaigns Prod,Sandbox LIFETIME,DAY,HOUR campaign_id Yes (DAY,HOUR) Link
AdsReports Prod,Sandbox LIFETIME,DAY,HOUR None Yes (DAY,HOUR) BasicReportsLink
AdvertisersReports Prod LIFETIME,DAY,HOUR None Yes (DAY,HOUR) BasicReportsLink
AdGroupsReports Prod,Sandbox LIFETIME,DAY,HOUR None Yes (DAY,HOUR) BasicReportsLink
CampaignsReports Prod,Sandbox LIFETIME,DAY,HOUR None Yes (DAY,HOUR) BasicReportsLink
AdvertisersAudienceReports Prod LIFETIME,DAY,HOUR None Yes (DAY,HOUR) AudienceReportsLink
AdGroupAudienceReports Prod,Sandbox DAY,HOUR None Yes (DAY,HOUR) AudienceReportsLink
AdsAudienceReports Prod,Sandbox DAY,HOUR None Yes (DAY,HOUR) AudienceReportsLink
CampaignsAudienceReportsByCountry Prod,Sandbox DAY,HOUR None Yes (DAY,HOUR) AudienceReportsLink

If there are more endpoints you'd like Airbyte to support, please create an issue.

Features

Feature Supported?
Full Refresh Sync Yes
Incremental - Append Sync Yes
SSL connection Yes
Namespaces No

Performance considerations

The connector is restricted by requests limitation. This connector should not run into TikTok Marketing API limitations under normal usage. Please create an issue if you see any rate limit issues that are not automatically retried successfully.

Getting started

Requirements

  • Access Token - This token will not expire.
  • Production Environment
    • App ID
    • Secret
  • SandBox Environment
    • Advertiser ID - It is generated for sandbox in one copy

Setup guide

Please read How to get your AppID, Secret and Access Token or How to create a SandBox Environment

Changelog

Version Date Pull Request Subject
0.1.6 2022-04-19 11378 updated logic for stream initializations, fixed errors in schemas, updated SAT and unit tests
0.1.5 2022-02-17 10398 Add Audience reports
0.1.4 2021-12-30 7636 Add OAuth support
0.1.3 2021-12-10 8425 Update title, description fields in spec
0.1.2 2021-12-02 8292 Support reports
0.1.1 2021-11-08 7499 Remove base-python dependencies
0.1.0 2021-09-18 5887 Release TikTok Marketing CDK Connector