v1.3
基于开放者的反馈,我们推出了TikTok API for Business v1.3, 提升开发者体验,推出新功能,并减少与TikTok Ads Manager的功能差距。欲了解v1.3功能更新的完整清单,请参考功能更新。
为了帮助您更好地发现新旧版本的不同,我们为API 参考中的每个接口文档都增加了对比表格。我们建议您在迁移前阅读这些表格。
时间线
v1.3在2022年8月15日推出,我们会同时支持v1.2至2023年8月15日。2023年8月15日后,v1.2版本将被淘汰。
重大改动
URL中的版本号改变
您需要将所有接口URL中的版本号从v1.2改为v1.3。
提升开发者体验
为了提升开发者体验,我们在v1.3推出了更为一致的API界面,这些改动适用于所有接口。
ID改为string类型
在v1.2为number类型的ID参数在v1.3全改为string类型,以解决与一些客户端的兼容问题。
参数命名改变
在v1.3, 我们保证所有参数的命名是一致的,且清晰易理解。
比如,在 /adgroup/create/ 接口中, ios_osv 改名为 min_ios_version, deep_external_action 改名为 secondary_optimization_event, store_authorized_bc 改名为 store_authorized_bc_id.
另一个例子是将所有筛选条件object都命名为filtering。
Boolean参数中只使用True/False
所有Boolean参数都使用True/False,而不是1/0 或Yes/No。
一致的返回格式
所有接口的返回格式都是统一的。下列为成功返回的示例,失败返回也有类似的格式以及错误码和报错信息。
(code Success-Response http)
HTTPS/1.1 200 OK
{
"message": "OK",
"code": 0,
"data": {}
}
(/code)
一致的时间格式
时间类型参数,比如create_time,都使用datetime格式(YYYY-MM-DD HH:MM:SS, ISO 8601),而非时间戳。
URL改动
一些v1.2接口名称不易理解。因此,我们在v1.3对这些接口的URL做了改动。URL中的实体(entity)变为了单数,与其他接口保持一致。 - 企业账户
|旧接口{50%} | 新接口{50%}|
|---|---|
| /business/get/ (POST) | /business/get/ (GET) |
| /business/videos/list/ (POST) | /business/video/list/ (GET) |
| /business/comments/list/ (POST) | /business/comment/list/ (GET) |
| /business/comments/replies/list/ (POST) | /business/comment/reply/list/ (GET) |
| /business/comments/create/ | /business/comment/create/ |
| /business/comments/replies/create/ | /business/comment/reply/create/ |
| /business/comments/delete/ | /business/comment/delete/ |
| /business/comments/hide/ | /business/comment/hide/ |
| /business/comments/like/ | /business/comment/like/ |
| /business/comments/pin/ | /business/comment/pin/ |
| /business/videos/publish/ | /business/video/publish/ |
- 商务中心
|旧接口{50%} | 新接口{50%}|
|---|---|
| /asset/ad/bind_info/ | /asset/bind/quota/ |
- 广告创编
|旧接口{50%} |新接口{50%}|
|---|---|
| /ad/tools/audience_size/ | /ad/audience_size/estimate/ |
| /adgroup/rf/inventory/estimate/ | /rf/inventory/estimate/ |
| /adgroup/rf/order/cancel/ | /rf/order/cancel/ |
| /campaign/update/status/ | /campaign/status/update/ |
|/adgroup/update/status/|/adgroup/status/update/|
|/ad/update/status/|/ad/status/update/|
|/adgroup/update/budget/|/adgroup/budget/update/|
|/pangle_flow_package/get/|/pangle_audience_package/get/|
- 商品库
| 旧接口 {50%} | 新接口 {50%} |
|---|---|
| /catalog/set/info/ | /catalog/set/product/get/ |
| /catalog/video/get/ | /catalog/video_package/get/ |
| /catalog/eventsource_bind/create/ | /catalog/eventsource/bind/ |
| /catalog/available_countries/get/ | /catalog/available_country/get/ |
| /catalog/eventsource_bind/delete/ | /catalog/eventsource/unbind/ |
- 更改日志
|旧接口{50%} | 新接口{50%}|
|---|---|
| /activities/task/check/ | /changelog/task/check/ |
| /activities/task/create/ | /changelog/task/create/ |
| /activities/task/download/ | /changelog/task/download/ |
- 创意
|旧接口{50%} | 新接口{50%}|
|---|---|
| /creative/image/tailor/ | /creative/image/edit/ |
| /creative/reports/get/ | /creative/report/get/ |
- 事件
|旧接口{50%} | 新接口{50%}|
|---|---|
| /app/external_action/ | /app/optimization_event/|
| /app/external_action/retargeting/ | /app/optimization_event/retargeting/|
- 线索
|旧接口{50%} | 新接口{50%}|
|---|---|
| /pages/leads/mock/create/ | /page/lead/mock/create/ |
| /pages/leads/mock/delete/ | /page/lead/mock/delete/ |
| /pages/leads/mock/get/ | /page/lead/mock/get/ |
| /pages/leads/task/ | /page/lead/task/ |
| /pages/leads/task/download/ | /page/lead/task/download/ |
| /pages/fields/get/ | /page/field/get/ |
| /pages/library/get/ | /page/library/get/ |
| /pages/library/transfer/ | /page/library/transfer/ |
- 落地页
|旧接口{50%} | 新接口{50%}|
|---|---|
| /pages/get/ | /page/get/ |
- Pangle
|旧接口{50%} | 新接口{50%}|
|---|---|
| /pangle_flow_package/get/ | /pangle_audience_package/get/ |
- 报表
|旧接口{50%} | 新接口{50%}|
|---|---|
| /reports/integrated/get/ (GET) | /report/integrated/get/ |
| /reports/integrated/get/ (POST) | /report/task/create/ |
| /reports/task/check/ | /report/task/check/ |
| /reports/task/download/ | /report/task/download/ |
| /reports/ad_benchmark/get/ | /report/ad_benchmark/get/ |
| /reports/video_performance/get/ | /report/video_performance/get/ |
- 达人平台
|旧接口{50%} | 新接口{50%}|
|---|---|
| /tcm/spark_ads/status/get/ | /tcm/spark_ad/status/get/ |
| /tcm/spark_ads/apply/ | /tcm/spark_ad/apply/ |
| /tcm/reports/get/ | /tcm/report/get/ |
| /tcm/item/audit_status/get/ | /tcm/video/audit_status/get/ |
| /tcm/item/audit_status/update/ | /tcm/video/audit_status/update/ |
| /creator/get/ | /tcm/creator/authorized/ |
| /creator/video/list/ | /tcm/creator/authorized/video/list/ |
| /tcm/creator/search/ | /tcm/creator/public/ |
| /tcm/creator/video/list/ | /tcm/creator/public/video/list/ |
- 工具
|旧接口{50%} | 新接口{50%}|
|---|---|
| /tools/target_recommend_tags/ | /tool/targeting_category/recommend/ |
| /tools/suggest_bid/ | /tool/bid/recommend/ |
| /tools/hashtag/recommend/ | /tool/hashtag/recommend/ |
| /tools/hashtag/get/ | /tool/hashtag/get/ |
| /tools/diagnosis/get/ | /tool/diagnosis/get/ |
| /tools/suggestion/adopt/ | /tool/diagnosis/adopt/ |
| /tools/action_category/ | /tool/action_category/ |
| /tools/carrier/ | /tool/carrier/ |
| /tools/device_model/ | /tool/device_model/ |
| /tools/interest_category/ | /tool/interest_category/ |
| /tools/interest_keywords/ | /tool/interest_keyword/ |
| /tools/language/ | /tool/language/ |
| /tools/regions/ | /tool/region/ |
| /tools/os_version/ | /tool/os_version/ |
| /tools/open_url/ | /tool/open_url/ |
| /tools/timezone/ | /tool/timezone/ |
| /tools/brand_safety/partner/authentication/ | /tool/brand_safety/partner/authorize/status/ |
新功能
以下列出了v1.3版本的新功能。
受众管理
- 我们现支持通过客户文件API使用单个或多个 ID 上传文件。
- 我们上线了/dmp/custom_audience/apply/接口,可以将自定义受众应用到多个广告组,或断开受众与广告组之间的关联;上线了/dmp/custom_audience/apply/log/接口,可以获取自定义受众的最新应用记录。
- 我们目前在/dmp/custom_audience/file/upload/中支持的最大文件大小已从50MB增加为250MB。
商务中心
- 我们上线了新接口/bc/advertiser/disable/,您可以使用该接口永久停用商务中心中的广告账户。
- 我们更新了接口/bc/advertiser/create/,支持在代理商商务中心和直客商务中心中创建合约广告账户或竞价广告账户。
- 我们上线了商务中心-资产组API,您可以使用该系列接口创建、更新、获取、删除资产组。
广告创编
在迁移至1.3版本前,请先阅读推广系列管理接口迁移指南,了解推广系列管理API 1.2与1.3版本之间的重点差异。
程序化广告
我们为程序化广告推出了新的接口,以缩小API与TikTok Ads Manager 的功能差距。新接口为 /ad/aco/create/, /ad/aco/update/, /ad/aco/get/ 和 /ad/aco/material_status/update/。同时,旧接口(/ad/dynamic/create/, /ad/dynamic/get/, 和 /ad/dynamic/update/) 将被淘汰。
在新接口中,我们新支持“潜在客户开放”和“参与度“作为推广目标,同时也支持动态CTA。此外,media_info的素材数量从10上升到30。您也可以通过新接口创建Spark Ads。
推广系列/广告组/广告
- 当您使用/campaign/create/,/campaign/update/,/adgroup/create/ ,/adgroup/update/ , //ad/create/ 或 /ad/update/ 接口创建或更新广告时,我们会返回广告所有信息。这样您无需额外通过GET接口获取这些信息。
- 推广目标简化: 我们推出了应用推广和网站转化量推广目标,助您简化广告创建过程。
- 您现在可以创建优化目标为落地页浏览量的广告组。新的枚举值
TRAFFIC_LANDING_PAGE_VIEW已被添加至参数 optimization_goal 中,与此优化目标相关的枚举值LANDING_PAGE_VIEW也已被添加至参数 optimization_event 中。 - 您现在可以使用全部库存或标准库存来配置品牌安全。您也可以在广告投放后使用更多类型的合作伙伴(比如,DOUBLE_VERIFY 和 IAS )对广告进行第三方品牌安全和可见性监测。
推广系列预算优化
我们现已支持推广系列预算优化(CBO),帮助广告主达到最好的推广系列投放效果。
效果预估API
我们推出了效果预估功能,提供出价和预算推荐,帮助提升广告组的表现。 您可以使用/delivery/budget/recommend/ 获取11组推荐预算及对应的预估转化数据,或使用/delivery/bid/recommend/获取7组推荐出价及对应的预估花费数据。使用效果预估功能前,请先查看获取推荐预算及获取推荐出价 ,了解前提条件和使用步骤。
iOS 14 专属推广系列配额优化
iOS 14 专属推广系列配额优化可以让您在每个广告网络中,为单个 iOS 应用分别创建11个 iOS 14 专属推广系列。
获取线索
我们已支持调用/v1.3/adgroup/create/来使用第三方网站表单创建线索广告。
轮播广告
我们支持创建轮播广告。轮播广告是TikTok上的新增广告样式,支持在信息流广告中使用图片。
购物广告
我们推出了购物广告。购物广告是用于最大化商家影响的付费广告解决方案,具有商品库驱动,更加智能、简约的特点。
拆分对比测试
我们在1.3版本推出了新的拆分对比测试API,从而减少其与TikTok广告管理平台的功能差异,并提供更多功能及灵活性。欲了解更多使用案例及提示,请查看拆分对比测试。您可以点击这里查看相关接口。
广告定向
- 我们在广告组接口(/adgroup/create/, /adgroup/update/, /adgroup/get/, /ad/audience_size/estimate/)新增了
zipcode_ids参数,可用于邮政编码定向。邮政编码定向目前仅支持定向美国的地域。 - 我们新增了地域ID,可用于定向更多英国、 德国、法国、美国、菲律宾、加拿大的地区。
- 我们在/adgroup/create/, /adgroup/update/, /ad/audience_size/estimate/中新增
spending_power(消费能力)定向选项,您可以通过该字段选择高消费人群进行定向投放。 - 我们上线了购买意向定向功能。您可以使用广告组接口(/adgroup/create/,/adgroup/update/,/adgroup/get/,/ad/audience_size/estimate/)定向近期行为表明有意向购买某内容类别商品的受众。
- 我们新增 /v1.3/tool/targeting/list/ 接口,支持获取用于定向受众的互联网服务提供商ID。
覆盖和频次广告
- 当您通过 /adgroup/rf/create/ 或 /adgroup/rf/update/接口创建或更新覆盖和频次广告时,我们会返回所有的广告信息。这样您无需额外通过GET接口获取这些信息。
- 在v1.3版本中,我们也减少了API产品与TikTok Ads Manager的功能差距。比如,我们在 /rf/inventory/estimate/接口中新增
rf_purchased_type,budget,purchased_impression和purchased_reach字段,帮助开发者更方便地预估库存。 estimate_key从 /adgroup/rf/create/, /adgroup/rf/update/ 和 /rf/inventory/estimate/中淘汰。
商品库管理
- 我们在 /v1.3/catalog/product/file/ 接口的请求参数新增字段
update_mode,支持通过文件URL上传商品时选择覆盖更新或增量更新模式。 - 我们上线了新接口/catalog/feed/switch/,您可以使用该接口修改更新源的计划状态。
- 我们在/catalog/feed/update/中新增枚举值
SUPPLEMENT。 - 我们更新了/catalog/product/update/接口支持增量更新和自定义标签。
创意管理
广告预览
- 我们支持预览购物广告。我们在 /creative/ads_preview/create/中新增了
shopping_ads_type等字段,帮助您预览购物广告。 - 我们在 /creative/ads_preview/create/接口中新支持了
PAGE,CARD, 和ADS_CREATION作为预览类型。您可以在preview_type(原命名:material_type)中填入ADS_CREATION,边创编边预览广告。 - 我们也更加地还原了广告预览效果。
创意素材包
我们在/creative/portfolio/create/和/creative/portfolio/get/
接口中已支持STICKER(倒计时贴纸)、DOWNLOAD_CARD(下载卡)、PRODUCT_CARD(商品卡片)、SHOWCASE(TikTok 橱窗)素材包类型。
智能修复
我们已新增智能修复功能,可以帮助您自动检测并修复潜在的广告复审问题。
创意报表
我们改进了 /v1.3/report/video_performance/get/ 接口,以添加其对获取视频素材关键帧指标的视频洞察的支持。
报表
- 您现在可通过(/report/integrated/get/ 和 /report/task/create/) 接口分别请求同步和异步报表。在v1.2版本中,只有/reports/integrated/get/接口通过Get/POST方法区分同步和异步报表。
- CHUNK模式在v1.2是白名单功能,但在v1.3 全部开发者都可以使用该模式。CHUNK模式在 /report/integrated/get/中的
query_mode开启时,获取报表数据的响应时间会缩短,并且请求更加稳定。 - 我们推出了新的报表指标,进一步缩小API与TikTok Ads Manager 的指标差距。
- 我们为/report/integrated/get/新增了响应头X-Tt-Ads-Throttle。当返回的广告ID数量超过10,000条时,会在响应头部添加警告。
- 如果您请求的维度或指标互斥,我们会报错。
淘汰旧接口
身份验证
- 淘汰/oauth2/access_token_v2/ ,使用 /oauth2/access_token/。
- 淘汰/oauth2/refresh_token/ ,因为已提供长期访问令牌。
- 淘汰/oauth2/creator_token/,使用新接口 /tt_user/oauth2/token/。
程序化广告
- 淘汰/ad/dynamic/create/ ,使用新接口 /ad/aco/create/ 。
- 淘汰 /ad/dynamic/get/ ,使用新接口 /ad/aco/get/ 。
- 淘汰 /ad/dynamic/update/,使用新接口 /ad/aco/update/ 。
报表
- 淘汰 /audience/ad/get/, /audience/adgroup/get/, 和/audience/campaign/get/ 。您可通过 /report/integrated/get/获取受众信息。
- 淘汰 /reports/ad/get/, /reports/adgroup/get/, /reports/advertiser/get/ 和 /reports/campaign/get/ ,您可通过 /report/integrated/get/获取相关广告信息。