नमस्ते Analytics Reporting API v4; सेवा खातों के लिए, Java क्विकस्टार्ट की सुविधा

इस ट्यूटोरियल में, Analytics Reporting API v4 को ऐक्सेस करने के ज़रूरी चरणों के बारे में बताया गया है.

ध्यान दें: इन क्विकस्टार्ट गाइड का मकसद, Google API क्लाइंट लाइब्रेरी का इस्तेमाल करके, एपीआई की अनुमति से जुड़ी शुरुआती रुकावटों को हल करने में आपकी मदद करना है. इन लाइब्रेरी पर अभी काम चल रहा है. इसलिए, हो सकता है कि कभी-कभी ये गाइड, नई क्लाइंट लाइब्रेरी के साथ सिंक न हो जाएं. यह समस्या आने पर, क्लाइंट लाइब्रेरी के दस्तावेज़ देखें और ज़रूरत पड़ने पर सहायता दस्तावेज़ देखें.

1. एपीआई चालू करें

Analytics Reporting API v4 का इस्तेमाल शुरू करने के लिए, सबसे पहले सेटअप टूल का इस्तेमाल करना होगा. इससे आपको Google API कंसोल में प्रोजेक्ट बनाने, एपीआई को चालू करने, और क्रेडेंशियल बनाने के बारे में जानकारी मिलेगी.

क्रेडेंशियल बनाएं

ध्यान दें: जब कहा जाए, तब नई निजी कुंजी बनाएं पर क्लिक करें और कुंजी टाइप चुनने के लिए, JSON चुनें और जनरेट की गई कुंजी को client_secrets.json के तौर पर सेव करें. आपको बाद में ट्यूटोरियल में इसकी ज़रूरत पड़ेगी.

1. सेवा खाते का पेज खोलें. पूछे जाने पर, प्रोजेक्ट चुनें.
2. सेवा खाता बनाएं पर क्लिक करें, सेवा खाते का नाम और जानकारी डालें. आप डिफ़ॉल्ट सेवा खाता आईडी इस्तेमाल करें या फिर कोई दूसरा, अलग खाता आईडी चुनें. काम पूरा हो जाने पर, बनाएं पर क्लिक करें.
3. इसके बाद आने वाले सेवा खाते की अनुमतियां (ज़रूरी नहीं) सेक्शन की ज़रूरत नहीं है. जारी रखें पर क्लिक करें.
4. उपयोगकर्ताओं को इस खाते का ऐक्सेस दें स्क्रीन पर, नीचे कुंजी बनाएं सेक्शन तक स्क्रोल करें. कुंजी बनाएं पर क्लिक करें.
5. दिखने वाले साइड पैनल में, अपनी कुंजी का फ़ॉर्मैट चुनें: JSON का सुझाव दिया जाता है.
6. बनाएं पर क्लिक करें. आपकी नई सार्वजनिक/निजी कुंजी की जोड़ी जनरेट करके आपकी मशीन पर डाउनलोड की जाती है. यह इस कुंजी की अकेली कॉपी की तरह काम करती है. इसे सुरक्षित तौर पर कैसे सेव किया जाए, इसकी जानकारी के लिए, सेवा खाता कुंजियां मैनेज करें देखें.
7. आपके कंप्यूटर पर सेव की गई निजी कुंजी डायलॉग पर, बंद करें पर क्लिक करें. इसके बाद, अपने सेवा खातों की टेबल पर वापस लौटने के लिए, हो गया पर क्लिक करें.

Google Analytics खाते में सेवा खाता जोड़ें

नए सेवा खाते का ईमेल पता, इससे मिलता-जुलता होगा:

[e-mail]

इस ईमेल पते का इस्तेमाल करके, Google Analytics के उस व्यू में कोई उपयोगकर्ता जोड़ें जिसे एपीआई की मदद से ऐक्सेस करना है. इस ट्यूटोरियल के लिए, सिर्फ़ पढ़ें और विश्लेषण करें अनुमतियां ज़रूरी हैं.

2. क्लाइंट लाइब्रेरी इंस्टॉल करना

Google Analytics API Java क्लाइंट इंस्टॉल करने के लिए, आपको एक ज़िप फ़ाइल डाउनलोड करनी होगी, जिसमें वे सभी जार शामिल होंगे जिन्हें आपको अपने Java क्लासपाथ में एक्सट्रैक्ट करके कॉपी करना है.

1. Analytics Reporting API v4 Java क्लाइंट लाइब्रेरी डाउनलोड करें, जिसे सभी ज़रूरी डिपेंडेंसी के साथ ZIP फ़ाइल के तौर पर बंडल किया गया है.
2. ZIP फ़ाइल निकालें.
3. libs डायरेक्ट्री में सभी JAR अपने क्लासपाथ में जोड़ें.
4. अपने क्लासपाथ में google-api-services-analyticsreporting-v4-[version].jar जार जोड़ें.

Java एनवायरमेंट की जानकारी

एक्लिप्स

Eclipse के लिए, अपने प्रोजेक्ट के क्लासपाथ में JAR जोड़ने के बारे में निर्देश पाने के लिए, यह StackOverflow का सवाल देखें.

NetBeans

अपने प्रोजेक्ट के क्लासपाथ में JAR जोड़ने के बारे में निर्देश पाने के लिए, NetBeans के लिए यह StackOverflow का सवाल देखें.

IntelliJ IDEA

IntiliJ IDEA प्रोजेक्ट के क्लासपाथ में JAR जोड़ने के बारे में निर्देश पाने के लिए, यह StackOverflow का सवाल देखें.

कमांड लाइन

अगर कमांड लाइन से डेवलप किया जा रहा है, तो अपने javac और java कमांड को शुरू करने के लिए इन शब्दों को जोड़ें:

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

ध्यान दें: आपके Java रनटाइम एनवायरमेंट के आधार पर, आपको अपने प्रोजेक्ट के क्लासपाथ में javax.servlet.jar डाउनलोड करके जोड़ना पड़ सकता है.

3. सैंपल सेटअप करें

आपको HelloAnalyticsReporting.java नाम की एक फ़ाइल बनानी होगी, जिसमें दिया गया सैंपल कोड शामिल होगा.

• नीचे दिए गए सोर्स कोड को HelloAnalyticsReporting.java में कॉपी करें या डाउनलोड करें.

• पहले डाउनलोड किए गए client_secrets.json को उसी डायरेक्ट्री में ले जाएं जिसमें सैंपल कोड है.
• KEY_FILE_LOCATION की वैल्यू को Developer Console में मौजूद सही वैल्यू से बदलें.

• VIEW_ID की वैल्यू को उस व्यू के आईडी से बदलें जिसे आपको ऐक्सेस करना है.

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

import com.google.api.services.analyticsreporting.v4.AnalyticsReportingScopes;
import com.google.api.services.analyticsreporting.v4.AnalyticsReporting;

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

public class HelloAnalyticsReporting {
  private static final String APPLICATION_NAME = "Hello Analytics Reporting";
  private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance();
  private static final String KEY_FILE_LOCATION = "<REPLACE_WITH_JSON_FILE>";
  private static final String VIEW_ID = "<REPLACE_WITH_VIEW_ID>";
  public static void main(String[] args) {
    try {
      AnalyticsReporting service = initializeAnalyticsReporting();

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

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

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

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

  /**
   * Queries the Analytics Reporting API V4.
   *
   * @param service An authorized Analytics Reporting API V4 service object.
   * @return GetReportResponse The Analytics Reporting API V4 response.
   * @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");

    Dimension pageTitle = new Dimension().setName("ga:pageTitle");

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

    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 An 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. सैंपल चलाएं

अगर आईडीई का इस्तेमाल किया जा रहा है, तो पक्का करें कि आपने HelloAnalytics क्लास पर डिफ़ॉल्ट रन टारगेट सेट किया हो. अगर ऐसा नहीं है, तो कमांड लाइन से ऐप्लिकेशन को कंपाइल करके चलाया जा सकता है:

• इसका इस्तेमाल करके सैंपल कंपाइल करें:

  javac -classpath '/path/to/analyticsreporting/*:/path/to/analyticsreporting/libs/*' HelloAnalyticsReporting.java
  

• इसका इस्तेमाल करके सैंपल चलाएं:

  java -classpath '.:/path/to/analyticsreporting/*:/path/to/analyticsreporting/libs/*' HelloAnalyticsReporting
  

जब इन चरणों को पूरा किया जाता है, तो सैंपल, दिए गए व्यू के लिए पिछले सात दिनों के सेशन की संख्या दिखाता है.

ध्यान दें: इस सैंपल को चलाने के लिए, आपके पास कम से कम एक Google Analytics प्रॉपर्टी और व्यू होना चाहिए.