生成异步报表

您可以生成异步报表，异步报表能够获取的数据没有时间限制。

注意
异步报表目前为白名单功能。如需使用此功能，请通过白名单功能管理申请。

步骤

请执行以下步骤以获得异步报表： 1. 使用/report/task/create/接口创建一个异步报表任务。您需要传入以下字段： - 广告主ID：使用advertiser_id字段指定广告主ID。这是一个必填字段。 - 广告服务类型：使用service_type字段选择生成竞价广告或竞价和合约广告（AUCTION）数据报表。 - 报表类型：根据您想生成报表的数据类型，您可以在report_type字段中指定四种类型之一：基础报表（BASIC）、受众分析报表（AUDIENCE）、试玩素材报表（PLAYABLE_MATERIAL）和 DSA 报表（CATALOG）。这是一个必填字段。

注意
不支持请求异步试玩素材报表。

报表数据层级：使用data_level字段指定您想要查询的报表数据层级。您可以获取以下层级的数据：推广系列、广告组、广告和广告主。

您选择的数据层级必须与维度相匹配。例如，如果您选择AUCTION_CAMPAIGN作为报表数据层级，那么您必须在维度中包含campaign_id。
查询时间范围：如果您希望获得某个时间段内的数据，您需要指定start_date和end_date。请注意，起始日期、结束日期、数据统计的时间起止都是基于广告账户的时区信息。

注意
异步报表无查询时间范围限制。
维度组合：使用dimensions字段组合数据，您可以指定多个维度。不同报表类型支持的维度不同，您可以查看报表类型下相应的文章以了解详情。这是一个必填字段。

注意
同步报表和异步报表中支持的维度和指标组合可能不同，因此同步报表中支持的维度和指标组合可能在异步报表中不支持。
指标：使用metrics字段指定您要查询的指标。不同报表类型支持的指标不同，您可以查看报表类型下相应的文章以了解详情。
筛选条件：如果您想缩小返回数据的范围，你可以使用filtering对象。不同报表类型支持的筛选条件和筛选类型不同，您可以查看报表类型下相应的文章以了解详情。

注意
异步模式下的基础报表，受众分析报表、DSA报表和合约广告报表仅支持campaign_ids，adgroup_ids和ad_ids为筛选条件。
文件格式：使用output_format决定文件的输出格式。您可以选择以下格式：CSV_STRING、CSV_DOWNLOAD、XLSX_DOWNLOAD。如果您选择CSV_DOWNLOAD或XLSX_DOWNLOAD，系统将返回一个下载链接。

使用/report/task/check/接口查询任务是否已完成。
在确认任务完成后，使用/report/task/download/接口下载报表数据。

示例

下面为/report/task/create/接口的示例。

请求

(code)
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/report/task/create/' \
--header 'Access-Token: {{access-token}}' \
--data-raw '{
    "advertiser_id": "{{advertiser_id}}",
    "data_level":"AUCTION_AD",
    "report_type":"BASIC",
    "dimensions": ["ad_id"],
    "metrics": ["clicks"],
    "start_date": "{{start_date}}",
    "end_date": "{{end_date}}",
    "output_format": "CSV_DOWNLOAD",
    "file_name": "{{file_name}}",
    "filtering": [
        {
        "field_name":"ad_ids",
        "filter_type":"IN",
        "filter_value": "[\"{{ad_id}}\",\"{{ad_id}}\"]"
        }
    ]
}'
(/code)

(code)
HTTPS/1.1 200 OK
{
    "message": "OK",
    "code": 0,
    "data": {
        "task_id": "{{task_id}}"
    },
    "request_id": "{{request_id}}"
}
(/code)