获取最大投放量或创意作品加热时段的详情
您可以使用本接口根据指定的时段 ID 获取最大投放量时段或创意作品加热时段详情。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/campaign/gmv_max/session/get/
方法 GET
Header
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。<br>可以通过[获取访问令牌](1738373164380162.html)接口获取。|
参数
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|advertiser_id {Required}|string|广告主 ID。|
|session_ids{必填}|string[]|商品 GMV Max 推广系列中的商品的最大投放量时段或创意作品加热时段 ID 列表。<br><br>最大数量: 20。<br><br><ul><li>若想获取商品 GMV Max 推广系列中生效状态的最大投放量时段的 ID 列表，可使用 [/campaign/gmv_max/session/list/](1835246996436162.html) 并挑选 `bid_type` 为 `NO_BID` 的时段。</li><li>若想获取商品 GMV Max 推广系列中生效状态的创意作品加热时段的 ID 列表，可使用 [/campaign/gmv_max/session/list/](1835246996436162.html) 并挑选 `bid_type` 为 `CREATIVE_NO_BID` 的时段。</li></ul>|
示例
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/campaign/gmv_max/session/get/?advertiser_id={{advertiser_id}}&session_ids=["{{session_id}}"]' \
--header 'Access-Token: {{Access-Token}}'
(/code)
返回
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|code |number| 返回码。完整返回码列表及描述，参见[附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|message |string| 返回信息。更多信息参见[附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
|request_id |string| 请求的日志 ID，唯一标识一个请求。 |
|data |object| 返回数据。 |
#|session_list|object[]|最大投放量时段或创意作品加热时段列表。|
##|campaign_id|string|商品 GMV Max 推广系列的 ID。|
##|bid_type|string|时段类型。<br><br>枚举值: <ul><li>`NO_BID`: 最大投放量时段。</li><li>`CREATIVE_NO_BID`: 创意作品加热时段。</li></ul>|
##|session_id|string|商品 GMV Max 推广系列中商品的最大投放量时段 ID 或视频的创意作品加热时段 ID。<br><br><ul><li>当 `bid_type` 为 `NO_BID`，此字段代表最大投放量时段。</li><li>当 `bid_type` 为 `CREATIVE_NO_BID`，此字段代表创意作品加热时段。</li></ul> |
##|budget|float|最大投放量日预算或创意作品加热日预算。<br><br><ul><li>最大投放量使用额外的预算，与目标 ROI 优化的预算分开，并按照更可预测的广告支出节奏进行投放。您的目标 ROI 预算不会用于采用最大投放量的商品。</li><li> 商品 GMV Max 推广系列中的创意作品加热功能允许商家手动为特定视频配置额外日预算，用于视频推广。</li></ul> |
##|product_list|object[]|有关特定商品的详情。|
###|spu_id|string|商品 SPU（标准化产品单元） ID。|
##|schedule_type|string|最大投放量或创意作品加热模式的排期类型。<br><br>枚举值:<br><ul><li>`SCHEDULE_FROM_NOW`: 从 `schedule_start_time` 开始，为该商品持续启用最大投放量模式或创意作品加热模式，直到推广系列的排期结束时间。</li><li>`SCHEDULE_START_END`: 在 `schedule_start_time` 和 `schedule_end_time` 排期期间为该商品启用最大投放量模式或创意作品加热模式。</li></ul>|
##|schedule_start_time|string|最大投放量模式或创意作品加热模式的开始时间，格式为 `YYYY-MM-DD HH:MM:SS` (UTC+0)。|
##|schedule_end_time|string|最大投放量模式或创意作品加热模式的结束时间，格式为 `YYYY-MM-DD HH:MM:SS` (UTC+0)。|
##|item_id|string|仅当 `bid_type` 为 `CREATIVE_NO_BID` 时返回。<br><br>启用创意作品加热的视频的 ID。|
示例
(code Success-Response http)
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_start_time": "{{schedule_start_time}}",
"schedule_type": "SCHEDULE_FROM_NOW",
"session_id": "{{session_id}}"
}
]
}
}
(/code)