Method: properties.runAccessReport

{
  "dimensions": [
    {
      object (AccessDimension)
    }
  ],
  "metrics": [
    {
      object (AccessMetric)
    }
  ],
  "dateRanges": [
    {
      object (AccessDateRange)
    }
  ],
  "dimensionFilter": {
    object (AccessFilterExpression)
  },
  "metricFilter": {
    object (AccessFilterExpression)
  },
  "offset": string,
  "limit": string,
  "timeZone": string,
  "orderBys": [
    {
      object (AccessOrderBy)
    }
  ],
  "returnEntityQuota": boolean,
  "includeAllUsers": boolean,
  "expandGroups": boolean
}

object (AccessDimension)

要求並在回應中顯示的維度。最多允許 9 個維度。

object (AccessMetric)

要求並在回應中顯示的指標。要求最多可包含 10 個指標。

object (AccessDateRange)

要讀取的存取記錄日期範圍。如果要求多個日期範圍，每個回應資料列都會包含以零為基底的日期範圍索引。如果兩個日期範圍重疊，兩個日期範圍的回應列就會包含重疊日期的存取記錄。最多允許 2 個日期範圍的要求。

object (AccessFilterExpression)

維度篩選器可讓您限制報表只回應符合篩選器的特定維度值。例如，篩選單一使用者的存取記錄。如需進一步瞭解相關範例，請參閱「維度篩選器的基本概念」。這個篩選條件無法使用指標。

object (AccessFilterExpression)

您可以使用指標篩選器，將報表回應限制在符合篩選器的特定指標值。指標篩選器會在匯總報表資料列後套用，類似於 SQL 中的 having 子句。這個篩選器無法使用維度。

string (int64 format)

起始資料列的列數。第一列會計為第 0 列。如果未指定偏移值，系統會將其視為 0。如果偏移量為零，這個方法會傳回第一頁的結果，其中包含 limit 項目。

如要進一步瞭解這個分頁參數，請參閱「分頁」。

string (int64 format)

要傳回的列數。如未指定，系統會傳回 10,000 列。無論您要求多少資料列，API 每項要求最多只會傳回 100,000 列。limit 必須為正數。

如果剩餘的資料列數量不如 limit 多，API 傳回的資料列可能會少於要求的 limit。舉例來說，維度 country 的可能值少於 300 個，因此如果只針對 country 製作報表，即使將 limit 設為較高的值，也無法取得超過 300 列的資料。

如要進一步瞭解這個分頁參數，請參閱「分頁」。

string

此要求的時區 (如果已指定)。如未指定，系統會使用資源的時區。系統會使用要求的時區來解讀報表的開始和結束日期。

格式為 IANA 時區資料庫 (https://www.iana.org/time-zones) 中的字串，例如「America/New_York」或「Asia/Tokyo」。

object (AccessOrderBy)

指定回應中列的排序方式。

boolean

切換是否要傳回 Analytics 資源目前配額的狀態。配額會傳回至 AccessQuota。如果是帳戶層級請求，這個欄位必須為 false。

boolean

選用設定。決定是否要在回應中納入從未發出 API 呼叫的使用者。如果為 true，則無論使用者是否已發出 API 呼叫，只要有權存取指定資源或帳戶的使用者都會納入回應中。如果設為 False，系統只會納入已發出 API 呼叫的使用者。

boolean

選用設定。決定是否要傳回使用者群組中的使用者。只有在 includeAllUsers 設為 true 時，這個欄位才能運作。如果為 true，則會傳回所有可存取指定資源或帳戶的使用者。如果為 false，則只會傳回具有直接存取權的使用者。