Introduzione all'API Analytics: guida rapida a PHP per le applicazioni web

Questo tutorial illustra i passaggi necessari per accedere a un account Google Analytics, eseguire query sulle API Analytics, gestire le risposte dell'API e generare i risultati. In questo tutorial vengono utilizzati l'API di reporting principale 3.0, l'API di gestione v3.0 e l'OAuth2.0.

Nota: lo scopo di queste guide rapide è aiutarti a superare gli ostacoli iniziali dell'autorizzazione delle API con le librerie client delle API di Google. Poiché queste librerie sono in fase di sviluppo attivo, a volte potrebbero non essere sincronizzate con le librerie client più recenti. Se riscontri questo problema, consulta la documentazione della libreria client e, se necessario, consulta la documentazione di assistenza.

Passaggio 1: attiva l'API Analytics

Per iniziare a utilizzare l'API Google Analytics, devi prima utilizzare lo strumento di configurazione, che ti guida nella creazione di un progetto nella console API di Google, nell'abilitazione dell'API e nella creazione delle credenziali.

Per creare un ID client web o un client applicazione installata, devi impostare un nome di prodotto nella schermata di consenso. Se non lo hai già fatto, ti verrà chiesto di configurare la schermata per il consenso.

Creare un ID client

Dalla pagina Credenziali:

1. Fai clic su Crea credenziali e seleziona ID client OAuth.
2. Seleziona Applicazione web per TIPO DI APPLICAZIONE.
3. Assegna un nome alla credenziale.
4. Lascia vuoto il campo AUTHORIZED JAVASCRIPT ORIGINS, che non è necessario per questo tutorial.
5. Imposta gli URI AUTHORIZED REDIRECT su http://localhost:8080/oauth2callback.php
6. Fai clic su Crea.

Seleziona la credenziale appena creata e fai clic su Scarica JSON. Salva il file scaricato come client_secrets.json. Ti servirà più avanti nel tutorial.

Passaggio 2: installa la libreria client di Google

Puoi ottenere la libreria client delle API di Google per PHP scaricando la release o utilizzando Composer:

composer require google/apiclient:^2.0

Passaggio 3: configura l'esempio

Dovrai creare due file:

1. index.php sarà la pagina principale visitata dall'utente.
2. oauth2callback.php gestirà la risposta OAuth 2.0.

index.php

Questo file contiene la logica principale per eseguire query sulle API di Google Analytics e visualizzare i risultati. Copia o scarica il primo codice campione in index.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_secretes.json you downloaded from the developer console.
$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_Analytics($client);

  // Get the first view (profile) id for the authorized user.
  $profile = getFirstProfileId($analytics);

  // Get the results from the Core Reporting API and print the results.
  $results = getResults($analytics, $profile);
  printResults($results);
} else {
  $redirect_uri = 'http://' . $_SERVER['HTTP_HOST'] . '/oauth2callback.php';
  header('Location: ' . filter_var($redirect_uri, FILTER_SANITIZE_URL));
}


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 "<p>First view (profile) found: $profileName</p>";
    print "<p>Total sessions: $sessions</p>";
  } else {
    print "<p>No results found.</p>";
  }
}

?>

oauth2callback.php

Questo file gestisce la risposta OAuth 2.0. Copia o scarica il secondo codice campione in 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));
}

Passaggio 4: esegui l'esempio

Dopo aver abilitato l'API Analytics, installato la libreria client delle API di Google per PHP e configurato il codice sorgente di esempio, quest'ultimo è pronto per essere eseguito.

Esegui l'esempio con un server web configurato per pubblicare PHP. Se utilizzi PHP 5.4 o versioni successive, puoi utilizzare il server web di test integrato di PHP eseguendo il seguente comando:

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

Quindi visita l'indirizzo http://localhost:8080 nel browser.

Al termine di questi passaggi, l'esempio restituisce il nome della prima vista (profilo) Google Analytics dell'utente autorizzato e il numero di sessioni negli ultimi sette giorni.

Nota: per eseguire correttamente questo esempio, devi avere almeno una proprietà e una vista (profilo) Google Analytics.

Con l'oggetto di servizio Analytics autorizzato ora puoi eseguire qualsiasi esempio di codice trovato nei documenti di riferimento dell'API Management. Ad esempio, potresti provare a modificare il codice per utilizzare il metodo accountSummaries.list.