傳回自訂的資料存取記錄報告。每次使用者讀取 Google Analytics (分析) 報表資料時,這份報表就會顯示。存取記錄最多會保留 2 年。
可要求資源的資料存取報表。資源必須在 Google Analytics (分析) 360 中。這個方法僅適用於管理員。
這些資料存取記錄包括 GA4 UI 報表、GA4 UI 探索、GA4 Data API,以及 Firebase 和 AdMob 等其他產品,可透過連結從 Google Analytics (分析) 擷取資料。這些記錄不包含資源設定變更,例如新增串流或變更資源的時區。如要進一步瞭解設定變更記錄,請參閱 searchChangeHistoryEvents。
HTTP 要求
POST https://analyticsadmin.googleapis.com/v1beta/{entity=accounts/*}:runAccessReport
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
entity |
資料存取報表支援在資源層級或帳戶層級要求。如果已在帳戶層級要求資料存取權,該資源的資料存取權報表會列出該帳戶中所有資源的所有存取權。 如要在資源層級提出要求,實體必須採用「property/123」做為 GA4 資源 ID。若想在帳戶層級提出請求,實體必須設為「accounts/1234」,如果「1234」是您的 GA4 帳戶 ID。 |
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
---|
{ "dimensions": [ { object ( |
欄位 | |
---|---|
dimensions[] |
要求中顯示的維度並顯示在回應中。要求最多允許 9 個維度。 |
metrics[] |
要求中會顯示及顯示的指標。要求最多可以有 10 個指標。 |
dateRanges[] |
要讀取的存取日期範圍。如果請求多個日期範圍,則每個回應資料列都會包含一個以零為基礎的日期範圍索引。如果兩個日期範圍重疊,重疊日期範圍的存取權記錄會包含這兩個日期範圍的回應資料列。要求最長可達 2 個日期範圍。 |
dimensionFilter |
維度篩選器可讓您限制報表接受與篩選器相符的特定維度值。例如依單一使用者的存取記錄進行篩選。詳情請參閱「維度篩選器的基礎知識」一節。這個篩選器無法用於指標。 |
metricFilter |
指標篩選器可讓您將報表回應限制為符合篩選器的特定指標值。指標會在匯總報表資料列後套用,就像 SQL 有 子句 一樣。這個篩選器無法用於這個維度。 |
offset |
起始資料列的資料列數。第一列會計為第 0 列。如未指定偏移值,系統會將其視為 0。如果偏移值為 0,這個方法會傳回第一頁含有 如要進一步瞭解這個分頁參數,請參閱「分頁」。 |
limit |
要傳回的資料列數。如未指定,系統會傳回 10,000 個資料列。無論您要求的請求數量為何,API 最多只會傳回 100,000 列資料。「 如果剩餘的 如要進一步瞭解這個分頁參數,請參閱「分頁」。 |
timeZone |
指定的要求時區 (如果已指定)。如未指定,則會採用資源的時區。系統會使用要求的時區來解讀報表的開始與結束日期。 採用 IANA 時區資料庫 (https://www.iana.org/time-zones) 的字串格式,例如「America/New_York」或「Asia/Tokyo」。 |
orderBys[] |
指定資料列中的回應方式。 |
returnEntityQuota |
切換是否要傳回這個 Analytics (分析) 資源配額的目前狀態。系統會在 AccessQuota 中傳回配額。如果是帳戶層級的請求,這個欄位必須為 false。 |
回應主體
如果成功,回應主體會包含 RunAccessReportResponse
的執行例項。
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics.edit