Method: accounts.runAccessReport

傳回自訂的資料存取記錄報表。這份報表會記錄使用者每次讀取 Google Analytics 報表資料的情形。存取記錄最多會保留 2 年。

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

這些資料存取記錄包括 GA 使用者介面報表、GA 使用者介面探索、GA 資料 API,以及 Firebase 和 AdMob 等其他產品,這些產品可透過連結從 Google Analytics 擷取資料。這些記錄不包含資源設定變更,例如新增串流或變更資源的時區。如要查看設定變更記錄,請參閱 searchChangeHistoryEvents

如要針對這個 API 提供意見回饋,請填寫 Google Analytics 存取報表意見回饋表單

HTTP 要求

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

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

路徑參數

參數
entity

string

資料存取報表支援資源層級或帳戶層級的索取要求。如果在帳戶層級提出要求,資料存取報表就會包含該帳戶下所有資源的所有存取權。

如要在資源層級提出要求,實體應為「properties/123」,其中「123」是 Google Analytics 資源 ID。如要提出帳戶層級要求,實體應為「accounts/1234」,其中「1234」是您的 Google Analytics 帳戶 ID。

要求主體

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

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)

在回應中要求及顯示的維度。要求最多可包含 9 個維度。

metrics[]

object (AccessMetric)

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

dateRanges[]

object (AccessDateRange)

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

dimensionFilter

object (AccessFilterExpression)

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

metricFilter

object (AccessFilterExpression)

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

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」或「Asia/Tokyo」。

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