Введение в Google Analytics API: краткое руководство по PHP для веб-приложений

В этом руководстве описывается, как получить доступ к аккаунту Google Analytics, отправлять запросы в API этого сервиса, обрабатывать ответы и извлекать результаты обработки с применением Core Reporting API 3.0, Management API 3.0 и OAuth 2.0.

Шаг 1. Включите Google Analytics API

Перед началом работы с Google Analytics API используйте инструмент настройки, чтобы создать проект в Google API Console, включить API и зарегистрировать учетные данные.

Создайте идентификатор клиента

Откройте раздел "Учетные данные" и выполните следующие действия:

  1. Нажмите Создать учетные данные и выберите вариант Идентификатор клиента OAuth.
  2. В качестве типа приложения выберите веб-приложение.
  3. Введите название.
  4. Поле Разрешенные источники JavaScript оставьте пустым.
  5. В поле Разрешенные URI перенаправления введите http://localhost:8080/oauth2callback.php.
  6. Нажмите кнопку Создать.

Выберите созданные учетные данные и нажмите Скачать файл JSON. Сохраните файл как client_secrets.json. Он понадобится вам позже.

Шаг 2. Установите клиентскую библиотеку Google

Клиентскую библиотеку Google API для PHP можно скачать здесь или получить с помощью PHP-менеджера Composer:

composer require google/apiclient:^2.0

Шаг 3. Настройте пример

Вам нужно создать два файла:

  1. index.php – для главной страницы, которую посещает пользователь.
  2. oauth2callback.php – для обработки ответов OAuth 2.0.

index.php

Этот файл содержит основной код для запросов API Google Analytics и отображения результатов. Скопируйте или скачайте пример кода для index.php.

<?php
// Загрузка клиентской библиотеки PHP для Google API.
require_once __DIR__ . '/vendor/autoload.php';

// Запуск сеанса для сохранения учетных данных.
session_start();

// Создание объекта клиента и установка конфигурации авторизации
// из файла client_secretes.json, скачанного из Developers Console.
$client = new Google_Client();
$client->setAuthConfig(__DIR__ . '/client_secrets.json');
$client->addScope(Google_Service_Analytics::ANALYTICS_READONLY);

// Если пользователь уже авторизовал это приложение, предоставьте токен доступа.
// В противном случае перенаправьте пользователя на страницу авторизации доступа в Google Analytics.
if (isset($_SESSION['access_token']) && $_SESSION['access_token']) {
  // Установка токена доступа на клиентском компьютере.
  $client->setAccessToken($_SESSION['access_token']);

  // Создание авторизованного объекта службы аналитики.
  $analytics = new Google_Service_Analytics($client);

  // Получение первого идентификатора представления (профиля) для авторизованного пользователя.
  $profile = getFirstProfileId($analytics);

  // Получение и вывод результатов из Core Reporting API.
  $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) {
  // Получение идентификатора первого представления (профиля) пользователя.

  // Получение списка аккаунтов авторизованного пользователя.
  $accounts = $analytics->management_accounts->listManagementAccounts();

  if (count($accounts->getItems()) > 0) {
    $items = $accounts->getItems();
    $firstAccountId = $items[0]->getId();

    // Получение списка ресурсов авторизованного пользователя.
    $properties = $analytics->management_webproperties
        ->listManagementWebproperties($firstAccountId);

    if (count($properties->getItems()) > 0) {
      $items = $properties->getItems();
      $firstPropertyId = $items[0]->getId();

      // Получение списка представлений (профилей) авторизованного пользователя.
      $profiles = $analytics->management_profiles
          ->listManagementProfiles($firstAccountId, $firstPropertyId);

      if (count($profiles->getItems()) > 0) {
        $items = $profiles->getItems();

        // Возврат идентификатора первого представления (профиля).
        return $items[0]->getId();

      } else {
        throw new Exception('Для этого пользователя не найдены представления (профили).');
      }
    } else {
      throw new Exception('Для этого пользователя не найдены представления.');
    }
  } else {
    throw new Exception('Для этого пользователя не найдены аккаунты.');
  }
}

function getResults($analytics, $profileId) {
  // Вызов Core Reporting API и отправка запроса о количестве сессий
  // за последние семь дней.
  return $analytics->data_ga->get(
      'ga:' . $profileId,
      '7daysAgo',
      'today',
      'ga:sessions');
}

function printResults($results) {
  // Синтаксический анализ ответа Core Reporting API с выводом
  // имени профиля и общего количества сессий.
  if (count($results->getRows()) > 0) {

    // Получение имени профиля.
    $profileName = $results->getProfileInfo()->getProfileName();

    // Получение значения первой записи в первом ряду.
    $rows = $results->getRows();
    $sessions = $rows[0][0];

    // Вывод результатов.
    print "<p>First view (profile) found: $profileName</p>";
    print "<p>Total sessions: $sessions</p>";
  } else {
    print "<p>No results found.</p>";
  }
}

?>

oauth2callback.php

Этот файл обрабатывает ответ OAuth 2.0. Скопируйте или скачайте пример кода для oauth2callback.php.

<?php

// Загрузка клиентской библиотеки PHP для Google API.
require_once __DIR__ . '/vendor/autoload.php';

// Запуск сеанса для сохранения учетных данных.
session_start();

// Создание объекта клиента и установка конфигурации авторизации
// из файла client_secretes.json, скачанного из 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);

// Выполнение процесса авторизации с сервера.
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. Запустите пример

После того как вы включите Google Analytics API, установите клиентскую библиотеку Google API для PHP и настроите код примера, он будет готов к запуску.

Запустите пример на веб-сервере, который поддерживает PHP. Если вы используете PHP 5.4 или более позднюю версию, вам доступен встроенный тестовый веб-сервер. Просто введите команду:

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

Затем перейдите на страницу http://localhost:8080 в браузере.

После выполнения всех шагов будет выведено название первого профиля авторизованного пользователя в Google Analytics и количество сеансов за последние семь дней.

Имея авторизованный служебный объект Analytics, вы можете запустить любой из примеров кода, приведенных в справочных материалах по Management API. Например, можно попробовать изменить код, чтобы использовать метод accountSummaries.list.