上传受众文件
您可以使用本接口上传受众数据文件。文件上传后,您将得到一个全局唯一的file_path,可用于后续创建或更新受众。
查看身份标识符标准化指南,了解身份标识符标准化的相关步骤。
提示
请查看下表了解本接口相关的文件大小、文件格式、加密和文件上传的要求。欲获取关于文件限制的更多信息以及客户文件示例模板,请参考客户文件。
| 类型 {30%}| 详情{70%} |
|---|---|
| 文件大小 | 请确保上传的文件小于250MB,超过250MB的文件将会被拒绝。 <br>对于超过250MB 的文件,可以将源文件分割成小文件分别上传,然后使用得到的多个`file_path`,通过接口[通过文件创建受众](https://ads.tiktok.com/marketing_api/docs?rid=4eezrhr6lg4&id=1739940570793985)生成一个完整的受众群体。 |
| 文件格式| 仅支持`csv`或`txt`文件格式。 |
| 加密 | 支持MD5加密或者 SHA256加密后的文件,推荐使用 SHA256加密。 <br><br> 需要通过`calculate_type`字段来声明加密状态。欲获取该字段的枚举值,可参见[枚举值-加密类型](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。当`calculate_type`设置为`PHONE_SHA256`时,请确保加密前手机号均为E.164格式,如+442071838750,加密后64位, 由a-f, A-F, 和数字组成。可了解更多[格式示例](https://ads.tiktok.com/help/article?aid=6721963343558475781)。 |
|标识符文件上传|您可以使用单个或多个ID类型上传文件。<br>如果使用多个ID类型上传文件,`calculate_type`必须设为`MULTIPLE_TYPES`, 且必须要有表头。支持的表头有"MAID","phone_SHA256","email_SHA256","MAID_SHA256","MAID_MD5"。 参阅[创建客户文件受众-客户文件API](https://ads.tiktok.com/marketing_api/docs?id=1747012327159809&rid=w8dfmqpyld9)了解详细步骤。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径| /v1.2/dmp/custom_audience/file/upload/|/v1.3/dmp/custom_audience/file/upload/|
|请求参数类型|advertiser_id: number<br>|advertiser_id`: string
|
## 请求
**地址** https://business-api.tiktok.com/open_api/v1.3/dmp/custom_audience/file/upload/
**方法** POST
**Header**
``` xtable
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
|Content-Type {必填}|string|请求信息类型。<br>允许格式: `multipart/form-data`。|
参数
请在请求body中包含请求参数,并选择form-data格式。file字段为file类型。
|字段|类型|描述|
|---|---|---|
|advertiser_id {必填}|string|广告主ID。|
|file {必填}|file|数据文件。仅支持`.txt`或者`.csv`文件。 |
|file_signature {必填}|string|文件的MD5,用于服务端校验文件完整性。|
|calculate_type {必填} |string |加密类型。加密类型需要和实际文件数据类型保持一致,否则上传将会失败,后续受众人群创建也会失败。枚举值详见[枚举值-加密类型](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。 |
示例
(code curl http)
curl --location 'https://business-api.tiktok.com/open_api/v1.3/dmp/custom_audience/file/upload/' \
--header 'Access-Token: {{Access-Token}}' \
--header 'Content-Type: multipart/form-data' \
--form 'file=@"/path/to/your/file"' \
--form 'advertiser_id="{{advertiser_id}}"' \
--form 'file_signature="{{file_signature}}"' \
--form 'calculate_type="{{calculate_type}}"'
(/code)
返回
|字段|类型|描述|
|---|---|---|
|code |number|返回码,详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|message |string|返回信息,详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|data |object|返回数据。|
#|file_path |string|在TikTok内部的文件地址。 <br><p><span style="color:darkred"><b>注意</b></span>:只有最初用于上传受众文件的广告主 ID,才能随后使用返回的 `file_path` 来创建受众。|
|request_id |string|请求的日志ID,唯一标识一个请求。
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"message": "OK",
"code": 0,
"data": {
"file_path": "f19fa450136c460f"
},
"request_id":"11111111111"
}
(/code);