Skip to main content

Airbyte Tiktok-Marketing Connector for AI platforms

Project description

Tiktok-Marketing

The Tiktok-Marketing agent connector is a Python package that equips AI agents to interact with Tiktok-Marketing through strongly typed, well-documented tools. It's ready to use directly in your Python app, in an agent framework, or exposed through an MCP.

Connector for the TikTok Marketing API (Business API v1.3). Provides access to advertiser accounts, campaigns, ad groups, ads, audiences, creative assets (images and videos), and daily performance reports at the advertiser, campaign, ad group, and ad levels. Requires an Access Token from the TikTok for Business platform. All list operations require an advertiser_id parameter to scope results to a specific advertiser account.

Example questions

The Tiktok-Marketing connector is optimized to handle prompts like these.

  • List all my TikTok advertisers
  • Show me all campaigns for my advertiser account
  • List all ad groups
  • Show me all ads
  • List my custom audiences
  • Show me all creative asset images
  • List creative asset videos
  • Show me daily ad performance reports
  • Get campaign performance metrics for the last 30 days
  • Show me advertiser spend reports
  • Which campaigns have the highest budget?
  • Find all paused ad groups
  • What ads were created last month?
  • Show campaigns with lifetime budget mode
  • Which ads had the most impressions yesterday?
  • What is my total ad spend this month?
  • Which campaigns have the highest click-through rate?

Unsupported questions

The Tiktok-Marketing connector isn't currently able to handle prompts like these.

  • Create a new campaign
  • Update ad group targeting
  • Delete an ad

Installation

uv pip install airbyte-agent-tiktok-marketing

Usage

Connectors can run in open source or hosted mode.

Open source

In open source mode, you provide API credentials directly to the connector.

from airbyte_agent_tiktok_marketing import TiktokMarketingConnector
from airbyte_agent_tiktok_marketing.models import TiktokMarketingAuthConfig

connector = TiktokMarketingConnector(
    auth_config=TiktokMarketingAuthConfig(
        access_token="<Your TikTok Marketing API access token>"
    )
)

@agent.tool_plain # assumes you're using Pydantic AI
@TiktokMarketingConnector.tool_utils
async def tiktok_marketing_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

Hosted

In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead.

This example assumes you've already authenticated your connector with Airbyte. See Authentication to learn more about authenticating. If you need a step-by-step guide, see the hosted execution tutorial.

from airbyte_agent_tiktok_marketing import TiktokMarketingConnector, AirbyteAuthConfig

connector = TiktokMarketingConnector(
    auth_config=AirbyteAuthConfig(
        external_user_id="<your_external_user_id>",
        airbyte_client_id="<your-client-id>",
        airbyte_client_secret="<your-client-secret>"
    )
)

@agent.tool_plain # assumes you're using Pydantic AI
@TiktokMarketingConnector.tool_utils
async def tiktok_marketing_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

Full documentation

Entities and actions

This connector supports the following entities and actions. For more details, see this connector's full reference documentation.

Entity Actions
Advertisers List, Search
Campaigns List, Search
Ad Groups List, Search
Ads List, Search
Audiences List, Search
Creative Assets Images List, Search
Creative Assets Videos List, Search
Advertisers Reports Daily List, Search
Campaigns Reports Daily List, Search
Ad Groups Reports Daily List, Search
Ads Reports Daily List, Search

Authentication

For all authentication options, see the connector's authentication documentation.

Tiktok-Marketing API docs

See the official Tiktok-Marketing API reference.

Version information

  • Package version: 0.1.3
  • Connector version: 1.1.2
  • Generated with Connector SDK commit SHA: 1c0056b9f6a8151cadd0f591788beba76579b2f3
  • Changelog: View changelog

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

airbyte_agent_tiktok_marketing-0.1.3.tar.gz (165.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

airbyte_agent_tiktok_marketing-0.1.3-py3-none-any.whl (185.7 kB view details)

Uploaded Python 3

File details

Details for the file airbyte_agent_tiktok_marketing-0.1.3.tar.gz.

File metadata

File hashes

Hashes for airbyte_agent_tiktok_marketing-0.1.3.tar.gz
Algorithm Hash digest
SHA256 b51fc342be42fb28220155caa17deb97849eec8dcdf9051a97a104fee55f1071
MD5 5a5fbf351de48d74bcbb78fd0e338571
BLAKE2b-256 af2011a96f51929fc035031f265e2463fc69411be36ee398659c5f2a91a3e638

See more details on using hashes here.

File details

Details for the file airbyte_agent_tiktok_marketing-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for airbyte_agent_tiktok_marketing-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0178ed4720d45607b0d563443a79657199c197f5f26d9c6f1fa6574a8bc1771b
MD5 421726533e98066ac2d941b6c6c6e742
BLAKE2b-256 b4c62525a0de57d6a4e9b2f2a658f187b9738ae2b9c70e9b47d0cf3eb95ccba5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page