生成同步报表
您可以通过生成同步报表，获取实时数据。
步骤
使用/report/integrated/get/并进行以下设置：
对于基础报表，受众分析报表，试玩素材报表或 DSA 报表
若您要使用/report/integrated/get/创建一个基础报表，受众分析报表，试玩素材报表或 DSA 报表：
- 广告主 ID：使用
advertiser_id或advertiser_ids字段指定广告主 ID。这是一个必填字段且advertiser_ids仅支持在基础报表和受众分析报表中使用。 - 广告服务类型：使用
service_type字段选择生成竞价广告或竞价和合约广告（AUCTION）数据报表。 - 报表类型：根据您想生成报表的数据类型，您可以在
report_type字段中指定四种类型之一：基础报表（BASIC）、受众分析报表（AUDIENCE）、试玩素材报表（PLAYABLE_MATERIAL）和DSA报表（CATALOG）。这是一个必填字段。 - 报表数据层级：使用
data_level字段指定您想要查询的报表数据层级。您可以获取以下层级的数据：推广系列、广告组、广告和广告主。
您选择的数据层级必须与维度相匹配。例如，如果您选择AUCTION_CAMPAIGN作为报表数据层级，那么您必须在维度中包含campaign_id。 - 查询时间范围：如果您希望获得某个时间段内的数据，您需要指定
start_date和end_date。请注意，起始日期、结束日期、数据统计的时间起止都是基于广告账户的时区信息。
注意
对于基础报表，受众分析报表，试玩素材报表和 DSA 报表：
- 若
dimensions的值中不包含stat_time_day，可最多检索 365 天的数据。- 若
dimensions的值中包含stat_time_day，从而拉取按天细分的数据，可最多检索 30 天的数据。
- 维度组合：使用
dimensions字段组合数据，您可以指定多个维度。不同报表类型支持的维度不同，您可以查看报表类型下相应的文章以了解详情。这是一个必填字段。 - 指标：使用
metrics字段指定您要查询的指标。不同报表类型支持的指标不同，您可以查看报表类型下相应的文章以了解详情。注意
如果您需要在竞价广告基础报表中获取所有查询指标的汇总数据，请在请求中开启enable_total_metrics字段。 - 筛选条件：如果您想缩小返回数据的范围，你可以使用
filtering对象。不同报表类型支持的筛选条件和筛选类型不同，您可以查看报表类型下相应的文章以了解详情。 - 分页大小：默认的分页大小是10。如果您的报表返回大量的结果，我们建议您使用
page_size来设置一个更大的分页大小。
对于商务中心报表
若您要使用/report/integrated/get/创建一个商务中心报表：
- 商务中心 ID：使用bc_id字段指定商务中心 ID。
- 报表类型：将report_type字段设置为BC。
- 查询时间范围：如果您希望获得某个时间段内的数据，您需要指定start_date和end_date。请注意，起始日期、结束日期、数据统计的时间起止都是基于广告账户的时区信息。
注意
对于商务中心报表，无论dimensions的值中是否包含stat_time_day，均可最多检索 365 天的数据。
- 维度组合：使用
dimensions字段组合数据，您可以指定多个维度。不同报表类型支持的维度不同，您可以查看报表类型下相应的文章以了解详情。这是一个必填字段。 - 指标：使用
metrics字段指定您要查询的指标。不同报表类型支持的指标不同，您可以查看报表类型下相应的文章以了解详情。 - 筛选条件：如果您想缩小返回数据的范围，你可以使用
filtering对象。不同报表类型支持的筛选条件和筛选类型不同，您可以查看报表类型下相应的文章以了解详情。 - 分页大小：默认的分页大小是10。如果您的报表返回大量的结果，我们建议您使用
page_size来设置一个更大的分页大小。
对于最大成交额广告报表
若您要使用/report/integrated/get/创建一个最大成交额广告报表：
- 广告主 ID：使用
advertiser_id字段指定广告主 ID。 - 广告服务类型：将
service_type字段设置为AUCTION。 - 报表类型：将
report_type字段设置为TT_SHOP。 - 报表数据层级：使用
data_level字段指定您想要查询的报表数据层级。您可以获取以下层级的数据：推广系列和广告主。
您选择的数据层级必须与维度相匹配。例如，如果您选择AUCTION_CAMPAIGN作为报表数据层级，那么您必须在维度中包含campaign_id。 - 查询时间范围：如果您希望获得某个时间段内的数据，您需要指定
start_date和end_date。请注意，起始日期、结束日期、数据统计的时间起止都是基于广告账户的时区信息。
注意
对于最大成交额广告报表：
- 若
dimensions的值中不包含stat_time_day，可最多检索 365 天的数据。- 若
dimensions的值中包含stat_time_day，从而拉取按天细分的数据，可最多检索 30 天的数据。
- 维度组合：使用
dimensions字段组合数据，您可以指定多个维度。不同报表类型支持的维度不同，您可以查看报表类型下相应的文章以了解详情。这是一个必填字段。 - 指标：使用
metrics字段指定您要查询的指标。不同报表类型支持的指标不同，您可以查看报表类型下相应的文章以了解详情。注意
如果您需要在最大成交额广告报表中获取所有查询指标的汇总数据，请在请求中开启enable_total_metrics字段。 - 分页大小：默认的分页大小是10。如果您的报表返回大量的结果，我们建议您使用
page_size来设置一个更大的分页大小。
示例
请求
(code)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/report/integrated/get/?advertiser_id={{advertiser_id}}}&service_type=AUCTION&data_level=AUCTION_AD&report_type=BASIC&dimensions=["ad_id"]&metrics=["clicks"]&start_date={{start_date}}}&end_date={{end_date}}}&filtering=[{"field_name":"ad_ids","filter_type":"IN","filter_value":"[\"{{ad_id}}\",\"{{ad_id}}\"]"}]' \
--header 'Access-Token:{{Access-Token}}}'
(/code)
返回
(code)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"page_info": {
"total_number": 1,
"total_page": 1,
"page_size": 1,
"page": 1
},
"list": [
{
"dimensions": {
"ad_id": "{{ad_id}}"
},
"metrics": {
"clicks": "34"
}
}
]
}
}
(/code)
更多示例
欲获取不同报表类型的代码示例，请参阅报表类型下每类报表的“使用案例”部分。
使用模拟数据进行测试
为了便于开发者测试报表功能，我们在所有的沙箱账户中提供了模拟数据。了解如何在沙箱账户中使用模拟数据以及支持的设置，请参阅沙箱账户-用于同步报表的模拟数据。