Create a GMV Max Campaign — TikTok Business API

Create a GMV Max Campaign

Request

Endpoint

Authentication & shop

Request parameters

Request examples

curl -s -X POST "https://partner.quantri360.com/v1/tiktok_business/campaign/gmv_max/create/" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"request_id":"","store_id":"","store_authorized_bc_id":"","shopping_ads_type":"","optimization_goal":"","deep_bid_type":"","budget":0,"promotion_days":{},"auto_budget":{},"schedule_type":"","schedule_start_time":"","identity_list":[{}],"item_list":[{}],"custom_anchor_video_list":[{}],"campaign_name":""}'

import requests

KEY = "q360_live_..."  # khóa API của brand
r = requests.post(
    "https://partner.quantri360.com/v1/tiktok_business/campaign/gmv_max/create/",
    params={},
    json={
        "request_id": "",
        "store_id": "",
        "store_authorized_bc_id": "",
        "shopping_ads_type": "",
        "optimization_goal": "",
        "deep_bid_type": "",
        "budget": 0,
        "promotion_days": {},
        "auto_budget": {},
        "schedule_type": "",
        "schedule_start_time": "",
        "identity_list": [
            {}
        ],
        "item_list": [
            {}
        ],
        "custom_anchor_video_list": [
            {}
        ],
        "campaign_name": ""
    },
    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/campaign/gmv_max/create/');
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: 'POST',
  headers: { Authorization: `Bearer ${KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({"request_id":"","store_id":"","store_authorized_bc_id":"","shopping_ads_type":"","optimization_goal":"","deep_bid_type":"","budget":0,"promotion_days":{},"auto_budget":{},"schedule_type":"","schedule_start_time":"","identity_list":[{}],"item_list":[{}],"custom_anchor_video_list":[{}],"campaign_name":""}),
});
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/campaign/gmv_max/create/' . '?' . http_build_query([]);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $key, 'Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"request_id":"","store_id":"","store_authorized_bc_id":"","shopping_ads_type":"","optimization_goal":"","deep_bid_type":"","budget":0,"promotion_days":{},"auto_budget":{},"schedule_type":"","schedule_start_time":"","identity_list":[{}],"item_list":[{}],"custom_anchor_video_list":[{}],"campaign_name":""}');
$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": {
        "advertiser_id": "{{advertiser_id}}",
        "age_groups": [
            "AGE_18_24",
            "AGE_25_34",
            "AGE_35_44",
            "AGE_45_54",
            "AGE_55_100"
        ],
        "budget": {{budget}},
        "campaign_id": "{{campaign_id}}",
        "campaign_name": "{{campaign_name}}",
        "custom_anchor_video_list": [],
        "deep_bid_type": "VO_MIN_ROAS",
        "identity_list": [
            {
                "identity_id": "{{identity_id}}",
                "identity_type": "TTS_TT",
                "store_id": "{{store_id}}"
            },
            {
                "identity_id": "{{identity_id}}",
                "identity_type": "TT_USER"
            },
            {
                "identity_authorized_bc_id": "{{identity_authorized_bc_id}}",
                "identity_id": "{{identity_id}}",
                "identity_type": "BC_AUTH_TT"
            }
        ],
        "item_list": [],
        "location_ids": [
            "1562822"
        ],
        "operation_status": "ENABLE",
        "optimization_goal": "VALUE",
        "placements": [
            "PLACEMENT_TIKTOK"
        ],
        "product_specific_type": "ALL",
        "product_video_specific_type": "AUTO_SELECTION",
		"affiliate_posts_enabled": true,
        "roas_bid": {{roas_bid}},
        "schedule_end_time": "{{schedule_end_time}}",
        "schedule_start_time": "{{schedule_start_time}}",
        "schedule_type": "SCHEDULE_START_END",
        "shopping_ads_type": "PRODUCT",
        "store_authorized_bc_id": "{{store_authorized_bc_id}}",
        "store_id": "{{store_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