在本快速入門中，您將建立並傳送 list 要求給 Google Analytics 管理員 API，然後查看回應，設定及驗證 API 存取權。
您可以使用 SDK 或本機環境或 Google Cloud VM 執行個體中的 REST API 完成此快速入門導覽課程。
以下是步驟摘要：
- 設定 Google Cloud 專案並啟用 Google Analytics Admin API。
- 在本機或 Cloud VM 執行個體上：
- 安裝、初始化及驗證 Google Cloud。
- 安裝所用語言的 SDK (選用)。
- 設定驗證機制。
- 設定 Google Analytics 存取權。
- 設定 SDK。
- 發出 API 呼叫。
設定 Google Cloud 專案
按一下下方的「Enable the Google Analytics Admin API」按鈕，即可選取或建立新的 Google Cloud 專案，並自動啟用 Google Analytics Admin API。
設定 Google Cloud
在本機電腦或 Cloud VM 執行個體上，設定並透過 Google Cloud 進行驗證。
-
安裝並初始化 Google Cloud。
-
如要確保
gcloud元件為最新版本，請執行下列指令。gcloud components update
如要避免向 Google Cloud 提供專案 ID，您可以使用 gcloud config set 指令設定預設專案和區域。
設定驗證機制
本快速入門課程會使用應用程式預設憑證，根據應用程式環境自動尋找憑證，因此您不必變更用戶端程式碼來進行驗證。
Google Analytics 管理員 API 支援使用者帳戶和服務帳戶：
- 使用者帳戶代表開發人員、管理員或任何其他與 Google API 和服務互動的使用者。
- 服務帳戶不代表特定真人使用者。在沒有人為直接介入的情況下，例如應用程式需要存取 Google Cloud 資源時，這些服務可用於管理驗證和授權作業。
如要進一步瞭解驗證程序，以及如何為應用程式設定帳戶憑證，請參閱「Google 的驗證方式」。
執行下列指令，產生本機應用程式預設憑證 (ADC) 檔案。這個指令會啟動網頁流程，讓您提供使用者憑證。
gcloud auth application-default login --scopes="https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/analytics.readonly"
請務必在指令中指定 Google Analytics Admin API 所需的範圍。詳情請參閱「設定應用程式預設憑證」。
以下是使用服務帳戶驗證的步驟：
- 建立服務帳戶。
- 執行下列 gcloud CLI 指令，將服務帳戶連結至 Cloud VM 執行個體：
gcloud compute instances stop YOUR-VM-INSTANCE-ID
gcloud compute instances set-service-account YOUR-VM-INSTANCE-ID \
--service-account YOUR-SERVICE-ACCOUNT-EMAIL-ALIAS \
--scopes="https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/analytics.readonly"
請務必在指令中指定 Google Analytics Admin API 所需的範圍。詳情請參閱「設定應用程式預設憑證」。
設定 Google Analytics 存取權
授予 Google Analytics 存取權，讓與使用者或服務帳戶相關聯的電子郵件地址存取資料。
為程式設計語言設定 SDK
在本機上安裝程式語言的 SDK。
go get google.golang.org/genproto/googleapis/analytics/admin/v1beta
輸入下列內容來設定環境變數。
將 PROJECT_ID 替換為 Google Cloud 專案的 ID。
EXPORT PROJECT_ID=PROJECT_ID
發出 API 呼叫
執行下列程式碼即可進行首次呼叫：
import com.google.analytics.admin.v1beta.Account; import com.google.analytics.admin.v1beta.AnalyticsAdminServiceClient; import com.google.analytics.admin.v1beta.AnalyticsAdminServiceClient.ListAccountsPage; import com.google.analytics.admin.v1beta.AnalyticsAdminServiceClient.ListAccountsPagedResponse; import com.google.analytics.admin.v1beta.ListAccountsRequest; /** * This application demonstrates the usage of the Analytics Admin API using service account * credentials. For more information on service accounts, see * https://cloud.google.com/iam/docs/understanding-service-accounts. * * <p>The following document provides instructions on setting service account credentials for your * application: https://cloud.google.com/docs/authentication/production * * <p>In a nutshell, you need to: * * <ol> * <li>Create a service account and download the key JSON file as described at * https://cloud.google.com/docs/authentication/production#creating_a_service_account. * <li>Provide service account credentials using one of the following options: * <ul> * <li>Set the {@code GOOGLE_APPLICATION_CREDENTIALS} environment variable. The API client * will use the value of this variable to find the service account key JSON file. See * https://cloud.google.com/docs/authentication/production#setting_the_environment_variable * for more information. * <p>OR * <li>Manually pass the path to the service account key JSON file to the API client by * specifying the {@code keyFilename} parameter in the constructor. See * https://cloud.google.com/docs/authentication/production#passing_the_path_to_the_service_account_key_in_code * for more information. * </ul> * </ol> * * <p>To run this sample using Maven: * * <pre>{@code * cd google-analytics-data * mvn compile exec:java -Dexec.mainClass="com.google.analytics.admin.samples.QuickstartSample" * }</pre> */ public class QuickstartSample { public static void main(String... args) throws Exception { listAccounts(); } // This is an example snippet that calls the Google Analytics Admin API and lists all Google // Analytics accounts available to the authenticated user. static void listAccounts() throws Exception { // Instantiates a client using default credentials. // See https://cloud.google.com/docs/authentication/production for more information // about managing credentials. try (AnalyticsAdminServiceClient analyticsAdmin = AnalyticsAdminServiceClient.create()) { // Calls listAccounts() method of the Google Analytics Admin API and prints // the response for each account. ListAccountsPagedResponse response = analyticsAdmin.listAccounts(ListAccountsRequest.newBuilder().build()); for (ListAccountsPage page : response.iteratePages()) { for (Account account : page.iterateAll()) { System.out.printf("Account name: %s%n", account.getName()); System.out.printf("Display name: %s%n", account.getDisplayName()); System.out.printf("Country code: %s%n", account.getRegionCode()); System.out.printf("Create time: %s%n", account.getCreateTime().getSeconds()); System.out.printf("Update time: %s%n", account.getUpdateTime().getSeconds()); System.out.println(); } } } } }
require 'vendor/autoload.php'; use Google\Analytics\Admin\V1beta\Account; use Google\Analytics\Admin\V1beta\Client\AnalyticsAdminServiceClient; use Google\Analytics\Admin\V1beta\ListAccountsRequest; /** * TODO(developer): Replace this variable with your Google Analytics 4 * property ID before running the sample. */ $property_id = 'YOUR-GA4-PROPERTY-ID'; // Using a default constructor instructs the client to use the credentials // specified in GOOGLE_APPLICATION_CREDENTIALS environment variable. // See https://cloud.google.com/docs/authentication/production for more information // about managing credentials. $client = new AnalyticsAdminServiceClient(); // Calls listAccounts() method of the Google Analytics Admin API and prints // the response for each account. $request = new ListAccountsRequest(); $response = $client->listAccounts($request); print 'Result:' . PHP_EOL; foreach ($response->iterateAllElements() as $account) { print 'Account name: ' . $account->getName() . PHP_EOL; print 'Display name: ' . $account->getDisplayName() . PHP_EOL; print 'Country code: ' . $account->getRegionCode() . PHP_EOL; print 'Create time: ' . $account->getCreateTime()->getSeconds() . PHP_EOL; print 'Update time: ' . $account->getUpdateTime()->getSeconds() . PHP_EOL; }
def list_accounts(transport: str = None): """ Lists the available Google Analytics accounts. Args: transport(str): The transport to use. For example, "grpc" or "rest". If set to None, a transport is chosen automatically. """ from google.analytics.admin import AnalyticsAdminServiceClient # Using a default constructor instructs the client to use the credentials # specified in GOOGLE_APPLICATION_CREDENTIALS environment variable. client = AnalyticsAdminServiceClient(transport=transport) results = client.list_accounts() # Displays the configuration information for all Google Analytics accounts # available to the authenticated user. print("Result:") for account in results: print(account)
// Imports the Google Analytics Admin API client library. const analyticsAdmin = require('@google-analytics/admin'); // Using a default constructor instructs the client to use the credentials // specified in GOOGLE_APPLICATION_CREDENTIALS environment variable. const analyticsAdminClient = new analyticsAdmin.AnalyticsAdminServiceClient(); // Lists all Google Analytics accounts available to the authenticated user. async function listAccounts() { // Uses listAccounts() with no arguments to fetch all pages. For more // information on pagination in the Node.js library, see: // https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#auto-pagination const [response] = await analyticsAdminClient.listAccounts(); console.log('Accounts:'); for (const account of response) { console.log('Account name:', account.name); console.log('Display name:', account.displayName); console.log('Region code:', account.regionCode); console.log('Create time:', account.createTime.seconds); console.log('Update time:', account.updateTime.seconds); } } listAccounts();
using Google.Analytics.Admin.V1Beta; using Google.Api.Gax; using System; namespace AnalyticsSamples { class QuickStart { static void Main(string[] args) { AnalyticsAdminServiceClient client = AnalyticsAdminServiceClient.Create(); PagedEnumerable<ListAccountsResponse, Account> response = client.ListAccounts( new ListAccountsRequest() ); foreach( Account account in response ) { Console.WriteLine("Account name: {0}", account.Name); Console.WriteLine("Display name: {0}", account.DisplayName); Console.WriteLine("Region code: {0}", account.RegionCode); Console.WriteLine("Update time: {0}", account.UpdateTime); Console.WriteLine("Create time: {0}", account.CreateTime); Console.WriteLine(); } } } }
如要傳送這項要求，請透過指令列執行 curl 指令，或在應用程式中加入 REST 呼叫。
curl -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \ -H "x-goog-user-project: ${PROJECT_ID}" \ -H "Content-Type: application/json" \ https://analyticsadmin.googleapis.com/v1beta/accounts
範例程式碼回應會列出使用者或服務帳戶可查看的 Google Analytics 帳戶：
{
"accounts": [
{
"name": "accounts/123456789",
"createTime": "2025-01-01T00:12:23.456Z",
"createTime": "2025-01-01T00:12:23.456Z",
"displayName": "Demo Account",
"regionCode": "US",
"gmpOrganization": "marketingplatformadmin.googleapis.com/organizations/abcdef12345678"
}
}