Neste guia de início rápido, você cria e envia solicitações list para a API Admin do Google Analytics. Em seguida, você consulta as respostas para configurar e verificar seu acesso à API.
É possível concluir este guia de início rápido usando um SDK ou a API REST no seu ambiente local ou em uma instância de VM do Google Cloud.
Confira um resumo das etapas:
- Configure um projeto do Google Cloud e ative a API Google Analytics Admin.
- Na máquina local ou na instância de VM do Cloud:
- Instale, inicialize e faça a autenticação com o Google Cloud.
- Instale o SDK para sua linguagem (opcional).
- Configure a autenticação.
- Configure o acesso ao Google Analytics.
- Configure um SDK.
- Faça uma chamada de API.
Configure um projeto do Google Cloud
Clique no botão Ativar a API Admin do Google Analytics abaixo para selecionar ou criar um projeto do Google Cloud e ativar automaticamente a API Admin do Google Analytics.
Configurar o Google Cloud
Na máquina local ou em uma instância de VM do Cloud, configure e faça a autenticação com o Google Cloud.
-
Instale e inicialize o Google Cloud.
-
Para garantir que os componentes
gcloudestejam atualizados, execute o comando a seguir.gcloud components update
Para evitar o fornecimento do ID do projeto ao Google Cloud, use o comando gcloud config set para definir um projeto e uma região padrão.
Configurar a autenticação
Este guia de início rápido usa credenciais padrão do aplicativo para encontrar credenciais automaticamente com base no ambiente do aplicativo. Assim, você não precisa mudar o código do cliente para autenticar.
A API Admin do Google Analytics oferece suporte a contas de usuário e contas de serviço:
- As contas de usuário representam um desenvolvedor, administrador ou qualquer outra pessoa que interage com as APIs e serviços do Google.
- As contas de serviço não representam um usuário humano específico. Eles oferecem uma maneira de gerenciar a autenticação e a autorização quando uma pessoa não está diretamente envolvida, como quando um aplicativo precisa acessar recursos do Google Cloud.
Para saber mais sobre autenticação e configuração de credenciais de conta para seu aplicativo, consulte Métodos de autenticação no Google.
Gere um arquivo local de credenciais padrão do aplicativo (ADC) executando o comando a seguir. Esse comando inicia um fluxo da Web em que você fornece suas credenciais de usuário.
gcloud auth application-default login --scopes="https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/analytics.readonly"
Especifique os escopos necessários pela API Admin do Google Analytics no comando. Para mais informações, consulte Configurar o Application Default Credentials.
Estas são as etapas para autenticar com uma conta de serviço:
- Crie uma conta de serviço.
- Anexe a conta de serviço à sua instância de VM do Cloud executando o seguinte comando da CLI gcloud:
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"
Especifique os escopos necessários pela API Admin do Google Analytics no comando. Para mais informações, consulte Configurar o Application Default Credentials.
Configurar o acesso ao Google Analytics
Conceda acesso ao Google Analytics ao e-mail associado à sua conta de usuário ou de serviço.
Configurar o SDK para sua linguagem de programação
Na máquina local, instale o SDK para sua linguagem de programação.
go get google.golang.org/genproto/googleapis/analytics/admin/v1beta
Insira o comando abaixo para configurar as variáveis de ambiente.
Substitua PROJECT_ID pelo ID do projeto do Google Cloud.
EXPORT PROJECT_ID=PROJECT_ID
Fazer uma chamada de API
Execute o código a seguir para fazer a primeira chamada:
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(); } } } }
Para enviar essa solicitação, execute o comando curl na linha de comando ou inclua a chamada REST no seu aplicativo.
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
A resposta do código de exemplo lista as contas do Google Analytics que o usuário ou a conta de serviço tem acesso para visualizar:
{
"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"
}
}