Campaign Manager 360 API v3.3 已被弃用,并将于 2021 年 6 月 30 日停用。所有用户都必须在该截止日期之前迁移到新版 API。

Reports: run

用于生成报表。立即试用

默认情况下,系统是异步生成报表的。您也可以同步生成小型报表。如果同步生成报表的操作没有及时完成,仍会返回一个报表文件,同时会以异步方式处理该报表。

请求

HTTP 请求

POST https://www.googleapis.com/dfareporting/v3.4/userprofiles/profileId/reports/reportId/run

参数

参数名称 说明
路径参数
profileId long Campaign Manager 360 用户个人资料 ID。
reportId long 报表的 ID。
可选的查询参数
synchronous boolean 如果已设置且值为 true,则会尝试同步生成报表。(默认值:false

授权

此请求需要获得以下范围的授权:

范围
https://www.googleapis.com/auth/dfareporting

如需了解详情,请参阅身份验证和授权页面。

请求正文

请勿使用此方法提供请求正文。

响应

如果成功,此方法将返回采用以下结构的响应正文:

{
  "kind": "dfareporting#file",
  "etag": etag,
  "reportId": long,
  "id": long,
  "lastModifiedTime": long,
  "status": string,
  "fileName": string,
  "format": string,
  "dateRange": {
    "kind": "dfareporting#dateRange",
    "startDate": date,
    "endDate": date,
    "relativeDateRange": string
  },
  "urls": {
    "browserUrl": string,
    "apiUrl": string
  }
}
属性名称 说明 备注
kind string 表明这是哪类资源。值:固定字符串 "dfareporting#file"
etag etag 此资源的 ETag。
reportId long 生成此文件时所依据的报表的 ID。
id long 此报表文件的唯一 ID。
lastModifiedTime long 表示此文件上次修改时间的时间戳(以自纪元以来经历的毫秒数表示)。
status string 此报表文件的状态。

可接受的值包括:
  • CANCELLED
  • FAILED
  • PROCESSING
  • REPORT_AVAILABLE
fileName string 此文件的名称。
format string 报表的输出格式,仅在已生成此文件的情况下才可用。

可接受的值包括:
  • CSV
  • EXCEL
dateRange nested object 表示此文件中包含的是哪个日期范围的报表数据。该日期范围始终是生成报表时使用的绝对日期范围。
dateRange.kind string 表明这是哪类资源,在本例中为 dfareporting#dateRange
dateRange.startDate date 日期范围的开始日期(含)。是一个“yyyy-MM-dd”格式的字符串。 可写入
dateRange.endDate date 日期范围的结束日期(含)。是一个“yyyy-MM-dd”格式的字符串。 可写入
dateRange.relativeDateRange string 相对于报表生成日期的日期范围。

可接受的值包括:
  • LAST_14_DAYS
  • LAST_24_MONTHS
  • LAST_30_DAYS
  • LAST_365_DAYS
  • LAST_60_DAYS
  • LAST_7_DAYS
  • LAST_90_DAYS
  • MONTH_TO_DATE
  • PREVIOUS_MONTH
  • PREVIOUS_QUARTER
  • PREVIOUS_WEEK
  • PREVIOUS_YEAR
  • QUARTER_TO_DATE
  • TODAY
  • WEEK_TO_DATE
  • YEAR_TO_DATE
  • YESTERDAY
可写入
urls object 可用来下载已完成的报表文件的网址。
urls.browserUrl string 用于通过浏览器下载报表数据的网址。
urls.apiUrl string 用于通过 API 下载报表数据的网址。

试试看!

使用下面的 API Explorer 对实际数据调用此方法,然后查看响应。