工具 API

creative_report_get

Runs a basic report on creative assets using /open_api/v1.3/creative/report/get/. Reports can include both undeleted and deleted creative assets. To generate creative-level cost data, first create ads or campaigns through /ad/create/, /ad/aco/create/, or /campaign/spc/create/; if no ads or campaigns were created, or they have generated no cost, the report may return empty results.

ecommerceOAuth1 积分

调用信息

工具标识
tiktok-ads.creative_report_get
服务提供方
TikTok 广告
平均响应
0 ms
近 7 天调用
0

输入参数

advertiser_id

Advertiser account ID to run the report for. Either `advertiser_id` or `advertiser_ids` must be set.

advertiser_ids

Either advertiser_id or advertiser_ids has to be set.

end_date

Required when `lifetime` is `false`. End date in closed interval format, for example `2020-01-01`, in the advertiser time zone.

filtering

Filtering criteria for the report.

info_fields

Creative info fields to return. Default: [`material_id`, `video_id`, `image_id`, `page_id`]. Allowed values are all fields shown under `info` in the response.

lifetime

Whether to query all data. If `true`, you do not need to specify `start_date` and `end_date`. Supported values: `true`, `false`. Default value: `false`.

material_type

Material type to report on.

metrics_fields

Metrics or dimension fields to return. Default: [`impressions`, `spend`]. Allowed values are all fields under `metrics` in the response.

page

Page number. Default value: 1. Range: >= 1.

page_size

Page size. Default value: 10. Range: 1-1000.

report_type必填

Report type. Enum values: VIDEO_INSIGHT: a Video Insights report for one or more advertiser accounts.

sort_field

Field to sort by. Supports sorting by material creation time and all metrics fields. By default, results are not sorted.

sort_type

Sorting order. Default value: `DESC`.

start_date

Required when `lifetime` is `false`. Start date in closed interval format, for example `2020-01-01`, in the advertiser time zone.