Apresentação da Reporting API v4 do Google Analytics: início rápido de PHP para aplicativos da Web

Este tutorial apresenta as etapas necessárias para acessar a Reporting API v4 do Google Analytics.

1. Ative a API

Para começar a usar a API de relatórios v4 do Google Analytics, primeiro é necessário usar a ferramenta de configuração, que orienta você na criação de um projeto no Console de APIs do Google, na ativação da API e na criação de credenciais.

Observação: para criar um Client-ID da Web ou um cliente de aplicativo instalado, é necessário definir um nome de produto na tela de consentimento. Você receberá uma solicitação para configurar a tela de consentimento, se ainda não o tiver feito.

Criar credenciais

  • Abra a página Credenciais.
  • Clique em Criar credenciais e selecione OAuth Client-ID
  • Em Tipo de aplicativo, selecione Aplicativo da Web.
  • Atribua um nome ao início rápido do Client-ID e clique em Criar.
  • Deixe as Origens de JavaScript autorizadas em branco. Elas não são necessárias neste tutorial.
  • Defina os URIs de redirecionamento autorizados como http://localhost:8080/oauth2callback.php.
  • Clique em Criar.

Na página Credenciais, clique no ID do cliente recém-criado. Em seguida, clique em Fazer o download do JSON e salve o arquivo como client_secrets.json. Você precisará dele mais adiante no tutorial.

2. Instale a biblioteca cliente

Acesse a biblioteca cliente das APIs do Google para PHP usando o Composer:

composer require google/apiclient:^2.0

3. Configure a amostra

Você precisa criar dois arquivos:

  • index.php será a página principal visitada pelo usuário.
  • oauth2callback.php cuidará da resposta do OAuth 2.0.

index.php

Este arquivo contém a principal lógica para consultar as Google Analytics APIs e exibir os resultados.

  • Copie ou faça o download do primeiro código de exemplo para index.php.
  • Substitua o valor de VIEW_ID. Você pode usar o Explorador da conta para encontrar o ID de uma vista.
<?php

// Load the Google API PHP Client Library.
require_once __DIR__ . '/vendor/autoload.php';

session_start();

$client = new Google_Client();
$client->setAuthConfig(__DIR__ . '/client_secrets.json');
$client->addScope(Google_Service_Analytics::ANALYTICS_READONLY);

// If the user has already authorized this app then get an access token
// else redirect to ask the user to authorize access to Google Analytics.
if (isset($_SESSION['access_token']) && $_SESSION['access_token']) {
  // Set the access token on the client.
  $client->setAccessToken($_SESSION['access_token']);

  // Create an authorized analytics service object.
  $analytics = new Google_Service_AnalyticsReporting($client);

  // Call the Analytics Reporting API V4.
  $response = getReport($analytics);

  // Print the response.
  printResults($response);

} else {
  $redirect_uri = 'http://' . $_SERVER['HTTP_HOST'] . '/oauth2callback.php';
  header('Location: ' . filter_var($redirect_uri, FILTER_SANITIZE_URL));
}

/**
 * Queries the Analytics Reporting API V4.
 *
 * @param service An authorized Analytics Reporting API V4 service object.
 * @return The Analytics Reporting API V4 response.
 */
function getReport($analytics) {

  // Replace with your view ID, for example XXXX.
  $VIEW_ID = "<REPLACE_WITH_VIEW_ID>";

  // Create the DateRange object.
  $dateRange = new Google_Service_AnalyticsReporting_DateRange();
  $dateRange->setStartDate("7daysAgo");
  $dateRange->setEndDate("today");

  // Create the Metrics object.
  $sessions = new Google_Service_AnalyticsReporting_Metric();
  $sessions->setExpression("ga:sessions");
  $sessions->setAlias("sessions");

  // Create the ReportRequest object.
  $request = new Google_Service_AnalyticsReporting_ReportRequest();
  $request->setViewId($VIEW_ID);
  $request->setDateRanges($dateRange);
  $request->setMetrics(array($sessions));

  $body = new Google_Service_AnalyticsReporting_GetReportsRequest();
  $body->setReportRequests( array( $request) );
  return $analytics->reports->batchGet( $body );
}

/**
 * Parses and prints the Analytics Reporting API V4 response.
 *
 * @param An Analytics Reporting API V4 response.
 */
function printResults($reports) {
  for ( $reportIndex = 0; $reportIndex < count( $reports ); $reportIndex++ ) {
    $report = $reports[ $reportIndex ];
    $header = $report->getColumnHeader();
    $dimensionHeaders = $header->getDimensions();
    $metricHeaders = $header->getMetricHeader()->getMetricHeaderEntries();
    $rows = $report->getData()->getRows();

    for ( $rowIndex = 0; $rowIndex < count($rows); $rowIndex++) {
      $row = $rows[ $rowIndex ];
      $dimensions = $row->getDimensions();
      $metrics = $row->getMetrics();
      for ($i = 0; $i < count($dimensionHeaders) && $i < count($dimensions); $i++) {
        print($dimensionHeaders[$i] . ": " . $dimensions[$i] . "\n");
      }

      for ($j = 0; $j < count($metrics); $j++) {
        $values = $metrics[$j]->getValues();
        for ($k = 0; $k < count($values); $k++) {
          $entry = $metricHeaders[$k];
          print($entry->getName() . ": " . $values[$k] . "\n");
        }
      }
    }
  }
}

oauth2callback.php

Este arquivo cuida da resposta do OAuth 2.0. Copie ou faça o download do segundo código de exemplo para oauth2callback.php.

<?php

// Load the Google API PHP Client Library.
require_once __DIR__ . '/vendor/autoload.php';

// Start a session to persist credentials.
session_start();

// Create the client object and set the authorization configuration
// from the client_secrets.json you downloaded from the Developers Console.
$client = new Google_Client();
$client->setAuthConfig(__DIR__ . '/client_secrets.json');
$client->setRedirectUri('http://' . $_SERVER['HTTP_HOST'] . '/oauth2callback.php');
$client->addScope(Google_Service_Analytics::ANALYTICS_READONLY);

// Handle authorization flow from the server.
if (! isset($_GET['code'])) {
  $auth_url = $client->createAuthUrl();
  header('Location: ' . filter_var($auth_url, FILTER_SANITIZE_URL));
} else {
  $client->authenticate($_GET['code']);
  $_SESSION['access_token'] = $client->getAccessToken();
  $redirect_uri = 'http://' . $_SERVER['HTTP_HOST'] . '/';
  header('Location: ' . filter_var($redirect_uri, FILTER_SANITIZE_URL));
}

4. Execute a amostra

Execute a amostra com um servidor da Web configurado para veicular PHP. Se você usa o PHP 5.4 ou mais recente, utilize o servidor de testes da Web incorporado executando o seguinte comando:

php -S localhost:8080 -t /path/to/sample

Em seguida, acesse http://localhost:8080 no seu navegador.

Quando você concluir essas etapas, a amostra gerará o número de sessões dos últimos sete dias para a vista específica.