डेवलपर गाइड

इस दस्तावेज़ में बताया गया है कि Google Analytics का डेटा पाने के लिए, रीयल टाइम रिपोर्टिंग एपीआई का इस्तेमाल कैसे करें.

शुरुआती जानकारी

रीयल टाइम रिपोर्टिंग एपीआई की मदद से, अपनी प्रॉपर्टी पर उस समय हो रही गतिविधि की रिपोर्ट की जा सकती है. रीयल-टाइम डेटा को ऐक्सेस करने के लिए, आपको एक ऐसी क्वेरी बनानी होती है जो व्यू (प्रोफ़ाइल) और कम से कम एक मेट्रिक के बारे में बताती हो. अपनी क्वेरी को बेहतर बनाने के लिए, डाइमेंशन और फ़िल्टर जैसे दूसरे क्वेरी पैरामीटर भी दिए जा सकते हैं. यह क्वेरी, Real Time Reporting API को भेजी जाती है, जो डेटा को टेबल के तौर पर दिखाती है.

अगर आपने इस एपीआई का इस्तेमाल पहले कभी नहीं किया है, तो रीयल-टाइम रिपोर्टिंग एपीआई और इससे मिलने वाले डेटा के बारे में जानने के लिए, रीयल टाइम रिपोर्टिंग एपीआई की खास जानकारी पढ़ें.

पहले से आवश्यक

Google Analytics डेटा पाने के लिए, रीयल टाइम रिपोर्टिंग एपीआई का इस्तेमाल करने से पहले:

  • एपीआई के साथ काम करने वाली प्रोग्रामिंग भाषा से जुड़ी खास क्लाइंट लाइब्रेरी की पूरी सूची देखने के लिए, क्लाइंट लाइब्रेरी पेज पढ़ें.
  • Google Analytics का डेटा पाने के लिए, क्लाइंट लाइब्रेरी का इस्तेमाल किए बिना, सिर्फ़ एपीआई इस्तेमाल करने का तरीका जानने के लिए, रेफ़रंस गाइड पढ़ें.

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

  1. Google API (एपीआई) कंसोल में अपना ऐप्लिकेशन रजिस्टर करें.
  2. Google Analytics डेटा के ऐक्सेस की अनुमति दें.
  3. Analytics सेवा ऑब्जेक्ट बनाएं.

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

रीयल टाइम रिपोर्टिंग एपीआई का इस्तेमाल करना

Real Time Reporting API का इस्तेमाल करने के लिए, एक ऐप्लिकेशन:

  1. रीयल टाइम रिपोर्टिंग एपीआई को क्वेरी करता है.
  2. एपीआई रिस्पॉन्स को मैनेज करता है.

रीयल टाइम रिपोर्टिंग एपीआई को क्वेरी करना

Analytics सेवा ऑब्जेक्ट, रीयल-टाइम रिपोर्टिंग एपीआई क्वेरी बनाने का तरीका उपलब्ध कराता है. क्वेरी पैरामीटर और एपीआई में उपलब्ध डेटा के बारे में जानकारी के लिए, इसे पढ़ें:

क्वेरी तय करने के बाद, उसके execute तरीके को कॉल करके Google Analytics के सर्वर पर क्वेरी भेजें.

एपीआई से मिले रिस्पॉन्स को मैनेज करना

अगर Real Time Reporting API की किसी क्वेरी का जवाब मिल जाता है, तो एपीआई, अनुरोध किया गया डेटा, रीयल-टाइम डेटा संसाधन के हिस्से के तौर पर दिखाता है. एपीआई रिस्पॉन्स के स्ट्रक्चर और फ़ॉर्मैट के बारे में ज़्यादा जानने के लिए, रीयल टाइम रिपोर्टिंग एपीआई का रेफ़रंस देखें.

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

कोड के उदाहरण

रीयल टाइम डेटा: पाएं पेज पर मौजूद उदाहरण सेक्शन में, अलग-अलग प्रोग्रामिंग भाषाओं में सैंपल कोड दिया गया है. इसकी मदद से, Real Time Reporting API की क्वेरी की जा सकती है और एपीआई से मिले रिस्पॉन्स को मैनेज किया जा सकता है.

क्वेरी की सीमाएं

रीयल टाइम एपीआई क्वेरी पर ये पाबंदियां हैं:

  • अगर इन डाइमेंशन फ़िल्टर की मदद से, किसी क्वेरी में rt:activeUsers मेट्रिक को शामिल किया जाता है, तो सिर्फ़ AND ऑपरेटर और बराबर संख्या में मैच टाइप (==) का इस्तेमाल किया जा सकता है.
    • rt:goalId
    • rt:eventAction
    • rt:eventCategory
    • rt:eventLabel

    rt:activeUsers मेट्रिक से, सिर्फ़ उन उपयोगकर्ताओं का डेटा इकट्ठा किया जाता है जो फ़िलहाल साइट पर सक्रिय हैं. इसलिए, rt:activeUsers के साथ rt:minutesAgo का इस्तेमाल न करें. इसका मतलब है कि rt:activeUsers का मतलब है कि rt:minutesAgo, 0 है.

  • मेट्रिक फ़िल्टर के लिए कोई सहायता उपलब्ध नहीं है.
  • fields पैरामीटर के लिए कोई सहायता मौजूद नहीं है.

कोटा मैनेजमेंट

जैसा कि सीमाएं और कोटा में बताया गया है, Real Time Reporting API के लिए रोज़ के ऐसे कोटा होते हैं जिन्हें अन्य Google Analytics API के साथ शेयर किया जाता है. अगर रीयल टाइम रिपोर्टिंग एपीआई की पोलिंग छोटी-छोटी अंतराल पर की जा रही है, तो हर दिन की तय सीमा बहुत जल्दी पूरी हो जाती है. ऐसा होने पर, अन्य Google Analytics API के अनुरोध भी तब तक काम करना बंद कर देते हैं, जब तक कि कोटा रीफ़्रेश नहीं किया जाता.

कोटे का इस्तेमाल बहुत तेज़ी से करने के कुछ उदाहरण यहां दिए गए हैं:

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

कोटा का इस्तेमाल कम करने और उसे बेहतर तरीके से मैनेज करने के लिए:

  • सर्वर-साइड कैश मेमोरी का इस्तेमाल करना. जब कई उपयोगकर्ता एक ही रीयल टाइम डेटा के लिए अनुरोध करते हैं, तो आपको हर उपयोगकर्ता के अनुरोध के लिए, रीयल-टाइम रिपोर्टिंग एपीआई से सीधे क्वेरी करने के बजाय, कैश मेमोरी में सेव किया गया जवाब देना चाहिए. इसके बाद, रोज़ के कोटा की सीमाओं को पार करने से बचने के लिए, समय-समय पर सही समय पर रीफ़्रेश करते हुए रीयल टाइम डेटा का इस्तेमाल करके कैश मेमोरी को रीफ़्रेश करते रहें.
  • अतिरिक्त डाइमेंशन तय करके, कई क्वेरी को मिलाएं और सर्वर या क्लाइंट साइड पर रिस्पॉन्स को पार्स करें.
  • रीयल टाइम डेटा के लिए अनुरोध करने का समय अंतराल बढ़ाएं.

उदाहरण: रीफ़्रेश इंटरवल का हिसाब लगाना

अगर आपको रीयल-टाइम डेटा के लिए बार-बार अनुरोध करना है, तो आपको इस्तेमाल के हिसाब से एक सही इंटरवल चुनना चाहिए.

उदाहरण के लिए, किसी एक Google Analytics व्यू (प्रोफ़ाइल) के लिए, हर दिन ज़्यादा से ज़्यादा 10,000 अनुरोध किए जा सकते हैं. एक दिन में, अगर आपको किसी एक व्यू (प्रोफ़ाइल) के लिए Core Reporting API पर 6,000 क्वेरी भेजने की उम्मीद है, तो आपके पास उस व्यू (प्रोफ़ाइल) के लिए 4,000 अनुरोध बचे रहेंगे.

मान लें कि आपने रीयल टाइम रिपोर्टिंग एपीआई का इस्तेमाल करके, ऐसे तीन रीयल-टाइम डैशबोर्ड लागू करने का फ़ैसला लिया है जो एक ही व्यू (प्रोफ़ाइल) से, रीयल-टाइम डेटा के लिए पूरे दिन क्वेरी करते हैं. हर डैशबोर्ड पर हर दिन करीब 1,333 क्वेरी (4,000 क्वेरी / 3 डैशबोर्ड) बनाई जा सकती हैं. एक दिन में 86,400 सेकंड होते हैं. इस तरह, हर डैशबोर्ड के लिए रीफ़्रेश इंटरवल 65 सेकंड (86,400 / 1,333) से ज़्यादा होना चाहिए, ताकि व्यू (प्रोफ़ाइल) के लिए हर दिन के अनुरोधों की कुल संख्या 4,000 से कम हो.