Skip to main content

TikTok Marketing Migration Guide

Availability
Available CoreAvailable StandardAvailable PlusAvailable ProAvailable Enterprise FlexAvailable Self-Managed EnterpriseAvailable PyAirbyte
Support Level
Airbyte
Connector Version
5.0.8 (last updated 5 days ago)
Definition ID
4bfac00d-ce15-44ff-95b9-9e3c3e8fbd35

Upgrading to 5.0.0​

The currency field in the pixels stream's events array has been corrected from boolean to string type. The TikTok API returns currency as a string value (e.g. "USD"), so the previous boolean type was incorrect and caused transform errors during syncs.

Users syncing the pixels stream need to refresh the source schema and clear data for that stream after upgrading.

Migration steps​

  1. Select Connections in the main nav bar.
    1. Select the connection(s) affected by the update.
  2. Select the Schema tab.
    1. Select Refresh source schema.
    2. Select OK and Save changes.
  3. Select the Status tab.
    1. In the Enabled streams list, click the three dots on the right side of the pixels stream and select Clear Data.

After the clear succeeds, trigger a sync by clicking Sync Now. For more information on clearing your data in Airbyte, see this page.

Upgrading to 4.0.0​

This version migrated source TikTok Marketing from the Python CDK to the declarative low-code CDK. Due to changes in how state is managed for incremental streams nested within a parent stream, this migration constitutes a breaking change.

The following streams are affected:

  • ad_group_audience_reports_by_country_daily
  • ad_group_audience_reports_by_platform_daily
  • ad_group_audience_reports_daily
  • ad_groups
  • ad_groups_reports_daily
  • ad_groups_reports_hourly
  • ads
  • ads_audience_reports_by_country_daily
  • ads_audience_reports_by_platform_daily
  • ads_audience_reports_by_province_daily
  • ads_audience_reports_daily
  • ads_reports_daily
  • ads_reports_hourly
  • advertisers_audience_reports_by_country_daily
  • advertisers_audience_reports_by_platform_daily
  • advertisers_audience_reports_daily
  • advertisers_reports_daily
  • advertisers_reports_hourly
  • campaigns
  • campaigns_audience_reports_by_country_daily
  • campaigns_audience_reports_by_platform_daily
  • campaigns_audience_reports_daily
  • campaigns_reports_daily
  • campaigns_reports_hourly
  • creative_assets_images
  • creative_assets_videos

See Clearing data to update your connection.

The advertiser_ids stream schema also changed: the advertiser_id field type was corrected from integer to string to match the API response. Users need to refresh the stream schema.

See Refresh schemas to update your connection.

Migration steps​

Refresh schemas​

Refresh the advertiser_ids schema to continue syncing that stream:

  1. Select Connections in the main navbar.
    1. Select the connection(s) affected by the update.
  2. Select the Schema tab.
    1. Select Refresh source schema.
    2. Select OK and Save changes.
  3. Select Connections in the main nav bar.
    1. Select the connection(s) affected by the update.
  4. Select the Status tab.
    1. In the Enabled streams list, click the three dots on the right side of the advertiser_ids stream and select Clear Data.

Important: If you were using advertiser_ids without provided advertiser_id in the source configuration you should firstly refresh source schema for advertiser_ids stream and then clear data for affected streams from the list above.

Clearing data​

Clear data for the affected streams listed above:

  1. Select Connections in the main nav bar.
    1. Select the connection(s) affected by the update.
  2. Select the Status tab.
    1. In the Enabled streams list, click the three dots on the right side of the impacted stream and select Clear Data.
  3. Do the same steps from 1-2.1 for all streams in your connection that were affected by this update.

After the clear succeeds, trigger a sync by clicking Sync Now. For more information on clearing your data in Airbyte, see this page.

Connector upgrade guide​

Review the following information to prepare for and execute your upgrade.

Review the changelog​

Before updating a connector, review the changelog to understand the changes and their potential impact on your existing connections. Find the changelog for any connector by navigating to the bottom of the documentation for that connector. Major version releases also include a migration guide.

Plan for major updates​

Major updates may require you to adjust connection settings or even make changes to your data pipelines. Allocate enough time and resources for this. Use the migration guide to ensure your transition process goes smoothly.

Airbyte provides tooling that guarantees safe connector version bumps and enforces automated version bumps for minor and patch updates. You always need to manually update for major version bumps.

Self-managed plans: pin a specific version if you can't update​

If you're unable to upgrade to the new version of a connector, you can pin that connector to a specific version.

  1. In the navigation bar:

    • If you're on the Self-Managed Enterprise plan, click Organization settings > Sources/Destinations.

    • If you're on any other plan, click Workspace settings > Sources/Destinations.

  2. Edit the entry for the connector you want to pin.

  3. Set the Default Version to the version you want to use.

Self-managed plans: update the local connector image​

If you self-manage Airbyte, you must manually update the connector image in your local registry before proceeding with the migration. Follow the steps below.

  1. In the navigation bar:

    • If you're on the Self-Managed Enterprise plan, click Organization settings > Sources/Destinations.

    • If you're on any other plan, click Workspace settings > Sources/Destinations.

  2. Find the connector you want to update in the list of connectors.

    note

    Airbyte lists two versions, the current in-use version and the latest version available.

  3. Click Change to update your OSS version to the latest available version.

Update the connector version​

Update each instance of the connector separately. If you have multiple instances of a connector, updating one doesn't affect the others.

  1. In the navigation bar:

    • If you're on the Self-Managed Enterprise plan, click Organization settings > Sources/Destinations.

    • If you're on any other plan, click Workspace settings > Sources/Destinations.

  2. Select the instance of the connector you wish to upgrade.

  3. Select Upgrade.

  4. Follow the prompt to confirm you are ready to upgrade to the new version.

Clear data from affected streams​

After upgrading a connector with a breaking change, you must refresh affected schemas and clear your data.

  1. In the nav bar, click Connections.

  2. Find the connection affected by the upgrade.

  3. Click the Schema tab.

  4. Click Refresh source schema (looks like ). When Airbyte finishes, it shows you any detected schema changes.

  5. Click OK.

  6. Click Save changes

  7. Clear the data for the streams affected by this upgrade.

Once the clear is complete, you can begin syncing your data again as usual.

Was this page helpful?