Reports: request

将报告请求插入报告系统。立即尝试

请求

HTTP 请求

POST https://www.googleapis.com/doubleclicksearch/v2/reports

授权

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

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

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

请求正文

在请求正文中,请按以下结构提供数据:

{
  "reportScope": {
    "agencyId": long,
    "advertiserId": long,
    "engineAccountId": long,
    "campaignId": long,
    "adGroupId": long,
    "keywordId": long,
    "adId": long
  },
  "reportType": string,
  "columns": [
    {
      "columnName": string,
      "savedColumnName": string,
      "customDimensionName": string,
      "customMetricName": string,
      "headerText": string,
      "startDate": string,
      "endDate": string,
      "groupByColumn": boolean,
      "platformSource": string,
      "productReportPerspective": string
    }
  ],
  "timeRange": {
    "startDate": string,
    "endDate": string,
    "changedMetricsSinceTimestamp": datetime,
    "changedAttributesSinceTimestamp": datetime
  },
  "filters": [
    {
      "column": {
        "columnName": string,
        "savedColumnName": string,
        "customDimensionName": string,
        "customMetricName": string,
        "headerText": string,
        "startDate": string,
        "endDate": string,
        "groupByColumn": boolean,
        "platformSource": string,
        "productReportPerspective": string
      },
      "operator": string,
      "values": [
        (value)
      ]
    }
  ],
  "orderBy": [
    {
      "column": {
        "columnName": string,
        "savedColumnName": string,
        "customDimensionName": string,
        "customMetricName": string,
        "headerText": string,
        "startDate": string,
        "endDate": string,
        "groupByColumn": boolean,
        "platformSource": string,
        "productReportPerspective": string
      },
      "sortOrder": string
    }
  ],
  "includeDeletedEntities": boolean,
  "includeRemovedEntities": boolean,
  "verifySingleTimeZone": boolean,
  "downloadFormat": string,
  "statisticsCurrency": string,
  "startRow": integer,
  "rowCount": integer,
  "maxRowsPerFile": integer
}
属性名称 说明 备注
reportScope object reportScope 是一组 ID,用于确定报告中要返回的实体子集。需要通过代理机构所需范围最小的级别的完整 ID 沿袭。
reportScope.agencyId long DS 代理机构 ID。
reportScope.advertiserId long DS 广告客户 ID。
reportScope.engineAccountId long DS 引擎帐号 ID。
reportScope.campaignId long DS 广告系列 ID。
reportScope.adGroupId long DS 广告组 ID。
reportScope.keywordId long DS 关键字 ID。
reportScope.adId long DS 广告 ID。
reportType string 确定报表中所返回行的类型。例如,如果您指定 reportType: keyword,则报表中的每一行将包含关键字的相关数据。有关每种类型可用的列,请参阅报告类型参考。
columns[] list 要包含在报告中的列。这包括 DoubleClick Search 列和已保存的列。对于 DoubleClick Search 列,只有 columnName 参数是必需的。对于已保存的列,只有 savedColumnName 参数是必需的。不能在同一节中设置 columnNamesavedColumnName

每个请求的列数上限为 300。

columns[].columnName string 要添加到报表中的 DoubleClick Search 列的名称。
columns[].savedColumnName string 要包含在报告中的已保存列的名称。报表的范围必须在广告客户或更小范围内,并且此已保存的列必须已在 DoubleClick Search 界面中创建。
columns[].headerText string 用于标识报告输出中此列的文本;如果未指定,则默认为 columnNamesavedColumnName。这可用于防止 DoubleClick Search 列与同名的已保存列之间发生冲突。
columns[].startDate string 包含日期,采用 YYYY-MM-DD 格式。如果提供,则此数据将仅替换此列所在报表的总体时间范围。必须与 endDate 一起提供。
columns[].endDate string 包含 YYYY-MM-DD 格式的当天。如果提供,则此数据将仅替换此列所在报表的总体时间范围。必须与 startDate 一起提供。
columns[].groupByColumn boolean 仅限同步报表。设置为 true 可按此列分组。默认值为 false
timeRange object 如果报告请求指标,此参数将用于限制特定时间范围内的指标。
timeRange.startDate string 包含日期,采用 YYYY-MM-DD 格式。
timeRange.endDate string 包含日期,采用 YYYY-MM-DD 格式。
timeRange.changedMetricsSinceTimestamp datetime 包含 RFC 格式的 UTC 时间戳,例如2013-07-16T10:16:23.555Z。如需更多参考,了解“更改的指标”报告的运作方式。
timeRange.changedAttributesSinceTimestamp datetime 包含 RFC 格式的 UTC 时间戳,例如2013-07-16T10:16:23.555Z。请参阅其他参考资料,了解更改后的属性报告的运作方式。
filters[] list 应用到报告的一系列过滤器。

每个请求的过滤器数量上限为 300 个。

filters[].column nested object 要对其执行过滤的列。这一列可以是 DoubleClick Search 列,也可以是已保存的列。
filters[].column.columnName string 要添加到报表中的 DoubleClick Search 列的名称。
filters[].column.savedColumnName string 要包含在报告中的已保存列的名称。报表的范围必须在广告客户或更小范围内,并且此已保存的列必须已在 DoubleClick Search 界面中创建。
filters[].operator string 要在过滤器中使用的运算符。如需查看可用运算符的列表,请参阅过滤条件参考文档。
filters[].values[] list 用于过滤列值的值的列表。

每个请求的过滤条件值数量上限为 300 个。

orderBy[] list 仅限同步报表。定义要对报告行进行排序的列和方向列表。

每个请求的最大订单数为 300。

orderBy[].column nested object 要对其排序的列。这一列可以是 DoubleClick Search 定义的列,也可以是已保存的列。
orderBy[].column.columnName string 要添加到报表中的 DoubleClick Search 列的名称。
orderBy[].column.savedColumnName string 要包含在报告中的已保存列的名称。报表的范围必须在广告客户或更小范围内,并且此已保存的列必须已在 DoubleClick Search 界面中创建。
orderBy[].sortOrder string 排序方向,可以是 ascendingdescending
includeDeletedEntities boolean 确定是否应在报告中包含已移除的实体。默认为 false。已弃用,请改用 includeRemovedEntities
verifySingleTimeZone boolean 如果为 true,则仅当所请求的全部统计数据都来自单个时区时,系统才会创建此报告。默认值为 false
downloadFormat string 报告应采用的格式。目前支持 csvtsv
statisticsCurrency string 指定以何种货币返回货币。可能的值包括:usdagency(如果报表的范围限定为代理机构或更低级别,则有效)、advertiser(如果报表的范围限定为 * 广告客户或更低级别则有效)或 account(如果报表的范围限定在引擎帐号或更低级别,则有效)。
startRow integer 仅限同步报表。要返回的第一行的索引(从零开始)。可接受的值包括050000(含 0 和 5000)。默认值为 0
rowCount integer 仅限同步报表。要返回的行数上限;额外的行会被丢弃。可接受的值包括010000(含 0 和 5000)。默认值为 10000
maxRowsPerFile integer 仅异步报告。每个报表文件的行数上限。系统会将一个大型报表拆分成多个文件(基于此字段)。可接受的值包括1000000100000000(含 0 和 5000)。
includeRemovedEntities boolean 确定是否应在报告中包含已移除的实体。默认为 false
columns[].customDimensionName string 按自定义维度细分报告。此报表的范围仅限于广告客户或更低级别,并且 DoubleClick Search 中必须已经设置了自定义维度。DoubleClick Search 中显示的自定义维度名称区分大小写。

在转化报告中使用时,返回指定转化的指定自定义维度的值(如果已设置)。此列不会细分转化报告。

columns[].platformSource string 用于提供自定义维度数据的平台。可接受的值为“Floodlight”。
filters[].column.customDimensionName string 按自定义维度细分报告。此报表的范围仅限于广告客户或更低级别,并且 DoubleClick Search 中必须已经设置了自定义维度。DoubleClick Search 中显示的自定义维度名称区分大小写。

在转化报告中使用时,返回指定转化的指定自定义维度的值(如果已设置)。此列不会细分转化报告。

filters[].column.headerText string 用于标识报告输出中此列的文本;如果未指定,则默认为 columnNamesavedColumnName。这可用于防止 DoubleClick Search 列与同名的已保存列之间发生冲突。
filters[].column.startDate string 包含日期,采用 YYYY-MM-DD 格式。如果提供,则此数据将仅替换此列所在报表的总体时间范围。必须与 endDate 一起提供。
filters[].column.endDate string 包含 YYYY-MM-DD 格式的当天。如果提供,则此数据将仅替换此列所在报表的总体时间范围。必须与 startDate 一起提供。
filters[].column.groupByColumn boolean 仅限同步报表。设置为 true 可按此列分组。默认值为 false
filters[].column.platformSource string 用于提供自定义维度数据的平台。可接受的值为“Floodlight”。
orderBy[].column.customDimensionName string 按自定义维度细分报告。此报表的范围仅限于广告客户或更低级别,并且 DoubleClick Search 中必须已经设置了自定义维度。DoubleClick Search 中显示的自定义维度名称区分大小写。

在转化报告中使用时,返回指定转化的指定自定义维度的值(如果已设置)。此列不会细分转化报告。

orderBy[].column.headerText string 用于标识报告输出中此列的文本;如果未指定,则默认为 columnNamesavedColumnName。这可用于防止 DoubleClick Search 列与同名的已保存列之间发生冲突。
orderBy[].column.startDate string 包含日期,采用 YYYY-MM-DD 格式。如果提供,则此数据将仅替换此列所在报表的总体时间范围。必须与 endDate 一起提供。
orderBy[].column.endDate string 包含 YYYY-MM-DD 格式的当天。如果提供,则此数据将仅替换此列所在报表的总体时间范围。必须与 startDate 一起提供。
orderBy[].column.groupByColumn boolean 仅限同步报表。设置为 true 可按此列分组。默认值为 false
orderBy[].column.platformSource string 用于提供自定义维度数据的平台。可接受的值为“Floodlight”。
columns[].customMetricName string 要包含在报告中的自定义指标的名称。报表必须已定位到广告客户或更小的范围,并且已在 DoubleClick Search 中设置了自定义指标。DoubleClick Search 中显示的自定义指标名称区分大小写。
filters[].column.customMetricName string 要包含在报告中的自定义指标的名称。报表必须已定位到广告客户或更小的范围,并且已在 DoubleClick Search 中设置了自定义指标。DoubleClick Search 中显示的自定义指标名称区分大小写。
orderBy[].column.customMetricName string 要包含在报告中的自定义指标的名称。报表必须已定位到广告客户或更小的范围,并且已在 DoubleClick Search 中设置了自定义指标。DoubleClick Search 中显示的自定义指标名称区分大小写。
columns[].productReportPerspective string 仅返回特定类型商品活动的指标。接受的值包括:
  • sold”:仅返回所售产品的指标
  • advertised”:仅返回在购物广告系列中所宣传的产品(无论是否已售出)的指标
filters[].column.productReportPerspective string 仅返回特定类型商品活动的指标。接受的值包括:
  • sold”:仅返回所售产品的指标
  • advertised”:仅返回在购物广告系列中所宣传的产品(无论是否已售出)的指标
orderBy[].column.productReportPerspective string 仅返回特定类型商品活动的指标。接受的值包括:
  • sold”:仅返回所售产品的指标
  • advertised”:仅返回在购物广告系列中所宣传的产品(无论是否已售出)的指标

响应

如果成功,此方法将在响应正文中返回 Reports 资源

试试看!

请使用下面的 API Explorer 针对实际数据调用此方法,然后查看响应。 或者,您还可以尝试使用独立的 Explorer