नमस्ते Analytics API: सेवा खातों के लिए Java क्विकस्टार्ट

इस ट्यूटोरियल में, Google Analytics खाता ऐक्सेस करने, Analytics एपीआई से क्वेरी करने, एपीआई के रिस्पॉन्स को मैनेज करने, और नतीजे देने के लिए ज़रूरी चरणों के बारे में बताया गया है. इस ट्यूटोरियल में, Core Reporting API v3.0, Management API v3.0, और OAuth2.0 का इस्तेमाल किया गया है.

पहला चरण: Analytics API चालू करना

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

क्लाइंट आईडी बनाना

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

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

नए सेवा खाते में ईमेल पता, <projectId>-<uniqueId>@developer.gserviceaccount.com होगा; इस ईमेल पते का इस्तेमाल करके, उस Google Analytics खाते में उपयोगकर्ता को जोड़ें जिसे आपको एपीआई के ज़रिए ऐक्सेस करना है. सिर्फ़ इस ट्यूटोरियल के लिए, पढ़ें और विश्लेषण करें की अनुमतियां ज़रूरी हैं.

दूसरा चरण: Google क्लाइंट लाइब्रेरी इंस्टॉल करना

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

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

तीसरा चरण: सैंपल सेटअप करना

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

  1. इस सोर्स कोड को HelloAnalytics.java में कॉपी करें या डाउनलोड करें.
  2. पहले डाउनलोड किए गए client_secrets.JSON को उसी डायरेक्ट्री में ले जाएं जिसमें सैंपल कोड है.
  3. KEY_FILE_LOCATION की वैल्यू को Developer Console में मौजूद सही वैल्यू से बदलें. 
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 com.google.api.services.analytics.Analytics;
import com.google.api.services.analytics.AnalyticsScopes;
import com.google.api.services.analytics.model.Accounts;
import com.google.api.services.analytics.model.GaData;
import com.google.api.services.analytics.model.Profiles;
import com.google.api.services.analytics.model.Webproperties;

import java.io.FileInputStream;
import java.io.IOException;
import java.security.GeneralSecurityException;
import java.io.IOException;


/**
 * A simple example of how to access the Google Analytics API using a service
 * account.
 */
public class HelloAnalytics {


  private static final String APPLICATION_NAME = "Hello Analytics";
  private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance();
  private static final String KEY_FILE_LOCATION = "<REPLACE_WITH_JSON_FILE>";
  public static void main(String[] args) {
    try {
      Analytics analytics = initializeAnalytics();

      String profile = getFirstProfileId(analytics);
      System.out.println("First Profile Id: "+ profile);
      printResults(getResults(analytics, profile));
    } catch (Exception e) {
      e.printStackTrace();
    }
  }

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

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

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


  private static String getFirstProfileId(Analytics analytics) throws IOException {
    // Get the first view (profile) ID for the authorized user.
    String profileId = null;

    // Query for the list of all accounts associated with the service account.
    Accounts accounts = analytics.management().accounts().list().execute();

    if (accounts.getItems().isEmpty()) {
      System.err.println("No accounts found");
    } else {
      String firstAccountId = accounts.getItems().get(0).getId();

      // Query for the list of properties associated with the first account.
      Webproperties properties = analytics.management().webproperties()
          .list(firstAccountId).execute();

      if (properties.getItems().isEmpty()) {
        System.err.println("No Webproperties found");
      } else {
        String firstWebpropertyId = properties.getItems().get(0).getId();

        // Query for the list views (profiles) associated with the property.
        Profiles profiles = analytics.management().profiles()
            .list(firstAccountId, firstWebpropertyId).execute();

        if (profiles.getItems().isEmpty()) {
          System.err.println("No views (profiles) found");
        } else {
          // Return the first (view) profile associated with the property.
          profileId = profiles.getItems().get(0).getId();
        }
      }
    }
    return profileId;
  }

  private static GaData getResults(Analytics analytics, String profileId) throws IOException {
    // Query the Core Reporting API for the number of sessions
    // in the past seven days.
    return analytics.data().ga()
        .get("ga:" + profileId, "7daysAgo", "today", "ga:sessions")
        .execute();
  }

  private static void printResults(GaData results) {
    // Parse the response from the Core Reporting API for
    // the profile name and number of sessions.
    if (results != null && !results.getRows().isEmpty()) {
      System.out.println("View (Profile) Name: "
        + results.getProfileInfo().getProfileName());
      System.out.println("Total Sessions: " + results.getRows().get(0).get(0));
    } else {
      System.out.println("No results found");
    }
  }
}

चौथा चरण: सैंपल चलाना

Analytics एपीआई चालू करने के बाद, Java के लिए Google API की क्लाइंट लाइब्रेरी इंस्टॉल करें और सैंपल सोर्स कोड सेट अप करें, ताकि सैंपल चलाने के लिए तैयार हो.

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

  1. इसका इस्तेमाल करके सैंपल कंपाइल करें: 
    javac -classpath /path/to/google/lib/*:/path/to/google/lib/libs/* HelloAnalytics.java
  2. इसका इस्तेमाल करके सैंपल चलाएं: 
    java -classpath ./:/path/to/google/lib/*:/path/to/google/lib/libs/* HelloAnalytics

इन चरणों को पूरा करने के बाद, सैंपल में, अनुमति वाले उपयोगकर्ता के पहले Google Analytics व्यू (प्रोफ़ाइल) का नाम और पिछले सात दिनों के सेशन की संख्या दिखती है.

अनुमति वाले Analytics सेवा ऑब्जेक्ट की मदद से, अब Management API के रेफ़रंस दस्तावेज़ में मिले किसी भी कोड सैंपल को चलाया जा सकता है. उदाहरण के लिए, आपके पास accountSummaries.list तरीके का इस्तेमाल करने के लिए, कोड को बदलने का विकल्प है.