流式 API
流式 API 是实时批量修改工具,支持数据合作伙伴公司和高投放量的广告主的高吞吐量需求。对于帮助多个广告主在 TikTok 上活跃受众的合作伙伴公司,我们建议使用流式 API。
注意
流式API仅用于活跃受众合作伙伴或某些高投放量广告主。对于您的受众管理需求,请使用客户文件API。
高投放量广告主的定义是:若您符合高投放量广告主的要求,请联系您的账户经理。
- 广告主至少上传500万个ID至广告账户。
- 需要实时数据刷新来活跃受众和启动广告系列。
- 每月至少有1万美元的支出。
如何申请访问流式 API
- 创建应用并申请受众管理下的“读取自定义受众”的API权限。
- 通过审核后,在应用内找到白名单管理,选择白名单管理下的“申请”。
- 在请求应用功能时,选择"流式API":
- 通过审核后,您将在“白名单管理”版块“白名单功能”下出现“流式API”。
客户文件 API 和流式 API 对比
下表列出了客户文件API和流式API的区别。
| 客户文件API | 流式API | |
|---|---|---|
| 类型 | 文件上传API:通过API上传准备好的文件 | 流式API:通过API实时更新或发送大量流数据 |
| 该API服务的适用者 |
|
|
| 何时使用该API服务 |
|
|
| 目标受众 | 第一方受众 | 第一方和第三方受众 |
| 吞吐量 | 低 (基于文件手动上传) | 高 |
| 是否支持定义受众规则 | 是 | 否 |
| 支持的ID类型 |
|
|
| API请求限制 | 文件上传API(/dmp/custom_audience/file/upload/)频次控制:1QPS/广告主账户,单个文件最大250MB。 创建受众API(/dmp/custom_audience/create/) 频次控制:1QPS/广告主账户。 修改受众API(/dmp/custom_audience/update/)频次控制:1QPS/广告主账户。 |
创建/删除受众细分群API(/segment/audience/)频次控制:1QPS/广告主账户。 受众目标映射API(/segment/mapping/)
|
| 每个账户最多支持的受众数量 | 400 | 400 |
| 服务等级协议 | 发出API调用后,您将立即收到成功/错误的响应。在成功的情况下,我们的系统将异步处理这些ID,其服务等级协议时间为48小时。 | 发出API调用后,您将立即收到成功/错误的响应。在成功的情况下,我们的系统将异步处理这些ID,其服务等级协议时间为48小时。 |
客户文件API使用流程
- 使用/dmp/custom_audience/file/upload/上传客户文件,返回中的
file_path将用于下一步操作。
您可以使用单个或多个ID类型上传文件。如果使用多个ID类型上传文件,calculate_type必须设为MULTIPLE_TYPES, 且必须要有表头。支持的表头有"MAID","phone_SHA256","email_SHA256","MAID_SHA256","MAID_MD5"。所有的表头都不区分大小写。每数据行的字段数量必须和表头数量保持一致。
带有单个ID类型的文件示范:
| 9f5326721cb782c |
| 9f5326721cb782c |
带有多个ID类型的文件示范:
| email_SHA256 | phone_SHA256 | MAID |
|---|---|---|
| 9f5326721cb782c | 9f5326721cb782c | 9f5326721cb782c |
| 9f5326721cb782c | 9f5326721cb782c | 9f5326721cb782c |
- 使用/dmp/custom_audience/create/创建受众,系统返回自定义受众ID(
custom_audience_id)。 - 在/dmp/custom_audience/update/中传入
custom_audience_id,批量更新不同的自定义受众。
流式API使用流程
- 使用/segment/audience/创建受众细分群,系统返回受众ID(
audience_id)。 -
在/segment/mapping/中传入
audience_id, 对同一个企业号下的不同广告账号进行批量受众细分映射。 -
若您想删除受众细分群映射,请使用/segment/mapping/并采用以下设置: - 将
action设置为delete。 - 若您想删除单一ID映射(每个用户或设备对应一个受众ID),传入data;若您想删除多ID映射(每个用户或设备对应多个受众ID),传入batch_data。 -
如果您想删除受众,请按以下步骤操作。请注意,在删除之前,需要先断开受众与广告组之间的关联。
- 使用 /dmp/custom_audience/apply/log/ 检查与要删除的受众相关联的广告组。提供
advertiser_id和custom_audience_ids参数,并在返回中获取adgroup_id。 - 使用 /dmp/custom_audience/apply/断开受众与广告组的关联。传入
advertiser_id、custom_audience_id和adgroup_ids,并将action_mode设置为disconnect。 - 断开关联后,使用/segment/audience/ 删除受众。传入
advertiser_id和delete_audience_id,并将action设置为delete。
流式API相关提示
同一个企业号下有多个广告账号
- 一个企业号可以关联多个广告账号。这种情况下,您只需要对这个企业号下的任意一个广告账号进行一次授权获得访问令牌,就能对其他广告账号使用同一个访问令牌获得这些广告账号的数据。
- 当为同一个企业号下的广告账号创建受众细分群时,您可以使用该企业号下任意一个广告账号获得的访问令牌,为多个广告账号创建受众细分群。
支持的 ID 类型
目前,流式 API 默认支持多个 ID 类型。