有关此类资源的方法列表,请参阅本页面的结尾部分。
资源表示形式
表示报告。
{
  "key": {
    "queryId": long,
    "reportId": long
  },
  "metadata": {
    "status": {
      "state": string,
      "failure": {
        "errorCode": string
      },
      "finishTimeMs": long,
      "format": string
    },
    "reportDataStartTimeMs": long,
    "reportDataEndTimeMs": long,
    "googleCloudStoragePath": string
  },
  "params": {
    "type": string,
    "groupBys": [
      string
    ],
    "filters": [
      {
        "type": string,
        "value": string
      }
    ],
    "metrics": [
      string
    ],
    "includeInviteData": boolean,
    "options": {
      "includeOnlyTargetedUserLists": boolean,
      "pathQueryOptions": {
        "channelGrouping": {
          "name": string,
          "rules": [
            {
              "name": string,
              "disjunctiveMatchStatements": [
                {
                  "eventFilters": [
                    {
                      "dimensionFilter": {
                        "filter": string,
                        "match": string,
                        "values": [
                          string
                        ]
                      }
                    }
                  ]
                }
              ]
            }
          ],
          "fallbackName": string
        },
        "pathFilters": [
          {
            "eventFilters": [
              {
                "dimensionFilter": {
                  "filter": string,
                  "match": string,
                  "values": [
                    string
                  ]
                }
              }
            ],
            "pathMatchPosition": string
          }
        ]
      }
    }
  }
}| 属性名称 | 值 | 说明 | 备注 | 
|---|---|---|---|
key | 
        nested object | 
        用于标识报告的键。 | |
key.queryId | 
        long | 
        查询 ID。 | |
key.reportId | 
        long | 
        报告 ID。 | |
metadata | 
        nested object | 
        报告元数据。 | |
metadata.googleCloudStoragePath | 
        string | 
        指向 Google Cloud Storage 中报告存储位置的路径。 | |
metadata.reportDataEndTimeMs | 
        long | 
        报告中显示数据的结束时间。 | |
metadata.reportDataStartTimeMs | 
        long | 
        报告中显示数据的开始时间。 | |
metadata.status | 
        nested object | 
        报告状态。 | |
metadata.status.failure | 
        nested object | 
        如果报告失败,则会记录原因。 | |
metadata.status.failure.errorCode | 
        string | 
        说明报告未创建原因的错误代码。
           可接受的值包括: 
  | 
        |
metadata.status.finishTimeMs | 
        long | 
        此报告成功完成或失败的时间。 | |
metadata.status.format | 
        string | 
        报告的文件类型。
           可接受的值包括: 
  | 
        |
metadata.status.state | 
        string | 
        报告的状态。
           可接受的值包括: 
  | 
        |
params | 
        nested object | 
        报告参数。 | |
params.filters[] | 
        list | 
        用于匹配报告中流量数据的过滤器。 | |
params.filters[].type | 
        string | 
        过滤器类型。
           可接受的值包括: 
  | 
        |
params.filters[].value | 
        string | 
        过滤条件值。 | |
params.groupBys[] | 
        list | 
        系统会按此字段中列出的过滤条件对数据进行分组。 | |
params.includeInviteData | 
        boolean | 
        已弃用。该字段已不再使用。 | |
params.metrics[] | 
        list | 
        要作为列添加到报表中的指标。 | |
params.options | 
        nested object | 
        其他查询选项。 | |
params.options.includeOnlyTargetedUserLists | 
        boolean | 
        是否仅包含广告订单或订单项明确定位的受众群体名单的数据。仅适用于 TYPE_GENERAL 报告。必须将“FILTER_AUDIENCE_LIST”添加为过滤条件或维度。必须将 FILTER_INSERTION_ORDER 或 FILTER_LINE_ITEM 添加为过滤条件。 | 
        |
params.options.pathQueryOptions | 
        nested object | 
        包含路径过滤条件和自定义渠道分组的选项。仅适用于 TYPE_PATH 和 TYPE_PATH_ATTRIBUTION 报告。 | 
        |
params.options.pathQueryOptions.channelGrouping | 
        nested object | 
        自定义渠道分组。仅适用于 TYPE_PATH 和 TYPE_PATH_ATTRIBUTION 报告。 | 
        |
params.options.pathQueryOptions.channelGrouping.fallbackName | 
        string | 
        要应用于与渠道分组中的任何规则均不匹配的事件的名称。 | |
params.options.pathQueryOptions.channelGrouping.name | 
        string | 
        渠道分组名称。 | |
params.options.pathQueryOptions.channelGrouping.rules[] | 
        list | 
        渠道分组中的规则。每个渠道分组最多只能设置 100 条规则。 | |
params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[] | 
        list | 
        规则中的析取匹配语句。DisjunctiveMatchStatement OR 包含的所有过滤条件。 | |
params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[] | 
        list | 
        过滤器。每个析取范式匹配语句最多只能设置 100 个过滤条件。 | |
params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter | 
        nested object | 
        按维度进行过滤。 | |
params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.filter | 
        string | 
        应用过滤条件的维度。
           可接受的值包括: 
  | 
        |
params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match | 
        string | 
        指明过滤条件与值的匹配方式。
           可接受的值包括: 
  | 
        |
params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.values[] | 
        list | 
        要用作过滤条件的值。 | |
params.options.pathQueryOptions.channelGrouping.rules[].name | 
        string | 
        规则名称。 | |
params.options.pathQueryOptions.pathFilters[] | 
        list | 
        路径过滤器。每个报告最多可以设置 100 个路径过滤条件。仅适用于 TYPE_PATH 和 TYPE_PATH_ATTRIBUTION 报告。 | 
        |
params.options.pathQueryOptions.pathFilters[].eventFilters[] | 
        list | 
        过滤要应用于路径某些部分的事件。 | |
params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter | 
        nested object | 
        按维度进行过滤。 | |
params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.filter | 
        string | 
        应用过滤条件的维度。
           可接受的值包括: 
  | 
        |
params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match | 
        string | 
        指明过滤条件与值的匹配方式。
           可接受的值包括: 
  | 
        |
params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.values[] | 
        list | 
        要用作过滤条件的值。 | |
params.options.pathQueryOptions.pathFilters[].pathMatchPosition | 
        string | 
        指示过滤器应匹配的路径位置(路径中的第一个、最后一个或任何事件)。
           可接受的值包括: 
  | 
        |
params.type | 
        string | 
        报告类型。 类型特有的限制: 
 可接受的值: 
  | 
        
方法
- listreports
 - 检索存储的报告。