Hello Analytics Reporting API v4; Java Quickstart สําหรับแอปพลิเคชันที่ติดตั้ง

จัดทุกอย่างให้เป็นระเบียบอยู่เสมอด้วยคอลเล็กชัน บันทึกและจัดหมวดหมู่เนื้อหาตามค่ากำหนดของคุณ

บทแนะนํานี้จะอธิบายขั้นตอนที่จําเป็นในการเข้าถึง Analytics Reporting API เวอร์ชัน 4

1. เปิดใช้ API

ในการเริ่มต้นใช้งาน Analytics Reporting API เวอร์ชัน 4 คุณต้องใช้เครื่องมือการตั้งค่าก่อน ซึ่งจะช่วยแนะนําคุณในการสร้างโปรเจ็กต์ในคอนโซล Google API, เปิดใช้ API และสร้างข้อมูลเข้าสู่ระบบ

หมายเหตุ: หากต้องการสร้างรหัสไคลเอ็นต์ของเว็บไคลเอ็นต์หรือไคลเอ็นต์แอปพลิเคชันที่ติดตั้งไว้ คุณต้องตั้งค่าชื่อผลิตภัณฑ์ในหน้าจอคํายินยอม หากยังไม่ได้ดําเนินการ ระบบจะแจ้งให้คุณกําหนดค่าหน้าจอคํายินยอม

สร้างข้อมูลเข้าสู่ระบบ

  • เปิดหน้าข้อมูลเข้าสู่ระบบ
  • คลิกสร้างข้อมูลเข้าสู่ระบบแล้วเลือกรหัสไคลเอ็นต์ OAuth
  • สําหรับประเภทแอปพลิเคชัน ให้เลือกอื่นๆ
  • ตั้งชื่อรหัสไคลเอ็นต์ว่า quickstart แล้วคลิกสร้าง

จากหน้าข้อมูลเข้าสู่ระบบ ให้คลิกรหัสไคลเอ็นต์ที่เพิ่งสร้างขึ้นแล้วคลิก ดาวน์โหลด JSON แล้วบันทึกเป็น client_secrets.json ซึ่งคุณจะต้องใช้ในบทแนะนําในภายหลัง

2. ติดตั้งไลบรารีของไคลเอ็นต์

หากต้องการติดตั้งไคลเอ็นต์ Java API ของ Google Analytics คุณต้องดาวน์โหลดไฟล์ ZIP ที่มี Jar ทั้งหมดที่ต้องการแตกและคัดลอกลงใน Java classpath

  1. ดาวน์โหลดไลบรารีของไคลเอ็นต์ Analytics Analytics v4 Java ซึ่งรวมอยู่ในไฟล์ ZIP ที่ต้องใช้ทรัพยากร Dependency ทั้งหมด
  2. แตกไฟล์ ZIP
  3. เพิ่ม JAR ทั้งหมดภายในไดเรกทอรี libs ไปยังคลาสเส้นทาง
  4. เพิ่มโหล google-api-services-analyticsreporting-v4-[version].jar ไปยัง Classpath

รายละเอียดสภาพแวดล้อม Java

Eclipse

สําหรับ Eclipse โปรดดูคําถามใน StackOverflow นี้สําหรับคําแนะนําในการเพิ่ม JAR ไปยัง classpath ของโปรเจ็กต์

ถั่วสุทธิ

สําหรับ NetBeans โปรดดูคําถาม StackOverflow นี้สําหรับคําแนะนําในการเพิ่ม JAR ไปยังคลาสเส้นทางของโปรเจ็กต์

แนวคิดของ IntelliJ

สําหรับ IntelliJ IDEA โปรดดูคําถามใน StackOverflow นี้สําหรับคําแนะนําในการเพิ่ม JAR ไปยังคลาสคลาสของโปรเจ็กต์

บรรทัดคำสั่ง

หากพัฒนาจากบรรทัดคําสั่ง ให้เพิ่มค่าต่อไปนี้ลงในการเรียกใช้คําสั่ง javac และ java

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

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 หลายบัญชี ระบบจะขอให้คุณเลือก 1 บัญชีที่จะใช้สําหรับการให้สิทธิ์

เมื่อคุณทําตามขั้นตอนเหล่านี้เสร็จแล้ว ตัวอย่างจะแสดงผลจํานวนเซสชันในช่วง 7 วันที่ผ่านมาสําหรับมุมมองที่กําหนด