查验文件名是否重名
您可以使用本接口查验一个或多个文件名是否已用于现有图片或视频的命名。
注意
同一个广告账户（advertiser_id）下不允许有重名的图片或视频。若您未查验文件名便调用/file/image/ad/upload/或 /file/video/ad/upload/接口上传图片或视频，随后出现重名报错，您需重新上传文件。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/file/name/check/
方法 GET
Header
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
参数
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
| advertiser_id {必填} | string | 广告主ID。 |
| files {+条件必填} | object[] |<ul><li>若想查验单个文件名是否重名，`file_name` 和 `file_type`必填。</li><li>若想查验多个文件名是否重名，`files`必填。</li></ul><br>想要查验是否重名的文件名信息。 <br><br>最大数量：20。 |
#| file_name {+条件必填} | string | 传入 `files` 时必填。 <br><br>文件名称。 |
#| file_type | string | 文件类型。<br><br>枚举值：`VIDEO`（视频），`IMAGE`（图片）。 <br>默认值：`VIDEO`。 |
| file_name {+条件必填} | string | <ul><li>若想查验单个文件名是否重名，`file_name` 和 `file_type`必填。</li><li>若想查验多个文件名是否重名，`files`必填。</li></ul><br>文件名称。 |
| file_type {+条件必填} | string | <ul><li>若想查验单个文件名是否重名，`file_name` 和 `file_type`必填。</li><li>若想查验多个文件名是否重名，`files`必填。</li></ul><br>文件类型。<br><br>枚举值：`VIDEO`（视频），`IMAGE`（图片）。 <br>默认值：`VIDEO`。 |
示例
查验单个文件名是否重名
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/file/name/check/?advertiser_id={{advertiser_id}}&file_name={{file_name}}&file_type={{file_type}}' \
--header 'Access-Token: {{Access-Token}}'
(/code)
查验多个文件名是否重名
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/file/name/check/?advertiser_id={{advertiser_id}}&files=[{"file_name":"{{file_name}}","file_type":"VIDEO"},{"file_name":"{{file_name}}","file_type":"VIDEO"}]' \
--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| 返回数据。 |
#| duplicate | boolean | 仅当请求中未传入 `files` 时返回本字段。<br><br>单个文件名是否重名。<br><br> 允许值：`true`，`false`。 |
#| duplicate_material_id | boolean | 仅当 `duplicate` 为 `true` 时返回。<br><br>已使用此文件名的图片或视频的素材 ID。 |
#| batch_results | object[] | 仅当请求中传入 `files` 时返回本字段。<br><br>文件名列表的查验结果。 |
##| file_name | string | 文件名称。 |
##| duplicate | boolean | 文件名是否重名。<br><br> 允许值：`true`，`false`。 |
##| duplicate_material_id | string | 仅当`duplicate`为`true`时返回。 <br><br>已使用此文件名的图片或视频的素材 ID。 |
示例
查验单个文件名是否重名
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"duplicate": false
}
}
(/code)
查验多个文件名是否重名
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"batch_results": [
{
"duplicate": false,
"file_name": "{{file_name}}"
},
{
"duplicate_material_id": "{{duplicate_material_id}}",
"duplicate": true,
"file_name": "{{file_name}}"
}
]
}
}
(/code)