tap-tiktok
is a Singer tap for TikTok.
Built with the Meltano Tap SDK for Singer Taps.
pipx install git+https://github.com/gthsheep/tap-tiktok
access_token
- Access Token for the API as obtained via the authentication process described below.
advertiser_id
- Advertiser ID for your TikTok account.
start_date
- Start date as of when to start collecting metrics, e.g. 2022-01-01T00:00:00Z
lookback
- Number of days prior to the current date for which data should be refetched (default 0
)
A full list of supported settings and capabilities for this tap is available by running:
tap-tiktok --about
To obtain an access_token
you should follow the App creation steps described in the TikTok documentation,
here, then the Authentication documentation,
here.
As for scopes for your App, metrics streams are fed by the Reporting permission set, then data for Campaign, Ad Group,
and Ads require their respective read permissions.
Ad Account Management -> Read Ads Management -> Read ads/ adgroups/ campaigns Reporting -> All Tiktok Business -> All
You can easily run tap-tiktok
by itself or in a pipeline using Meltano.
tap-tiktok --version
tap-tiktok --help
tap-tiktok --config CONFIG --discover > ./catalog.json
pipx install poetry
poetry install
Create tests within the tap_tiktok/tests
subfolder and
then run:
poetry run pytest
You can also test the tap-tiktok
CLI interface directly using poetry run
:
poetry run tap-tiktok --help
Testing with Meltano
Note: This tap will work in any Singer environment and does not require Meltano. Examples here are for convenience and to streamline end-to-end orchestration scenarios.
Your project comes with a custom meltano.yml
project file already created. Open the meltano.yml
and follow any "TODO" items listed in
the file.
Next, install Meltano (if you haven't already) and any needed plugins:
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-tiktok
meltano install
Now you can test and orchestrate using Meltano:
# Test invocation:
meltano invoke tap-tiktok --version
# OR run a test `elt` pipeline:
meltano elt tap-tiktok target-jsonl
See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.