如需本資源的方法清單,請見本頁結尾。
資源表示法
代表報表。
{
  "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 | 規則內的選擇性比對 MatchStatements。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
- 擷取已儲存的報表。