The tap-tiktok
extractor
pulls data from
TikTok Ads that can
then be sent to a destination using a
loader.
Airbyte Usage Notice
Container-based connectors
can introduce deployment challenges including the potential need to run
Docker-in-Docker (not currently supported by services like AWS ECS, Meltano
Cloud, etc. see
FAQ
and
Airbyte's ECS deployment docs
for more details). Before using this variant we recommend considering if/how
you will be able to deploy container-based connectors to production.
For more context on how this Airbyte integration works please checkout out the
FAQ in the Meltano Docs.
Alternate Implementations
- Airbyte
🥉
- Gary James (default)
- Reeport
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-tiktok extractor to your
project using
:meltano add -
Configure the tap-tiktok
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-tiktok --variant airbytemeltano config tap-tiktok set --interactivemeltano config tap-tiktok testNext steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
tap-tiktok
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this extractor. If you find they are out of date, please
consider updating them by making a pull request to the YAML file that defines the
capabilities for this extractor.
This plugin has the following capabilities:
- about
- catalog
- discover
- schema-flattening
- state
- stream-maps
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-tiktok settings that are known to Meltano are documented below. To quickly
find the setting you're looking for, click on any setting name from the list:
airbyte_config.credentials.access_tokenairbyte_config.credentials.advertiser_idairbyte_config.credentials.app_idairbyte_config.credentials.auth_typeairbyte_config.credentials.secretairbyte_config.end_dateairbyte_config.report_granularityairbyte_config.start_dateairbyte_spec.imageairbyte_spec.tagdocker_mounts
Expand To Show SDK Settings
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-tiktok list
You can
override these settings or specify additional ones
in your meltano.yml by adding the settings key.
Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.
Airbyte Config Credentials Access Token (airbyte_config.credentials.access_token)
-
Environment variable:
TAP_TIKTOK_AIRBYTE_CONFIG_CREDENTIALS_ACCESS_TOKEN
Long-term Authorized Access Token., The long-term authorized access token.
Configure this setting directly using the following Meltano command:
meltano config tap-tiktok set airbyte_config credentials.access_token [value]Airbyte Config Credentials Advertiser Id (airbyte_config.credentials.advertiser_id)
-
Environment variable:
TAP_TIKTOK_AIRBYTE_CONFIG_CREDENTIALS_ADVERTISER_ID
The Advertiser ID which generated for the developer's Sandbox application.
Configure this setting directly using the following Meltano command:
meltano config tap-tiktok set airbyte_config credentials.advertiser_id [value]Airbyte Config Credentials App Id (airbyte_config.credentials.app_id)
-
Environment variable:
TAP_TIKTOK_AIRBYTE_CONFIG_CREDENTIALS_APP_ID
The Developer Application App ID.
Configure this setting directly using the following Meltano command:
meltano config tap-tiktok set airbyte_config credentials.app_id [value]Airbyte Config Credentials Auth Type (airbyte_config.credentials.auth_type)
-
Environment variable:
TAP_TIKTOK_AIRBYTE_CONFIG_CREDENTIALS_AUTH_TYPE
oauth2.0, sandbox_access_token
Configure this setting directly using the following Meltano command:
meltano config tap-tiktok set airbyte_config credentials.auth_type [value]Airbyte Config Credentials Secret (airbyte_config.credentials.secret)
-
Environment variable:
TAP_TIKTOK_AIRBYTE_CONFIG_CREDENTIALS_SECRET
The Developer Application Secret.
Configure this setting directly using the following Meltano command:
meltano config tap-tiktok set airbyte_config credentials.secret [value]Airbyte Config End Date (airbyte_config.end_date)
-
Environment variable:
TAP_TIKTOK_AIRBYTE_CONFIG_END_DATE
The date until which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DD. All data generated between start_date and this date will be replicated. Not setting this option will result in always syncing the data till the current date.
Configure this setting directly using the following Meltano command:
meltano config tap-tiktok set airbyte_config end_date [value]Airbyte Config Report Granularity (airbyte_config.report_granularity)
-
Environment variable:
TAP_TIKTOK_AIRBYTE_CONFIG_REPORT_GRANULARITY
The granularity used for aggregating performance data in reports. See the docs.
Configure this setting directly using the following Meltano command:
meltano config tap-tiktok set airbyte_config report_granularity [value]Airbyte Config Start Date (airbyte_config.start_date)
-
Environment variable:
TAP_TIKTOK_AIRBYTE_CONFIG_START_DATE
The Start Date in format: YYYY-MM-DD. Any data before this date will not be replicated. If this parameter is not set, all data will be replicated.
Configure this setting directly using the following Meltano command:
meltano config tap-tiktok set airbyte_config start_date [value]Airbyte Spec Image (airbyte_spec.image)
-
Environment variable:
TAP_TIKTOK_AIRBYTE_SPEC_IMAGE -
Default Value:
airbyte/source-tiktok-marketing
Airbyte image to run
Configure this setting directly using the following Meltano command:
meltano config tap-tiktok set airbyte_spec image [value]Airbyte Spec Tag (airbyte_spec.tag)
-
Environment variable:
TAP_TIKTOK_AIRBYTE_SPEC_TAG -
Default Value:
latest
Airbyte image tag
Configure this setting directly using the following Meltano command:
meltano config tap-tiktok set airbyte_spec tag [value]Docker Mounts (docker_mounts)
-
Environment variable:
TAP_TIKTOK_DOCKER_MOUNTS
Docker mounts to make available to the Airbyte container. Expects a list of maps containing source, target, and type as is documented in the docker --mount documentation
Configure this setting directly using the following Meltano command:
meltano config tap-tiktok set docker_mounts [value]Expand To Show SDK Settings
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_TIKTOK_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-tiktok set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_TIKTOK_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-tiktok set flattening_max_depth [value]Stream Map Config (stream_map_config)
-
Environment variable:
TAP_TIKTOK_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Configure this setting directly using the following Meltano command:
meltano config tap-tiktok set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TAP_TIKTOK_STREAM_MAPS
Config object for stream maps capability. For more information check out Stream Maps.
Configure this setting directly using the following Meltano command:
meltano config tap-tiktok set stream_maps [value]Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general-yellow){kind=icon}
