跳转至

原始需求

# ECERPH-14378 tiktok》新增tiktok广告推广列表页面 🚀 0-1 需求 | 状态:已完成 | 创建:2024-08-02 | 最后更新:2026-05-18 云效链接 负责人:陈家宜 | 需求类型:交付先锋(便捷性等) | 模块:TikTok-达人模块 | 迭代:20240918-常规-9月第三迭代

原始需求描述

  1. 背景(谁?什么问题?有什么影响?为什么?)

UI图:https://www.figma.com/design/R8QFuJz7Qqvn7gxfdVxCs9/TikTok%E4%B8%93%E7%89%88?node-id=10646-2283&t=fcA97hxjI7bM85cI-0

  1. 需求(做什么?怎么做?有什么要注意的?)

  1. 对接中心接口

(1)中台接口需求:https://devops.aliyun.com/projex/req/ECERPJ-4298# 《中台》Tiktok广告接口对接》

(2)接口请求频率说明

接口名称

作用

请求说明

获取账号信息

获取账号状态、时区、币种

每天请求一次

获取广告系列列表

获取广告系列基础信息

1. 按照账号时区换算成时区的当前时间然后按照创建时间进行获取

2.初次请求拉取最近 30 天的创建的广告系列

3.自动更新逻辑:

今天数据15分钟更新一次。

昨天、前天数据30分钟更新一次

4-7天的数据1小时更新一次

8-14天的数据3小时更新一次

14-30天的数据12小时更新

30天-60天的数据1天更新一次

60天以上的数据停止自动更新,用户有需要自行手动更新

3.暂不开放手动更新的按钮(二期安排)

获取广告组列表

获取广告组基础信息

1. 按照campaign_ids获取对应广告系列下的广告组

2.自动更新逻辑同上

获取广告

获取广告基础信息

1. 按照campaign_ids获取对应广告系列下的广告

2.自动更新逻辑同上

获取基础报表

获取基础报表的数据

1. 按照系统内的广告系列、广告组、广告查询基础数据

2.按照天的维度获取数据。

3.自动更新逻辑同上。

更新广告

更新广告基础属性

根据用户操作触发

更新广告状态

关停,开启或者删除广告

根据用户操作触发

更新广告组预算

更新广告组的总预算或设置广告组日预算或动态日预算

根据用户操作触发

更新广告组

更改广告组属性

根据用户操作触发

更新广告组状态

关停,开启或者删除广告组

根据用户操作触发

更新广告系列

更新推广系列的预算

根据用户操作触发

更新广告系列操作状态

关停,开启或者删除广告系列

根据用户操作触发

2.广告推广列表字段说明

(1)属性字段:每个广告层级的属性字段,这些字段无法进行合计计算是每个广告层级的基础属性说明。仅需要获取最新数据更新即可

①广告账户

系统字段

数据来源

接口字段

备注

是否默认显示

广告账号iD

获取账号信息

advertiser_id

广告账号名称

获取账号信息

name

广告账号公司名称

获取账号信息

company

广告账号国家

获取账号信息

country

广告账号币种

获取账号信息

currency

广告账号行业

获取账号信息

industry

广告账号状态

获取账号信息

status

状态枚举值

STATUS_DISABLE    已关闭

STATUS_PENDING_CONFIRM    申请待审核

STATUS_PENDING_VERIFIED    待验证

STATUS_CONFIRM_FAIL    审核失败

STATUS_ENABLE    已批准

STATUS_CONFIRM_FAIL_END    CRM审核失败

STATUS_PENDING_CONFIRM_MODIFY    修改待审核

STATUS_CONFIRM_MODIFY_FAIL    修改审核失败

STATUS_LIMIT    受到处罚

STATUS_WAIT_FOR_BPM_AUDIT    CRM系统待审核

STATUS_WAIT_FOR_PUBLIC_AUTH    银行账户待验证

STATUS_SELF_SERVICE_UNAUDITED    自助服务账户资格待验证

STATUS_CONTRACT_PENDING    合同尚未生效

广告账号时区

获取账号信息

timezone

广告账号时区名称

获取账号信息

display_timezone

广告账号可用余额

获取账号信息

balance

创建时间

获取账号信息

create_time

广告系列数量

系统统计

点击跳转到广告系列tab页面并且选中对应的广告账户,筛选出对应的广告系列

广告主账号

系统

系统授权的广告账号

显示账号别名和账号英文名

②广告系列

系统字段名称

数据来源

接口字段

备注

是否默认显示

广告账户

获取广告系列列表

advertiser_id

广告系列id

获取广告系列列表

campaign_id

创建时间

获取广告系列列表

create_time

更新时间

获取广告系列列表

modify_time

广告系列名称

获取广告系列列表

campaign_name

投放策略

获取广告系列列表

bid_type

预算方式

获取广告系列列表

budget_mode

枚举值:

BUDGET_MODE_INFINITE: Unlimited budget.(无限预算)

BUDGET_MODE_TOTAL: Lifetime budget.(生命周期预算)

BUDGET_MODE_DAY : Daily budget.(每日预算)

BUDGET_MODE_DYNAMIC_DAILY_BUDGET: (动态每日预算) 

操作状态

获取广告系列列表

operation_status

枚举值:

ENABLE 开启

DISABLE 关闭

次要状态

获取广告系列列表

secondary_status

枚举值看campign状态说明

预算

获取广告系列列表

budget

广告组数量

系统统计

点击跳转到广告组tab页面并且筛选广告系列id筛选出该广告系列下所有的广告组

广告主账号

系统

系统授权的广告账号

显示账号别名和账号英文名

广告系列次要状态和系统字段:广告系列投放状态的映射关系

广告系列状态枚举值

次要状态返回参数

次要状态系统名称

未投放

CAMPAIGN_STATUS_ADVERTISER_AUDIT_DENY

广告主账号审核未通过

未投放

CAMPAIGN_STATUS_ADVERTISER_AUDIT

广告主账号审核中

未投放

ADVERTISER_CONTRACT_PENDING

合同未生效

未投放

ADVERTISER_ACCOUNT_PUNISH

广告主账户被惩罚

投放中

CAMPAIGN_STATUS_ENABLE

广告系列投放中

已删除

CAMPAIGN_STATUS_DELETE

推广系列已删除

未投放

CAMPAIGN_STATUS_ADVERTISER_AUDIT_DENY

广告主账号审核未通过

未投放

CAMPAIGN_STATUS_ADVERTISER_AUDIT

广告主账号审核中

未投放

ADVERTISER_CONTRACT_PENDING

合同未生效

未投放

ADVERTISER_ACCOUNT_PUNISH

广告主账户被惩罚

未投放

CAMPAIGN_STATUS_BUDGET_EXCEED

推广系列超出预算

未投放

CAMPAIGN_STATUS_IDENTITY_USED_BY_GMV_MAX_AD

发布身份不可用,因为已被其他最大成交额广告使用。

已暂停

CAMPAIGN_STATUS_DISABLE

推广系列已暂停

已暂停

CAMPAIGN_STATUS_AWAITING_RELEASE

等待释放

投放中

CAMPAIGN STATUS_ENABLE

广告系列投放中

③广告组字段说明

系统字段名称

数据来源

接口字段

备注

是否默认显示

广告账户

获取广告组列表

advertiser_id

广告系列id

获取广告组列表

campaign_id

广告组id

获取广告组列表

adgroup_ids

创建时间

获取广告组列表

create_time

更新时间

获取广告组列表

modify_time

广告组名称

获取广告组列表

adgroup_name

操作状态

获取广告组列表

operation_status

ENABLE : The ad is enabled (in 'ON' status).   开

DISABLE: The ad is disabled (in 'OFF' status).  关

FROZEN: The ad is terminated and cannot be enabled.   关并且不能再开启

主状态

获取广告组列表

primary_status

主要状态保存在库即可

次要状态

获取广告组列表

secondary_status

次要状态需要翻译后显示在界面上

竞价策略

获取广告组列表

bid_strategy

BID_TYPE_CUSTOM 成本上限

BID_TYPE_NO_BID  最大投放量

出价

获取广告组列表

bid_price

广告投放时间(起始)

获取广告组列表

schedules.start_time

广告投放时间(结束)

获取广告组列表

schedules.end_time

店铺ID

获取广告组列表

store_id

需要使用这个店铺ID去关联系统的内授权的tk店铺。能关联到的请看下则显示店铺别名和店铺ID。如果无法正常关联的话则只显示店铺id,店铺别名处显示--

店铺授权id

获取广告组列表

store_authorized_bc_id

仅保存

预算模式

获取广告组列表

budget_mode

BUDGET_MODE_TOTAL:总预算

BUDGET_MODE_DYNAMIC_DAILY_BUDGET:动态每日预算

BUDGET_MODE_DAY:每日预算

广告投放时间类型。

获取广告组列表

schedule_type

SCHEDULE_FROM_NOW:持续投放

SCHEDULE_START_END:时间段内投放

广告数量

系统统计

点击挑战到广告tab页面并且筛选上填入广告组id筛选出广告组下的所有广告

广告主账号

系统

系统授权的广告账号

显示账号别名和账号英文名

主要状态和次要状态枚举值说明

主状态枚举值

系统广告组投放状态

支持的secondary_status值

(广告组层级)

次要状态系统名称

STATUS_DELETE

已删除

ADGROUP_STATUS_CAMPAIGN_DELETE

推广系列已删除

STATUS_DELETE

已删除

ADGROUP_STATUS_DELETE

广告组已删除

STATUS_DISABLE

已暂停

ADGROUP_STATUS_CAMPAIGN_DISABLE

推广系列已暂停

STATUS_DISABLE

已暂停

ADGROUP_STATUS_DISABLE

广告组已暂停

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_ADVERTISER_AUDIT_DENY

广告主账号审核未通过

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_ADVERTISER_AUDIT

广告主账号审核中

STATUS_NOT_DELIVERY

未投放

ADVERTISER_CONTRACT_PENDING

合同未生效

STATUS_NOT_DELIVERY

未投放

ADVERTISER_ACCOUNT_PUNISH

广告主账户被惩罚

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_BALANCE_EXCEED

账户余额不足/付费失败

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_CREATE

暂无创意

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_TRANSCODING_FAIL

无法转换视频,请重新上传。

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_AUDIT

新建审核中

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_REAUDIT

修改审核中

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_AUDIT_DENY

审核未通过

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_PARTIAL_AUDIT_NO_DELIVERY

广告组部分审核中,且不在投放中

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_LIVE_NOT_START

LIVE 尚未开始

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_INDUSTRY_QUALIFICATION_MISSING

待补充资质

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_INDUSTRY_QUALIFICATION_EXPIRED

资质已过期

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_INDUSTRY_QUALIFICATION_DENY

资质不通过

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_CAMPAIGN_EXCEED

推广系列超出预算

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_BUDGET_EXCEED

广告组超出预算

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_ADGROUP_PRE_ONLINE

广告组处于预上线状态,尚未开始投放。

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_FROZEN

广告组被冻结

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_NOT_START

未在排期内

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_ASSET_AUTHORIZATION_LOST

素材不可用或相关授权已被撤销

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_PIXEL_UNBIND

Pixel解绑

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_ADGROUP_QUOTA_LIMIT

已超出配额。如要继续,请暂停某个投放中的广告组。

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_IDENTITY_USED_BY_GMV_MAX_AD

发布身份不可用,因为已被其他最大成交额广告使用。

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_SEARCH_KEYWORDS_IN_REVIEW

关键词审核中

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_SEARCH_KEYWORDS_NOT_AVAILABLE

关键词不可用

STATUS_DELIVERY_OK

投放中

ADGROUP_STATUS_SEARCH_KEYWORDS_PARTIAL_APPROVED

关键词部分通过审核

STATUS_DELIVERY_OK

投放中

ADGROUP_STATUS_PARTIAL_AUDIT_DELIVERY_OK

广告组部分审核中,且在投放中

STATUS_DELIVERY_OK

投放中

ADGROUP_STATUS_SHADOW_ADGROUP_REAUDIT

修改审核中

STATUS_DELIVERY_OK

投放中

ADGROUP_STATUS_DELIVERY_OK

投放中

STATUS_TIME_DONE

已完成

ADGROUP_STATUS_TIME_DONE

注意:本状态代表该广告组在所设置的投放结束时间结束投放。

已结束

STATUS_RF_CLOSED

已关闭

ADGROUP_STATUS_RF_DEDUCTION_FAILED

余额不足

STATUS_RF_CLOSED

已关闭

ADGROUP_STATUS_RF_NO_VALID_CREATIVE

无有效广告

STATUS_RF_CLOSED

已关闭

ADGROUP_STATUS_RF_CLOSED_OTHERS

广告组已关闭

STATUS_RF_CLOSED

已关闭

ADGROUP_STATUS_RF_AD_AUDIT_DENY

广告审核失败

STATUS_RF_CLOSED

已关闭

ADVERTISER_ACCOUNT_INVALID

无效账号状态

STATUS_RF_CLOSED

已关闭

ADGROUP_STATUS_RF_ADGROUP_INVALID

覆盖和频次广告组不存在或为其他异常状态

STATUS_RF_CLOSED

已关闭

ADGROUP_STATUS_RF_WITHDRAW_ORDER

预定已取消

STATUS_TIME_DONE

已完成

ADGROUP_STATUS_RF_TERMINATE

广告组已终止

STATUS_TIME_DONE

已完成

ADGROUP_STATUS_RF_TIME_DONE

注意:本状态代表该覆盖和频次广告组由于预算不足或账户余额不足,在所设置的投放结束时间前结束了投放。

已完成

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_RF_NO_DELIVERY_CREATIVE

暂无有效创意

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_RF_SHORT_BALANCE

账户余额低于扣款金额

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_RF_BOOKING

已预订

STATUS_NOT_DELIVERY

未投放

ADGROUP_STATUS_RF_SCHEDULE

已排期

④广告字段说明

系统字段名称

数据来源

接口字段

备注

是否默认显示

广告账户

获取广告

advertiser_id

广告系列id

获取广告

campaign_id

广告组id

获取广告

adgroup_ids

创建时间

获取广告

create_time

更新时间

获取广告

modify_time

广告系列名称

获取广告

campaign_name

广告组名称

获取广告

adgroup_name

广告ID

获取广告

ad_id

广告名称

获取广告

ad_name

商品

获取广告

item_group_ids

存在多个商品的情况,,需要使用此id去关联系统内所有商品的product id。匹配到product id后关联显示商品的图片、店铺、售价、可售数。如果关联不到product id的话则显示--,图片则显示无图占位图

产品集ID

获取广告

product_set_id

仅保存

SKU

获取广告

sku_ids

仅保存

橱窗商品

获取广告

showcase_products.item_group_id

使用橱窗内商品才会出现这个商品。需要使用此id去关联系统内所有商品的product id。匹配到product id后关联显示商品的图片、店铺、售价、可售数。如果关联不到product id的话则显示--,图片则显示无图占位图

橱窗店铺ID

获取广告

showcase_products.store_id

使用橱窗内商品才会出现这个店铺。关联系统授权店铺,关联上则显示店铺别名。无法关联上则显示店铺id,店铺别名显示--

视频 ID

获取广告

video_id

使用视频id拼接就能跳转到tiktok对应的视频上。要么这个字段有值要么是tiktok_item_id有值

图片ID

获取广告

image_ids

主状态

获取广告

primary_status

枚举值看ad状态说明

次要状态

获取广告

secondary_status

枚举值看ad状态说明

操作状态

获取广告

operation_status

ENABLE : The ad is enabled (in 'ON' status).

DISABLE: The ad is disabled (in 'OFF' status).

FROZEN: The ad is terminated and cannot be enabled.

转化事件

获取广告

optimization_event

https://business-api.tiktok.com/portal/docs?id=1739361474981889

Tiktok视频id

获取广告

tiktok_item_id

使用视频id拼接就能跳转到tiktok对应的视频上

推广目标

获取广告

objective_type

APP_PROMOTION    应用推广

WEB_CONVERSIONS    网站转化量

REACH    竞价覆盖。

TRAFFIC    访问量

VIDEO_VIEWS    视频播放量

PRODUCT_SALES    商品销量

ENGAGEMENT    社区互动

LEAD_GENERATION    线索收集

RF_REACH (白名单功能)    合约覆盖和频次或 TikTok Pulse

TOPVIEW_REACH    合约 TopView 

广告主账号

系统

系统授权的广告账号

显示账号别名和账号英文名

主要状态和次要状态枚举值说明

主要状态

广告投放状态枚举值

次要状态返回参数

次要状态系统名称

STATUS_NOT_DELIVERY

未投放

AD_STATUS_ADVERTISER_AUDIT_DENY

广告主账号审核未通过

STATUS_NOT_DELIVERY

未投放

AD_STATUS_ADVERTISER_AUDIT

广告主账号审核中

STATUS_NOT_DELIVERY

未投放

ADVERTISER_CONTRACT_PENDING

合同未生效

STATUS_NOT_DELIVERY

未投放

ADVERTISER_ACCOUNT_PUNISH

广告主账户被惩罚

STATUS_NOT_DELIVERY

未投放

AD_STATUS_AUDIT

新建审核中

STATUS_NOT_DELIVERY

未投放

AD_STATUS_NOT_START

未设置排期

STATUS_DELIVERY_OK

投放中

AD_STATUS_PARTIAL_AUDIT_DELIVERY_OK

广告部分审核中,且在投放中

STATUS_DELIVERY_OK

投放中

AD_STATUS_DELIVERY_OK

广告投放中

STATUS_TIME_DONE

已完成

AD_STATUS_DONE

已完成

STATUS_RF_CLOSED

已关闭

AD_STATUS_PROMOTE_AD_OFFLINE_AUDIT

审核未通过

STATUS_RF_CLOSED

已关闭

AD_STATUS_PROMOTE_ADGROUP_CLOSED

广告组已关闭

STATUS_DELETE

已删除

AD_STATUS_CAMPAIGN_DELETE

推广系列已删除

STATUS_DELETE

已删除

AD_STATUS_ADGROUP_DELETE

广告组已删除

STATUS_DELETE

已删除

AD_STATUS_DELETE

创意已删除

STATUS_NOT_DELIVERY

未投放

AD_STATUS_ADVERTISER_AUDIT_DENY

广告主账号审核未通过

STATUS_NOT_DELIVERY

未投放

AD_STATUS_ADVERTISER_AUDIT

广告主账号审核中

STATUS_NOT_DELIVERY

未投放

ADVERTISER_CONTRACT_PENDING

合同未生效

STATUS_NOT_DELIVERY

未投放

ADVERTISER_ACCOUNT_PUNISH

广告主账户被惩罚

STATUS_NOT_DELIVERY

未投放

AD_STATUS_LIVE_OFFLINE

直播未开始

STATUS_NOT_DELIVERY

未投放

AD_STATUS_BALANCE_EXCEED

账户余额不足/付费失败

STATUS_NOT_DELIVERY

未投放

AD_STATUS_ADGROUP_PARTIAL_AUDIT_NO_DELIVERY

新建审核中

STATUS_NOT_DELIVERY

未投放

AD_STATUS_PARTIAL_AUDIT_NO_DELIVERY

新建审核中

STATUS_NOT_DELIVERY

未投放

AD_STATUS_ADGROUP_AUDIT_DENY

审核未通过

STATUS_NOT_DELIVERY

未投放

AD_STATUS_ADGROUP_INDUSTRY_QUALIFICATION_MISSING

待补充资质

STATUS_NOT_DELIVERY

未投放

AD_STATUS_ADGROUP_INDUSTRY_QUALIFICATION_EXPIRED

资质不通过

STATUS_NOT_DELIVERY

未投放

AD_STATUS_ADGROUP_INDUSTRY_QUALIFICATION_DENY

资质已过期

STATUS_NOT_DELIVERY

未投放

AD_STATUS_MUSIC_AUTHORIZATION_MISSING

缺失音乐资质

STATUS_NOT_DELIVERY

未投放

AD_STATUS_TRANSCODING_FAIL

请替换广告组中出错的视频

STATUS_NOT_DELIVERY

未投放

AD_STATUS_AUDIT

新建审核中

STATUS_NOT_DELIVERY

未投放

AD_STATUS_REAUDIT

修改审核中

STATUS_NOT_DELIVERY

未投放

AD_STATUS_AUDIT_DENY

审核未通过

STATUS_NOT_DELIVERY

未投放

AD_STATUS_PROCESS_AUDIO

音频处理中,如果此状态持续时间过长,请重新上传素材。

STATUS_NOT_DELIVERY

未投放

AD_STATUS_CAMPAIGN_EXCEED

推广系列超出预算

STATUS_NOT_DELIVERY

未投放

AD_STATUS_BUDGET_EXCEED

广告组超出预算

STATUS_NOT_DELIVERY

未投放

AD_STATUS_AD_PRE_ONLINE

广告处于预上线状态,尚未开始投放。

STATUS_NOT_DELIVERY

未投放

AD_STATUS_NOT_START

未设置排期

STATUS_NOT_DELIVERY

未投放

AD_STATUS_ADGROUP_ASSET_AUTHORIZATION_LOST

素材不可用或相关授权已被撤销

STATUS_NOT_DELIVERY

未投放

AD_STATUS_ASSET_AUTHORIZATION_LOST

素材不可用或相关授权已被撤销

STATUS_NOT_DELIVERY

未投放

AD_STAUS_PIXEL_UNBIND

Pixel解绑

STATUS_NOT_DELIVERY

未投放

AD_STATUS_AD_QUOTA_LIMIT

由于你的账户已超出配额,广告组被暂停。如要继续,请暂停某个投放中的广告组。

STATUS_NOT_DELIVERY

未投放

AD_STATUS_PRODUCT_UNAVAILABLE

商品不可用。 请尝试修改此广告,以了解原因。

STATUS_NOT_DELIVERY

未投放

AD_STATUS_ANCHOR_UNAVAILABLE

商品链接不可用。请尝试修改此广告,了解原因。

STATUS_NOT_DELIVERY

未投放

AD_STATUS_NO_AUTHORIZATION_OF_SHOWCASE

广告发布身份不可用。请修改广告以查看详情。

STATUS_DELIVERY_OK

投放中

AD_STATUS_PARTIAL_AUDIT_DELIVERY_OK

广告部分审核中,且在投放中

STATUS_DELIVERY_OK

投放中

AD_STATUS_DELIVERY_OK

广告投放中

STATUS_DISABLE

已暂停

AD_STATUS_CAMPAIGN_DISABLE

推广系列已暂停

STATUS_DISABLE

已暂停

AD_STATUS_ADGROUP_DISABLE

广告组已暂停

STATUS_DISABLE

已暂停

AD_STATUS_DISABLE

广告暂停

STATUS_FROZEN

投放中

ADGROUP_STATUS_FROZEN

广告组被冻结

STATUS_TIME_DONE

已完成

AD_STATUS_DONE

已完成

STATUS_RF_CLOSED

已关闭

AD_STATUS_RF_ADGROUP_CLOSED

广告组已关闭

(2)基础数据指标字段

指标名称

系统名称

数据类型

详细描述

汇总计算公式

是否默认显示

广告主

广告系列

广告组

广告

spend

总消耗

string

在所选择的时间内投放广告产生的花费金额。

求和

true

true

true

true

billed_cost

净消耗

string

不包含广告赠款和优惠券的广告消耗。

注意:

此指标仅支持在同步基础报表中使用。

此指标可能会延迟11小时,并且它在2023年9月1日后才开始有数据。

求和

true

true

true

true

cash_spend

现金消耗

string

所选时间范围内投放广告产生的现金消耗。仅支持广告主层级和分天查询,不支持 lifetime,不支持分时查询。

注意:指标更新可能有 24-48 小时的延迟。

求和

true

false

false

false

cpc

CPC(目标页面)

string

广告花费平均到单次点击(目标页面)的成本。

注意:从 7 月 6 日开始,异步报表中的指标名称已从“CPC”更新为“CPC(目标页面)”。

CPC=总消耗/点击量(目标页面)

CPC=spend/clicks

true

true

true

true

cpm

CPM

string

每千次展现您所产生的平均花费。

CPM=(总消耗/展示数)*1000

CPM=(spend/impressions)*1000

true

true

true

true

impressions

展示数

string

广告展现次数。

求和

true

true

true

true

clicks

点击量(目标页面)

string

用户点击广告并进入广告主指定的目标页面的次数。

注意:从 7 月 6 日开始,异步报表中的指标名称已从“点击量”更新为“点击量(目标页面)”。

求和

true

true

true

true

ctr

CTR(目标页面)

string

广告展现中产生了点击(目标页面)的次数占比。

注意:从 7 月 6 日开始,异步报表中的指标名称已从“CTR”更新为“CTR(目标页面)”。

CTR=(点击量(目标页面)/展示数)× 100%

CTR=(clicks/impressions)× 100%

true

true

true

true

reach

总覆盖人数

string

至少看过一次广告的人数。该指标为预估所得。

求和

true

true

true

true

cost_per_1000_reached

覆盖千人成本

string

覆盖每一千人的平均成本。该指标为预估所得

Cost per 1,000 People Reached =(总消耗/总覆盖人数)*1000

Cost per 1,000 People Reached =(spend/reach)*1000

true

true

true

true

conversion

转化数

string

广告达成目标转化的次数,目标转化会根据创建时的投放设置有所不同(计数结果基于展示时间点统计)。

求和

true

true

true

true

cost_per_conversion

转化成本

string

广告花费平均到单次转化的成本(计数结果基于展示时间点统计)。

CPA

=(总消耗/转化数)× 100%

CPA=(spend/conversion)× 100%

true

true

true

true

conversion_rate_v2

转化率(展示)

string

转化次数占广告获得的总展示次数的百分比。

(总计数是根据每次广告展示的时间计算的。)

转化率=(转化数/展示数)× 100%

CVR (Impression=(conversion/impressions)× 100%

true

true

true

true

real_time_conversion

实时转化

string

广告达成目标转化的次数,目标转化会根据创建时的投放设置有所不同(计数结果基于转化事件发生的时间统计)

求和

true

true

true

true

real_time_cost_per_conversion

实时单次转化费用

string

广告花费平均到单次转化的成本(计数结果基于转化事件发生的时间统计)

Real-time CPA 

=(总消耗/实时转化)× 100%

Real-time CPA =(spend/real_time_conversion)× 100%

true

true

true

true

real_time_conversion_rate_v2

实时转化率(展示)

string

转化次数占广告获得的总展示次数的百分比。

(总计数取决于实际发生转化的时间。)

Real-time转化率=(实时转化/展示数)× 100%

Real-timeCVR (Impression=(real_time_conversion/impressions)× 100%

true

true

true

true

result

成效

string

广告最终实现成效的次数,与您的优化目标相对应。不支持广告主维度和推广系列维度查询(计数结果基于展示时间点统计)

求和

false

false

true

true

cost_per_result

单次成效费用

string

获得单次成效的成本。(计数结果基于展示时间点统计)不支持广告主维度和推广系列维度查询。

Cost per result

=(总消耗/成效)× 100%

Cost per result=(spend/result)× 100%

false

false

true

true

result_rate

成效率 (%)

string

广告观看或点击过程中获得成效的占比。(计数结果基于展示时间点统计)不支持广告主维度和推广系列维度查询。

result_rate=(成效/展示数)× 100%

result_rate=(result/impressions)× 100%

false

false

true

true

real_time_result

实时成效

string

广告最终实现成效的次数,与您的优化目标相对应。不支持广告主维度和推广系列维度查询(计数结果基于转化事件发生的时间统计)

求和

false

false

true

true

real_time_cost_per_result

实时单次成效费用

string

获得单次成效的成本。(计数结果基于转化事件发生的时间统计)不支持广告主维度和推广系列维度查询。

Real-time cost per result=(总消耗/实时成效)× 100%

Real-time cost per result=(spend/real_time_result)× 100%

false

false

true

true

real_time_result_rate

实时成效率 (%)

string

广告观看或点击过程中获得成效的占比。(计数结果基于转化事件发生的时间统计)不支持广告主维度和推广系列维度查询。

Real-time result rate =(实时成效/展示数)× 100%

Real-time result rate =(实时成效/impressions)× 100%

false

false

true

true

frequency

频次

string

平均每个被覆盖用户的观看次数。

frequency=展示数/总覆盖人数

frequency=impressions/reach

true

true

true

false

currency

货币

string

货币代码,比如USD。请注意如果要使用currency作为指标,则请求中的dimensions字段必须包含adgroup_id/ad_id/campaign_id/advertiser_id。

保存即可

true

true

true

true

(3)视频播放数据指标

指标名称

系统名称

数据类型

详细描述

汇总计算公式

video_play_actions

播放次数

string

视频播放的次数,不计重播。

求和

video_watched_2s

播放2s次数

string

视频播放达2s的次数,不计重播。

求和

video_watched_continuous_2s

连续观看 2 秒次数

string

视频至少连续播放 2 秒且至少 50% 的视频像素处于可见区域内的次数。

求和

video_watched_6s

播放6s次数

string

视频播放达6s或播放完成的次数,不计重播。

求和

average_video_play

平均视频播放时长

string

视频平均每次播放时长,包括重播时长。

平均数=求和/非0天的天数

average_video_play_per_user

平均每人播放时长

string

视频平均每人播放时长,包括重播时长。该指标为预估所得。

平均数=求和/非0天的天数

video_views_p25

播放25%次数

string

视频播放到25%的次数,不计重播。

求和

video_views_p50

播放50%次数

string

视频播放到50%的次数,不计重播。

求和

video_views_p75

播放75%次数

string

视频播放到75%的次数,不计重播。

求和

video_views_p100

播放100%次数

string

视频播放到100%的次数,不计重播。

求和

engaged_view

观看6秒次数(专注观看)

string

用户观看视频时长达到6秒,或观看付费广告的一天内与视频互动至少一次。纳入统计的互动包括:点赞,分享,关注,访问主页,点击,话题标签点击,音乐点击,锚点点击,以及创新互动样式行为点击。

求和

engaged_view_15s

观看15秒次数(专注观看)

string

用户观看视频时长达到15秒,或观看付费广告的一天内与视频互动至少一次。纳入统计的互动包括:点赞,分享,关注,访问主页,点击,话题标签点击,音乐点击,锚点点击,以及创新互动样式行为点击。

求和

(4)商店事件指标

指标名称

系统名称

详细描述

汇总计算公式

ROAS(商店)

onsite_shopping_roas

ROAS(商店)

归因于广告的 TikTok Shop 总收入的广告支出回报率 (ROAS)。总计数是根据每次广告展示的时间计算的。

ROAS =总收入(商店)/总消耗

ROAS =total_onsite_shopping_value/spend

付费数(商店)

onsite_shopping

付费数(商店)

归因于广告的 TikTok Shop 订单提交操作数。总计数是根据每次广告展示的时间计算的。

求和

cost_per_onsite_shopping

平均付费成本(商店)

归因于广告的每次 TikTok Shop 付费的平均成本。总计数是根据每次广告展示的时间计算的。

Cost per purchase (Shop) =总消耗/付费数(商店)

Cost per purchase (Shop) =spend/onsite_shopping

onsite_shopping_rate

付费率(商店) (%)

TikTok Shop 付费数占广告点击数的百分比。总计数是根据每次广告展示的时间计算的。

Purchase rate (Shop) =付费数(商店)/点击量(目标页面)*100

Purchase rate (Shop)=onsite_shopping/clicks

value_per_onsite_shopping

平均订单价值(商店)

归因于广告的每次 TikTok Shop 付费的平均订单价值。总计数是根据每次广告展示的时间计算的。

Average order value (Shop) =总收入(商店)/付费数(商店)

Average order value (Shop)=total_onsite_shopping_value/onsite_shopping

total_onsite_shopping_value

总收入(商店)

归因于广告的 TikTok Shop 订单的总收入。用户支付的金额加上 TikTok Shop 平台向用户提供的所有折扣。总计数是根据每次广告展示的时间计算的。

求和

开始结账数(商店)

onsite_initiate_checkout_count

开始结账数(商店)

归因于广告的 TikTok Shop 开始结账操作数,例如商品页面上的"立即购买"和"使用优惠券购买"按钮获得的点击数。总计数是根据每次广告展示的时间计算的。

求和

cost_per_onsite_initiate_checkout_count

开始结账平均成本(商店)

归因于广告的 TikTok Shop 开始结账操作的平均成本。总计数是根据每次广告展示的时间计算的。

Cost per checkout initiated (Shop) =总消耗/开始结账数(商店)

Cost per checkout initiated (Shop) =spend/onsite_initiate_checkout_count

onsite_initiate_checkout_count_rate

开始结账率(商店) (%)

TikTok Shop 开始结账操作数占广告点击数的百分比。总计数是根据每次广告展示的时间计算的。

Checkout initiation rate (Shop) =开始结账数(商店)/点击量(目标页面)*100

Checkout initiation rate (Shop) =onsite_initiate_checkout_count/clicks

value_per_onsite_initiate_checkout_count

开始结账平均价值(商店)

归因于广告的 TikTok Shop 开始结账操作的平均价值。总计数是根据每次广告展示的时间计算的。

Value per checkout initiated (Shop) =开始结账价值(商店)/开始结账数(商店)

Value per checkout initiated (Shop) =value_per_onsite_initiate_checkout_count/onsite_shopping

total_onsite_initiate_checkout_count_value

开始结账价值(商店)

归因于广告的 TikTok Shop 开始结账操作的总价值。总计数是根据每次广告展示的时间计算的。

求和

商品页浏览数(商店)

onsite_on_web_detail

商品页浏览数(商店)

归因于广告的 TikTok Shop 商品详情页浏览数。总计数是根据每次广告展示的时间计算的。

求和

cost_per_onsite_on_web_detail

商品页浏览平均成本(商店)

归因于广告的每次 TikTok Shop 商品详情页浏览的平均成本。总计数是根据每次广告展示的时间计算的。

Cost per product page view (Shop) =总消耗/商品页浏览数(商店)

Cost per product page view (Shop) =spend/onsite_on_web_detail

onsite_on_web_detail_rate

商品页浏览率(商店) (%)

TikTok Shop 商品详情页浏览数占广告点击数的百分比。总计数是根据每次广告展示的时间计算的。

Product page view rate (Shop) =商品页浏览数(商店)/点击量(目标页面)*100

Product page view rate (Shop) =onsite_on_web_detail/clicks

value_per_onsite_on_web_detail

商品页浏览平均价值(商店)

归因于广告的每次 TikTok Shop 商品详情页浏览的平均价值。总计数是根据每次广告展示的时间计算的。

Value per product page view (Shop) =商品页浏览价值(商店)/商品页浏览数(商店)

Value per product page view (Shop) =total_onsite_on_web_detail_value/onsite_on_web_detail

total_onsite_on_web_detail_value

商品页浏览价值(商店)

归因于广告的 TikTok Shop 商品详情页浏览的总价值。总计数是根据每次广告展示的时间计算的。

求和

加入购物车数(商店)

onsite_on_web_cart

加入购物车数(商店)

归因于广告的 TikTok Shop 加入购物车操作数。总计数是根据每次广告展示的时间计算的。

求和

cost_per_onsite_on_web_cart

加入购物车平均成本(商店)

归因于广告的 TikTok Shop 加入购物车操作的平均成本。总计数是根据每次广告展示的时间计算的。

Cost per add to cart (Shop) =总消耗/加入购物车数(商店)

Cost per add to cart (Shop) =spend/onsite_on_web_cart

onsite_on_web_cart_rate

加入购物车率(商店) (%)

TikTok Shop 加入购物车操作数占广告点击数的百分比。总计数是根据每次广告展示的时间计算的。

Add to cart rate (Shop) =加入购物车数(商店)/点击量(目标页面)*100

Add to cart rate (Shop) =onsite_on_web_cart/clicks

value_per_onsite_on_web_cart

加入购物车平均价值(商店)

归因于广告的 TikTok Shop 加入购物车操作的平均价值。总计数是根据每次广告展示的时间计算的。

Value per add to cart (Shop) =加入购物车数(商店)/加入购物车价值(商店)

Value per add to cart (Shop) =onsite_on_web_cart/total_onsite_on_web_cart_value

total_onsite_on_web_cart_value

加入购物车价值(商店)

归因于广告的 TikTok Shop 加入购物车操作的总价值。总计数是根据每次广告展示的时间计算的。

求和

(5)live指标

指标名称

简要描述

详细描述

汇总计算公式

live_views

LIVE 播放量

观众访问您的 LIVE 的次数。 包含重复访问。

求和

live_unique_views

LIVE 去重播放量

进入您的 LIVE 的去重观众的数量。

求和

live_effective_views

LIVE 有效播放量

观众访问您的 LIVE 超过 10 秒的次数。 包含重复访问。

求和

live_product_clicks

LIVE 商品点击数

观众在 LIVE 播放过程中点击商品查看商品详细信息页面的次数。

求和

3.广告列表的操作说明

操作

调用接口

支持操作的广告层级

操作场景

编辑预算

(1)广告系列则调用更新广告系列接口

(2)广告组调用更新广告组预算接口

广告系列

广告组

(1)单个编辑

(2)批量编辑预算

①勾选了不同的广告账户的广告组点击批量编辑则toast提示“请勿勾选不同广告账户的广告系列/广告组进行编辑”

②仅支持勾选20个进行编辑预算,点击超过20个则弹出toast提示“一次只能勾选20条进行操作”

③勾选同个广告账户的广告组点击批量编辑的情况下出现以下弹窗

日预算:budget_mode=BUDGET_MODE_DAY、BUDGET_MODE_DYNAMIC_DAILY_BUDGET

总预算:budget_mode=BUDGET_MODE_TOTAL

无法修改:覆盖和频次广告系列 + SPC +CBO 不支持修改预算

广告系列下buying_types为RESERVATION_RF、RESERVATION_TOP_VIEW 或者is_smart_performance_campaign为ture、budget_optimize_on为ture的广告系列以及下层的广告组都不能进行预算修改

无法修改的广告系列/广告组显示在此无法进行编辑

如果此次勾选的广告系列和广告组没有对应预算类型则显示如下

提交后显示处理结果如下:

编辑出价

(1)广告组调用更新广告组接口更新bid_price

广告组

(1)单个编辑

(2)批量编辑

①仅支持勾选10个进行编辑出价,点击超过20个则弹出toast提示“一次只能勾选10条进行操作”

②勾选了不同的广告账户的广告组点击批量编辑则toast提示“请勿勾选不同广告账户的广告组进行编辑”

③勾选同个广告账户的广告组点击批量编辑的情况下出现以下弹窗

提交编辑的时候

如果billing_event = OCPM 和 bid_type = BID_TYPE_CUSTOM的情况下, 编辑conversion_bid_price

其他情况下,编辑bid_price

提交后显示处理结果如下:

启动/停止/删除

(1)广告系列调用接口更新广告系列操作状态

(2)广告组调用接口更新广告组状态

(3)广告调用接口更新广告状态

广告系列

广告组

广告

仅支持勾选20个进行编辑预算,提示“一次只能勾选20条进行操作”

启动/停止/删除

提交成功

提交失败

  

日志

系统记录

广告系列

广告组

广告

系统固定的日志弹窗。弹窗内容见下的日志场景说明

日志说明

操作人

操作场景

操作文案

系统/用户

平台/用户更新预算

预算由23.00 USD更新为78.12 USD。

系统/用户

平台/用户更新出价

出价由23.00 USD更新为78.12 USD。

系统/用户

平台更新操作状态

操作状态更新为关闭/开启/删除

系统

平台更新投放状态

广告投放状态更新为投放中-超出预算。

4.筛选项

(1)数据显示维度:汇总/日/周/月

汇总:显示筛选时间所有数据的汇总

日:筛选时间内所有的数据按照天的维度分别显示每天的数据

周:筛选时间内数据按照自然周分别显示每周的数据

(2)广告主账号:系统授权账号。下拉显示账号别名并且支持搜索和多选筛选

(3)广告账户:下拉显示广告账户名称支持筛选并且多选筛选

(4)以下字段支持模糊搜索。

广告系列名称

广告组名称

广告名称

广告系列ID

广告组ID

广告ID

(5)广告系列投放状态。支持以下枚举值,支持多选

未投放

投放中

已删除

已暂停

(6)广告组投放状态,支持以下枚举值,支持多选

投放中

未投放

已暂停

已完成

已删除

已关闭

(7)广告投放状态,支持以下枚举值,支持多选

投放中

未投放

已暂停

已完成

已删除

已关闭

5.导出

  

(1)导出的文件名称格式为日期+时间+5位自增数例如2024080817191100001

(2)在哪个页面上点击导出则导出对应广告维度的数据

(3)导出的时候按照勾选的维度导出对应维度的字段。

(4)导出当前广告维度按照筛选结果中最近的1万条数据。