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

Из этой статьи вы узнаете, как настроить авторизацию в 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. Установите клиентскую библиотеку

Чтобы установить клиент Java для Google Analytics API, скачайте ZIP-файл со всеми необходимыми файлами JAR. Их нужно извлечь и скопировать в путь к классу Java.

  1. Скачайте клиентскую библиотеку Java для Analytics Reporting API версии 4. Она упакована в ZIP-файл вместе со всеми необходимыми зависимыми компонентами.
  2. Распакуйте ZIP-файл.
  3. Добавьте все файлы JAR из каталога libs в путь к классу Java.
  4. Добавьте файл google-api-services-analyticsreporting-v4-[version].jar в путь к классу.

Средства разработки на Java

Eclipse

Если вы используете Eclipse, узнайте, как добавлять файлы JAR в путь к классу, на форуме StackOverflow.

NetBeans

Пользователи NetBeans могут найти аналогичную информацию здесь.

IntelliJ IDEA

Пользователям IntelliJ IDEA рекомендуем ознакомиться с этой инструкцией.

Командная строка

Если вы используете командную строку, добавьте в командные вызовы javac и java следующий фрагмент:

-classpath /path/to/directory/with/unzipped/jars

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

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

  • Скопируйте или скачайте приведенный ниже исходный код для HelloAnalyticsReporting.java.
  • Переместите загруженный файл client_secrets.json в каталог с исходным кодом.
  • Замените значения KEY_FILE_LOCATION значениями из Developer Console.
  • Замените значение VIEW_ID идентификатором представления, к которому нужно получить доступ.
import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.JsonFactory;
import com.google.api.client.json.gson.GsonFactory;

import java.io.FileInputStream;
import java.io.IOException;
import java.security.GeneralSecurityException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import com.google.api.services.analyticsreporting.v4.AnalyticsReportingScopes;
import com.google.api.services.analyticsreporting.v4.AnalyticsReporting;

import com.google.api.services.analyticsreporting.v4.model.ColumnHeader;
import com.google.api.services.analyticsreporting.v4.model.DateRange;
import com.google.api.services.analyticsreporting.v4.model.DateRangeValues;
import com.google.api.services.analyticsreporting.v4.model.GetReportsRequest;
import com.google.api.services.analyticsreporting.v4.model.GetReportsResponse;
import com.google.api.services.analyticsreporting.v4.model.Metric;
import com.google.api.services.analyticsreporting.v4.model.Dimension;
import com.google.api.services.analyticsreporting.v4.model.MetricHeaderEntry;
import com.google.api.services.analyticsreporting.v4.model.Report;
import com.google.api.services.analyticsreporting.v4.model.ReportRequest;
import com.google.api.services.analyticsreporting.v4.model.ReportRow;

public class HelloAnalyticsReporting {
  private static final String APPLICATION_NAME = "Hello Analytics Reporting";
  private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance();
  private static final String KEY_FILE_LOCATION = "<REPLACE_WITH_JSON_FILE>";
  private static final String VIEW_ID = "<REPLACE_WITH_VIEW_ID>";
  public static void main(String[] args) {
    try {
      AnalyticsReporting service = initializeAnalyticsReporting();

      GetReportsResponse response = getReport(service);
      printResponse(response);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }

  /**
   * Initializes an Analytics Reporting API V4 service object.
   *
   * @return An authorized Analytics Reporting API V4 service object.
   * @throws IOException
   * @throws GeneralSecurityException
   */
  private static AnalyticsReporting initializeAnalyticsReporting() throws GeneralSecurityException, IOException {

    HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
    GoogleCredential credential = GoogleCredential
        .fromStream(new FileInputStream(KEY_FILE_LOCATION))
        .createScoped(AnalyticsReportingScopes.all());

    // Construct the Analytics Reporting service object.
    return new AnalyticsReporting.Builder(httpTransport, JSON_FACTORY, credential)
        .setApplicationName(APPLICATION_NAME).build();
  }

  /**
   * Queries the Analytics Reporting API V4.
   *
   * @param service An authorized Analytics Reporting API V4 service object.
   * @return GetReportResponse The Analytics Reporting API V4 response.
   * @throws IOException
   */
  private static GetReportsResponse getReport(AnalyticsReporting service) throws IOException {
    // Create the DateRange object.
    DateRange dateRange = new DateRange();
    dateRange.setStartDate("7DaysAgo");
    dateRange.setEndDate("today");

    // Create the Metrics object.
    Metric sessions = new Metric()
        .setExpression("ga:sessions")
        .setAlias("sessions");

    Dimension pageTitle = new Dimension().setName("ga:pageTitle");

    // Create the ReportRequest object.
    ReportRequest request = new ReportRequest()
        .setViewId(VIEW_ID)
        .setDateRanges(Arrays.asList(dateRange))
        .setMetrics(Arrays.asList(sessions))
        .setDimensions(Arrays.asList(pageTitle));

    ArrayList<ReportRequest> requests = new ArrayList<ReportRequest>();
    requests.add(request);

    // Create the GetReportsRequest object.
    GetReportsRequest getReport = new GetReportsRequest()
        .setReportRequests(requests);

    // Call the batchGet method.
    GetReportsResponse response = service.reports().batchGet(getReport).execute();

    // Return the response.
    return response;
  }

  /**
   * Parses and prints the Analytics Reporting API V4 response.
   *
   * @param response An Analytics Reporting API V4 response.
   */
  private static void printResponse(GetReportsResponse response) {

    for (Report report: response.getReports()) {
      ColumnHeader header = report.getColumnHeader();
      List<String> dimensionHeaders = header.getDimensions();
      List<MetricHeaderEntry> metricHeaders = header.getMetricHeader().getMetricHeaderEntries();
      List<ReportRow> rows = report.getData().getRows();

      if (rows == null) {
         System.out.println("No data found for " + VIEW_ID);
         return;
      }

      for (ReportRow row: rows) {
        List<String> dimensions = row.getDimensions();
        List<DateRangeValues> metrics = row.getMetrics();

        for (int i = 0; i < dimensionHeaders.size() && i < dimensions.size(); i++) {
          System.out.println(dimensionHeaders.get(i) + ": " + dimensions.get(i));
       	}

        for (int j = 0; j < metrics.size(); j++) {
          System.out.print("Date Range (" + j + "): ");
          DateRangeValues values = metrics.get(j);
          for (int k = 0; k < values.getValues().size() && k < metricHeaders.size(); k++) {
            System.out.println(metricHeaders.get(k).getName() + ": " + values.getValues().get(k));
          }
        }
      }
    }
  }
}

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

Если вы используете IDE, убедитесь, что цель запуска по умолчанию определена классом HelloAnalytics. В противном случае вы можете составить и запустить приложение из командной строки.

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

    javac -classpath '/path/to/analyticsreporting/*:/path/to/analyticsreporting/libs/*' HelloAnalyticsReporting.java
    
  • Запустите пример, используя следующий код:

    java -classpath '.:/path/to/analyticsreporting/*:/path/to/analyticsreporting/libs/*' HelloAnalyticsReporting
    

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