API отчетов Hello Analytics v4; Краткое руководство по PHP для сервисных аккаунтов

В этом руководстве описаны шаги, необходимые для доступа к Analytics Reporting API версии 4.

1. Включите API

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

Создать учетные данные

1. Откройте страницу сервисных аккаунтов . При появлении запроса выберите проект.
2. Нажмите « add » « Создать учетную запись службы» и введите имя и описание учетной записи службы. Вы можете использовать идентификатор сервисной учетной записи по умолчанию или выбрать другой уникальный идентификатор. Когда закончите, нажмите «Создать» .
3. Следующий раздел разрешений учетной записи службы (необязательно) не требуется. Нажмите Продолжить .
4. На экране « Предоставить пользователям доступ к этой учетной записи службы » прокрутите вниз до раздела « Создать ключ ». Нажмите add Создать ключ .
5. На появившейся боковой панели выберите формат ключа: рекомендуется JSON .
6. Щелкните Создать . Ваша новая пара открытый/закрытый ключ будет сгенерирована и загружена на ваш компьютер; он служит единственной копией этого ключа. Сведения о безопасном хранении см. в разделе Управление ключами сервисных учетных записей .
7. Нажмите « Закрыть » в диалоговом окне « Закрытый ключ, сохраненный на вашем компьютере », затем нажмите « Готово », чтобы вернуться к таблице учетных записей служб.

Добавьте учетную запись службы в учетную запись Google Analytics.

Вновь созданная учетная запись службы будет иметь адрес электронной почты, похожий на:

quickstart@PROJECT-ID.iam.gserviceaccount.com

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

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

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

composer require google/apiclient:^2.0

3. Настройте образец

Вам нужно будет создать один файл с именем HelloAnalytics.php , который будет содержать приведенный ниже пример кода.

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

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

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