本頁面由 Cloud Translation API 翻譯而成。

Method: accounts.runAccessReport

HTTP 要求
路徑參數
要求主體
- JSON 表示法
回應主體
授權範圍
試試看！

傳回資料存取記錄的自訂報表。每當使用者讀取 Google Analytics 報表資料時，報表就會提供記錄。存取記錄最多會保留 2 年。

可要求資源的資料存取報表。您可以為任何資源提出報表要求，但與配額無關的維度只能在 Google Analytics 360 資源中要求。這個方法僅供管理員使用。

這些資料存取記錄包括 Google Analytics UI 報表、Google Analytics UI 探索、Google Analytics Data API，以及 Firebase 和可以透過連結從 Google Analytics 擷取資料的 AdMob。這些記錄不包含資源設定變更 (例如新增串流或變更資源的時區)。如需瞭解設定變更記錄，請參閱 searchChangeHistoryEvents。

如要提供有關這個 API 的寶貴意見，請填寫 Google Analytics 存取報表意見回饋表單。

HTTP 要求

POST https://analyticsadmin.googleapis.com/v1beta/{entity=accounts/*}:runAccessReport

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

路徑參數

參數

參數
`entity`	`string` 「資料存取報表」支援在資源或帳戶層級提出要求。若在帳戶層級提出請求，資料存取報表會包含該帳戶下所有資源的所有存取權。如要在屬性層級提出要求，實體應為「properties/123」表示「123」就是您的 GA4 資源 ID。如要在帳戶層級提出要求，實體應為「accounts/1234」表示「1234」是您的 GA4 帳戶 ID。

entity

string

「資料存取報表」支援在資源或帳戶層級提出要求。若在帳戶層級提出請求，資料存取報表會包含該帳戶下所有資源的所有存取權。

如要在屬性層級提出要求，實體應為「properties/123」表示「123」就是您的 GA4 資源 ID。如要在帳戶層級提出要求，實體應為「accounts/1234」表示「1234」是您的 GA4 帳戶 ID。

要求主體

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

JSON 表示法

JSON 表示法
{ "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 }

{
  "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
}

欄位
`dimensions[]`	`object (AccessDimension)` 要求並顯示的維度。最多允許 9 個維度。
`metrics[]`	`object (AccessMetric)` 回應中要求及顯示的指標。最多可有 10 個指標。
`dateRanges[]`	`object (AccessDateRange)` 要讀取的存取記錄日期範圍。如果要求多個日期範圍，則每個回應列都會包含以零為基準的日期範圍索引。如果兩個日期範圍重疊，兩個日期範圍的回應列中都會包含重疊日期的存取權記錄。最多允許 2 個日期範圍的要求。
`dimensionFilter`	`object (AccessFilterExpression)` 維度篩選器可讓您限制報表只回應符合篩選器的特定維度值。例如，篩選單一使用者的存取記錄。詳情請參閱「維度篩選器的基本知識」一文。無法在這個篩選器中使用指標。
`metricFilter`	`object (AccessFilterExpression)` 您可以運用指標篩選器，限制報表回應僅適用於符合篩選器的特定指標值。如同 SQL 包含子句，系統會在匯總報表的資料列後套用指標篩選器。無法在這個篩選器中使用維度。
`offset`	`string (int64 format)` 起始資料列的列數。第一列會計為第 0 列。如果未指定偏移值，系統會將其視為 0。如果偏移值為零，這個方法會傳回第一頁的結果，內含 `limit` 項目。如要進一步瞭解這個分頁參數，請參閱「分頁」。
`limit`	`string (int64 format)` 要傳回的列數。如未指定，系統會傳回 10,000 列。無論您要求多少列，API 在每個要求最多只能傳回 100,000 列資料。`limit`必須為正數。如果 `limit` 的剩餘資料列數不足，API 傳回的資料列可能會少於要求的 `limit`。舉例來說，維度 `country` 的可能值少於 300 個，因此如果只針對 `country` 製作報表，即使將 `limit` 設為較高的值，也無法取得超過 300 列的資料。如要進一步瞭解這個分頁參數，請參閱「分頁」。
`timeZone`	`string` 此要求的時區 (如有指定)。如果未指定，則會使用屬性的時區。要求的時區是用於解讀開始時間和報表的結束日期採用 IANA 時區資料庫 (https://www.iana.org/time-zones) 的字串；例如「America/New_York」或「亞洲/東京」
`orderBys[]`	`object (AccessOrderBy)` 指定回應中列的排序方式。
`returnEntityQuota`	`boolean` 切換是否要傳回這項 Analytics 資源的配額目前狀態。配額會在 AccessQuota 中傳回。如果是帳戶層級請求，這個欄位必須為 false。
`includeAllUsers`	`boolean` 選用設定。決定是否要在回應中加入從未發出 API 呼叫的使用者。設為 true 時，無論是否發出 API 呼叫，凡是可存取指定資源或帳戶的使用者，都會納入回應中。如果設為 False，系統只會納入已發出 API 呼叫的使用者。
`expandGroups`	`boolean` 選用設定。決定是否要傳回使用者群組中的使用者。只有在 includeAllUsers 設為 true 時，才能使用這個欄位。若為 true，則會傳回所有可存取指定資源或帳戶的使用者。如果設為 False，系統只會傳回具備直接存取權的使用者。

回應主體

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

授權範圍

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

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