Hello Analytics API: Java-Kurzanleitung für Dienstkonten

In dieser Anleitung werden die Schritte beschrieben, die erforderlich sind, um auf ein Google Analytics-Konto zuzugreifen, die Analytics APIs abzufragen, die API-Antworten zu verarbeiten und die Ergebnisse auszugeben. In dieser Anleitung werden die Core Reporting API v3.0, die Management API v3.0 und OAuth 2.0 verwendet.

Hinweis: Diese Kurzanleitungen sollen Ihnen die ersten Hürden bei der API-Autorisierung mit den Google API-Clientbibliotheken erleichtern. Da sich diese Bibliotheken in der aktiven Entwicklung befinden, können diese Leitfäden gelegentlich nicht mit den neuesten Clientbibliotheken synchron sein. Falls dieses Problem auftritt, lesen Sie die Dokumentation der Clientbibliothek und gegebenenfalls die Hilfedokumentation.

Schritt 1: Analytics API aktivieren

Für den Einstieg in die Google Analytics API müssen Sie zuerst das Einrichtungstool verwenden. Es führt Sie durch die Erstellung eines Projekts in der Google API Console sowie durch die Aktivierung der API und die Erstellung von Anmeldedaten.

Client-ID erstellen

1. Öffne die Seite Dienstkonten. Wähle ein Projekt aus, wenn du dazu aufgefordert wirst.
2. Klicke auf Dienstkonto erstellen und gib einen Namen und eine Beschreibung für das Dienstkonto ein. Du kannst die standardmäßige Dienstkonto-ID verwenden oder eine andere eindeutige ID auswählen. Wenn du fertig bist, klicke auf Erstellen.
3. Für den folgenden Abschnitt Dienstkontoberechtigungen (optional) sind keine Maßnahmen erforderlich. Klicke auf Weiter.
4. Scrolle auf dem Bildschirm Nutzern Zugriff auf dieses Dienstkonto erteilen nach unten zum Abschnitt Schlüssel erstellen. Klicke auf Schlüssel erstellen.
5. Wähle in der angezeigten Seitenleiste das Format für deinen Schlüssel aus. Empfohlen wird JSON.
6. Klicken Sie auf Erstellen. Dein neues öffentliches/privates Schlüsselpaar wird generiert und auf deinen Computer heruntergeladen. Dies ist die einzige Kopie dieses Schlüssels. Informationen dazu, wie du den Schlüssel sicher speicherst, findest du unter Dienstkontoschlüssel verwalten.
7. Klicke im Dialogfeld Privater Schlüssel auf deinem Computer gespeichert auf Schließen und dann auf Fertig, um zur Tabelle deiner Dienstkonten zurückzukehren.

Wenn Sie zur Eingabe des Schlüsseltyps aufgefordert werden, wählen Sie JSON aus und speichern Sie den generierten Schlüssel als client_secrets.json. Sie benötigen ihn später in der Anleitung.

Dienstkonto zum Google Analytics-Konto hinzufügen

Das neu erstellte Dienstkonto hat die E-Mail-Adresse <projectId>-<uniqueId>@developer.gserviceaccount.com. Verwenden Sie diese E-Mail-Adresse, um dem Google Analytics-Konto, auf das Sie über die API zugreifen möchten, einen Nutzer hinzuzufügen. Für diese Anleitung sind nur die Berechtigungen Lesen und Analysieren erforderlich.

Schritt 2: Google-Clientbibliothek installieren

Um den Google Analytics API-Java-Client zu installieren, müssen Sie eine ZIP-Datei mit allen JAR-Dateien herunterladen, die Sie extrahieren und in Ihren Java-Klassenpfad kopieren müssen.

1. Laden Sie die Google Analytics-Java-Clientbibliothek herunter, die als ZIP-Datei mit allen erforderlichen Abhängigkeiten gebündelt ist.
2. Extrahieren Sie die ZIP-Datei.
3. Fügen Sie alle JARs im Verzeichnis libs Ihrem Klassenpfad hinzu.
4. Fügen Sie die JAR-Datei google-api-services-analytics-v3-[version].jar in Ihren Klassenpfad ein.

Weitere Informationen zu den Details der Java-Umgebung.

Details zur Java-Umgebung

Wenn Sie Eclipse verwenden, finden Sie hier eine Anleitung zum Hinzufügen von JARs zum Klassenpfad Ihres Projekts.

Wenn Sie NetBeans verwenden, finden Sie hier eine Anleitung zum Hinzufügen von JARs zum Klassenpfad Ihres Projekts.

Wenn Sie IntelliJ IDEA verwenden, finden Sie hier eine Anleitung zum Hinzufügen von JARs zum Klassenpfad Ihres Projekts.

Wenn Sie die Entwicklung über die Befehlszeile ausführen, fügen Sie den javac- und java-Befehlsaufrufen -classpath /path/to/directory/with/unzipped/jars hinzu.

Hinweis: Je nach Java-Laufzeitumgebung müssen Sie möglicherweise auch die Datei javax.Servlet.jar herunterladen und dem Klassenpfad Ihres Projekts hinzufügen.

Schritt 3: Beispiel einrichten

Sie müssen eine einzelne Datei mit dem Namen HelloAnalytics.java erstellen, die den angegebenen Beispielcode enthält.

1. Kopieren oder laden Sie den folgenden Quellcode in HelloAnalytics.java herunter.
2. Verschieben Sie die zuvor heruntergeladene client_secrets.JSON in dasselbe Verzeichnis wie den Beispielcode.
3. Ersetzen Sie die Werte von KEY_FILE_LOCATION durch die entsprechenden Werte aus der Developer Console.

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 com.google.api.services.analytics.Analytics;
import com.google.api.services.analytics.AnalyticsScopes;
import com.google.api.services.analytics.model.Accounts;
import com.google.api.services.analytics.model.GaData;
import com.google.api.services.analytics.model.Profiles;
import com.google.api.services.analytics.model.Webproperties;

import java.io.FileInputStream;
import java.io.IOException;
import java.security.GeneralSecurityException;
import java.io.IOException;


/**
 * A simple example of how to access the Google Analytics API using a service
 * account.
 */
public class HelloAnalytics {


  private static final String APPLICATION_NAME = "Hello Analytics";
  private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance();
  private static final String KEY_FILE_LOCATION = "<REPLACE_WITH_JSON_FILE>";
  public static void main(String[] args) {
    try {
      Analytics analytics = initializeAnalytics();

      String profile = getFirstProfileId(analytics);
      System.out.println("First Profile Id: "+ profile);
      printResults(getResults(analytics, profile));
    } catch (Exception e) {
      e.printStackTrace();
    }
  }

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

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

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


  private static String getFirstProfileId(Analytics analytics) throws IOException {
    // Get the first view (profile) ID for the authorized user.
    String profileId = null;

    // Query for the list of all accounts associated with the service account.
    Accounts accounts = analytics.management().accounts().list().execute();

    if (accounts.getItems().isEmpty()) {
      System.err.println("No accounts found");
    } else {
      String firstAccountId = accounts.getItems().get(0).getId();

      // Query for the list of properties associated with the first account.
      Webproperties properties = analytics.management().webproperties()
          .list(firstAccountId).execute();

      if (properties.getItems().isEmpty()) {
        System.err.println("No Webproperties found");
      } else {
        String firstWebpropertyId = properties.getItems().get(0).getId();

        // Query for the list views (profiles) associated with the property.
        Profiles profiles = analytics.management().profiles()
            .list(firstAccountId, firstWebpropertyId).execute();

        if (profiles.getItems().isEmpty()) {
          System.err.println("No views (profiles) found");
        } else {
          // Return the first (view) profile associated with the property.
          profileId = profiles.getItems().get(0).getId();
        }
      }
    }
    return profileId;
  }

  private static GaData getResults(Analytics analytics, String profileId) throws IOException {
    // Query the Core Reporting API for the number of sessions
    // in the past seven days.
    return analytics.data().ga()
        .get("ga:" + profileId, "7daysAgo", "today", "ga:sessions")
        .execute();
  }

  private static void printResults(GaData results) {
    // Parse the response from the Core Reporting API for
    // the profile name and number of sessions.
    if (results != null && !results.getRows().isEmpty()) {
      System.out.println("View (Profile) Name: "
        + results.getProfileInfo().getProfileName());
      System.out.println("Total Sessions: " + results.getRows().get(0).get(0));
    } else {
      System.out.println("No results found");
    }
  }
}

Schritt 4: Beispiel ausführen

Nachdem Sie die Analytics API aktiviert haben, haben Sie die Google APIs-Clientbibliothek für Java installiert und den Beispielcode eingerichtet, mit dem das Beispiel ausgeführt werden kann.

Wenn Sie eine IDE verwenden, muss ein Standardausführungsziel auf die Klasse HelloAnalytics festgelegt sein. Andernfalls können Sie die Anwendung über die Befehlszeile kompilieren und ausführen:

1. Kompilieren Sie das Beispiel mit

   javac -classpath /path/to/google/lib/*:/path/to/google/lib/libs/* HelloAnalytics.java

   .
2. Führen Sie das Beispiel mit

   java -classpath ./:/path/to/google/lib/*:/path/to/google/lib/libs/* HelloAnalytics

   aus.

Wenn Sie diese Schritte abgeschlossen haben, werden im Beispiel der Name der ersten Google Analytics-Datenansicht (Profil) des autorisierten Nutzers und die Anzahl der Sitzungen in den letzten sieben Tagen ausgegeben.

Hinweis: Zum Ausführen dieses Beispiels benötigen Sie mindestens eine Google Analytics-Property und eine Datenansicht (Profil).

Mit dem autorisierten Analytics-Dienstobjekt können Sie jetzt alle Codebeispiele aus der Referenzdokumentation zur Management API ausführen. Sie könnten beispielsweise versuchen, den Code so zu ändern, dass die Methode accountSummaries.list verwendet wird.