Введение в Google Analytics Reporting API версии 4: краткое руководство по PHP для сервисных аккаунтов

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

1. Включите API

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

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

  1. Откройте страницу Сервисные аккаунты. При необходимости выберите проект.
  2. Нажмите Создать сервисный аккаунт.
  3. Укажите название аккаунта и выберите Создать новый закрытый ключ. Затем нажмите кнопку Сохранить.

Система создаст новую пару ключей (открытый и закрытый), которая будет сохранена на ваш компьютер. Эта копия является единственной, и вы должны самостоятельно обеспечивать ее сохранность.

Добавьте в Google Аналитику сервисный аккаунт

У нового сервисного аккаунта будет адрес электронной почты такого типа:

quickstart@PROJECT-ID.iam.gserviceaccount.com

Используйте этот адрес, чтобы добавить пользователя в представление Google Аналитики, к которому вам нужен доступ через API. Для выполнения задач, описанных в этом руководстве, потребуется только разрешение на чтение и анализ.

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

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

composer require google/apiclient:^2.0

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

Вам нужно создать файл HelloAnalytics.php с кодом этого примера.

  • Скопируйте или скачайте исходный код ниже, а затем добавьте его в файл HelloAnalytics.php.
  • Перенесите загруженный ключ service-account-credentials.json в тот каталог, где находится код примера.
  • Измените значение VIEW_ID. Чтобы найти этот параметр, воспользуйтесь инструментом Account Explorer.

HelloAnalytics.php

<?php

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

$analytics = initializeAnalytics();
$response = getReport($analytics);
printResults($response);

/**
 * Initializes an Analytics Reporting API V4 service object.
 *
 * @return An authorized Analytics Reporting API V4 service object.
 */
function initializeAnalytics()
{

  // Use the developers console and download your service account
  // credentials in JSON format. Place them in this directory or
  // change the key file location if necessary.
  $KEY_FILE_LOCATION = __DIR__ . '/service-account-credentials.json';

  // Create and configure a new client object.
  $client = new Google_Client();
  $client->setApplicationName("Hello Analytics Reporting");
  $client->setAuthConfig($KEY_FILE_LOCATION);
  $client->setScopes(['https://www.googleapis.com/auth/analytics.readonly']);
  $analytics = new Google_Service_AnalyticsReporting($client);

  return $analytics;
}

/**
 * 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");
        }
      }
    }
  }
}

4. Запустите пример

Запустите пример, используя следующий код:

php HelloAnalytics.php

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