Hello Analytics API: krótkie wprowadzenie do języka Java dotyczącego zainstalowanych aplikacji

W tym samouczku omawiamy, jak uzyskać dostęp do konta Google Analytics, wysyłać zapytania do interfejsów API Analytics, obsługiwać odpowiedzi interfejsu API i wyświetlać wyniki. W tym samouczku używane są interfejsy Core Reporting API w wersji 3.0, Management API w wersji 3.0 i OAuth2.0.

Uwaga: te krótkie przewodniki pomogą Ci przezwyciężyć początkowe trudności związane z autoryzacją interfejsu API w bibliotekach klienta interfejsów API Google. Ponieważ są one w trakcie programowania, przewodniki mogą czasami nie być zsynchronizowane z najnowszymi bibliotekami klienta. Jeśli napotkasz ten problem, zajrzyj do dokumentacji biblioteki klienta, a w razie potrzeby – do dokumentacji pomocy.

Krok 1. Włącz Analytics API

Aby rozpocząć korzystanie z interfejsu Google Analytics API, musisz najpierw użyć narzędzia do konfiguracji, które przeprowadzi Cię przez proces tworzenia projektu w Konsoli interfejsów API Google, włączania interfejsu API i tworzenia danych logowania.

Aby utworzyć identyfikator klienta internetowego lub klienta zainstalowanej aplikacji, musisz ustawić nazwę usługi na ekranie zgody. Zobaczysz prośbę o skonfigurowanie ekranu zgody, jeśli nie zostało to jeszcze zrobione.

Utwórz identyfikator klienta

Na stronie Dane logowania:

1. Kliknij Utwórz dane logowania i wybierz Identyfikator klienta OAuth.
2. Dla opcji APPLICATION TYPE wybierz Inne.
3. Nazwij dane logowania.
4. Kliknij Utwórz.

Wybierz utworzone dane logowania i kliknij Pobierz JSON. Zapisz pobrany plik jako client_secrets.json. Będzie Ci on potrzebny w dalszej części samouczka.

Krok 2. Zainstaluj bibliotekę klienta Google

Aby zainstalować klienta Java interfejsu Google Analytics API, musisz pobrać plik ZIP zawierający wszystkie pliki jar, które musisz wyodrębnić i skopiować do ścieżki klasy Java.

1. Pobierz bibliotekę klienta Google Analytics w języku Java, która jest dołączona jako plik ZIP ze wszystkimi wymaganymi zależnościami.
2. Wyodrębnij plik ZIP
3. Dodaj do ścieżki klasy wszystkie pliki JAR z katalogu libs.
4. Dodaj do ścieżki klasy plik jar google-api-services-analytics-v3-[version].jar.

...dowiedz się więcej o szczegółach środowiska Java.

Szczegóły środowiska Java

Jeśli używasz Eclipse, tutaj znajdziesz instrukcje dodawania plików JAR do ścieżki klasy projektu.

Jeśli używasz NetBeans, tutaj znajdziesz instrukcje dodawania plików JAR do ścieżki klasy projektu.

Jeśli używasz IntelliJ IDEA, tutaj znajdziesz instrukcje dodawania plików JAR do ścieżki klasy projektu.

Jeśli programujesz z poziomu wiersza poleceń, dodaj do wywołań poleceń javac i java -classpath /path/to/directory/with/unzipped/jars.

Uwaga: w zależności od środowiska wykonawczego Java może być konieczne pobranie pliku javax.servlet.jar i dodanie go do ścieżki klasy projektu.

Krok 3. Skonfiguruj przykład

Musisz utworzyć jeden plik o nazwie HelloAnalytics.java, który będzie zawierał podany przykładowy kod.

1. Skopiuj lub pobierz ten kod źródłowy do HelloAnalytics.java.
2. Przenieś pobrany wcześniej plik client_secrets.json do tego samego katalogu, w którym znajduje się przykładowy kod.

import com.google.api.client.auth.oauth2.Credential;
import com.google.api.client.extensions.java6.auth.oauth2.AuthorizationCodeInstalledApp;
import com.google.api.client.extensions.jetty.auth.oauth2.LocalServerReceiver;
import com.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeFlow;
import com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.JsonFactory;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.client.util.store.FileDataStoreFactory;
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.File;
import java.io.IOException;
import java.io.InputStreamReader;


/**
 * A simple example of how to access the Google Analytics API.
 */
public class HelloAnalytics {
  // Path to client_secrets.json file downloaded from the Developer's Console.
  // The path is relative to HelloAnalytics.java.
  private static final String CLIENT_SECRET_JSON_RESOURCE = "client_secrets.json";

  // The directory where the user's credentials will be stored.
  private static final File DATA_STORE_DIR = new File(
      System.getProperty("user.home"), ".store/hello_analytics");

  private static final String APPLICATION_NAME = "Hello Analytics";
  private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance();
  private static NetHttpTransport httpTransport;
  private static FileDataStoreFactory dataStoreFactory;

  public static void main(String[] args) {
    try {
      Analytics analytics = initializeAnalytics();
      String profile = getFirstProfileId(analytics);
      printResults(getResults(analytics, profile));
    } catch (Exception e) {
      e.printStackTrace();
    }
  }

  private static Analytics initializeAnalytics() throws Exception {

    httpTransport = GoogleNetHttpTransport.newTrustedTransport();
    dataStoreFactory = new FileDataStoreFactory(DATA_STORE_DIR);

    // Load client secrets.
    GoogleClientSecrets clientSecrets = GoogleClientSecrets.load(JSON_FACTORY,
        new InputStreamReader(HelloAnalytics.class
            .getResourceAsStream(CLIENT_SECRET_JSON_RESOURCE)));

    // Set up authorization code flow for all auth scopes.
    GoogleAuthorizationCodeFlow flow = new GoogleAuthorizationCodeFlow
        .Builder(httpTransport, JSON_FACTORY, clientSecrets,
        AnalyticsScopes.all()).setDataStoreFactory(dataStoreFactory)
        .build();

    // Authorize.
    Credential credential = new AuthorizationCodeInstalledApp(flow,
        new LocalServerReceiver()).authorize("user");

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

Krok 4. Uruchom próbkę

Gdy włączysz interfejs Analytics API, zainstalujesz bibliotekę klienta interfejsów API Google dla Javy i skonfigurujesz przykładowy kod źródłowy, który będzie gotowy do uruchomienia.

Jeśli używasz IDE, sprawdź, czy Twój domyślny cel uruchamiania jest ustawiony na klasę HelloAnalytics.

1. Aplikacja wczyta w przeglądarce stronę autoryzacji.
2. Jeśli nie zalogujesz się na konto Google, pojawi się prośba o zalogowanie. Jeśli jesteś zalogowany(-a) na kilku kontach Google, pojawi się prośba o wybranie jednego z nich do autoryzacji.

Gdy wykonasz te czynności, w przykładzie zostanie wyświetlona nazwa pierwszego widoku Google Analytics (profilu) autoryzowanego użytkownika oraz liczba sesji w ciągu ostatnich 7 dni.

Uwaga: aby uruchomić ten przykładowy widok, musisz mieć co najmniej jedną usługę i widok (profil) Google Analytics.

Za pomocą autoryzowanego obiektu usługi Analytics możesz teraz uruchamiać dowolny z przykładów kodu, który znajdziesz w dokumentacji interfejsu Management API. Możesz na przykład zmienić kod i użyć metody accountSummaries.list.