Este tutorial mostra as etapas necessárias para acessar uma conta do Google Analytics, consultar as APIs do Google Analytics, lidar com as respostas da API e gerar os resultados. A API de relatórios principais v3.0, a API de gerenciamento v3.0 e o OAuth2.0 são usados neste tutorial.
Etapa 1: ativar a Google Analytics API
Para começar a usar a Google Analytics API, primeiro use a ferramenta de configuração, que fornece orientações para você criar um projeto no console de APIs do Google, ativar a API e criar credenciais.
Criar um ID de cliente
- Abra a página Contas de serviço. Se solicitado, selecione um projeto.
- Clique em Criar conta de serviço.
- Na janela Criar conta de serviço, digite um nome para a conta de serviço e selecione Fornecer uma nova chave privada. Se você quiser conceder autoridade em todo o domínio do Google Workspace à conta de serviço, selecione também Habilitar a delegação em todo o domínio Google Workspace. Em seguida, clique em Salvar.
Seu novo par de chave pública/privada é gerado, e o download dele é feito na sua máquina. Essa é a única cópia da chave. Você é responsável por guardá-la com segurança.
Adicionar conta de serviço à conta do Google Analytics
A conta de serviço recém-criada terá um endereço de e-mail, <projectId>-<uniqueId>@developer.gserviceaccount.com
. Use-o para adicionar um usuário à conta do Google Analytics que você deseja acessar por meio da API. Apenas para este tutorial, são necessárias permissões de leitura e análise.
Etapa 2: instalar a biblioteca cliente do Google
Para ver a biblioteca de cliente das APIs do Google para PHP, faça o download da versão ou use o Composer (em inglês):
composer require google/apiclient:^2.0
Etapa 3: configurar a amostra
Você precisa criar um único arquivo chamado HelloAnalytics.php
, que conterá o código de amostra abaixo.
- Copie ou faça o download do código-fonte a seguir para
HelloAnalytics.php
. - Mova o
service-account-credentials.json
recebido anteriormente no mesmo diretório que o código de amostra.
HelloAnalytics.php
<?php // Load the Google API PHP Client Library. require_once __DIR__ . '/vendor/autoload.php'; $analytics = initializeAnalytics(); $profile = getFirstProfileId($analytics); $results = getResults($analytics, $profile); printResults($results); function initializeAnalytics() { // Creates and returns the Analytics Reporting service object. // Use the developers console and download your service account // credentials in JSON format. Place them in this directory or // change the key file location if necessary. $KEY_FILE_LOCATION = __DIR__ . '/service-account-credentials.json'; // Create and configure a new client object. $client = new Google_Client(); $client->setApplicationName("Hello Analytics Reporting"); $client->setAuthConfig($KEY_FILE_LOCATION); $client->setScopes(['https://www.googleapis.com/auth/analytics.readonly']); $analytics = new Google_Service_Analytics($client); return $analytics; } function getFirstProfileId($analytics) { // Get the user's first view (profile) ID. // Get the list of accounts for the authorized user. $accounts = $analytics->management_accounts->listManagementAccounts(); if (count($accounts->getItems()) > 0) { $items = $accounts->getItems(); $firstAccountId = $items[0]->getId(); // Get the list of properties for the authorized user. $properties = $analytics->management_webproperties ->listManagementWebproperties($firstAccountId); if (count($properties->getItems()) > 0) { $items = $properties->getItems(); $firstPropertyId = $items[0]->getId(); // Get the list of views (profiles) for the authorized user. $profiles = $analytics->management_profiles ->listManagementProfiles($firstAccountId, $firstPropertyId); if (count($profiles->getItems()) > 0) { $items = $profiles->getItems(); // Return the first view (profile) ID. return $items[0]->getId(); } else { throw new Exception('No views (profiles) found for this user.'); } } else { throw new Exception('No properties found for this user.'); } } else { throw new Exception('No accounts found for this user.'); } } function getResults($analytics, $profileId) { // Calls the Core Reporting API and queries for the number of sessions // for the last seven days. return $analytics->data_ga->get( 'ga:' . $profileId, '7daysAgo', 'today', 'ga:sessions'); } function printResults($results) { // Parses the response from the Core Reporting API and prints // the profile name and total sessions. if (count($results->getRows()) > 0) { // Get the profile name. $profileName = $results->getProfileInfo()->getProfileName(); // Get the entry for the first entry in the first row. $rows = $results->getRows(); $sessions = $rows[0][0]; // Print the results. print "First view (profile) found: $profileName\n"; print "Total sessions: $sessions\n"; } else { print "No results found.\n"; } }
Etapa 4: executar a amostra
Depois que você ativar a API Google Analytics, instalar a biblioteca de cliente das APIs do Google para PHP e configurar o código-fonte da amostra, ela estará pronta para ser executada.
Execute a amostra usando:
php HelloAnalytics.php
Quando você concluir essas etapas, a amostra gerará o nome da primeira vista (perfil) do Google Analytics do usuário autorizado, além do número de sessões dos últimos sete dias.
Com o objeto de serviço autorizado do Google Analytics, agora você pode executar qualquer uma das amostras de código nos documentos de referência da API de gerenciamento. Por exemplo, tente alterar o código para usar o método accountSummaries.list.