（已废弃）获取报表
您可以使用本接口获取动态场景视频报表。
注意
动态场景API目前处于测试阶段。若要申请使用该接口，请通过白名单功能管理。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径|/v1.2/dynamic_scene/report/get/| /v1.3/dynamic_scene/report/get/|
|请求参数类型|advertiser_id: number |advertiser_id`: string |
## 请求
**地址**
https://business-api.tiktok.com/open_api/v1.3/dynamic_scene/report/get/
**方法** GET
**Header**
``` xtable
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
参数
|字段|类型|描述|
|---|---|---|
|advertiser_id {必填}|string| 广告主ID。 |
| data_level {必填}| string | 要查询的数据层级。目前只支持 `ADGROUP`。|
| input_ids {必填} | string[] | ` data_level `字段的ID。目前只支持广告组ID。 |
| dimensions {必填} | string[] | 报告数据维度组合。例如：`["campaign_id", "stat_time_day"]`表示组合`campaign_id`和`stat_time_day (days)`。<br> 目前只支持`[advertiser_id, adgroup_id, story_arc, order, video_id]` 。请确保同时传递`[advertiser_id, adgroup_id, story_arc, order, video_id]`所有的值。 |
| metrics | string[] | 指标。获取详情请查看下方的返回。 |
| start_time | string | 开始日期，格式为 `YYYY-MM-DD`。该日期基于广告账号的时区。 |
| end_time | string | 结束日期，格式为 `YYYY-MM-DD`。该日期基于广告账号的时区。<br><p><span style="color:darkred"><b>注意</b></span>: 开始和结束日期相差不得超过1年。 |
| order_field | string | 排序字段。除了属性指标之外，所有指标值均支持排序。默认不排序。|
| order_type | string | 排序顺序。枚举值： `ASC`, `DESC`。默认值`DESC`。 |
| filters | object[] | 筛选条件。|
# | field_name | string | 筛选名称。枚举值： `story_arc`，`order`。 |
# | filter_type | string | 筛选类型。目前只支持 `IN`。 |
# | filter_value | string | 筛选值。当使用`IN`筛选类型时，`filter_value` 必须是合法的JSON数组字符串。 <br>如果`filter_name`为`order`，且您想传入所有的可选值，请在此字段填入`-1`。 |
| page | number | 当前页数，默认值：`1`。 |
| page_size | number | 分页大小。范围: 1-1000，默认值：`10`。 |
示例
(code curl http)
{
"advertiser_id": 6865632230773882886,
"data_level": "ADGROUP",
"input_ids": ["1734945725409298"],
"dimensions": ["advertiser_id", "adgroup_id", "story_arc", "order", "video_id"],
"order_field": "complete_plays",
"start_time": "2022-06-09",
"end_time": "2022-06-15",
"filters": [
{"field_name": "story_arc", "filter_type": "IN", "filter_value": "[\"wing display\", \"wing display\", \"wing display\", \"wing display\", \"Ending CTA\"]"},
{"field_name": "order", "filter_type": "IN", "filter_value": "[\"-1\"]"}
]
}
(/code)
返回
|字段|类型|描述|
|---|---|---|
|code |number|返回码，详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|message |string|返回信息，详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|list |object[]|返回数据。|
#|dimension|object|维度。|
##|advertiser_id|string|广告主ID。|
##| adgroup_id|string|广告组ID。|
##|story_arc|string|故事线，包含多个槽位。|
##|order|number|槽位在故事线中的顺序，范围是0到5。|
##|video_id|string|已创建的视频ID。|
#|metric|object|指标。|
##| clicks|float|视频点击数。|
##| complete_plays|float|视频完整播放数。|
##| break_plays|float|视频中断播放数。|
##| ctr|float|视频点击率。|
##| complete_play_rate|float|视频完整播放率。|
##| break_play_rate|float|视频中断播放率。|
|request_id |string|请求的日志id，唯一标识一个请求。 |
示例
(code Success-Response http)
{
"code": 0,
"message": "OK",
"request_id": "202206240742360102452460661D20FC4D",
"data": {
"list": [
{
"metrics": {
"scene_play_complete": 3190,
"clicks": 172,
"complete_play_rate": 0.1,
"play_break_count": 29242,
"break_play_rate": 0.9,
"ctr": 0.53
},
"dimensions": {
"advertiser_id": "6865632230773882886",
"story_arc": "wing display-wing display-wing display-wing display-Ending CTA",
"adgroup_id": "1734945725409298",
"order": "0",
"video_id": "v10033g50000c8splk3c77ubudr9fdo0"
}
},
{
"metrics": {
"scene_play_complete": 419,
"clicks": 45,
"complete_play_rate": 0.09,
"play_break_count": 4091,
"break_play_rate": 0.91,
"ctr": 1.0
},
"dimensions": {
"advertiser_id": "6865632230773882886",
"story_arc": "wing display-wing display-wing display-wing display-Ending CTA",
"adgroup_id": "1734945725409298",
"order": "0",
"video_id": "v10033g50000c8sohe3c77ucmpbk3ts0"
}
},
{
"metrics": {
"scene_play_complete": 1007,
"clicks": 29,
"complete_play_rate": 0.32,
"play_break_count": 2183,
"break_play_rate": 0.68,
"ctr": 0.91
},
"dimensions": {
"advertiser_id": "6865632230773882886",
"story_arc": "wing display-wing display-wing display-wing display-Ending CTA",
"adgroup_id": "1734945725409298",
"order": "1",
"video_id": "v10033g50000c8sohqbc77u3o2tpa6j0"
}
},
{
"metrics": {
"scene_play_complete": 112,
"clicks": 7,
"complete_play_rate": 0.27,
"play_break_count": 307,
"break_play_rate": 0.73,
"ctr": 1.67
},
"dimensions": {
"advertiser_id": "6865632230773882886",
"story_arc": "wing display-wing display-wing display-wing display-Ending CTA",
"adgroup_id": "1734945725409298",
"order": "1",
"video_id": "v10033g50000c8sp4rbc77ub2kipqn10"
}
},
{
"metrics": {
"scene_play_complete": 614,
"clicks": 12,
"complete_play_rate": 0.61,
"play_break_count": 393,
"break_play_rate": 0.39,
"ctr": 1.19
},
"dimensions": {
"advertiser_id": "6865632230773882886",
"story_arc": "wing display-wing display-wing display-wing display-Ending CTA",
"adgroup_id": "1734945725409298",
"order": "2",
"video_id": "v10033g50000c8sohe3c77ucmpbk3ts0"
}
},
{
"metrics": {
"scene_play_complete": 54,
"clicks": 5,
"complete_play_rate": 0.48,
"play_break_count": 58,
"break_play_rate": 0.52,
"ctr": 4.46
},
"dimensions": {
"advertiser_id": "6865632230773882886",
"story_arc": "wing display-wing display-wing display-wing display-Ending CTA",
"adgroup_id": "1734945725409298",
"order": "2",
"video_id": "v10033g50000c8sohqbc77u3o2tpa6j0"
}
},
{
"metrics": {
"scene_play_complete": 331,
"clicks": 6,
"complete_play_rate": 0.54,
"play_break_count": 283,
"break_play_rate": 0.46,
"ctr": 0.98
},
"dimensions": {
"advertiser_id": "6865632230773882886",
"story_arc": "wing display-wing display-wing display-wing display-Ending CTA",
"adgroup_id": "1734945725409298",
"order": "3",
"video_id": "v10033g50000c8sp4rbc77ub2kipqn10"
}
},
{
"metrics": {
"scene_play_complete": 44,
"clicks": 1,
"complete_play_rate": 0.81,
"play_break_count": 10,
"break_play_rate": 0.19,
"ctr": 1.85
},
"dimensions": {
"advertiser_id": "6865632230773882886",
"story_arc": "wing display-wing display-wing display-wing display-Ending CTA",
"adgroup_id": "1734945725409298",
"order": "3",
"video_id": "v10033g50000c8splk3c77ubudr9fdo0"
}
},
{
"metrics": {
"scene_play_complete": 0,
"clicks": 9,
"complete_play_rate": 0.0,
"play_break_count": 375,
"break_play_rate": 1.0,
"ctr": 2.4
},
"dimensions": {
"advertiser_id": "6865632230773882886",
"story_arc": "wing display-wing display-wing display-wing display-Ending CTA",
"adgroup_id": "1734945725409298",
"order": "4",
"video_id": "v10033g50000c8sms2jc77u9e2o0ftr0"
}
}
],
"page_info": {
"page": 1,
"page_size": 10,
"total_page": 3,
"total_number": 25
}
}
}
(/code);