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)

要讀取資料的日期範圍。如果要求多個日期範圍，則每個回應列都會包含以零為基準的日期範圍索引。如果兩個日期範圍重疊，這兩個日期範圍的回應列就會包含重疊日期的事件資料。在同類群組要求中，您必須指定這個dateRanges。
offset

string (int64 format)

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

string (int64 format)

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

enum (MetricAggregation)

指標匯總。匯總指標值會顯示在 dimensionValues 設為「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