Hello Analytics Reporting API v4; yüklü uygulamalar için Java hızlı başlangıç kılavuzu

Bu eğitimde, Analytics Reporting API v4'e erişmek için gereken adımlar açıklanmaktadır.

Not: Bu hızlı başlangıç kılavuzlarının amacı, Google API İstemci Kitaplıkları ile API yetkilendirmesinin ilk zorluklarını aşmanıza yardımcı olmaktır. Bu kitaplıklar aktif geliştirme aşamasında olduğundan zaman zaman en yeni istemci kitaplıklarıyla senkronize olmayabilir. Bu sorunla karşılaşırsanız İstemci Kitaplığı dokümanlarına göz atmanız ve gerekirse yardım dokümanlarına bakmanız gerekir.

1. API'yi etkinleştirme

Analytics Reporting API v4'ü kullanmaya başlamak için önce Google API Konsolu'nda proje oluşturma, API'yi etkinleştirme ve kimlik bilgileri oluşturma konusunda size yol gösterecek olan kurulum aracını kullanmanız gerekir.

Not: Web İstemci Kimliği veya Yüklü Uygulama İstemcisi oluşturmak için izin ekranında bir ürün adı belirlemeniz gerekir. Henüz yapmadıysanız İzin ekranını yapılandırma yapmanız istenir.

Kimlik bilgileri oluştur

• Credentials (Kimlik Bilgileri) sayfasını açın.
• Kimlik bilgileri oluştur'u tıklayın ve OAuth istemci kimliği'ni seçin.
• Uygulama türü için Diğer'i seçin.
• İstemci kimliğini quickstart olarak adlandırın ve quickstart'u tıklayın.

Kimlik bilgileri sayfasında yeni oluşturulan istemci kimliğini tıklayın ve JSON'yi indir'i tıklayıp client_secrets.json olarak kaydedin. Eğitimin ilerleyen bölümlerinde bu bilgiye ihtiyacınız olacaktır.

2. İstemci kitaplığını yükleme

Google Analytics API Java İstemcisini yüklemek için çıkarmanız ve Java sınıf yolunuza kopyalamanız gereken tüm jar dosyalarını içeren bir zip dosyası indirmeniz gerekir.

1. Gerekli tüm bağımlılıkları içeren bir ZIP dosyası olarak sunulan Analytics Reporting API v4 Java İstemci Kitaplığı'nı indirin.
2. ZIP dosyasını çıkarın.
3. libs dizinindeki tüm JAR'ları sınıf yolunuza ekleyin.
4. google-api-services-analyticsreporting-v4-[version].jar jar dosyasını sınıf yolunuza ekleyin.

Java ortamı ayrıntıları

Güneş/ay tutulması

Eclipse için projenizin sınıf yoluna JAR eklemeyle ilgili talimatlar için bu StackOverflow sorusuna bakın.

NetBeans

NetBeans için projenizin sınıf yoluna JAR eklemeyle ilgili talimatlar için bu StackOverflow sorusuna bakın.

IntelliJ IDEA

Projenizin sınıf yoluna JAR eklemeyle ilgili talimatlar için IntelliJ IDEA ile ilgili bu StackOverflow sorusuna bakın.

Komut satırı

Komut satırından geliştirme yapıyorsanız javac ve java komut çağrılarınıza aşağıdakileri ekleyin:

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

Not: Java çalışma zamanı ortamınıza bağlı olarak, javax.servlet.jar dosyasını indirip projenizin sınıf yoluna eklemeniz de gerekebilir.

3. Örneği oluşturun

Belirtilen örnek kodu içeren HelloAnalyticsReporting.java adında tek bir dosya oluşturmanız gerekir.

• Aşağıdaki kaynak kodunu HelloAnalyticsReporting.java hizmetine kopyalayın veya indirin.

• Daha önce indirilen client_secrets.json öğesini örnek kodla aynı dizine taşıyın.

• VIEW_ID değerini, erişmek istediğiniz görünümün kimliğiyle değiştirin.

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 java.io.File;
import java.io.IOException;
import java.io.InputStreamReader;
import java.security.GeneralSecurityException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

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


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

  // Replace with your view ID.
  private static final String VIEW_ID = "<REPLACE_WITH_VIEW_ID>";

  // 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 Reporting";
  private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance();
  private static NetHttpTransport httpTransport;
  private static FileDataStoreFactory dataStoreFactory;

  public static void main(String[] args) {
    try {
      Analyticsreporting service = initializeAnalyticsReporting();

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


  /**
   * Initializes an authorized Analytics Reporting service object.
   *
   * @return The analytics reporting service object.
   * @throws IOException
   * @throws GeneralSecurityException
   */
  private static Analyticsreporting initializeAnalyticsReporting() throws GeneralSecurityException, IOException {

    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 authorization scopes.
    GoogleAuthorizationCodeFlow flow = new GoogleAuthorizationCodeFlow
        .Builder(httpTransport, JSON_FACTORY, clientSecrets,
            AnalyticsreportingScopes.all()).setDataStoreFactory(dataStoreFactory)
        .build();

    // Authorize.
    Credential credential = new AuthorizationCodeInstalledApp(flow,
        new LocalServerReceiver()).authorize("user");
    // Construct the Analytics Reporting service object.
    return new Analyticsreporting.Builder(httpTransport, JSON_FACTORY, credential)
        .setApplicationName(APPLICATION_NAME).build();
  }

  /**
   * Query the Analytics Reporting API V4.
   * Constructs a request for the sessions for the past seven days.
   * Returns the API response.
   *
   * @param service
   * @return GetReportResponse
   * @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");

    //Create the Dimensions object.
    Dimension browser = new Dimension()
        .setName("ga:browser");

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

    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 the 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. Örneği çalıştır

IDE kullanıyorsanız HelloAnalytics sınıfına ayarlanmış varsayılan bir çalıştırma hedefiniz olduğundan emin olun.

• Uygulama, yetkilendirme sayfasını bir tarayıcıda yükler.
• Google hesabınıza giriş yapmadıysanız giriş yapmanız istenir. Birden çok Google hesabına giriş yaptıysanız yetkilendirme için kullanılacak bir hesap seçmeniz istenir.

Bu adımları tamamladığınızda, örnek, belirtilen görünüm için son yedi gündeki oturum sayısını verir.

Not: Bu örneği başarıyla çalıştırmak için en az bir Google Analytics mülküne ve görünümüne sahip olmanız gerekir.