The tap-tiktok extractor pulls data from TikTok Ads that can then be sent to a destination using a loader.
Available Variants
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
meltano config tap-tiktok set --interactive
meltano config tap-tiktok test
Next 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:
- catalog
- discover
- state
- about
- 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:
You can also list these settings using
with the meltano config
list
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.
API Key (api_key)
-
Environment variable:
TAP_TIKTOK_API_KEY
API Token gained from Tiktok
Configure this setting directly using the following Meltano command:
meltano config tap-tiktok set api_key [value]
Advertiser ID (advertiser_id)
-
Environment variable:
TAP_TIKTOK_ADVERTISER_ID
Identifier for the advertiser to extract data for
Configure this setting directly using the following Meltano command:
meltano config tap-tiktok set advertiser_id [value]
Start date (start_date)
-
Environment variable:
TAP_TIKTOK_START_DATE
Start date as of when to collect metrics from
Configure this setting directly using the following Meltano command:
meltano config tap-tiktok set start_date [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
channel.