上传试玩素材
此接口可用于上传试玩素材。
v1.2 与 v1.3 接口对比
下表概述了 v1.2 接口与 v1.3 接口之间的差异。
``xtable
|变更{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径|/v1.2/playable/upload/|/v1.3/playable/upload/|
|请求参数类型 |advertiser_id: number|advertiser_id: string|
|返回参数类型|playable_id: number|playable_id`: string|
## 请求
**接口**
https://business-api.tiktok.com/open_api/v1.3/playable/upload/
**方法** POST
**Header**
``` xtable
| 字段 | 类型 | 描述 |
|---|---|---|
| Access-Token {必填} | string | 授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
| Content-Type {必填} | string | 请求信息类型<br>允许的值:`"multipart/form-data"` |
参数
| 字段 | 类型 | 描述 |
|---|---|---|
| advertiser_id {必填} | string | 广告主 ID。 |
| upload_type | string | 上传试玩素材的方式。<br><br>枚举值:`UPLOAD_BY_FILE`、`UPLOAD_BY_FILE_ID`。<br>默认值:`UPLOAD_BY_FILE`。 |
| playable_package {+条件必填} | file |当 `upload_type` 为 `UPLOAD_BY_FILE` 时,此为必填字段。<br><br>试玩素材文件。<br><br>规格要求:<br>1. 文件为 ZIP 格式,大小不超过 5 MB。<br>2. 已访问试玩 JS-SDK,调用方法为 `window.openAppStore();`<br>3. 主 HTML 文件需命名为 `index.html`,且位于主目录下。<br>4. `playable_orientation` 字段应存储在 `config.json` 文件中,且位于一级目录下,值为 0 (`BOTH`)、1 (`PORTRAIT`) 或 2 (`LANDSCAPE`)。示例:`{ "playable_orientation": 0, }`。<br>5. 文件名仅可包含大小写字母、数字、减号和下划线。<br>6. 文件中不得使用 `mraid.js` 格式。<br>7.文件不得通过外部网络加载动态素材。<br>8. 文件不得使用 JS 重定向。<br>9.文件不得发起 HTTP 请求。<br>10.不得上传内容为空的文件。 |
|file_id{+条件必填}| string | 当 `upload_type` 为 `UPLOAD_BY_FILE_ID` 时,此为必填字段。<br><br>要上传的文件的 `file_id`。此字段适用于已上传到文件库的文件。<br>你可以通过[文件](https://business-api.tiktok.com/portal/docs/files/v1.3)接口获取 `file_id`。 |
示例
(code curl http)
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/playable/upload/' \
--header 'Access-Token: {{Access-Token}}' \
--header 'Content-Type: multipart/form-data' \
--form 'advertiser_id="{{advertiser_id}}"' \
--form 'upload_type="UPLOAD_BY_FILE"' \
--form 'playable_package=@"{{playable_package}}"'
(/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|返回数据|
#| playable_id | string | 试玩素材 ID。 |
示例
(code Success-Response http)
HTTPS / 1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"playable_id": "{{playable_id}}"
}
}
(/code);