广告物料上传
上传一张图片或一个视频。上传成功后,物料自动绑定到指定广告账户。
请求地址 : https://catyph.ximalaya.com/ads-catyph/v1/segment/upload
请求方式 : POST
Content-Type : multipart/form-data
请求头参数 :
| 字段名 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| access-token | string | 是 | 鉴权用 access-token |
请求参数 :
传参形式 : Form Data
| 字段名 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| ad_account_id | int | 是 | 操作广告账户 ID,账户须已授权给当前开发者 |
| files | file | 是 | 每次只能上传一张图片或一个视频 |
支持的文件:
- 图片:JPG、JPEG、PNG、GIF
- 视频:MP4
- 每次请求仅允许上传一个文件,图片和视频不能同时上传
- 文件格式必须与文件真实内容一致,仅修改文件扩展名不能通过校验
- JPG 和 JPEG 按同一种图片格式处理
- 文件大小、图片或视频分辨率、宽高比以及 GIF/视频时长,必须同时匹配同一条当前可用广告样式规则
- GIF 和视频时长按实际秒数校验;无法解析时长且样式配置了时长限制时,上传失败
请求示例:
Bash
curl -X POST \
'https://catyph.ximalaya.com/ads-catyph/v1/segment/upload' \
-H 'access-token: ACCESS_TOKEN' \
-F 'ad_account_id=AD_ACCOUNT_ID' \
-F 'files=@/absolute/path/banner.jpg;type=image/jpeg'
图片和视频必须分开请求,不能在一次请求中同时上传。
返回字段释义:
| 字段名 | 类型 | 描述 |
|---|---|---|
| status | int | 0 表示成功,其他值表示失败 |
| type | string | SUCCESS 表示成功,ERROR 表示失败 |
| msg | string | 成功时返回 success;失败时返回具体失败原因 |
| trace_id | string | 每次请求的唯一 ID,用于问题排查 |
接口不返回素材 ID、URL、MD5、尺寸等其他业务数据。
成功示例:
JSON
{
"status": 0,
"type": "SUCCESS",
"msg": "success",
"trace_id": "045394684339f2d5561448a920bcff8c"
}
失败示例:
JSON
{
"status": 10010022,
"type": "ERROR",
"msg": "视频分辨率不符合要求:实际720×1280,支持的最小分辨率为1280×720",
"trace_id": "045394684339f2d5561448a920bcff8c"
}
失败原因:
| 状态码 | 失败原因示例 | 说明 |
|---|---|---|
10010003 | 权限校验不通过 | access-token 无效、已过期,或广告账户未授权 |
10010020 | 上传文件为空 | 未选择文件或文件内容为空 |
10010025 | 每次只能上传一张图片或一个视频 | 一次请求提交了多个文件 |
10010021 | 不支持文件扩展名,或文件真实格式与扩展名不一致 | 仅支持 JPG、JPEG、PNG、GIF 和 MP4;服务端会识别文件真实格式 |
10010026 | 无法从文件名识别素材格式 | 文件名没有有效扩展名 |
10010027 | 图片内容无法解析 | 图片损坏或不是有效的 JPG、JPEG、PNG、GIF |
10010028 | 视频内容无法解析 | 视频损坏或不是标准 MP4 视频 |
10010029 | 读取上传文件失败 | 服务端读取上传内容失败,请重新选择文件上传 |
10010022 | 文件大小不符合要求 | 实际大小超过当前格式在可用样式中允许的最大值 |
10010022 | 图片或视频分辨率不符合要求 | 实际宽高未达到可用样式配置的最小宽高 |
10010022 | 图片或视频比例不符合要求 | 实际宽高比不符合可用样式配置 |
10010022 | 无法获取 GIF 动画或视频时长 | 样式配置了时长限制,但服务端无法解析素材时长 |
10010022 | GIF 动画或视频时长不符合要求 | 实际时长不在可用样式配置范围内 |
10010022 | 文件各项参数未能同时匹配同一样式 | 单项参数分别有效,但没有一条样式同时满足全部条件 |
10010023 | 素材已存在 | 当前广告账户下已存在 MD5、文件类型及比例相同的有效素材 |
10010030 | 文件上传失败 | 文件上传失败,请稍后重试 |
10010031 | 物料处理失败 | 物料处理失败,请稍后重试 |
10010032 | 物料绑定广告账户失败 | 物料绑定广告账户失败,请稍后重试 |
10050002 | 服务端异常 | 服务端异常 |