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, and creative assets (images and videos). 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
  • Which campaigns have the highest budget?
  • Find all paused ad groups
  • What ads were created last month?
  • Show campaigns with lifetime budget mode

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
  • Show me ad performance reports
  • What is my ad spend this month?

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

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.1
  • Connector version: 1.0.2
  • Generated with Connector SDK commit SHA: 0186dbc7998aa603d640de92ab4b9a5a6d9310ca
  • 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.1.tar.gz (151.7 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.1-py3-none-any.whl (174.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for airbyte_agent_tiktok_marketing-0.1.1.tar.gz
Algorithm Hash digest
SHA256 bcde1325807533a57151f4cd72a4ff24ea90dbc26f7aaa08c75a23188ee9bdd7
MD5 d19332b23be41467e7dc9eee51ab72ea
BLAKE2b-256 2467b67aa061dc01c363ea9c9ee498f574ec9f4def395e1193a2ac4ceaee8203

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for airbyte_agent_tiktok_marketing-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ef414e2f05d92769ed252a1f62222239f33a6c883bb9b444efbc86d5aa61da00
MD5 7da6ef501cf58dd218eee368f04b4085
BLAKE2b-256 8cb599ec60f3a03e979e5a7ad1aa68c5c274f3070cd735929b4024b9a339ffe8

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