Hello Analytics API: krótkie wprowadzenie do aplikacji internetowych PHP

W tym samouczku omawiamy czynności wymagane do uzyskania dostępu do konta Google Analytics, wysyłania zapytań do interfejsów API Analytics, obsługiwania odpowiedzi interfejsu API i zwracania wyników. W tym samouczku używane są Core Reporting API w wersji 3.0, Management API w wersji 3.0 oraz OAuth2.0.

Krok 1. Włącz Analytics API

Aby zacząć korzystać z interfejsu Google Analytics API, musisz najpierw użyć narzędzia do konfiguracji, które przeprowadzi Cię przez proces tworzenia projektu w Konsoli interfejsów API Google, włączania interfejsu API i tworzenia danych logowania.

Utwórz identyfikator klienta

Na stronie Dane logowania:

  1. Kliknij Utwórz dane logowania i wybierz Identyfikator klienta OAuth.
  2. Jako TYP APLIKACJI wybierz Aplikacja internetowa.
  3. Nazwij dane logowania.
  4. Pozostaw pole AUTHORIZED JAVASCRIPT ORIGINS puste. Nie jest to potrzebne w tym samouczku.
  5. Ustaw AUTHORIZED REDIRECT URIS (AUTORYZOWANE identyfikatory URI REDIRECT) na http://localhost:8080/oauth2callback.php
  6. Kliknij Utwórz.

Wybierz nowo utworzone dane logowania i kliknij Pobierz JSON. Zapisz pobrany plik jako client_secrets.json. Będzie on potrzebny w dalszej części samouczka.

Krok 2. Zainstaluj bibliotekę klienta Google

Możesz pobrać bibliotekę klienta interfejsów API Google dla języka PHP, pobierając daną wersję lub korzystając z usługi Composer:

composer require google/apiclient:^2.0

Krok 3. Skonfiguruj przykład

Musisz utworzyć 2 pliki:

  1. index.php będzie stroną główną odwiedzaną przez użytkownika.
  2. oauth2callback.php będzie obsługiwać odpowiedź OAuth 2.0.

index.php

Ten plik zawiera główną logikę wysyłania zapytań do interfejsów Google Analytics API i wyświetlania wyników. Skopiuj lub pobierz pierwszy przykładowy kod do usługi 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

Ten plik obsługuje odpowiedź OAuth 2.0. Skopiuj lub pobierz drugi przykładowy kod do usługi 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));
}


Krok 4. Uruchom próbkę

Po włączeniu interfejsu Analytics API, zainstalowaniu biblioteki klienta interfejsów API Google dla języka PHP i skonfigurowaniu przykładowego kodu źródłowego, który jest gotowy do uruchomienia, można już zacząć działać.

Uruchom przykład na serwerze WWW skonfigurowanym do obsługi języka PHP. Jeśli korzystasz z języka PHP w wersji 5.4 lub nowszej, możesz użyć wbudowanego testowego serwera WWW PHP, wykonując to polecenie:

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

Następnie otwórz w przeglądarce stronę http://localhost:8080.

Po wykonaniu tych czynności w przykładzie pojawi się nazwa pierwszego widoku Google Analytics (profilu) autoryzowanego użytkownika oraz liczba sesji w ciągu ostatnich 7 dni.

Za pomocą autoryzowanego obiektu usługi Analytics możesz teraz uruchamiać dowolny przykładowy kod, który znajdziesz w dokumentacji referencyjnej interfejsu Management API. Możesz na przykład zmienić kod i użyć metody accountSummaries.list.