TikTok Ads

tap-tiktok from gthesheep

Social Media Marketing Platform

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:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-tiktok extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-tiktok
  3. Configure the tap-tiktok settings using
    meltano config
    :
  4. meltano config tap-tiktok set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-tiktok test

Next steps

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 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

Advertiser ID (advertiser_id)

  • Environment variable: TAP_TIKTOK_ADVERTISER_ID

Identifier for the advertiser to extract data for

Start date (start_date)

  • Environment variable: TAP_TIKTOK_START_DATE

Start date as of when to collect metrics from

Commands

The tap-tiktok extractor supports the following commands that can be used with
meltano invoke
:

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-tiktok extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the
#plugins-general
channel.

Install

meltano add extractor tap-tiktok

Maintenance Status

  • Maintenance Status
  • Stars
  • Forks
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Gary James

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)
  • Built with the Meltano SDK

Keywords

  • apimeltano_sdk