 | Tiktok Business
|
The tap-tiktok-business extractor pulls data from Tiktok Business that can then be sent to a destination using a loader.
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-tiktok-business extractor to your project
using
:meltano add -
Configure the tap-tiktok-business settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-tiktok-businessmeltano config tap-tiktok-business set --interactivemeltano config tap-tiktok-business 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-business
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
- state
- discover
- about
- stream-maps
- schema-flattening
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-tiktok-business 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:
client_idclient_secretaccess_tokenrefresh_tokenbusiness_idsstart_datestream_mapsstream_map_configflattening_enabledflattening_max_depth
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.
Client Id (client_id)
-
Environment variable:
TAP_TIKTOK_BUSINESS_CLIENT_ID
Client ID for the TikTok Business API
Client Secret (client_secret)
-
Environment variable:
TAP_TIKTOK_BUSINESS_CLIENT_SECRET
Client secret for the TikTok Business API
Access Token (access_token)
-
Environment variable:
TAP_TIKTOK_BUSINESS_ACCESS_TOKEN
The token to authenticate against the API service
Refresh Token (refresh_token)
-
Environment variable:
TAP_TIKTOK_BUSINESS_REFRESH_TOKEN
The token to generate a new access token
Business Ids (business_ids)
-
Environment variable:
TAP_TIKTOK_BUSINESS_BUSINESS_IDS
unique ids for each TikTok business account to be queried
Start Date (start_date)
-
Environment variable:
TAP_TIKTOK_BUSINESS_START_DATE
The earliest record date to sync
Stream Maps (stream_maps)
-
Environment variable:
TAP_TIKTOK_BUSINESS_STREAM_MAPS
Config object for stream maps capability.
Stream Map Config (stream_map_config)
-
Environment variable:
TAP_TIKTOK_BUSINESS_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_TIKTOK_BUSINESS_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_TIKTOK_BUSINESS_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-generalInstall
meltano add extractor tap-tiktok-businessMaintenance Status
-brightgreen){kind=icon}
Maintainer
Meltano Stats
Keywords
