Method: runReport

傳回 Google Analytics (分析) 事件資料的自訂報表。報表包含由 Google Analytics (分析) 追蹤程式碼收集到的資料衍生的統計資料。API 傳回的資料會以表格形式呈現，所請求維度和指標的欄。指標則是針對資源中的使用者活動所做的個別評估，例如活躍使用者或事件計數。維度會依部分常見條件細分指標，例如國家/地區或事件名稱。

HTTP 要求

POST https://analyticsdata.googleapis.com/v1alpha:runReport

這個網址使用 gRPC 轉碼語法。

要求主體

要求主體的資料會採用以下結構：

JSON 表示法 
{
  "entity": {
    object (Entity)
  },
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean
}
欄位
entity

object (Entity)

追蹤事件的資源。在批次要求中，這個實體應未指定或與批次層級實體一致。
dimensions[]

object (Dimension)

要求及顯示的維度。
metrics[]

object (Metric)

要求及顯示的指標，
dateRanges[]

object (DateRange)

要讀取的資料日期範圍。如果要求多個日期範圍，則每個回應列都會包含以 0 為基礎的日期範圍索引。如果兩個日期範圍重疊，這兩個日期範圍的事件資料會納入這兩個日期範圍的回應列中。在同類群組要求中，不得指定這個 dateRanges。
offset

string (int64 format)

起始資料列的列數。第一列會計為第 0 列。
limit

string (int64 format)

要傳回的列數。如未指定 limit 參數，則會傳回 10,000 列。無論您要求的數量為何，API 每個要求最多只能傳回 100,000 個資料列。
metricAggregations[]

enum (MetricAggregation)

指標匯總。匯總指標值會顯示在 DimensionsValue 設為「RESERVED_(MetricAggregation)」的資料列中。
dimensionFilter

object (FilterExpression)

維度的篩選器子句。必須要求在這個篩選器中使用維度。這個篩選器無法使用指標。
metricFilter

object (FilterExpression)

指標的篩選器子句。套用於匯總後階段，與 SQL 有子句類似。您必須要求指標，才能在這個篩選器中使用。無法在這個篩選器中使用維度。
orderBys[]

object (OrderBy)

指定資料列在回應中的排序方式。
currencyCode

string

採用 ISO4217 格式的貨幣代碼，例如「AED」、「USD」、「JPY」。如果這個欄位空白，報表就會使用實體的預設貨幣。
cohortSpec

object (CohortSpec)

與這項要求相關聯的同類群組。如果請求中有同類群組群組，就必須顯示「同類群組」維度。
keepEmptyRows

boolean

如為 false 或未指定，則不會傳回所有指標等於 0 的每一列。如果設為 true，如果未遭到篩選器單獨移除，系統就會傳回這些資料列。
returnPropertyQuota

boolean

切換是否要傳回這項 Analytics (分析) 資源的配額目前的狀態。系統會在 PropertyQuota 中傳回配額。

回應主體

如果成功，回應主體會包含 RunReportResponse 的執行例項。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics