获取试玩素材
此接口可用于获取试玩素材列表。
v1.2 与 v1.3 接口对比
下表概述了 v1.2 接口与 v1.3 接口之间的差异。
``xtable
|变更{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径|/v1.2/playable/get/|/v1.3/playable/get/|
|请求参数类型 |advertiser_id: number<br>playable_id: number|advertiser_id: string<br>playable_id: string|
|返回参数类型|advertiser_id: number<br>playable_id: number|advertiser_id: string<br>playable_id: string|
|新增返回参数|/|operation_status`|
## 请求
**地址** https://business-api.tiktok.com/open_api/v1.3/playable/get/
**方法** GET
**Header**
``` xtable
| 字段 | 类型 | 描述 |
|---|---|---|
| Access-Token {必填} | string | 授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
参数
| 字段 | 类型 | 描述 |
|---|---|---|
| advertiser_id {必填} | string | 广告主 ID。 |
|playable_id|string|用于筛选结果的试玩素材 ID。|
|playable_name|string|用于筛选结果的试玩素材名称。|
|playable_url|string|试玩 URL。|
|status|string|试玩素材状态。<br><br>枚举值:`AUDIT_FAIL`、`AUDIT_SUCCESS`、`VALIDATE_FAIL`、`VALIDATE_SUCCESS`、`VALIDATING`。|
|operation_status|string|试玩素材运行状态。<br><br>枚举值:`UPLOADED`、`SAVED`、`DELETED`。<br>默认值:`SAVED`。|
|page|number|当前页码。<br><br>值范围:≥ 1。<br>默认值:1。|
|page_size|number|分页大小。<br><br>值范围:1-100。<br>默认值:10。 |
示例
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/playable/get/?advertiser_id={{advertiser_id}}&page=1&page_size=100' \
--header 'Access-Token: {{Access-Token}}'
(/code)
返回
| 字段 | 类型 | 描述 |
|---|---|---|
|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|返回数据。|
#|list|object []|试玩素材列表。|
##|advertiser_id|string|广告主 ID。|
##|playable_id|string|试玩素材 ID。|
##|playable_url|string|试玩 URL。|
##|playable_name|string|试玩素材名称。|
##|playable_orientation|string|试玩素材方向。<br><br>枚举值:<ul><li>`BOTH`:竖版或横版。</li><li>`LANDSCAPE`:横版。</li><li>`PORTRAIT`:竖版。</li></ul>|
##|status|string|试玩素材状态。<br><br>枚举值:`AUDIT_FAIL`、`AUDIT_SUCCESS`、`VALIDATE_FAIL`、`VALIDATE_SUCCESS`、`VALIDATING`。|
##|operation_status|string|试玩素材运行状态。<br><br>枚举值:`UPLOADED`、`SAVED`、`DELETED`。|
#|page_info |object | 分页信息。 |
##|page |number | 当前页码。 |
##|page_size |number | 分页大小。 |
##|total_number |number | 结果总数。 |
##|total_page |number |结果总页数。 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"list": [
{
"advertiser_id": "{{advertiser_id}}",
"operation_status": "SAVED",
"playable_id": "{{playable_id}}",
"playable_name": "{{playable_name}}",
"playable_orientation": "BOTH",
"playable_url": "{{playable_url}}",
"status": "VALIDATE_SUCCESS"
}
],
"page_info": {
"page": 1,
"page_size": 100,
"total_number": 1,
"total_page": 1
}
}
}
(/code);