नमस्ते Analytics Reporting API v4; इंस्टॉल किए गए ऐप्लिकेशन के लिए, Java क्विकस्टार्ट की सुविधा

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

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

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

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

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

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

• क्रेडेंशियल पेज खोलें.
• क्रेडेंशियल बनाएं पर क्लिक करें और OAuth क्लाइंट आईडी चुनें
• ऐप्लिकेशन के टाइप के लिए अन्य चुनें.
• क्लाइंट आईडी को quickstart नाम दें और quickstart पर क्लिक करें.

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

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 को उसी डायरेक्ट्री में ले जाएं जिसमें सैंपल कोड है.

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

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

• यह ऐप्लिकेशन, ब्राउज़र में अनुमति देने वाले पेज को लोड कर देगा.
• अगर आप पहले से अपने Google खाते में लॉग इन नहीं हैं, तो आपको लॉग इन करने के लिए कहा जाएगा. अगर आपने एक से ज़्यादा Google खातों में लॉग इन किया हुआ है, तो आपको अनुमति देने के लिए एक खाता चुनने के लिए कहा जाएगा.

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

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