傳回資料存取記錄的自訂報表。每次使用者讀取 Google Analytics (分析) 報表資料時,這份報表都會列出記錄。存取記錄最多會保留 2 年。
可要求資源的資料存取報表。系統可能會要求任何資源的報表,但與配額無關的維度,就只能在 Google Analytics (分析) 360 資源中要求。這個方法僅供「管理員」使用。
這些資料存取記錄包括 GA4 UI 報表、GA4 UI 探索、GA4 Data API,以及可透過連結從 Google Analytics (分析) 擷取資料的其他產品 (如 Firebase 和 AdMob)。這些記錄不包含資源設定變更 (例如新增串流或變更資源時區),如需設定變更記錄,請參閱 searchChangeHistoryEvents。
HTTP 要求
POST https://analyticsadmin.googleapis.com/v1alpha/{entity=properties/*}:runAccessReport
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
entity |
資料存取報表支援在資源層級或帳戶層級提出要求。如在帳戶層級提出要求,資料存取報表就會包含該帳戶下所有資源的所有存取權。 如要在資源層級提出要求,實體應以「properties/123」為例,且「123」是您的 GA4 資源 ID。如要在帳戶層級提出要求,實體應為「accounts/1234」,例如「1234」是您的 GA4 帳戶 ID。 |
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
---|
{ "dimensions": [ { object ( |
欄位 | |
---|---|
dimensions[] |
要求及顯示在回應中的維度。要求最多可包含 9 個維度。 |
metrics[] |
要求及顯示在回應中的指標。要求最多可包含 10 個指標。 |
dateRanges[] |
要讀取的存取記錄日期範圍。如果要求多個日期範圍,則每個回應列都會包含以 0 為基礎的日期範圍索引。如果兩個日期範圍重疊,這兩個日期範圍的回應列就會包含重疊日期的存取權記錄。最多可以要求 2 個日期範圍。 |
dimensionFilter |
維度篩選器可讓您限制報表只傳回符合篩選器的特定維度值。例如,篩選單一使用者的存取記錄。詳情請參閱「維度篩選器基礎知識」一文。這個篩選器無法使用指標。 |
metricFilter |
指標篩選器可限制報表只會列出符合篩選條件的特定指標值。指標篩選器會在匯總報表資料列後套用,與 SQL 含子句類似。無法在這個篩選器中使用維度。 |
offset |
起始資料列的列數。第一列會計為第 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。 |
includeAllUsers |
選用設定。決定是否要在回應中納入從未發出 API 呼叫的使用者。如果設為 true,所有可存取指定資源或帳戶的使用者,無論是否發出 API 呼叫,都會納入回應中。如果設為 False,系統只會納入已發出 API 呼叫的使用者。 |
expandGroups |
選用設定。決定是否要傳回使用者群組中的使用者。只有在 includeAllUsers 設為 true 時,此欄位才有效。若為 true,系統會傳回所有具有指定資源或帳戶存取權的使用者。如果設為 False,系統只會傳回具有直接存取權的使用者。 |
回應主體
如果成功,回應主體會包含 RunAccessReportResponse
的執行例項。
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics.edit