(To be deprecated) Create a Legacy Smart+ Campaign — TikTok Business API

(To be deprecated) Create a Legacy Smart+ Campaign

Request

Endpoint

Authentication & shop

Request parameters

Request examples

curl -s -X POST "https://partner.quantri360.com/v1/tiktok_business/campaign/spc/create/" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"objective_type":"","campaign_name":"","promotion_type":"","optimization_goal":"","billing_event":"","location_ids":[],"budget":0,"schedule_type":"","schedule_start_time":"","media_info_list":[{"media_info":{}}],"title_list":[{}],"call_to_action_list":[{}],"product_info":{},"card_list":[{}],"page_list":[{}],"landing_page_urls":[{}],"utm_params":[{}],"disclaimer_info":{},"app_tracking_info_list":[{}]}'

import requests

KEY = "q360_live_..."  # khóa API của brand
r = requests.post(
    "https://partner.quantri360.com/v1/tiktok_business/campaign/spc/create/",
    params={},
    json={
        "objective_type": "",
        "campaign_name": "",
        "promotion_type": "",
        "optimization_goal": "",
        "billing_event": "",
        "location_ids": [],
        "budget": 0,
        "schedule_type": "",
        "schedule_start_time": "",
        "media_info_list": [
            {
                "media_info": {}
            }
        ],
        "title_list": [
            {}
        ],
        "call_to_action_list": [
            {}
        ],
        "product_info": {},
        "card_list": [
            {}
        ],
        "page_list": [
            {}
        ],
        "landing_page_urls": [
            {}
        ],
        "utm_params": [
            {}
        ],
        "disclaimer_info": {},
        "app_tracking_info_list": [
            {}
        ]
    },
    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/spc/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({"objective_type":"","campaign_name":"","promotion_type":"","optimization_goal":"","billing_event":"","location_ids":[],"budget":0,"schedule_type":"","schedule_start_time":"","media_info_list":[{"media_info":{}}],"title_list":[{}],"call_to_action_list":[{}],"product_info":{},"card_list":[{}],"page_list":[{}],"landing_page_urls":[{}],"utm_params":[{}],"disclaimer_info":{},"app_tracking_info_list":[{}]}),
});
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/spc/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, '{"objective_type":"","campaign_name":"","promotion_type":"","optimization_goal":"","billing_event":"","location_ids":[],"budget":0,"schedule_type":"","schedule_start_time":"","media_info_list":[{"media_info":{}}],"title_list":[{}],"call_to_action_list":[{}],"product_info":{},"card_list":[{}],"page_list":[{}],"landing_page_urls":[{}],"utm_params":[{}],"disclaimer_info":{},"app_tracking_info_list":[{}]}');
$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": {
        "pixel_id": null,
        "carousel_image_index": null,
        "deeplink": "",
        "adgroup_secondary_status": "ADGROUP_STATUS_AUDIT",
        "gender": "GENDER_UNLIMITED",
        "special_industries": null,
        "location_ids": [
            "6252001"
        ],
        "schedule_end_time": "{{schedule_end_time}}",
        "excluded_audience_ids": null,
        "shopping_ads_fallback_type": null,
        "promotion_type": "APP_ANDROID",
        "product_ids": null,
        "automatic_add_on_enabled": null,
        "budget": {{budget}},
        "skip_learning_phase": true,
        "impression_tracking_url": null,
        "share_disabled": false,
        "deep_bid_type": "DEFAULT",
        "engaged_view_attribution_window": "SEVEN_DAYS",
        "conversion_bid_price": null,
        "is_advanced_dedicated_campaign": false,
        "promotion_website_type": null,
        "schedule_type": "SCHEDULE_START_END",
        "attribution_event_count": "ONCE",
        "campaign_app_profile_page_state": "UNSET",
        "product_set_id": null,
        "roas_bid": null,
        "call_to_action_id": "{{call_to_action_id}}",
        "app_promotion_type": "APP_INSTALL",
        "languages": [],
        "is_smart_performance_campaign": true,
        "call_to_action_list": [],
        "click_tracking_url": null,
        "modify_time": "{{modify_time}}",
        "bid_price": null,
        "media_info_list": [
            {
                "media_info": {
                    "video_info": {
                        "video_id": "{{video_id}}",
                        "file_name": "{{file_name}}"
                    },
                    "identity_type": null,
                    "aigc_disclosure_type": null,
                    "music_info": null,
                    "tiktok_item_id": null,
                    "image_info": [
                        {
                            "web_uri": "{{web_uri}}"
                        }
                    ],
                    "identity_id": null
                }
            }
        ],
        "catalog_creative_toggle": null,
        "advertiser_id": "{{advertiser_id}}",
        "app_id": "{{app_id}}",
        "identity_type": "CUSTOMIZED_USER",
        "card_list": null,
        "campaign_secondary_status": "CAMPAIGN_STATUS_ENABLE",
        "page_list": null,
        "scheduled_budget": 0,
        "bid_type": "BID_TYPE_NO_BID",
        "placements": [
            "PLACEMENT_TIKTOK",
            "PLACEMENT_PANGLE"
        ],
        "app_download_url": "{{app_download_url}}",
        "view_attribution_window": "ONE_DAY",
        "create_time": "{{create_time}",
        "dayparting": 
"111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
        "product_specific_type": null,
        "catalog_authorized_bc_id": null,
        "schedule_start_time": "{{schedule_start_time}}",
        "comment_disabled": false,
        "campaign_type": "REGULAR_CAMPAIGN",
        "deeplink_type": null,
        "campaign_id": "{{campaign_id}}",
        "product_source": null,
        "blocked_pangle_app_ids": null,
        "carousel_image_labels": null,
        "billing_event": "OCPM",
        "campaign_name": "{{campaign_name}}",
        "app_name": "{{app_name}}",
        "optimization_goal": "INSTALL",
        "video_download_disabled": false,
        "operation_status": "ENABLE",
        "click_attribution_window": "SEVEN_DAYS",
        "title_list": [
            {
                "title": "{{title}}"
            }
        ],
        "landing_page_urls": null,
        "spc_audience_age": "18+",
        "app_type": "APP_ANDROID",
        "spc_type": "UNSET",
        "web_all_in_one_catalog_status": null,
        "optimization_event": "ACTIVE",
        "objective_type": "APP_PROMOTION",
        "placement_type": "PLACEMENT_TYPE_AUTOMATIC",
        "exclude_age_under_eighteen": true,
        "identity_id": "{{identity_id}}",
        "budget_mode": "BUDGET_MODE_DYNAMIC_DAILY_BUDGET",
        "catalog_id": null
    }
}

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