Get max delivery or creative boost sessions within a campaign
GET/campaign/gmv_max/session/list/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/campaign/gmv_max/session/list/
Description
Use this endpoint to retrieve all active max delivery sessions for products or creative boost sessions for videos within a Product GMV Max Campaign.
Sessions that have ended cannot be accessed via /campaign/gmv_max/session/list/. To access details of those sessions, use /campaign/gmv_max/session/get/.
Request
Endpoint
GET https://partner.quantri360.com/v1/tiktok_business/campaign/gmv_max/session/list/
Authentication & shop
| Name | In | Type | Sample | Description |
|---|---|---|---|---|
| Authorization | header | header | Bearer q360_live_ab12cd34_… | Khóa API của brand (tạo ở mục API key). Bắt buộc với mọi request. Brand suy từ key — không truyền mã brand. |
| platform_shop_id | query | string | 7000000000000000001 | Tài sản TikTok Business đã kết nối — "Mã tài sản" ở trang Nền tảng hoặc GET /v1/platforms (tài khoản quảng cáo cho Marketing API, tài khoản TikTok cho Organic / Messaging). Có thể bỏ khi chỉ kết nối một tài sản. |
Request parameters
| Name | In | Type | Required | Sample | Description |
|---|---|---|---|---|---|
| campaign_id | query | string | Yes | The ID of the Product GMV Max Campaign.
- To create a Product GMV Max Campaign and obtain the campaign ID, use /campaign/gmv_max/create/ and set shopping_ads_type to PRODUCT.
- To filter existing Product GMV Max Campaigns within your ad account, use /gmv_max/campaign/get/ and set filtering to {"gmv_max_promotion_types":["PRODUCT_GMV_MAX"]}. |
Request examples
curl -s "https://partner.quantri360.com/v1/tiktok_business/campaign/gmv_max/session/list/?campaign_id=" \ -H "Authorization: Bearer $KEY"
Python
import requests
KEY = "q360_live_..." # khóa API của brand
r = requests.get(
"https://partner.quantri360.com/v1/tiktok_business/campaign/gmv_max/session/list/",
params={
"campaign_id": ""
},
headers={"Authorization": f"Bearer {KEY}"},
timeout=60,
)
print(r.status_code)
print(r.json())Node.js
const KEY = 'q360_live_...'; // khóa API của brand
const url = new URL('https://partner.quantri360.com/v1/tiktok_business/campaign/gmv_max/session/list/');
for (const [k, v] of Object.entries({"campaign_id":""})) 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
<?php $key = 'q360_live_...'; // khóa API của brand $url = 'https://partner.quantri360.com/v1/tiktok_business/campaign/gmv_max/session/list/' . '?' . http_build_query(['campaign_id' => '']); $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)
| Name | Type | Sample | Description |
|---|---|---|---|
| code | number | Response code. For the complete list of response codes and descriptions, see Appendix-Return Code. | |
| message | string | Response message. For details, see Appendix - Return Codes. | |
| request_id | string | The log ID of a request, which uniquely identifies the request. | |
| data | object | Returned data. | |
| session_list | object[] | The list of max delivery sessions for products or creative boost sessions for videos within the Product GMV Max Campaign. | |
| campaign_id | string | The ID of the Product GMV Max Campaign. | |
| bid_type | string | Session type. Enum values: - `NO_BID`: max delivery session. - `CREATIVE_NO_BID`: creative boost session. | |
| session_id | string | The ID of the max delivery session for the product or creative boost session for the video in the Product GMV Max Campaign. - When `bid_type` is `NO_BID`, this field represents the ID of a max delivery session. - When `bid_type` is `CREATIVE_NO_BID`, this field represents the ID of a creative boost session. | |
| budget | float | The daily max delivery budget or daily creative boost budget. - Max delivery uses additional budget, separate from target ROI optimization budget, paced for more predictable ad spending. Your target ROI budget won’t be used for products using max delivery while max delivery is active. - Creative Boost is a functionality within Product GMV Max that allows sellers to manually promote specific videos by allocating extra daily budget. | |
| product_list | object[] | Details about the specific products. | |
| spu_id | string | The Product SPU (standard product unit) ID. | |
| schedule_type | string | Schedule type for max delivery or creative boost. Enum values: - `SCHEDULE_FROM_NOW`: To enable the max delivery or creative boost mode for the product continuously after the `schedule_start_time`, until the campaign scheduled end time. - `SCHEDULE_START_END`: To enable the max delivery or creative boost mode for the product between the `schedule_start_time` and `schedule_end_time`. | |
| schedule_start_time | string | The start time for the max delivery or creative boost mode, in the format of `YYYY-MM-DD HH:MM:SS` (UTC+0). | |
| schedule_end_time | string | The end time for the max delivery or creative boost mode, in the format of `YYYY-MM-DD HH:MM:SS` (UTC+0). |
Response sample
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"session_list": [
{
"bid_type": "NO_BID",
"budget": {{budget}},
"campaign_id": "{{campaign_id}}",
"product_list": [
{
"spu_id": "{{spu_id}}"
}
],
"schedule_end_time": "{{schedule_end_time}}",
"schedule_start_time": "{{schedule_start_time}}",
"schedule_type": "SCHEDULE_FROM_NOW",
"session_id": "{{session_id}}"
}
]
}
}
Get started
- Sign up for Partner
- Enable a data type of the Ads (Marketing API) group on the platform page
- Create an API key (tick the TikTok Business channel)
- Call it as in the examples above