Apresentação da API Google Analytics: guia de início rápido de PHP para contas de serviço

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 Core Reporting v3.0, a API Management v3.0 e o OAuth2.0 são usados neste tutorial.

Observação:o objetivo desses guias de início rápido é ajudar você a superar as dificuldades iniciais da autorização da API com as bibliotecas de cliente das APIs do Google. Como essas bibliotecas estão em constante desenvolvimento, é possível que esses guias não estejam em sincronia com as bibliotecas de cliente mais recentes. Se você se deparar com esse problema, consulte a documentação da biblioteca de cliente e, se necessário, consulte a documentação de ajuda.

Etapa 1: ativar a API Google Analytics

Para começar a usar a API Google Analytics, 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

1. Abra a página Contas de serviço. Se solicitado, selecione um projeto.
2. Clique em Criar conta de serviço, digite um nome e uma descrição para a conta correspondente. Você pode usar o ID da conta de serviço padrão ou escolher um código diferente e único. Quando terminar, clique em Criar.
3. A seção seguinte ,Permissões da conta de serviço (opcional), não é necessária. Clique em Continuar.
4. Em Conceda aos usuários acesso a essa conta de serviço, role a tela para baixo até a seção Criar chave. Clique em Criar chave.
5. No painel lateral exibido, selecione o formato da sua chave: JSON é a opção recomendada.
6. Clique em Criar. Seu novo par de chave pública/privada é gerado, e o download é feito na sua máquina. Essa é a única cópia da chave. Para saber mais sobre como armazenar com segurança, consulte Como gerenciar chaves de contas de serviço.
7. Clique em Fechar na caixa de diálogo Chave privada salva no seu computador e clique em Concluir para retornar à tabela das suas contas de serviço.

Quando o Tipo de chave for solicitado, selecione JSON e salve a chave gerada como service-account-credentials.json. Você precisará dela posteriormente no tutorial.

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 esse endereço de e-mail para adicionar um usuário à conta do Google Analytics que você quer acessar pela API. Neste tutorial, são necessárias apenas permissões de leitura e análise.

Etapa 2: Instalar a biblioteca de cliente do Google

Acesse a biblioteca de cliente das APIs do Google para PHP fazendo o download da versão ou usando o Composer:

composer require google/apiclient:^2.0

Etapa 3: configurar a amostra

Você precisará criar um único arquivo chamado HelloAnalytics.php, que conterá o exemplo de código abaixo.

1. Copie ou faça o download do código-fonte a seguir para HelloAnalytics.php.
2. Mova o service-account-credentials.json salvo anteriormente para o mesmo diretório que o exemplo de código.

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.

Observação: para executar essa amostra, você precisa ter pelo menos uma propriedade e uma vista da propriedade (perfil) do Google Analytics.

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 Management. Por exemplo, tente alterar o código para usar o método accountSummaries.list.