TikTok Ads Manager ACTION
List Ad Groups
List ad groups in a TikTok Ads account with optional filters. Returns ad group IDs, names, status, budget, schedule, and targeting. Use campaign IDs from List Campaigns to filter. Use ad group IDs returned here as input to List Ads or Create or Update Ad. See the documentation
- Action
- Read only
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's TikTok Ads Manager account once, then configure and run List Ad Groups from your backend or agent.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "tiktok_ads_manager-list-ad-groups",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
tiktok_ads_manager: { authProvisionId: "apn_xxxxxxx" },
advertiserId: "Advertiser ID",
campaignIds: ["Campaign IDs"],
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "tiktok_ads_manager-list-ad-groups",
"configured_props": {
"tiktok_ads_manager": { "authProvisionId": "apn_xxxxxxx" },
"advertiserId": "Advertiser ID",
"campaignIds": ["Campaign IDs"]
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "tiktok_ads_manager",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "tiktok_ads_manager-list-ad-groups",
arguments: {
advertiserId: "Advertiser ID",
campaignIds: ["Campaign IDs"],
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
advertiserId Advertiser ID | string | Your TikTok Ads Manager advertiser ID. Find it in the Ads Manager URL after aadvid= (e.g., aadvid=7123456789012345678). Also visible under Account Info in Business Center. Required |
campaignIds Campaign IDs | string[] | Filter by campaign IDs (max 100). Use List Campaigns to find IDs. Optional |
adgroupIds Ad Group IDs | string[] | Filter by specific ad group IDs (max 100). Optional |
adgroupName Ad Group Name | string | Filter by ad group name. Optional |
primaryStatus Filter by Status | string | Filter by primary status. Default is STATUS_NOT_DELETE (all except deleted). Use STATUS_ALL to include deleted ad groups. Optional |
secondaryStatus Secondary Status | string | Filter by ad group secondary status. Example values: ADGROUP_STATUS_DELIVERY_OK, ADGROUP_STATUS_CAMPAIGN_DISABLE, ADGROUP_STATUS_DELETE. Optional |
objectiveType Objective Type | string | Filter by advertising objective. Example values: REACH, TRAFFIC, VIDEO_VIEWS, CONVERSIONS, APP_PROMOTION. Optional |
billingEvents Billing Events | string[] | Filter by billing event types. Example values: CPC, CPM, OCPM, CPV. Optional |
creationFilterStartTime Created After | string | Return ad groups created after this time. Format: YYYY-MM-DD HH:MM:SS (UTC). A range within 6 months is recommended. Optional |
creationFilterEndTime Created Before | string | Return ad groups created before this time. Format: YYYY-MM-DD HH:MM:SS (UTC). A range within 6 months is recommended. Optional |
page Page | integer | Page number for paginated results. Starts at 1. Optional |
pageSize Page Size | integer | Number of results per page. Default: 10, max: 1000. Optional |
REFERENCE
Tool details
Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.
- Registry key
- tiktok_ads_manager-list-ad-groups
- Version
- 0.0.2
- App
- TikTok Ads Manager
- Authentication
- OAuth
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗