Developer resources

Get the recommended GMV Max ROI target and budget — TikTok Business API

Get the recommended GMV Max ROI target and budget · call it through Quantri360 with one API key for your own accounts / assets that you connected and authorized — 360 handles request signing and refreshing the authorization you granted.

Open in the API index TikTok Business platform page

Get the recommended GMV Max ROI target and budget

GET/gmv_max/bid/recommend/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/gmv_max/bid/recommend/

Description

Use this endpoint to obtain the recommended ROI target and budget for a Product GMV Max or Live GMV Campaign that uses a specific TikTok Shop.

Request

Endpoint

GET https://partner.quantri360.com/v1/tiktok_business/gmv_max/bid/recommend/

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	Description
store_id	query	string	Yes	The ID of the TikTok Shop. To obtain a TikTok Shop that is available for GMV Max Campaigns, use /gmv_max/store/list/ and confirm that the returned `is_gmv_max_available` is `true`.
shopping_ads_type	query	string	Yes	The type of the GMV Max Campaign. Enum values: - `PRODUCT`: Product GMV Max Campaign. - `LIVE`: Live GMV Max Campaign.
optimization_goal	query	string	Yes	Optimization goal. Enum value: - `VALUE`: Gross revenue.
item_group_ids	query	string[]	No	Valid only when `shopping_ads_type` is `PRODUCT`. The list of SPU (standard product unit) IDs for specific products to be promoted in a Product GMV Max Campaign. - If you want to promote all products from the TikTok Shop in the Product GMV Max Campaign, you don't need to pass this field. - If you want to promote specific products from the TikTok Shop in the Product GMV Max Campaign, specify these products via this field. Max size: 50. To obtain the list of SPU IDs for products within a TikTok Shop, use /store/product/get/. Set `ad_creation_eligible` to `GMV_MAX` and select `item_group_id` values where `status` is `AVAILABLE` and `gmv_max_ads_status` is `UNOCCUPIED`.
identity_id	query	string	No	Required and valid only when `shopping_ads_type` is `LIVE` The LIVE source identity that you want to use in a LIVE GMV Max Campaign. To obtain a list of identities for LIVE GMV Max Campaigns, use /gmv_max/identity/get/ and select identities with`live_gmv_max_available` as `true`.

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok_business/gmv_max/bid/recommend/?store_id=&shopping_ads_type=&optimization_goal=" \
  -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/gmv_max/bid/recommend/",
    params={
        "store_id": "",
        "shopping_ads_type": "",
        "optimization_goal": ""
    },
    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/gmv_max/bid/recommend/');
for (const [k, v] of Object.entries({"store_id":"","shopping_ads_type":"","optimization_goal":""})) 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/gmv_max/bid/recommend/' . '?' . http_build_query(['store_id' => '', 'shopping_ads_type' => '', 'optimization_goal' => '']);
$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	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.
roas_bid	number	Recommended ROI target for the optimization goal Groess revenue. The ROI is based on the average ROI for your product category.
budget	number	Recommended daily budget for the optimization goal Groess revenue, in the currency of the ad account. The budget is calculated with your average ad spend for your selected products or average ad spend in your product category from the previous 14 days. Higher budgets are recommended to ensure delivery throughout the day because lower budgets may spend more quickly and limit your campaign performance. To retrieve the currency of an ad account, use /advertiser/info/ and check the returned `currency`.

Response sample

HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "budget": 300,
        "roas_bid": 2
    }
}

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