Reports

“Reports”是指报表资源的列表。借助 Reports 方法,您的应用可以列出报表、创建新报表或更新现有的报表。您还可以生成报表,这会使系统创建 File 资源。

有关此类资源的方法列表,请参阅本页面的结尾部分。

资源表示形式

报表资源的表示形式。

{
  "kind": "dfareporting#report",
  "id": long,
  "etag": etag,
  "lastModifiedTime": unsigned long,
  "ownerProfileId": long,
  "accountId": long,
  "subAccountId": long,
  "name": string,
  "fileName": string,
  "format": string,
  "type": string,
  "criteria": {
    "dateRange": {
      "kind": "dfareporting#dateRange",
      "startDate": date,
      "endDate": date,
      "relativeDateRange": string
    },
    "dimensions": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "metricNames": [
      string
    ],
    "dimensionFilters": [
      dimensionValues Resource
    ],
    "activities": {
      "kind": "dfareporting#activities",
      "filters": [
        dimensionValues Resource
      ],
      "metricNames": [
        string
      ]
    },
    "customRichMediaEvents": {
      "kind": "dfareporting#customRichMediaEvents",
      "filteredEventIds": [
        dimensionValues Resource
      ]
    }
  },
  "pathToConversionCriteria": {
    "dateRange": {
      "kind": "dfareporting#dateRange",
      "startDate": date,
      "endDate": date,
      "relativeDateRange": string
    },
    "floodlightConfigId": dimensionValues Resource,
    "activityFilters": [
      dimensionValues Resource
    ],
    "conversionDimensions": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "perInteractionDimensions": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "metricNames": [
      string
    ],
    "customFloodlightVariables": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "customRichMediaEvents": [
      dimensionValues Resource
    ],
    "reportProperties": {
      "clicksLookbackWindow": integer,
      "impressionsLookbackWindow": integer,
      "maximumInteractionGap": integer,
      "maximumClickInteractions": integer,
      "maximumImpressionInteractions": integer,
      "includeAttributedIPConversions": boolean,
      "includeUnattributedIPConversions": boolean,
      "includeUnattributedCookieConversions": boolean,
      "pivotOnInteractionPath": boolean
    }
  },
  "reachCriteria": {
    "enableAllDimensionCombinations": boolean,
    "dateRange": {
      "kind": "dfareporting#dateRange",
      "startDate": date,
      "endDate": date,
      "relativeDateRange": string
    },
    "dimensions": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "metricNames": [
      string
    ],
    "reachByFrequencyMetricNames": [
      string
    ],
    "dimensionFilters": [
      dimensionValues Resource
    ],
    "activities": {
      "kind": "dfareporting#activities",
      "filters": [
        dimensionValues Resource
      ],
      "metricNames": [
        string
      ]
    },
    "customRichMediaEvents": {
      "kind": "dfareporting#customRichMediaEvents",
      "filteredEventIds": [
        dimensionValues Resource
      ]
    }
  },
  "crossDimensionReachCriteria": {
    "dateRange": {
      "kind": "dfareporting#dateRange",
      "startDate": date,
      "endDate": date,
      "relativeDateRange": string
    },
    "dimension": string,
    "pivoted": boolean,
    "dimensionFilters": [
      dimensionValues Resource
    ],
    "breakdown": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "metricNames": [
      string
    ],
    "overlapMetricNames": [
      string
    ]
  },
  "floodlightCriteria": {
    "dateRange": {
      "kind": "dfareporting#dateRange",
      "startDate": date,
      "endDate": date,
      "relativeDateRange": string
    },
    "floodlightConfigId": dimensionValues Resource,
    "dimensionFilters": [
      dimensionValues Resource
    ],
    "reportProperties": {
      "includeAttributedIPConversions": boolean,
      "includeUnattributedIPConversions": boolean,
      "includeUnattributedCookieConversions": boolean
    },
    "dimensions": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "metricNames": [
      string
    ],
    "customRichMediaEvents": [
      dimensionValues Resource
    ]
  },
  "pathCriteria": {
    "dateRange": {
      "kind": "dfareporting#dateRange",
      "startDate": date,
      "endDate": date,
      "relativeDateRange": string
    },
    "floodlightConfigId": dimensionValues Resource,
    "activityFilters": [
      dimensionValues Resource
    ],
    "customChannelGrouping": {
      "kind": "dfareporting#channelGrouping",
      "name": string,
      "fallbackName": string,
      "rules": [
        {
          "kind": "dfareporting#channelGroupingRule",
          "name": string,
          "disjunctiveMatchStatements": [
            {
              "kind": "dfareporting#disjunctiveMatchStatement",
              "eventFilters": [
                {
                  "kind": "dfareporting#eventFilter",
                  "dimensionFilter": {
                    "kind": "dfareporting#pathReportDimensionValue",
                    "dimensionName": string,
                    "values": [
                      string
                    ],
                    "ids": [
                      string
                    ],
                    "matchType": string
                  }
                }
              ]
            }
          ]
        }
      ]
    },
    "pathFilters": [
      {
        "kind": "dfaReporting#pathFilter",
        "eventFilters": [
          {
            "kind": "dfareporting#eventFilter",
            "dimensionFilter": {
              "kind": "dfareporting#pathReportDimensionValue",
              "dimensionName": string,
              "values": [
                string
              ],
              "ids": [
                string
              ],
              "matchType": string
            }
          }
        ],
        "pathMatchPosition": string
      }
    ],
    "dimensions": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "metricNames": [
      string
    ]
  },
  "pathAttributionCriteria": {
    "dateRange": {
      "kind": "dfareporting#dateRange",
      "startDate": date,
      "endDate": date,
      "relativeDateRange": string
    },
    "floodlightConfigId": dimensionValues Resource,
    "activityFilters": [
      dimensionValues Resource
    ],
    "customChannelGrouping": {
      "kind": "dfareporting#channelGrouping",
      "name": string,
      "fallbackName": string,
      "rules": [
        {
          "kind": "dfareporting#channelGroupingRule",
          "name": string,
          "disjunctiveMatchStatements": [
            {
              "kind": "dfareporting#disjunctiveMatchStatement",
              "eventFilters": [
                {
                  "kind": "dfareporting#eventFilter",
                  "dimensionFilter": {
                    "kind": "dfareporting#pathReportDimensionValue",
                    "dimensionName": string,
                    "values": [
                      string
                    ],
                    "ids": [
                      string
                    ],
                    "matchType": string
                  }
                }
              ]
            }
          ]
        }
      ]
    },
    "pathFilters": [
      {
        "kind": "dfaReporting#pathFilter",
        "eventFilters": [
          {
            "kind": "dfareporting#eventFilter",
            "dimensionFilter": {
              "kind": "dfareporting#pathReportDimensionValue",
              "dimensionName": string,
              "values": [
                string
              ],
              "ids": [
                string
              ],
              "matchType": string
            }
          }
        ],
        "pathMatchPosition": string
      }
    ],
    "dimensions": [
      {
        "kind": "dfareporting#sortedDimension",
        "name": string,
        "sortOrder": string
      }
    ],
    "metricNames": [
      string
    ]
  },
  "schedule": {
    "active": boolean,
    "repeats": string,
    "every": integer,
    "repeatsOnWeekDays": [
      string
    ],
    "startDate": date,
    "expirationDate": date,
    "runsOnDayOfMonth": string
  },
  "delivery": {
    "emailOwner": boolean,
    "emailOwnerDeliveryType": string,
    "message": string,
    "recipients": [
      {
        "kind": "dfareporting#recipient",
        "email": string,
        "deliveryType": string
      }
    ]
  }
}
属性名称 说明 备注
accountId long 此报表所属的帐号 ID。
criteria object “STANDARD”类型的报表的报表条件。
criteria.activities nested object 活动组。
criteria.activities.filters[] list 活动过滤器列表。所有维度值都必须是“dfa:activity”类型或者是“dfa:activityGroup”类型。 可写入
criteria.activities.kind string 所属资源种类,在本例中为 dfareporting#activities
criteria.activities.metricNames[] list Floodlight 活动指标的名称列表。 可写入
criteria.customRichMediaEvents nested object 自定义 Rich Media 事件组。
criteria.customRichMediaEvents.filteredEventIds[] list 自定义 Rich Media 事件 ID 列表。所有维度值都必须是“dfa:richMediaEventTypeIdAndName”类型。 可写入
criteria.customRichMediaEvents.kind string 所属资源种类,在本例中为 dfareporting#customRichMediaEvents
criteria.dateRange nested object 应生成此报表的日期范围。
criteria.dateRange.endDate date 日期范围的结束日期(含)。字符串格式为“yyyy-MM-dd”。 可写入
criteria.dateRange.kind string 所属资源种类,在本例中为 dfareporting#dateRange
criteria.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
可写入
criteria.dateRange.startDate date 日期范围的开始日期(含)。字符串格式为“yyyy-MM-dd”。 可写入
criteria.dimensionFilters[] list 用来对维度进行过滤的过滤器列表。

不同维度的过滤器之间为 AND 关系;同一个维度的多个过滤器归为一组,彼此之间的关系为 OR。

可写入
criteria.dimensions[] list 报表应包含的标准维度列表。 可写入
criteria.dimensions[].kind string 所属资源种类,在本例中为 dfareporting#sortedDimension
criteria.dimensions[].name string 维度名称。
criteria.dimensions[].sortOrder string 维度列的可选排序顺序。

可接受的值包括:
  • ASCENDING
  • DESCENDING
criteria.metricNames[] list 报表应包含的指标名称列表。 可写入
crossDimensionReachCriteria object “CROSS_DIMENSION_REACH”类型的报表的报表条件。 可写入
crossDimensionReachCriteria.breakdown[] list 报表应包含的维度列表。 可写入
crossDimensionReachCriteria.breakdown[].kind string 所属资源种类,在本例中为 dfareporting#sortedDimension
crossDimensionReachCriteria.breakdown[].name string 维度名称。
crossDimensionReachCriteria.breakdown[].sortOrder string 维度列的可选排序顺序。

可接受的值包括:
  • ASCENDING
  • DESCENDING
crossDimensionReachCriteria.dateRange nested object 应生成此报表的日期范围。 可写入
crossDimensionReachCriteria.dateRange.endDate date 日期范围的结束日期(含)。字符串格式为“yyyy-MM-dd”。 可写入
crossDimensionReachCriteria.dateRange.kind string 所属资源种类,在本例中为 dfareporting#dateRange
crossDimensionReachCriteria.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
可写入
crossDimensionReachCriteria.dateRange.startDate date 日期范围的开始日期(含)。字符串格式为“yyyy-MM-dd”。 可写入
crossDimensionReachCriteria.dimension string 维度选项。

可接受的值包括:
  • ADVERTISER
  • CAMPAIGN
  • SITE_BY_ADVERTISER
  • SITE_BY_CAMPAIGN
可写入
crossDimensionReachCriteria.dimensionFilters[] list 用来对维度进行过滤的过滤器列表。 可写入
crossDimensionReachCriteria.metricNames[] list 报表应包含的指标名称列表。 可写入
crossDimensionReachCriteria.overlapMetricNames[] list 报表应包含的重叠指标名称列表。 可写入
crossDimensionReachCriteria.pivoted boolean 是否为透视报表。默认为 true。 可写入
delivery object 报表的电子邮件递送设置。 可写入
delivery.emailOwner boolean 是否应通过电子邮件将报表发送给报表所有者。 可写入
delivery.emailOwnerDeliveryType string 供所有者接收报表的递送类型(如果已启用)。

可接受的值包括:
  • ATTACHMENT
  • LINK
可写入
delivery.message string 要随每封电子邮件发送的信息。 可写入
delivery.recipients[] list 通过电子邮件发送的报表的收件人列表。 可写入
delivery.recipients[].deliveryType string 供收件人接收报表的递送类型。

可接受的值包括:
  • ATTACHMENT
  • LINK
可写入
delivery.recipients[].email string 收件人的电子邮件地址。 可写入
delivery.recipients[].kind string 所属资源种类,在本例中为 dfareporting#recipient
etag etag 此响应的 ETag,用于缓存。
fileName string 为此报表生成报表文件时使用的文件名。 可写入
floodlightCriteria object “FLOODLIGHT”类型的报表的报表条件。
floodlightCriteria.customRichMediaEvents[] list 要包含的自定义富媒体事件列表。
floodlightCriteria.dateRange nested object 应生成此报表的日期范围。
floodlightCriteria.dateRange.endDate date 日期范围的结束日期(含)。字符串格式为“yyyy-MM-dd”。 可写入
floodlightCriteria.dateRange.kind string 所属资源种类,在本例中为 dfareporting#dateRange
floodlightCriteria.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
可写入
floodlightCriteria.dateRange.startDate date 日期范围的开始日期(含)。字符串格式为“yyyy-MM-dd”。 可写入
floodlightCriteria.dimensionFilters[] list 用来对维度进行过滤的过滤器列表。

不同维度的过滤器之间为 AND 关系;同一个维度的多个过滤器归为一组,彼此之间的关系为 OR。

可写入
floodlightCriteria.dimensions[] list 报表应包含的维度列表。 可写入
floodlightCriteria.dimensions[].kind string 所属资源种类,在本例中为 dfareporting#sortedDimension
floodlightCriteria.dimensions[].name string 维度名称。
floodlightCriteria.dimensions[].sortOrder string 维度列的可选排序顺序。

可接受的值包括:
  • ASCENDING
  • DESCENDING
floodlightCriteria.floodlightConfigId nested object 要在此报表中显示数据的 Floodlight ID。系统将自动添加与此 ID 相关联的所有广告客户。值的维度必须是“dfa:floodlightConfigId”。 可写入
floodlightCriteria.metricNames[] list 报表应包含的指标名称列表。 可写入
floodlightCriteria.reportProperties object 报表的属性。
floodlightCriteria.reportProperties.includeAttributedIPConversions boolean 包含没有任何 Cookie 但有曝光路径的转化。
floodlightCriteria.reportProperties.includeUnattributedCookieConversions boolean 包含具有 DoubleClick Cookie 但没有曝光的用户转化。这表示该用户没有点击或浏览来自 Floodlight 组内广告客户的广告,或者本次互动发生在回溯期之外。
floodlightCriteria.reportProperties.includeUnattributedIPConversions boolean 包含没有相关 Cookie 和曝光的转化。因此,您将无法得知您的广告在促成转化前的回溯期内是如何向用户展示的。
format string 报表的输出格式,如果未指定,默认格式为 CSV。请注意,如果报表的大小超出格式的容量,已完成的报表文件中的实际格式可能会所有不同。如此一来,CSV 就会成为后备格式。

可接受的值包括:
  • CSV
  • EXCEL
可写入
id long 用于标识此报表资源的唯一 ID。
kind string 所属资源种类,在本例中为 dfareporting#report
lastModifiedTime unsigned long 此报表最后一次修改的时间戳(单位为毫秒,自纪元开始的时间算起)。
name string 报表的名称。 可写入
ownerProfileId long 此报表所有者的用户个人资料 ID。
pathAttributionCriteria object “PATH_ATTRIBUTION”类型的报表的报表条件。
pathAttributionCriteria.activityFilters[] list 要过滤的“dfa:activity”值列表。 可写入
pathAttributionCriteria.customChannelGrouping nested object 渠道分组。
pathAttributionCriteria.customChannelGrouping.fallbackName string ChannelGrouping 后备名称。
pathAttributionCriteria.customChannelGrouping.kind string 所属资源种类,在本例中为 dfareporting#channelGrouping
pathAttributionCriteria.customChannelGrouping.name string ChannelGrouping 名称。
pathAttributionCriteria.customChannelGrouping.rules[] list 此渠道分组中包含的规则。
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[] list 此规则中包含的析取范式匹配语句。
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[] list 此析取范式匹配语句中包含的事件过滤器。
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter nested object 此 EventFilter 中包含的维度过滤器。
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.dimensionName string 维度名称。
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.ids[] list 与值相关联的可能的 ID(如果有)。
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.kind string 所属资源种类,在本例中为 dfareporting#pathReportDimensionValue
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.matchType string 在过滤过程中用来确定“value”字段的匹配方式。如果未指定,则默认为 EXACT。如果设为 WILDCARD_EXPRESSION,则允许将“*”作为变量长度字符序列的占位符,且可以使用反斜杠对其进行转义。请注意,只有付费搜索维度 (dfa:paidSearch*) 允许使用 EXACT 以外的 matchType。

可接受的值包括:
  • BEGINS_WITH
  • CONTAINS
  • EXACT
  • WILDCARD_EXPRESSION
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.values[] list 维度的可能值。
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].kind string 所属资源种类,在本例中为 dfareporting#eventFilter
pathAttributionCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].kind string 所属资源种类,在本例中为 dfareporting#disjunctiveMatchStatement
pathAttributionCriteria.customChannelGrouping.rules[].kind string 所属资源种类,在本例中为 dfareporting#channelGroupingRule
pathAttributionCriteria.customChannelGrouping.rules[].name string 规则名称。
pathAttributionCriteria.dateRange nested object 应生成此报表的日期范围。
pathAttributionCriteria.dateRange.endDate date 日期范围的结束日期(含)。字符串格式为“yyyy-MM-dd”。 可写入
pathAttributionCriteria.dateRange.kind string 所属资源种类,在本例中为 dfareporting#dateRange
pathAttributionCriteria.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
可写入
pathAttributionCriteria.dateRange.startDate date 日期范围的开始日期(含)。字符串格式为“yyyy-MM-dd”。 可写入
pathAttributionCriteria.dimensions[] list 报表应包含的维度列表。 可写入
pathAttributionCriteria.dimensions[].kind string 所属资源种类,在本例中为 dfareporting#sortedDimension
pathAttributionCriteria.dimensions[].name string 维度名称。
pathAttributionCriteria.dimensions[].sortOrder string 维度列的可选排序顺序。

可接受的值包括:
  • ASCENDING
  • DESCENDING
pathAttributionCriteria.floodlightConfigId nested object 要在此报表中显示数据的 Floodlight ID。系统将自动添加与此 ID 相关联的所有广告客户。值的维度必须是“dfa:floodlightConfigId”。 可写入
pathAttributionCriteria.metricNames[] list 报表应包含的指标名称列表。 可写入
pathAttributionCriteria.pathFilters[] list 路径过滤器。
pathAttributionCriteria.pathFilters[].eventFilters[] list 路径报表中的事件过滤器。
pathAttributionCriteria.pathFilters[].eventFilters[].dimensionFilter nested object 此 EventFilter 中包含的维度过滤器。
pathAttributionCriteria.pathFilters[].eventFilters[].dimensionFilter.dimensionName string 维度名称。
pathAttributionCriteria.pathFilters[].eventFilters[].dimensionFilter.ids[] list 与值相关联的可能的 ID(如果有)。
pathAttributionCriteria.pathFilters[].eventFilters[].dimensionFilter.kind string 所属资源种类,在本例中为 dfareporting#pathReportDimensionValue
pathAttributionCriteria.pathFilters[].eventFilters[].dimensionFilter.matchType string 在过滤过程中用来确定“value”字段的匹配方式。如果未指定,则默认为 EXACT。如果设为 WILDCARD_EXPRESSION,则允许将“*”作为变量长度字符序列的占位符,且可以使用反斜杠对其进行转义。请注意,只有付费搜索维度 (dfa:paidSearch*) 允许使用 EXACT 以外的 matchType。

可接受的值包括:
  • BEGINS_WITH
  • CONTAINS
  • EXACT
  • WILDCARD_EXPRESSION
pathAttributionCriteria.pathFilters[].eventFilters[].dimensionFilter.values[] list 维度的可能值。
pathAttributionCriteria.pathFilters[].eventFilters[].kind string 所属资源种类,在本例中为 dfareporting#eventFilter
pathAttributionCriteria.pathFilters[].kind string 所属资源种类,在本例中为 dfareporting#pathFilter
pathAttributionCriteria.pathFilters[].pathMatchPosition string 在过滤过程中用来确定“value”字段的匹配方式。如果未指定,则默认为 EXACT。如果设为 WILDCARD_EXPRESSION,则允许将“*”作为变量长度字符序列的占位符,且可以使用反斜杠对其进行转义。请注意,只有付费搜索维度 (dfa:paidSearch*) 允许使用 EXACT 以外的 matchType。

可接受的值包括:
  • ANY
  • FIRST
  • LAST
  • PATH_MATCH_POSITION_UNSPECIFIED
pathCriteria object “PATH”类型的报表的报表条件。
pathCriteria.activityFilters[] list 要过滤的“dfa:activity”值列表。 可写入
pathCriteria.customChannelGrouping nested object 渠道分组。
pathCriteria.customChannelGrouping.fallbackName string ChannelGrouping 后备名称。
pathCriteria.customChannelGrouping.kind string 所属资源种类,在本例中为 dfareporting#channelGrouping
pathCriteria.customChannelGrouping.name string ChannelGrouping 名称。
pathCriteria.customChannelGrouping.rules[] list 此渠道分组中包含的规则。
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[] list 此规则中包含的析取范式匹配语句。
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[] list 此析取范式匹配语句中包含的事件过滤器。
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter nested object 此 EventFilter 中包含的维度过滤器。
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.dimensionName string 维度名称。
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.ids[] list 与值相关联的可能的 ID(如果有)。
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.kind string 所属资源种类,在本例中为 dfareporting#pathReportDimensionValue
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.matchType string 在过滤过程中用来确定“value”字段的匹配方式。如果未指定,则默认为 EXACT。如果设为 WILDCARD_EXPRESSION,则允许将“*”作为变量长度字符序列的占位符,且可以使用反斜杠对其进行转义。请注意,只有付费搜索维度 (dfa:paidSearch*) 允许使用 EXACT 以外的 matchType。

可接受的值包括:
  • BEGINS_WITH
  • CONTAINS
  • EXACT
  • WILDCARD_EXPRESSION
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.values[] list 维度的可能值。
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].kind string 所属资源种类,在本例中为 dfareporting#eventFilter
pathCriteria.customChannelGrouping.rules[].disjunctiveMatchStatements[].kind string 所属资源种类,在本例中为 dfareporting#disjunctiveMatchStatement
pathCriteria.customChannelGrouping.rules[].kind string 所属资源种类,在本例中为 dfareporting#channelGroupingRule
pathCriteria.customChannelGrouping.rules[].name string 规则名称。
pathCriteria.dateRange nested object 应生成此报表的日期范围。
pathCriteria.dateRange.endDate date 日期范围的结束日期(含)。字符串格式为“yyyy-MM-dd”。 可写入
pathCriteria.dateRange.kind string 所属资源种类,在本例中为 dfareporting#dateRange
pathCriteria.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
可写入
pathCriteria.dateRange.startDate date 日期范围的开始日期(含)。字符串格式为“yyyy-MM-dd”。 可写入
pathCriteria.dimensions[] list 报表应包含的维度列表。 可写入
pathCriteria.dimensions[].kind string 所属资源种类,在本例中为 dfareporting#sortedDimension
pathCriteria.dimensions[].name string 维度名称。
pathCriteria.dimensions[].sortOrder string 维度列的可选排序顺序。

可接受的值包括:
  • ASCENDING
  • DESCENDING
pathCriteria.floodlightConfigId nested object 要在此报表中显示数据的 Floodlight ID。系统将自动添加与此 ID 相关联的所有广告客户。值的维度必须是“dfa:floodlightConfigId”。 可写入
pathCriteria.metricNames[] list 报表应包含的指标名称列表。 可写入
pathCriteria.pathFilters[] list 路径过滤器。
pathCriteria.pathFilters[].eventFilters[] list 路径报表中的事件过滤器。
pathCriteria.pathFilters[].eventFilters[].dimensionFilter nested object 此 EventFilter 中包含的维度过滤器。
pathCriteria.pathFilters[].eventFilters[].dimensionFilter.dimensionName string 维度名称。
pathCriteria.pathFilters[].eventFilters[].dimensionFilter.ids[] list 与值相关联的可能的 ID(如果有)。
pathCriteria.pathFilters[].eventFilters[].dimensionFilter.kind string 所属资源种类,在本例中为 dfareporting#pathReportDimensionValue
pathCriteria.pathFilters[].eventFilters[].dimensionFilter.matchType string 在过滤过程中用来确定“value”字段的匹配方式。如果未指定,则默认为 EXACT。如果设为 WILDCARD_EXPRESSION,则允许将“*”作为变量长度字符序列的占位符,且可以使用反斜杠对其进行转义。请注意,只有付费搜索维度 (dfa:paidSearch*) 允许使用 EXACT 以外的 matchType。

可接受的值包括:
  • BEGINS_WITH
  • CONTAINS
  • EXACT
  • WILDCARD_EXPRESSION
pathCriteria.pathFilters[].eventFilters[].dimensionFilter.values[] list 维度的可能值。
pathCriteria.pathFilters[].eventFilters[].kind string 所属资源种类,在本例中为 dfareporting#eventFilter
pathCriteria.pathFilters[].kind string 所属资源种类,在本例中为 dfareporting#pathFilter
pathCriteria.pathFilters[].pathMatchPosition string 在过滤过程中用来确定“value”字段的匹配方式。如果未指定,则默认为 EXACT。如果设为 WILDCARD_EXPRESSION,则允许将“*”作为变量长度字符序列的占位符,且可以使用反斜杠对其进行转义。请注意,只有付费搜索维度 (dfa:paidSearch*) 允许使用 EXACT 以外的 matchType。

可接受的值包括:
  • ANY
  • FIRST
  • LAST
  • PATH_MATCH_POSITION_UNSPECIFIED
pathToConversionCriteria object “PATH_TO_CONVERSION”类型的报表的报表条件。
pathToConversionCriteria.activityFilters[] list 要过滤的“dfa:activity”值列表。 可写入
pathToConversionCriteria.conversionDimensions[] list 报表应包含的转化维度列表。 可写入
pathToConversionCriteria.conversionDimensions[].kind string 所属资源种类,在本例中为 dfareporting#sortedDimension
pathToConversionCriteria.conversionDimensions[].name string 维度名称。
pathToConversionCriteria.conversionDimensions[].sortOrder string 维度列的可选排序顺序。

可接受的值包括:
  • ASCENDING
  • DESCENDING
pathToConversionCriteria.customFloodlightVariables[] list 报表应包含的自定义 Floodlight 变量列表。 可写入
pathToConversionCriteria.customFloodlightVariables[].kind string 所属资源种类,在本例中为 dfareporting#sortedDimension
pathToConversionCriteria.customFloodlightVariables[].name string 维度名称。
pathToConversionCriteria.customFloodlightVariables[].sortOrder string 维度列的可选排序顺序。

可接受的值包括:
  • ASCENDING
  • DESCENDING
pathToConversionCriteria.customRichMediaEvents[] list 要包含的自定义富媒体事件列表。
pathToConversionCriteria.dateRange nested object 应生成此报表的日期范围。
pathToConversionCriteria.dateRange.endDate date 日期范围的结束日期(含)。字符串格式为“yyyy-MM-dd”。 可写入
pathToConversionCriteria.dateRange.kind string 所属资源种类,在本例中为 dfareporting#dateRange
pathToConversionCriteria.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
可写入
pathToConversionCriteria.dateRange.startDate date 日期范围的开始日期(含)。字符串格式为“yyyy-MM-dd”。 可写入
pathToConversionCriteria.floodlightConfigId nested object 要在此报表中显示数据的 Floodlight ID。系统将自动添加与此 ID 相关联的所有广告客户。值的维度必须是“dfa:floodlightConfigId”。 可写入
pathToConversionCriteria.metricNames[] list 报表应包含的指标名称列表。 可写入
pathToConversionCriteria.perInteractionDimensions[] list 报表应包含的每次互动维度列表。 可写入
pathToConversionCriteria.perInteractionDimensions[].kind string 所属资源种类,在本例中为 dfareporting#sortedDimension
pathToConversionCriteria.perInteractionDimensions[].name string 维度名称。
pathToConversionCriteria.perInteractionDimensions[].sortOrder string 维度列的可选排序顺序。

可接受的值包括:
  • ASCENDING
  • DESCENDING
pathToConversionCriteria.reportProperties object 报表的属性。
pathToConversionCriteria.reportProperties.clicksLookbackWindow integer Campaign Manager 360 会进行检查,以了解在转化发生之前,指定时间段内是否出现了点击互动。默认情况下,此值是从 Floodlight 中提取的,您也可以手动输入自定义值。有效值:1 到 90。
pathToConversionCriteria.reportProperties.impressionsLookbackWindow integer Campaign Manager 360 会进行检查,以了解在转化发生之前,指定时间段内是否出现了展示互动。默认情况下,此值是从 Floodlight 中提取的,您也可以手动输入自定义值。有效值:1 到 90。
pathToConversionCriteria.reportProperties.includeAttributedIPConversions boolean 已弃用:没有影响。
pathToConversionCriteria.reportProperties.includeUnattributedCookieConversions boolean 包含具有 DoubleClick Cookie 但没有曝光的用户转化。这表示该用户没有点击或浏览来自 Floodlight 组内广告客户的广告,或者本次互动发生在回溯期之外。
pathToConversionCriteria.reportProperties.includeUnattributedIPConversions boolean 包含没有相关 Cookie 和曝光的转化。因此,您将无法得知您的广告在促成转化前的回溯期内是如何向用户展示的。
pathToConversionCriteria.reportProperties.maximumClickInteractions integer 报表中可包含的点击互动次数上限。目前使用付费 E2C 报表的广告客户最多可获取 200 次曝光(100 次点击,100 次展示)。如果您的广告联盟中有另一位广告客户使用付费 E2C 报表,您在每个报表中可拥有的曝光总数最多为 5。
pathToConversionCriteria.reportProperties.maximumImpressionInteractions integer 报表中可包含的点击互动次数上限。目前使用付费 E2C 报表的广告客户最多可获取 200 次曝光(100 次点击,100 次展示)。如果您的广告联盟中有另一位广告客户使用付费 E2C 报表,您在每个报表中可拥有的曝光总数最多为 5。
pathToConversionCriteria.reportProperties.maximumInteractionGap integer 同一用户多次互动(点击或展示)之间可以相隔的时长的上限。有效值:1 到 90。
pathToConversionCriteria.reportProperties.pivotOnInteractionPath boolean 启用互动路径透视功能。
reachCriteria object “REACH”类型的报表的报表条件。
reachCriteria.activities nested object 活动组。
reachCriteria.activities.filters[] list 活动过滤器列表。所有维度值都必须是“dfa:activity”类型或者是“dfa:activityGroup”类型。 可写入
reachCriteria.activities.kind string 所属资源种类,在本例中为 dfareporting#activities
reachCriteria.activities.metricNames[] list Floodlight 活动指标的名称列表。 可写入
reachCriteria.customRichMediaEvents nested object 自定义 Rich Media 事件组。
reachCriteria.customRichMediaEvents.filteredEventIds[] list 自定义 Rich Media 事件 ID 列表。所有维度值都必须是“dfa:richMediaEventTypeIdAndName”类型。 可写入
reachCriteria.customRichMediaEvents.kind string 所属资源种类,在本例中为 dfareporting#customRichMediaEvents
reachCriteria.dateRange nested object 应生成此报表的日期范围。
reachCriteria.dateRange.endDate date 日期范围的结束日期(含)。字符串格式为“yyyy-MM-dd”。 可写入
reachCriteria.dateRange.kind string 所属资源种类,在本例中为 dfareporting#dateRange
reachCriteria.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
可写入
reachCriteria.dateRange.startDate date 日期范围的开始日期(含)。字符串格式为“yyyy-MM-dd”。 可写入
reachCriteria.dimensionFilters[] list 用来对维度进行过滤的过滤器列表。

不同维度的过滤器之间为 AND 关系;同一个维度的多个过滤器归为一组,彼此之间的关系为 OR。

可写入
reachCriteria.dimensions[] list 报表应包含的维度列表。 可写入
reachCriteria.dimensions[].kind string 所属资源种类,在本例中为 dfareporting#sortedDimension
reachCriteria.dimensions[].name string 维度名称。
reachCriteria.dimensions[].sortOrder string 维度列的可选排序顺序。

可接受的值包括:
  • ASCENDING
  • DESCENDING
reachCriteria.enableAllDimensionCombinations boolean 是否在报表中启用所有覆盖面维度组合。默认值为 false。如果启用,报表的日期范围应为过去 42 天内。 可写入
reachCriteria.metricNames[] list 报表应包含的指标名称列表。 可写入
reachCriteria.reachByFrequencyMetricNames[] list 报表应包含的按频次计算的覆盖面指标名称列表。 可写入
schedule object 报表的时间安排。只有在报表的“dateRange”是相对日期范围,并且该相对日期范围不是“TODAY”时,才可以设置。 可写入
schedule.active boolean 时间安排是否有效。必须设为 true 或 false。 可写入
schedule.every integer 指定应每隔几天、几周或几个月生成一次报表。如果“repeats”值为“DAILY”、“WEEKLY”或“MONTHLY”,就需要进行设置。 可写入
schedule.expirationDate date 此定期报表生成作业停止运行的到期日期。 可写入
schedule.repeats string 此报表生成作业运行的时间间隔。注意:
  • “DAILY”,同时需要设置“every”字段。
  • “WEEKLY”,同时需要设置“every”和“repeatsOnWeekDays”字段。
  • “MONTHLY”,同时需要设置“every”和“runsOnDayOfMonth”字段。
可写入
schedule.repeatsOnWeekDays[] list 列出值为“WEEKLY”时定期生成的报表应在一周的哪几天生成。 可写入
schedule.runsOnDayOfMonth string 枚举值,用来指定“每月”定期生成的报表应将每月的同一天作为“startDate”进行重复,还是在每月的相应周的同一天重复。

例如:如果“startDate”是 2012 年 4 月 2 日 (2012-04-02) 星期一,那么“DAY_OF_MONTH”就会在每月的第 2 天生成后续报表,而“WEEK_OF_MONTH”会在每月的第一个星期一生成后续报表。



可接受的值包括:
  • DAY_OF_MONTH
  • WEEK_OF_MONTH
可写入
schedule.startDate date 定期报表生成作业的日期范围的开始日期。 可写入
subAccountId long 此报表所属的子帐号 ID(如果适用)。
type string 报表类型。

可接受的值包括:
  • CROSS_DIMENSION_REACH
  • FLOODLIGHT
  • PATH
  • PATH_ATTRIBUTION
  • PATH_TO_CONVERSION
  • REACH
  • STANDARD

方法

可在报表中操作的方法列表。

delete
根据报表 ID 删除报表。
get
根据报表 ID 检索报表。
insert
创建报表。
list
检索报表列表。
patch
更新报表。此方法支持修补语义。
run
生成报表。
update
更新报表。