管理 Google Analytics 帳戶與資源設定、透過 Cloud CLI 啟用 Analytics Admin API、列出帳戶與資源,並管理資料串流、自訂維度、轉換事件與各項整合。當你需要透過程式化方式設定 Google Analytics 帳戶、建立資源、管理資料保留期限、設定 Measurement Protocol 金鑰,或管理 Firebase 與 Google Ads 連結時使用此 Skill。
Google Analytics Admin API 入門指南
Google Analytics Admin API 提供透過程式化方式存取 Google Analytics 帳戶與資源設定的功能。你可以利用它來自動化帳戶管理、控制資料串流、設定自訂維度,並處理各項 Google 產品的整合。
透過 Cloud CLI 啟用 API
在發送 API 請求前,請先確認你的 Google Cloud 專案已啟用 Google Analytics Admin API。
若系統未找到 gcloud 指令,請提示使用者在執行下列命令前先安裝 Google Cloud CLI。
-
啟用 API: 使用 Cloud CLI (
gcloud) 啟用analyticsadmin.googleapis.com。gcloud services enable analyticsadmin.googleapis.com --quiet原因:啟用 API 可確保你的 Cloud 專案獲配管理 Google Analytics 設定所需的配額與權限。
-
驗證 API 啟用狀態:
gcloud services list --enabled --filter="analyticsadmin.googleapis.com"
身份驗證
為了解析與驗證 API 請求,你需要產生應用程式預設憑證 (Application Default Credentials, ADC) 並授予帳戶所需的存取權限範圍 (Scopes)。請在終端機中執行以下命令:
gcloud auth application-default login --scopes="https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/analytics.readonly"
原因:這會在你的本機環境中設定 ADC,並帶入所需的 Cloud Platform 與 Google Analytics 唯讀權限,讓用戶端函式庫能自動驗證後續請求。
[!NOTE] 變更設定須知:任何會修改 Google Analytics 帳戶或資源設定的方法,都需要授與
https://www.googleapis.com/auth/analytics.edit權限範圍。
Admin API 常見應用場景
你可以使用 Google Analytics Admin API 進行以下操作:
- 執行資料存取報告 (Data Access reports,詳情請參考 https://developers.google.com/analytics/devguides/config/admin/v1/access-api.md.txt)
- 建立帳戶摘要 (Account summaries)
- 管理帳戶
- 建置新帳戶
- 搜尋帳戶變更歷史紀錄事件
- 管理與建立資源
- 管理資源的資料保留設定
- 管理轉換事件
- 管理自訂維度與指標
- 管理資料串流並設定 Measurement Protocol 密鑰
- 管理 Firebase 連結
- 管理 Google Ads 連結
- 管理關鍵事件 (Key events)
v1alpha 專屬應用場景
以下功能目前僅在 Admin API 的 v1alpha 版本中提供:
- 管理帳戶與資源的存取權限綁定 (Access bindings)
- 建立與管理彙總資源 (Rollup properties)
- 建立與管理子資源 (Subproperties)
- 確認使用者資料收集條款 (Acknowledge user data collection)
- 修改資源的歸因、資料保留、Google 訊號 (Google signals)、報表識別資訊 (Reporting identity) 以及使用者提供資料 (User Provided Data) 等設定
- 管理 AdSense 連結
- 管理 BigQuery 連結
- 管理受眾 (Audiences)
- 管理管道組 (Channel groups)
- 管理計算指標 (Calculated metrics)
- 管理 Display & Video 360 廣告主連結
- 管理擴充資料集 (Expanded data sets)
- 管理報表資料註記 (Reporting data annotations)
- 管理 Search Ads 360 連結
- 管理資料串流的事件建立規則 (Event create rules)
- 管理 iOS 資料串流的 SKAdNetwork 轉換值結構 (Schema)
- 提交 Google Analytics 資源的使用者資料刪除請求
呼叫 Admin API
請使用官方的 Google Analytics Admin 用戶端函式庫來與 Admin API 互動。請注意,目前 v1beta 是 Admin API 最穩定的版本;若需要使用最新功能,可考慮使用 v1alpha。
[!IMPORTANT] Agent 強制指令:當使用者選擇或需要特定程式語言時,請閱讀下方
references/目錄中對應的用戶端函式庫設定參考指南。
支援的用戶端函式庫
Python
如需安裝或設定 Python 版 Google Analytics Admin API 用戶端函式庫,請參閱設定指南:
- Python 安裝指南 (套件:
google-analytics-admin)
Java
如需安裝或設定 Java 版 Google Analytics Admin API 用戶端函式庫,請參閱設定指南:
- Java 安裝指南 (構件:
com.google.cloud:google-cloud-analytics-admin)
PHP
如需安裝或設定 PHP 版 Google Analytics Admin API 用戶端函式庫,請參閱設定指南:
- PHP 安裝指南 (套件:
google/analytics-admin)
Node.js
如需安裝或設定 Node.js 版 Google Analytics Admin API 用戶端函式庫,請參閱設定指南:
- Node.js 安裝指南 (套件:
@google-analytics/admin)
Go
如需安裝或設定 Go 版 Google Analytics Admin API 用戶端函式庫,請參閱設定指南:
- Go 安裝指南 (套件:
cloud.google.com/go/analytics/admin/apiv1beta)
.NET
如需安裝或設定 .NET / C# 版 Google Analytics Admin API 用戶端函式庫,請參閱設定指南:
- .NET 安裝指南 (套件:
Google.Analytics.Admin.V1Beta)
Ruby
如需安裝或設定 Ruby 版 Google Analytics Admin API 用戶端函式庫,請參閱設定指南:
- Ruby 安裝指南 (Gem:
google-analytics-admin-v1alpha)
[!NOTE] 其他資源:如需更多使用 Java、PHP、Node.js、.NET、Python 及 REST 呼叫 Admin API 的範例,或是使用服務帳戶 (Service Account) 進行身份驗證的提示,請參閱官方 Admin API 快速入門。若需查看
v1alpha和v1beta的完整 API 參考文件,請造訪 Admin API 參考文件。
Python 快速上手
-
安裝用戶端函式庫:
pip install google-analytics-admin若系統未提供
pip,請提示使用者在安裝用戶端函式庫前先安裝pip。 -
列出帳戶與資源: 以下完整的程式碼範例展示如何呼叫 Admin API,透過
list_account_summaries()列出當前使用者可存取的所有帳戶及其子資源。from google.analytics.admin import AnalyticsAdminServiceClient def sample_list_account_summaries(): # 初始化用戶端。 # 假設環境中已設定好應用程式預設憑證 (ADC)。 client = AnalyticsAdminServiceClient() # list_account_summaries 會傳回使用者可存取的所有帳戶及其子資源摘要。 account_summaries = client.list_account_summaries() print("可用的 Google Analytics 帳戶與資源:") for summary in account_summaries: print(f"帳戶: {summary.display_name} ({summary.account})") for property_summary in summary.property_summaries: print(f" 資源: {property_summary.display_name} ({property_summary.property})") if __name__ == "__main__": sample_list_account_summaries()






