बेहतर कॉन्फ़िगरेशन - Android SDK

इस दस्तावेज़ में Android v3 के लिए Google Analytics SDK की कुछ उन्नत कॉन्फ़िगरेशन सुविधाओं का अवलोकन दिया गया है.

खास जानकारी

Android के लिए Google Analytics SDK टूल, डेटा को सेट करने और Google Analytics को भेजने के लिए, Tracker क्लास देता है. साथ ही, GoogleAnalytics सिंगलटन होता है, जो आपके लागू करने की ग्लोबल कॉन्फ़िगरेशन वैल्यू के लिए इंटरफ़ेस के तौर पर काम करता है.

डेटा लेयर में इवेंट बनाने की प्रोसेस

किसी भी डेटा को मेज़र करने से पहले, आपको Context और Google Analytics प्रॉपर्टी आईडी देकर, GoogleAnalytics सिंगलटन से कम से कम एक ट्रैकर शुरू करना होगा:

// Initialize a tracker using a Google Analytics property ID.
GoogleAnalytics.getInstance(this).getTracker("UA-XXXX-Y")

अब इस ट्रैकर का इस्तेमाल, सेटिंग तय करने और Google Analytics को डेटा भेजने के लिए किया जा सकता है.

डेटा सेट करना और भेजना

Google Analytics को डेटा भेजने के लिए, ट्रैकर पर पैरामीटर-वैल्यू पेयर के मैप सेट करें. साथ ही, उन्हें set और send तरीकों की मदद से भेजें:

/*
 * Send a screen view to Google Analytics by setting a map of parameter
 * values on the tracker and calling send.
 */
Tracker tracker = GoogleAnalytics.getInstance(this).getTracker("UA-XXXX-Y");

HashMap<String, String> hitParameters = new HashMap<String, String>();
hitParameters.put(Fields.HIT_TYPE, "appview");
hitParameters.put(Fields.SCREEN_NAME, "Home Screen");

tracker.send(hitParameters);

MapBuilder क्लास हिट बनाने की प्रोसेस को आसान बनाती है और ज़्यादातर मामलों में इसका सुझाव दिया जाता है. यहां हम कम कोड के साथ वही स्क्रीन व्यू भेज सकते हैं:

// Sending the same screen view hit using MapBuilder.createAppView()
tracker.send(MapBuilder
  .createAppView()
  .set(Fields.SCREEN_NAME, "Home Screen")
  .build()
);

मेज़रमेंट प्रोटोकॉल एम्परसैंड सिंटैक्स

वैल्यू को किसी एक हिट पर भी सेट किया जा सकता है. इसके लिए, Builder या बाद के सभी हिट पर वैल्यू सेट करें. इसके लिए, मेज़रमेंट प्रोटोकॉल के एम्परसैंड सिंटैक्स का इस्तेमाल करके, वैल्यू को ट्रैकर ऑब्जेक्ट पर ही सेट करें:

// Setting the content description field on a single hit using ampersand syntax.
tracker.send(MapBuilder
  .createAppView()
  .set(Fields.SCREEN_NAME, "Home Screen")
  .build()
);

उपलब्ध मेज़रमेंट प्रोटोकॉल पैरामीटर की पूरी सूची के लिए, मेज़रमेंट प्रोटोकॉल पैरामीटर रेफ़रंस देखें.

एक से ज़्यादा हिट पर वैल्यू लागू करना

ट्रैकर पर सीधे सेट की गई कोई भी वैल्यू बनी रहेगी और एक से ज़्यादा हिट पर लागू होगी, जैसा कि इस उदाहरण में दिखाया गया है:

// Set screen name on the tracker to be sent with all hits.
tracker.set(Fields.SCREEN_NAME, "Home Screen");

// Send a screen view for "Home Screen"
tracker.send(MapBuilder
    .createAppView()
    .build()
);

// This event will also be sent with &cd=Home%20Screen.
tracker.send(MapBuilder
    .createEvent("UX", "touch", "menuButton", null)
    .build()
);

// Clear the screen name field when we're done.
tracker.set(Fields.SCREEN_NAME, null);

सिर्फ़ वे वैल्यू, जिन्हें आप एक से ज़्यादा हिट में लागू करना चाहते हैं, सीधे ट्रैकर पर सेट की जानी चाहिए. ट्रैकर पर स्क्रीन का नाम सेट करना फ़ायदेमंद होगा, क्योंकि बाद के स्क्रीन व्यू और इवेंट हिट पर वही वैल्यू लागू की जा सकती है. हालांकि, ट्रैकर पर हिट टाइप जैसी फ़ील्ड को सेट करने का सुझाव नहीं दिया जाता, क्योंकि यह हर हिट के साथ बदल सकता है.

कई ट्रैकर इस्तेमाल करना

एक ही जगह पर लागू करने में एक से ज़्यादा ट्रैकर का इस्तेमाल किया जा सकता है, जो एक से ज़्यादा प्रॉपर्टी को डेटा भेजने के लिए उपयोगी हो सकता है:

Tracker t1 = GoogleAnalytics.getInstance(this).getTracker("UA-XXXX-1");

// Trackers may be named. By default, name is set to the property ID.
Tracker t2 = GoogleAnalytics.getInstance(this).getTracker("altTracker", "UA-XXXX-2";

t1.set(Fields.SCREEN_NAME, "Home Screen");
t2.set(Fields.SCREEN_NAME, getClass().toString());

// Send screen view to UA-XXXX-1.
t1.send(MapBuilder
   .createAppView()
   .build()
);

// Send screen view to UA-XXXX-2.
t2.send(MapBuilder
   .createAppView()
   .build()
);

अपने-आप मेज़रमेंट की सुविधाएं, जैसे कि ऑटोमैटिक स्क्रीन और अपवाद को मेज़र न करने वाली सुविधाएं, Google Analytics को डेटा भेजने के लिए सिर्फ़ एक ट्रैकर का इस्तेमाल करेंगी. अगर इन सुविधाओं का इस्तेमाल किया जा रहा है और आपको दूसरे ट्रैकर का इस्तेमाल करके डेटा भेजना है, तो आपको यह काम मैन्युअल तरीके से करना होगा.

डिफ़ॉल्ट ट्रैकर का इस्तेमाल करना

Google Analytics, एक डिफ़ॉल्ट ट्रैकर बनाए रखता है. शुरू किया गया पहला ट्रैकर, डिफ़ॉल्ट ट्रैकर बन जाता है. हालांकि, उसे बदला भी जा सकता है:

// Tracker t1 becomes the default tracker because it is initialized first.
Tracker t1 = GoogleAnalytics.getInstance(this).getTracker("UA-XXXX-1");
Tracker t2 = GoogleAnalytics.getInstance(this).getTracker("UA-XXXX-2");


// Returns tracker t1.
Tracker defaultTracker = GoogleAnalytics.getInstance(this).getDefaultTracker();

// Hit sent to UA-XXXX-1.
defaultTracker.send(MapBuilder
    .createAppView()
    .set(Fields.SCREEN_NAME, "Home Screen")
    .build()
);

// Override the default tracker.
GoogleAnalytics.getInstance(this).setDefaultTracker(t2);

// Now this call returns tracker t2.
defaultTracker = GoogleAnalytics.getInstance(this).getDefaultTracker();

// Hit sent to UA-XXXX-2.
defaultTracker.send(MapBuilder
    .createAppView()
    .set(Fields.SCREEN_NAME, getClass().toString())
    .build()
);

सैंपलिंग

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

उदाहरण के लिए, EasyTracker और एक्सएमएल के ज़रिए 50% की दर से क्लाइंट-साइड सैंपलिंग चालू करने के लिए, अपनी analytics.xml फ़ाइल में इस पैरामीटर का इस्तेमाल करें:

<string name="ga_sampleFrequency">50.0</string>

किसी ट्रैकर के लिए, प्रोग्राम के हिसाब से क्लाइंट-साइड सैंपलिंग चालू करने के लिए:

mTracker.set(Fields.SAMPLE_RATE, 50.0d);

ऐप्लिकेशन-लेवल से ऑप्ट आउट करना

ऐप्लिकेशन-लेवल पर ऑप्ट आउट फ़्लैग को चालू किया जा सकता है. यह पूरे ऐप्लिकेशन में Google Analytics को बंद कर देगा. ध्यान दें कि हर बार ऐप्लिकेशन के चालू होने पर यह फ़्लैग सेट होना चाहिए और डिफ़ॉल्ट रूप से NO पर सेट होगा.

ऐप्लिकेशन लेवल से ऑप्ट आउट करने की सेटिंग पाने के लिए, इनका इस्तेमाल करें:

boolean isOptedOut = GoogleAnalytics.getInstance(this).getAppOptOut();

ऐप्लिकेशन-लेवल पर ऑप्ट आउट करने के लिए, इनका इस्तेमाल करें:

GoogleAnalytics.getInstance(this).setAppOptOut(true);

लागू करने के सामान्य तरीके में, हो सकता है कि ऐप्लिकेशन SharedPreferences में होने वाले बदलाव की जानकारी दे और उसी हिसाब से Google Analytics की ऑप्ट आउट सेटिंग को अपडेट कर दे:

SharedPreferences userPrefs = PreferenceManager.getDefaultSharedPreferences(this);

userPrefs.registerOnSharedPreferenceChangeListener(new SharedPreferences.OnSharedPreferenceChangeListener () {

  @Override
  public void onSharedPreferenceChanged(SharedPreferences sharedPreferences,
      String key) {

    if (key.equals(TRACKING_PREF_KEY)) {
      GoogleAnalytics.getInstance(getApplicationContext()).setAppOptOut(sharedPreferences.getBoolean(key, false));
    } else {
    // Any additional changed preference handling.
    }
  }
});

जांच और डीबग करना

Android के लिए Google Analytics SDK टूल, टेस्टिंग और डीबगिंग को आसान बनाने के लिए टूल उपलब्ध कराता है.

ड्राई रन

SDK टूल एक dryRun फ़्लैग देता है, जिसे सेट करने पर यह किसी भी डेटा को Google Analytics में भेजे जाने से रोकता है. जब भी आप किसी लागू करने की प्रोसेस की जांच कर रहे हों या उसे डीबग कर रहे हों, तब आपको dryRun फ़्लैग सेट करना चाहिए. साथ ही, अपनी Google Analytics रिपोर्ट में टेस्ट डेटा नहीं दिखाना चाहिए.

ड्राई रन फ़्लैग सेट करने के लिए:

// When dry run is set, hits will not be dispatched, but will still be logged as
// though they were dispatched.
GoogleAnalytics.getInstance(this).setDryRun(true);

लॉगर

Logger इंटरफ़ेस को वर्बोसिटी के इन लेवल पर SDK से मिलने वाले उपयोगी मैसेज मैनेज करने के लिए दिया जाता है: error, warning, info, और verbose.

SDK टूल, स्टैंडर्ड Logger को लागू करता है, जो डिफ़ॉल्ट रूप से कंसोल में सिर्फ़ चेतावनी या गड़बड़ी के मैसेज लॉग करता है. ये मैसेज, Logcat में उपलब्ध होंगे. Logger की कितने शब्दों में जानकारी दी जाए, यह सेट करने के लिए:

// Set the log level to verbose.
GoogleAnalytics.getInstance(this).getLogger()
    .setLogLevel(LogLevel.VERBOSE);

Logger को पसंद के मुताबिक लागू करने की सुविधा का भी इस्तेमाल किया जा सकता है:

// Provide a custom logger.
GoogleAnalytics.getInstance(this).setLogger(new CustomLogger ());

पूरा उदाहरण

नीचे दिए गए उदाहरण में, Google Analytics लागू करने की प्रोसेस शुरू करने और सिंगल स्क्रीन व्यू भेजने के लिए ज़रूरी कोड दिखाया गया है.

package com.example.app;

import com.google.analytics.tracking.android.GAServiceManager;
import com.google.analytics.tracking.android.GoogleAnalytics;
import com.google.analytics.tracking.android.Tracker;

import android.app.Application;
import android.content.SharedPreferences;
import android.preference.PreferenceManager;


/*
 * An advanced Google Analytics implementation may be initialized
 * in a subclass of Application. Note that this example assumes data
 * only needs to be sent to a single Google Analytics property ID.
 */
public class MyApp extends Application {

  private static GoogleAnalytics mGa;
  private static Tracker mTracker;

  /*
   * Google Analytics configuration values.
   */
  // Placeholder property ID.
  private static final String GA_PROPERTY_ID = "UA-XXXX-Y";

  // Dispatch period in seconds.
  private static final int GA_DISPATCH_PERIOD = 30;

  // Prevent hits from being sent to reports, i.e. during testing.
  private static final boolean GA_IS_DRY_RUN = false;

  // GA Logger verbosity.
  private static final LogLevel GA_LOG_VERBOSITY = LogLevel.INFO;

  // Key used to store a user's tracking preferences in SharedPreferences.
  private static final String TRACKING_PREF_KEY = "trackingPreference";


  /*
   * Method to handle basic Google Analytics initialization. This call will not
   * block as all Google Analytics work occurs off the main thread.
   */
  private void initializeGa() {
    mGa = GoogleAnalytics.getInstance(this);
    mTracker = mGa.getTracker(GA_PROPERTY_ID);

    // Set dispatch period.
    GAServiceManager.getInstance().setLocalDispatchPeriod(GA_DISPATCH_PERIOD);

    // Set dryRun flag.
    mGa.setDryRun(GA_IS_DRY_RUN);

    // Set Logger verbosity.
    mGa.getLogger().setLogLevel(GA_LOG_VERBOSITY);

    // Set the opt out flag when user updates a tracking preference.
    SharedPreferences userPrefs = PreferenceManager.getDefaultSharedPreferences(this);
    userPrefs.registerOnSharedPreferenceChangeListener(new SharedPreferences.OnSharedPreferenceChangeListener () {
      @Override
      public void onSharedPreferenceChanged(SharedPreferences sharedPreferences,
          String key) {
        if (key.equals(TRACKING_PREF_KEY)) {
          GoogleAnalytics.getInstance(getApplicationContext()).setAppOptOut(sharedPreferences.getBoolean(key, false));
        }
      }
    });
  }

  @Override
  public void onCreate() {
    super.onCreate();
    initializeGa();
  }

  /*
   * Returns the Google Analytics tracker.
   */
  public static Tracker getGaTracker() {
    return mTracker;
  }

  /*
   * Returns the Google Analytics instance.
   */
  public static GoogleAnalytics getGaInstance() {
    return mGa;
  }
}

इसके बाद, किसी उपयोगकर्ता को पहली स्क्रीन दिखाए जाने पर स्क्रीन व्यू मेज़र किया जाता है:

package com.example.app

import android.app.Activity

/**
 * A simple Activity that sends a screen view to Google Analytics
 * when it is displayed to the user.
 */
public class HomeScreen extends Activity {

  private static final String SCREEN_LABEL = "Home Screen";

  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    // Fields set on a tracker persist for all hits, until they are
    // overridden or cleared by assignment to null.
    MyApp.getGaTracker().set(Fields.SCREEN_NAME, SCREEN_LABEL);
  }

  @Override
  public void onStart() {
    super.onStart();

    // Send a screen view when the Activity is displayed to the user.
    MyApp.getGaTracker().send(MapBuilder
        .createAppView.build());
  }
}