Get ad groups — TikTok Business API

Get ad groups

Request

Endpoint

Authentication & shop

Request parameters

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok_business/adgroup/get/" \
  -H "Authorization: Bearer $KEY"

import requests

KEY = "q360_live_..."  # khóa API của brand
r = requests.get(
    "https://partner.quantri360.com/v1/tiktok_business/adgroup/get/",
    params={},
    headers={"Authorization": f"Bearer {KEY}"},
    timeout=60,
)
print(r.status_code)
print(r.json())

const KEY = 'q360_live_...'; // khóa API của brand
const url = new URL('https://partner.quantri360.com/v1/tiktok_business/adgroup/get/');
for (const [k, v] of Object.entries({})) url.searchParams.set(k, typeof v === 'object' ? JSON.stringify(v) : String(v));
const r = await fetch(url, {
  method: 'GET',
  headers: { Authorization: `Bearer ${KEY}` },
});
console.log(r.status, await r.json());

<?php
$key = 'q360_live_...'; // khóa API của brand
$url = 'https://partner.quantri360.com/v1/tiktok_business/adgroup/get/' . '?' . http_build_query([]);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $key]);
$res = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, "\n", $res;

Response

Response fields (as returned by TikTok Business)

Response sample

HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "list": [
            {
                "budget_mode": "BUDGET_MODE_TOTAL",
                "included_custom_actions": [],
                "delivery_mode": null,
                "auto_targeting_enabled": false,
                "app_download_url": null,
                "placements": [
                    "PLACEMENT_TIKTOK"
                ],
                "pixel_id": null,
                "conversion_window": null,
                "schedule_type": "SCHEDULE_START_END",
                "brand_safety_partner": null,
                "interest_category_ids": [],
                "adgroup_id": "{{adgroup_id}}",
                "campaign_name": "{{campaign_name}}",
                "schedule_infos": null,
                "share_disabled": false,
                "brand_safety_type": "NO_BRAND_SAFETY",
                "campaign_id": "{{campaign_id}}",
                "ios14_quota_type": "UNOCCUPIED",
                "network_types": [],
                "app_type": null,
                "bid_type": "BID_TYPE_NO_BID",
                "conversion_bid_price": 0,
                "optimization_goal": "CLICK",
                "deep_bid_type": null,
                "video_download_disabled": false,
                "schedule_end_time": "{{schedule_end_time}}",
                "scheduled_budget": 0,
                "is_hfss": false,
                "frequency": null,
                "bid_price": 0,
                "actions": [],
                "deep_cpa_bid": 0,
                "adgroup_name": "{{adgroup_name}}",
                "category_id": "0",
                "purchased_impression": null,
                "budget": {{budget}},
                "app_id": null,
                "promotion_type": "WEBSITE",
                "age_groups": null,
                "next_day_retention": null,
                "pacing": "PACING_MODE_SMOOTH",
                "device_price_ranges": null,
                "location_ids": [
                    "{{location_id}}"
                ],
                "secondary_status": "ADGROUP_STATUS_CREATE",
                "billing_event": "CPC",
                "advertiser_id": "{{advertiser_id}}",
                "create_time": "{{create_time}}",
                "operation_status": "ENABLE",
                "placement_type": "PLACEMENT_TYPE_NORMAL",
                "optimization_event": null,
                "audience_ids": [],
                "secondary_optimization_event": null,
                "excluded_custom_actions": [],
                "languages": [],
                "modify_time": "{{modify_time}}",
                "excluded_audience_ids": [],
                "rf_estimated_cpr": null,
                "skip_learning_phase": false,
                "operating_systems": [
                    "ANDROID"
                ],
                "creative_material_mode": "CUSTOM",
                "search_result_enabled": false,
                "rf_purchased_type": null,
                "inventory_filter_enabled": false,
                "adgroup_app_profile_page_state": null,
                "rf_estimated_frequency": null,
                "gender": "GENDER_UNLIMITED",
                "statistic_type": null,
                "purchased_reach": null,
                "is_new_structure": true,
                "interest_keyword_ids": [],
                "bid_display_mode": "CPMV",
                "dayparting": "111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
                "keywords": null,
                "schedule_start_time": "{{schedule_start_time}}",
                "comment_disabled": false,
                "frequency_schedule": null,
                "feed_type": null
            },
            {
                "budget_mode": "BUDGET_MODE_TOTAL",
                "included_custom_actions": [],
                "delivery_mode": null,
                "auto_targeting_enabled": false,
                "app_download_url": null,
                "placements": [
                    "PLACEMENT_TIKTOK"
                ],
                "pixel_id": null,
                "conversion_window": null,
                "schedule_type": "SCHEDULE_START_END",
                "brand_safety_partner": null,
                "interest_category_ids": [],
                "adgroup_id": "{{adgroup_id}}",
                "campaign_name": "{{campaign_name}}",
                "schedule_infos": null,
                "share_disabled": false,
                "brand_safety_type": "NO_BRAND_SAFETY",
                "campaign_id": "{{campaign_id}}",
                "ios14_quota_type": "UNOCCUPIED",
                "network_types": [],
                "app_type": null,
                "bid_type": "BID_TYPE_NO_BID",
                "conversion_bid_price": 0,
                "optimization_goal": "CLICK",
                "deep_bid_type": null,
                "video_download_disabled": false,
                "schedule_end_time": "{{schedule_end_time}}",
                "scheduled_budget": 0,
                "is_hfss": false,
                "frequency": null,
                "bid_price": 0,
                "actions": [],
                "deep_cpa_bid": 0,
                "adgroup_name": "{{adgroup_name}}",
                "category_id": "0",
                "purchased_impression": null,
                "budget": {{budget}},
                "app_id": null,
                "promotion_type": "WEBSITE",
                "age_groups": null,
                "next_day_retention": null,
                "pacing": "PACING_MODE_SMOOTH",
                "device_price_ranges": null,
                "location_ids": [
                    "{{location_id

Get started

1. Sign up for Partner
2. Enable a data type of the Ads (Marketing API) group on the platform page
3. Create an API key (tick the TikTok Business channel)
4. Call it as in the examples above