مرحبًا في الإصدار 4 من واجهة برمجة التطبيقات لإعداد التقارير في "إحصاءات Google"، وبدء استخدام Java سريعًا للتطبيقات المثبّتة

يوضّح هذا البرنامج التعليمي الخطوات المطلوبة للوصول إلى الإصدار 4 من واجهة برمجة التطبيقات لإعداد التقارير في "إحصاءات Google".

ملاحظة: إنّ الغرض من أدلة البدء السريع هذه هو مساعدتك في اجتياز العقبات الأولية التي تواجه تفويض واجهة برمجة التطبيقات باستخدام مكتبات عميل Google API. وبما أنّ هذه المكتبات قيد التطوير النشط، قد لا تكون هذه الأدلة متزامنة من حين لآخر مع أحدث مكتبات العملاء. إذا واجهت هذه المشكلة، يجب مراجعة مستندات مكتبة العميل وإذا لزم الأمر، يمكنك الاطّلاع على مستندات المساعدة.

1- تفعيل واجهة برمجة التطبيقات

لبدء استخدام الإصدار 4 من واجهة برمجة التطبيقات لإعداد التقارير في "إحصاءات Google"، عليك أولاً استخدام أداة الإعداد التي ترشدك خلال إنشاء مشروع في وحدة تحكّم Google API وتفعيل واجهة برمجة التطبيقات وإنشاء بيانات الاعتماد.

ملاحظة: لإنشاء معرّف عميل على الويب أو عميل تطبيق مثبّت، يجب ضبط اسم منتج في شاشة الموافقة. سيُطلب منك ضبط شاشة الموافقة في حال عدم تنفيذ ذلك.

إنشاء بيانات اعتماد

• افتح صفحة بيانات الاعتماد.
• انقر على إنشاء بيانات اعتماد ثم اختر معرِّف عميل OAuth.
• بالنسبة إلى نوع التطبيق، اختَر غير ذلك.
• أدخِل اسم معرّف العميل للبدء وانقر على إنشاء.

من صفحة بيانات الاعتماد انقر على معرِّف العميل الذي تم إنشاؤه حديثًا، ثم انقر على تنزيل JSON وحفظه كـ client_secrets.json؛ ستحتاج إليه لاحقًا في البرنامج التعليمي.

2. تثبيت مكتبة البرامج

لتثبيت عميل Java API في "إحصاءات Google"، عليك تنزيل ملف ZIP يحتوي على جميع الأواني التي تحتاج إلى استخراجها ونسخها في مسار صف Java.

1. نزِّل الإصدار 4 من مكتبة واجهة برمجة التطبيقات لإعداد التقارير في "إحصاءات Google"، والتي يتم تجميعها كملف ZIP مع جميع التبعيات المطلوبة.
2. استخرِج ملف ZIP.
3. يمكنك إضافة جميع ملفات JAR ضمن الدليل libs إلى مسار الصف.
4. أضِف إناء google-api-services-analyticsreporting-v4-[version].jar إلى مسار الصف.

تفاصيل بيئة Java

الكسوف

بالنسبة إلى Eclipse، يمكنك الاطّلاع على سؤال StackOverflow للحصول على تعليمات عن إضافة ملفات JAR إلى مسار مشروعك على مستوى المشروع.

شبكة NetBeans

بالنسبة إلى NetBeans، يُرجى الاطّلاع على سؤال StackOverflow للحصول على تعليمات عن إضافة ملفات JAR إلى مشروعك في الصف الدراسي.

منصة IntelliJ IDEA

بالنسبة إلى IntelliJ IDEA، يُرجى الاطّلاع على سؤال StackOverflow للحصول على تعليمات عن إضافة ملفات JAR إلى مشروعك في الصف الدراسي.

سطر الأوامر

في حال التطوير من سطر الأوامر، يُرجى إضافة ما يلي إلى استدعاءات الأمر javac وjava:

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

ملاحظة: وفقًا لبيئة وقت تشغيل جافا، قد تحتاج أيضًا إلى تنزيل javax.servlet.jar وإضافته إلى مسار مشروعك.

3- إعداد النموذج

يجب إنشاء ملف واحد باسم HelloAnalyticsReporting.java، والذي سيتضمّن رمز النموذج المحدد.

• انسخ رمز المصدر التالي أو نزِّله إلى HelloAnalyticsReporting.java.

• انقِل client_secrets.json التي سبق تنزيلها إلى الدليل نفسه الذي يتضمّن نموذج الرمز.

• استبدل قيمة VIEW_ID بمعرّف الملف الشخصي الذي تريد الوصول إليه.

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. تنفيذ النموذج

إذا كنت تستخدم بيئة التطوير المتكاملة (IDE)، احرص على ضبط هدف التشغيل التلقائي الذي تم ضبطه على فئة HelloAnalytics.

• سيُحمِّل التطبيق صفحة التفويض في أحد المتصفّحات.
• إذا لم يسبق لك تسجيل الدخول إلى حسابك على Google، سيُطلب منك تسجيل الدخول. إذا سجّلت الدخول إلى حسابات متعددة على Google، سيُطلب منك اختيار حساب واحد لاستخدامه في التفويض.

عند الانتهاء من هذه الخطوات، ينتج عن النموذج عدد الجلسات لآخر سبعة أيام في طريقة العرض المحددة.

ملاحظة: لتشغيل هذا النموذج بنجاح، يجب أن يكون لديك موقع "إحصاءات Google" وملف شخصي واحد على الأقل.