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

Из этой статьи вы узнаете, как выполнить авторизацию в Analytics Reporting API версии 4.

1. Включите API

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

Примечание. Чтобы создать идентификатор веб-клиента или клиента установленного приложения, нужно указать название продукта на экране подтверждения. Если вы ещё не указали название, вам будет предложено сделать это в настройках.

Создание учетных данных

  • Откройте страницу Учетные данные.
  • Нажмите Создать учетные данные и выберите вариант Идентификатор клиента OAuth.
  • В разделе Тип приложения выберите вариант Веб-приложение.
  • Введите название quickstart и нажмите Создать.
  • Поле Разрешенные источники JavaScript оставьте пустым.
  • В поле Разрешенные URI перенаправления введите http://localhost:8080/oauth2callback.php.
  • Нажмите кнопку Создать.

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

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

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

composer require google/apiclient:^2.0

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

Создайте два файла:

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

index.php

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

  • Скопируйте или скачайте пример кода для index.php.
  • Измените значение VIEW_ID. Чтобы найти этот параметр, воспользуйтесь инструментом Account Explorer.
<?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

Этот файл обрабатывает ответ OAuth 2.0. Скопируйте или скачайте пример кода для 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. Запустите пример

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

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

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

Когда вы выполните все шаги, на экране появится количество сеансов в выбранном представлении за последние семь дней.