You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/integrations/sources/tiktok-marketing.md
+19-9Lines changed: 19 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ This page contains the setup guide and reference information for the [TikTok Mar
19
19
20
20
**For Airbyte Open Source:**
21
21
22
-
For the Production environment:
22
+
For the Production environment (OAuth2.0):
23
23
24
24
- Access token
25
25
- Secret
@@ -50,10 +50,13 @@ To access the Sandbox environment:
50
50
2. Click Sources and then click + New source.
51
51
3. On the Set up the source page, select TikTok Marketing from the Source type dropdown.
52
52
4. Enter a name for the TikTok Marketing connector.
53
-
5. Select `OAuth2.0` Authorization method, then click `Authenticate your account`.
54
-
6. Log in and Authorize to the Tiktok account
55
-
7. Choose required Start date
56
-
8. click `Set up source`.
53
+
5. Select `OAuth2.0` as the authorization method, then click `Authenticate your account`.
54
+
6. Log in and authorize the TikTok account.
55
+
7. Choose a **Start date**. Any data before this date is not replicated.
56
+
8. Optionally, set an **End date** to limit how far forward the connector replicates data. If not set, the connector syncs data up to the current date.
57
+
9. Optionally, adjust the **Attribution window** (default: 3 days, range: 0–364 days). This controls how far back the connector looks to update metrics for incremental report streams. A higher value helps capture delayed attribution data.
58
+
10. Optionally, enable **Include deleted data** to sync deleted ads, ad groups, and campaigns in report streams.
59
+
11. Click **Set up source**.
57
60
<!-- /env:cloud -->
58
61
59
62
<!-- env:oss -->
@@ -63,9 +66,12 @@ To access the Sandbox environment:
63
66
1. Navigate to the Airbyte Open Source dashboard.
64
67
2. In the left navigation bar, click **Sources**. In the top-right corner, click **+ new source**.
65
68
3. On the Set up the source page, enter the name for the connector and select **Tiktok Marketing** from the Source type dropdown.
66
-
4. Select `Production Access Token` or `Sandbox Access Token` Authorization method, then copy and paste info from step 1.
67
-
5. Choose required Start date
68
-
6. Click `Set up source`.
69
+
4. Select `OAuth2.0` or `Sandbox Access Token` as the authorization method, then enter the credentials from step 1.
70
+
5. Choose a **Start date**. Any data before this date is not replicated.
71
+
6. Optionally, set an **End date** to limit how far forward the connector replicates data. If not set, the connector syncs data up to the current date.
72
+
7. Optionally, adjust the **Attribution window** (default: 3 days, range: 0–364 days). This controls how far back the connector looks to update metrics for incremental report streams. A higher value helps capture delayed attribution data.
73
+
8. Optionally, enable **Include deleted data** to sync deleted ads, ad groups, and campaigns in report streams.
74
+
9. Click `Set up source`.
69
75
<!-- /env:oss -->
70
76
71
77
## Supported sync modes
@@ -139,6 +145,10 @@ Reports synced by this connector can use either hourly, daily, or lifetime granu
139
145
140
146
The connector is restricted by [requests limitation](https://business-api.tiktok.com/portal/docs?rid=fgvgaumno25&id=1740029171730433). This connector should not run into TikTok Marketing API limitations under normal usage. Please [create an issue](https://github.com/airbytehq/airbyte/issues) if you see any rate limit issues that are not automatically retried successfully.
141
147
148
+
## Upgrading
149
+
150
+
For information on breaking changes and migration steps, see the [TikTok Marketing Migration Guide](./tiktok-marketing-migrations.md).
151
+
142
152
## Changelog
143
153
144
154
<details>
@@ -176,7 +186,7 @@ The connector is restricted by [requests limitation](https://business-api.tiktok
| 4.4.0-rc1 | 2025-01-29 |[51584](https://github.com/airbytehq/airbyte/pull/51584)| Update to concurrent CDK |
181
191
| 4.3.7 | 2025-01-11 |[47118](https://github.com/airbytehq/airbyte/pull/47118)| Starting with this version, the Docker image is now rootless. Please note that this and future versions will not be compatible with Airbyte versions earlier than 0.64 |
0 commit comments