Core Reporting API - रेफ़रंस गाइड

इस दस्तावेज़ में Core Reporting API के वर्शन 3.0 के लिए, क्वेरी और जवाब, दोनों की पूरी जानकारी दी गई है.

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

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

अनुरोध

यह एपीआई, डेटा का अनुरोध करने के लिए एक ही तरीका उपलब्ध कराता है:

analytics.data.ga.get()

यह तरीका अलग-अलग क्लाइंट लाइब्रेरी में दिखाया जाता है और इसमें क्वेरी पैरामीटर सेट करने के लिए, अलग-अलग भाषा के इंटरफ़ेस मौजूद हैं.

इस एपीआई के लिए, REST-full एंडपॉइंट के तौर पर भी क्वेरी की जा सकती है:

Authorization: Bearer {oauth2-token}

GET https://www.googleapis.com/analytics/v3/data/ga
  ?ids=ga:12345
  &start-date=2008-10-01
  &end-date=2008-10-31
  &metrics=ga:sessions,ga:bounces

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

क्वेरी पैरामीटर सारांश

इस टेबल में, उन सभी क्वेरी पैरामीटर की खास जानकारी दी गई है जिन्हें Core Reporting API स्वीकार करता है. ज़्यादा जानकारी के लिए, पैरामीटर के हर नाम पर क्लिक करें.

नाम वैल्यू ज़रूरी है खास जानकारी
ids string हाँ ga:XXXX फ़ॉर्म का यूनीक टेबल आईडी, जहां XXXX Analytics का व्यू (प्रोफ़ाइल) आईडी होता है, जिसके लिए क्वेरी को डेटा हासिल किया जाएगा.
start-date string हाँ Analytics का डेटा फ़ेच करने की शुरू होने की तारीख. अनुरोध शुरू होने की तारीख को YYYY-MM-DD के फ़ॉर्मैट में या मिलते-जुलते तारीख के तौर पर तय कर सकते हैं (जैसे, today, yesterday या NdaysAgo, जहां N एक धनात्मक पूर्णांक है).
end-date string हाँ Analytics का डेटा फ़ेच करने की आखिरी तारीख. अनुरोध खत्म होने की तारीख को YYYY-MM-DD के फ़ॉर्मैट में या मिलते-जुलते तारीख के तौर पर तय कर सकता है (जैसे, today, yesterday या NdaysAgo जहां N एक धनात्मक पूर्णांक है).
metrics string हाँ कॉमा लगाकर अलग की गई मेट्रिक की सूची, जैसे कि ga:sessions,ga:bounces.
dimensions string no आपके Analytics डेटा के लिए, कॉमा लगाकर अलग किए गए डाइमेंशन की सूची, जैसे कि ga:browser,ga:city.
sort string no यह कॉमा लगाकर अलग किए गए डाइमेंशन और मेट्रिक की सूची होती है. इस सूची में, लौटाए गए डेटा को क्रम से लगाने और क्रम से लगाने की दिशा के बारे में बताया जाता है.
filters string no डाइमेंशन या मेट्रिक फ़िल्टर, जो आपके अनुरोध के डेटा को दिखाने पर पाबंदी लगाते हैं.
segment string no आपके अनुरोध के लिए लौटाए गए डेटा को सेगमेंट करता है.
samplingLevel string no पसंदीदा सैंपलिंग लेवल. अनुमति वाली वैल्यू:
  • DEFAULT — जवाब के तौर पर एक सैंपल साइज़ दिखाता है, जो रफ़्तार और सटीक साइज़ के बीच संतुलन बनाता है.
  • FASTER — छोटे साइज़ के सैंपल के साथ तेज़ी से रिस्पॉन्स देता है.
  • HIGHER_PRECISION — यह फ़ंक्शन बड़े सैंपल साइज़ का इस्तेमाल करके, ज़्यादा सटीक रिस्पॉन्स देता है. हालांकि, इस वजह से रिस्पॉन्स मिलने में समय लग सकता है.
include-empty-rows boolean no डिफ़ॉल्ट तौर पर, यह 'सही' पर सेट होता है. अगर यह नीति 'गलत' पर सेट है, तो उन लाइनों को रिस्पॉन्स में शामिल नहीं किया जाएगा जिनमें मेट्रिक की सभी वैल्यू शून्य हैं.
start-index integer no वापस पाने के लिए डेटा की पहली लाइन, 1 से शुरू होती है. इस पैरामीटर का इस्तेमाल, max-results पैरामीटर के साथ, पेज पर नंबर डालने के तरीके के तौर पर करें.
max-results integer no जवाब में शामिल की जाने वाली पंक्तियों की ज़्यादा से ज़्यादा संख्या.
output string no रिस्पॉन्स के तौर पर दिखने वाले Analytics डेटा के लिए, पसंदीदा आउटपुट टाइप. स्वीकार की जाने वाली वैल्यू json और dataTable हैं. डिफ़ॉल्ट: json.
fields string no जवाब में शामिल करने के लिए, फ़ील्ड के सबसेट के बारे में बताने वाला सिलेक्टर.
prettyPrint string no इंडेंट और लाइन ब्रेक के साथ रिस्पॉन्स दिखाता है. डिफ़ॉल्ट false.
userIp string no उस असली उपयोगकर्ता का आईपी पता बताता है जिसके लिए एपीआई कॉल किया जा रहा है. इसका इस्तेमाल, हर आईपी पते के इस्तेमाल की सीमा तय करने के लिए किया जाता है.
quotaUser string no उपयोगकर्ता का आईपी पता मालूम न होने पर, यह userIp का विकल्प होता है.
access_token string no OAuth 2.0 टोकन उपलब्ध कराने का एक तरीका है.
callback string no रिस्पॉन्स को मैनेज करने वाले JavaScript कॉलबैक फ़ंक्शन का नाम. JavaScript JSON-P अनुरोधों में इस्तेमाल किया जाता है.
key string no OAuth 1.0a के लिए अनुमति देने के लिए इस्तेमाल किया जाता है, ताकि कोटा पाने के लिए आपके ऐप्लिकेशन की जानकारी दी जा सके. उदाहरण के लिए: key=AldefliuhSFADSfasdfasdfASdf.

क्वेरी पैरामीटर की जानकारी

ids

ids=ga:12345
ज़रूरी है.
Analytics का डेटा वापस पाने के लिए इस्तेमाल किया जाने वाला यूनीक आईडी. यह आईडी, Analytics व्यू (प्रोफ़ाइल) आईडी के साथ नेमस्पेस ga: को जोड़कर बनाया गया है. व्यू (प्रोफ़ाइल) आईडी को फिर से पाने के लिए, analytics.management.profiles.list तरीके का इस्तेमाल करें. यह तरीका, Google Analytics Management API में व्यू (प्रोफ़ाइल) संसाधन में, id उपलब्ध कराता है.

शुरू होने की तारीख

start-date=2009-04-20
ज़रूरी है.
Analytics से जुड़े सभी डेटा के अनुरोधों में तारीख की सीमा तय की जानी चाहिए. अगर अनुरोध में start-date और end-date पैरामीटर शामिल नहीं किए जाते हैं, तो सर्वर गड़बड़ी दिखाता है. YYYY-MM-DD पैटर्न का इस्तेमाल करके या today, yesterday या NdaysAgo पैटर्न का इस्तेमाल करके, तारीख की वैल्यू किसी खास तारीख के लिए हो सकती हैं. वैल्यू, [0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo) से मेल खानी चाहिए.
सबसे पहले मान्य start-date 2005-01-01 है. शुरू होने की तारीख के लिए, ज़्यादा से ज़्यादा सीमा तय नहीं है.
मिलते-जुलते तारीख, हमेशा क्वेरी के समय की मौजूदा तारीख से जुड़े होते हैं और क्वेरी में बताए गए व्यू (प्रोफ़ाइल) के टाइमज़ोन के हिसाब से होते हैं.

मिलती-जुलती तारीखों का इस्तेमाल करके पिछले सात दिनों (कल से शुरू) की तारीख की सीमा का उदाहरण:

  &start-date=7daysAgo
  &end-date=yesterday

खत्म होने की तारीख

end-date=2009-05-20
ज़रूरी है.
Analytics से जुड़े सभी डेटा के अनुरोधों में तारीख की सीमा तय की जानी चाहिए. अगर अनुरोध में start-date और end-date पैरामीटर शामिल नहीं किए जाते हैं, तो सर्वर गड़बड़ी दिखाता है. YYYY-MM-DD पैटर्न का इस्तेमाल करके या today, yesterday या NdaysAgo पैटर्न का इस्तेमाल करके, तारीख की वैल्यू किसी खास तारीख के लिए हो सकती हैं. वैल्यू, [0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo) से मेल खानी चाहिए.
सबसे पहला मान्य end-date, 2005-01-01 है. end-date के लिए, ज़्यादा से ज़्यादा सीमा लागू नहीं होती है.
मिलते-जुलते तारीख, हमेशा क्वेरी के समय की मौजूदा तारीख से जुड़े होते हैं और क्वेरी में बताए गए व्यू (प्रोफ़ाइल) के टाइमज़ोन के हिसाब से होते हैं.

मिलती-जुलती तारीखों का इस्तेमाल करके, पिछले 10 दिनों (आज से शुरू) की तारीख की सीमा का उदाहरण:

  &start-date=9daysAgo
  &end-date=today

आयाम

dimensions=ga:browser,ga:city
ज़रूरी नहीं.
dimensions पैरामीटर, मेट्रिक को सामान्य शर्तों के हिसाब से बांटता है. उदाहरण के लिए, ga:browser या ga:city के हिसाब से. आप अपनी साइट के पेज व्यू की कुल संख्या के बारे में पूछ सकते हैं. हालांकि, ब्राउज़र के हिसाब से बांटे गए पेज व्यू की संख्या के बारे में पूछना ज़्यादा दिलचस्प हो सकता है. इस मामले में, आपको Firefox, Internet Explorer, Chrome वगैरह से मिले पेज व्यू की संख्या दिखेगी.

डेटा अनुरोध में dimensions का इस्तेमाल करते समय, इन शर्तों का ध्यान रखें:

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


metrics

metrics=ga:sessions,ga:bounces
ज़रूरी है.
आपकी साइट पर उपयोगकर्ताओं की गतिविधि के एग्रीगेट किए गए आंकड़े, जैसे कि क्लिक या पेज व्यू. अगर किसी क्वेरी में dimensions पैरामीटर नहीं है, तो नतीजे के तौर पर दिखने वाली मेट्रिक, अनुरोध की गई तारीख की सीमा के लिए एग्रीगेट वैल्यू दिखाती हैं. जैसे, कुल पेज व्यू या कुल बाउंस. हालांकि, डाइमेंशन का अनुरोध करने पर, वैल्यू को डाइमेंशन वैल्यू के हिसाब से सेगमेंट में बांटा जाता है. उदाहरण के लिए, ga:pageviews से अनुरोध किया गया ga:country हर देश के पेज व्यू की कुल संख्या दिखाता है. मेट्रिक के लिए अनुरोध करते समय, इन बातों का ध्यान रखें:
  • किसी भी अनुरोध में कम से कम एक मेट्रिक दी जानी चाहिए. अनुरोध में सिर्फ़ डाइमेंशन शामिल नहीं किए जा सकते.
  • किसी भी क्वेरी के लिए ज़्यादा से ज़्यादा 10 मेट्रिक दी जा सकती हैं.
  • कई कैटगरी की मेट्रिक के ज़्यादातर कॉम्बिनेशन का एक साथ इस्तेमाल किया जा सकता है, बशर्ते कोई डाइमेंशन न बताया गया हो.
  • किसी मेट्रिक का इस्तेमाल दूसरे डाइमेंशन या मेट्रिक के साथ मिलाकर किया जा सकता है. हालांकि, ऐसा सिर्फ़ तब किया जा सकता है, जब उस मेट्रिक के लिए मान्य कॉम्बिनेशन लागू होते हों. ज़्यादा जानकारी के लिए, डाइमेंशन और मेट्रिक का रेफ़रंस देखें.


क्रम से लगाएं

sort=ga:country,ga:browser
ज़रूरी नहीं.

यह मेट्रिक और डाइमेंशन की सूची होती है. इस सूची में, लौटाए गए डेटा को क्रम से लगाने और क्रम से लगाने की दिशा के बारे में बताया जाता है.

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

क्वेरी के नतीजों को क्रम से लगाने पर, आपको अपने डेटा के बारे में अलग-अलग सवाल पूछने की सुविधा मिलती है. उदाहरण के लिए, "मेरे लोकप्रिय देश कौनसे हैं और वे कौनसे ब्राउज़र सबसे ज़्यादा इस्तेमाल करते हैं?" सवाल के जवाब में नीचे दिए गए पैरामीटर की मदद से क्वेरी बनाई जा सकती है. यह पहले ga:country और फिर ga:browser के मुताबिक, दोनों को बढ़ते क्रम में क्रम में लगाता है:

sort=ga:country,ga:browser

"मेरे टॉप ब्राउज़र कौनसे हैं और किन देशों में इनका सबसे ज़्यादा इस्तेमाल होता है?", इस सवाल का जवाब देने के लिए, इस पैरामीटर की मदद से क्वेरी करें. यह पहले ga:browser और फिर ga:country के हिसाब से क्रम में लगाता है. दोनों को बढ़ते क्रम में लगाया जाता है:
sort=ga:browser,ga:country

sort पैरामीटर का इस्तेमाल करते समय, इन बातों का ध्यान रखें:

  • सिर्फ़ उन डाइमेंशन या मेट्रिक वैल्यू के मुताबिक क्रम से लगाएं जिनका इस्तेमाल आपने dimensions या metrics पैरामीटर में किया है. अगर आपका अनुरोध किसी ऐसे फ़ील्ड पर क्रम से लगाया जाता है जिसे डाइमेंशन या मेट्रिक पैरामीटर में नहीं दिखाया गया है, तो आपको गड़बड़ी मिलेगी.
  • डिफ़ॉल्ट रूप से, en-US स्थान-भाषा में, स्ट्रिंग को वर्णमाला के बढ़ते क्रम में लगाया जाता है.
  • संख्याओं को डिफ़ॉल्ट रूप से बढ़ते हुए क्रम में लगाया जाता है.
  • तारीखों को डिफ़ॉल्ट रूप से, तारीख के हिसाब से बढ़ते क्रम में लगाया जाता है.

फ़िल्टर

filters=ga:medium%3D%3Dreferral
ज़रूरी नहीं.

filters क्वेरी स्ट्रिंग पैरामीटर, आपके अनुरोध से मिले डेटा को सीमित करता है. filters पैरामीटर का इस्तेमाल करने के लिए, फ़िल्टर करने के लिए कोई डाइमेंशन या मेट्रिक दें. इसके बाद, फ़िल्टर एक्सप्रेशन का इस्तेमाल करें. उदाहरण के लिए, यह क्वेरी व्यू (प्रोफ़ाइल) 12134 के लिए ga:pageviews और ga:browser का अनुरोध करती है, जहां ga:browser डाइमेंशन स्ट्रिंग Firefox से शुरू होता है:

https://www.googleapis.com/analytics/v3/data/ga
?ids=ga:12134
&dimensions=ga:browser
&metrics=ga:pageviews
&filters=ga:browser%3D~%5EFirefox
&start-date=2007-01-01
&end-date=2007-12-31

फ़िल्टर की गई क्वेरी, उन लाइनों पर पाबंदी लगाती हैं जिन्हें नतीजे में शामिल किया जाता है या नहीं किया जाता. नतीजे की हर लाइन की जांच, फ़िल्टर के हिसाब से की जाती है: अगर फ़िल्टर मैच करता है, तो लाइन बनी रहती है. साथ ही, लाइन मेल न खाने पर, लाइन को हटा दिया जाता है.

  • यूआरएल को कोड में बदलने का तरीका: Google API की क्लाइंट लाइब्रेरी, फ़िल्टर ऑपरेटर को अपने-आप कोड में बदल देती हैं.
  • डाइमेंशन फ़िल्टर करना: किसी डाइमेंशन को एग्रीगेट करने से पहले, फ़िल्टर किया जाता है. ऐसा इसलिए, ताकि दिखाई गई मेट्रिक सिर्फ़ काम के डाइमेंशन की कुल वैल्यू दिखा सकें. ऊपर दिए गए उदाहरण में, पेज व्यू की संख्या सिर्फ़ वे पेज व्यू होंगे जिनमें Firefox ब्राउज़र है.
  • मेट्रिक फ़िल्टर करना: मेट्रिक के हिसाब से फ़िल्टर करना, एग्रीगेट होने के बाद होता है.
  • मान्य कॉम्बिनेशन: आपके पास उस डाइमेंशन या मेट्रिक के लिए फ़िल्टर करने का विकल्प होता है जो आपकी क्वेरी का हिस्सा नहीं है. हालांकि, इसके लिए ज़रूरी है कि अनुरोध में मौजूद सभी डाइमेंशन/मेट्रिक और फ़िल्टर मान्य कॉम्बिनेशन हों. उदाहरण के लिए, हो सकता है कि आप किसी खास ब्राउज़र पर फ़िल्टर करके, पेज व्यू की तारीख वाली सूची के लिए क्वेरी करना चाहें. ज़्यादा जानकारी के लिए, डाइमेंशन और मेट्रिक का रेफ़रंस देखें.

फ़िल्टर सिंटैक्स


एक फ़िल्टर इस फ़ॉर्म का इस्तेमाल करता है:

ga:name operator expression

इस सिंटैक्स में:

  • name — उस डाइमेंशन या मेट्रिक का नाम जिसके हिसाब से फ़िल्टर करना है. उदाहरण के लिए: पेज व्यू मेट्रिक पर ga:pageviews फ़िल्टर.
  • operator — इस्तेमाल करने के लिए फ़िल्टर के मैच का टाइप तय करता है. ऑपरेटर या तो डाइमेंशन या मेट्रिक के हिसाब से होते हैं.
  • एक्सप्रेशन — नतीजों में शामिल की जाने वाली या उनसे बाहर रखी जाने वाली वैल्यू दिखाता है. एक्सप्रेशन, रेगुलर एक्सप्रेशन के सिंटैक्स का इस्तेमाल करते हैं.

ऑपरेटर फ़िल्टर करें


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

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

मेट्रिक फ़िल्टर
ऑपरेटर ब्यौरा कोड में बदला गया यूआरएल उदाहरण
== Equals %3D%3D ऐसे नतीजे दिखाएं जिनमें पेज पर ठीक 10 सेकंड हो:
filters=ga:timeOnPage%3D%3D10
!= इसके बराबर नहीं है !%3D वे नतीजे दिखाएं जिनमें पेज पर समय दस सेकंड नहीं है:
filters=ga:timeOnPage!%3D10
> इससे ज़्यादा %3E ऐसे नतीजे दिखाएं जब पेज पर समय पूरी तरह से 10 सेकंड से ज़्यादा हो:
filters=ga:timeOnPage%3E10
< इससे कम %3C ऐसे नतीजे दिखाएं जिनमें पेज पर दिखने का समय पूरी तरह से 10 सेकंड से कम हो:
filters=ga:timeOnPage%3C10
>= इससे ज़्यादा या इसके बराबर %3E%3D ऐसे नतीजे दिखाएं जिनमें पेज पर 10 सेकंड या उससे ज़्यादा समय हो:
filters=ga:timeOnPage%3E%3D10
<= इससे कम या इसके बराबर %3C%3D ऐसे नतीजे दिखाएं जिनमें पेज पर समय 10 सेकंड या उससे कम हो:
filters=ga:timeOnPage%3C%3D10

डाइमेंशन फ़िल्टर
ऑपरेटर ब्यौरा कोड में बदला गया यूआरएल उदाहरण
== एग्ज़ैक्ट मैच वाला कीवर्ड %3D%3D एग्रीगेट मेट्रिक जहां शहर अरवाइन है:
filters=ga:city%3D%3DIrvine
!= मिलान नहीं होता है !%3D एग्रीगेट मेट्रिक जहां शहर नहीं है:
filters=ga:city!%3DIrvine
=@ इसमें सबस्ट्रिंग शामिल है %3D@ एग्रीगेट मेट्रिक जहां शहर में यॉर्क शामिल है:
filters=ga:city%3D@York
!@ इसमें सबस्ट्रिंग नहीं है !@ एग्रीगेट मेट्रिक जहां शहर में यॉर्क शामिल नहीं है:
filters=ga:city!@York
=~ इसमें रेगुलर एक्सप्रेशन का मैच शामिल है %3D~ ऐसी एग्रीगेट मेट्रिक जहां शहर की शुरुआत नए से होती है:
filters=ga:city%3D~%5ENew.*
(%5E, यूआरएल है. इसे ^ वर्ण से कोड में बदला गया है, जो पैटर्न को स्ट्रिंग की शुरुआत में ऐंकर करता है.)
!~ रेगुलर एक्सप्रेशन से मेल नहीं खाता !~ एग्रीगेट मेट्रिक जहां शहर की शुरुआत नए से नहीं होती:
filters=ga:city!~%5ENew.*

फ़िल्टर एक्सप्रेशन

फ़िल्टर एक्सप्रेशन के लिए कुछ अहम नियम दिए गए हैं:

  • यूआरएल-रिज़र्व किए गए वर्ण& जैसे वर्ण, सामान्य तरीके से यूआरएल-कोड में बदले जाने चाहिए.
  • रिज़र्व्ड वर्ण — किसी एक्सप्रेशन में दिखने पर, सेमीकोलन और कॉमा बैकस्लैश एस्केप करने चाहिए:
    • सेमीकोलन \;
    • कॉमा \,
  • रेगुलर एक्सप्रेशन=~ और !~ ऑपरेटर का इस्तेमाल करके, फ़िल्टर एक्सप्रेशन में रेगुलर एक्सप्रेशन का इस्तेमाल भी किया जा सकता है. उनका सिंटैक्स, Perl रेगुलर एक्सप्रेशन की तरह ही है. साथ ही, इसमें ये अन्य नियम भी हैं:
    • ज़्यादा से ज़्यादा 128 वर्ण — 128 से ज़्यादा वर्णों वाले रेगुलर एक्सप्रेशन की वजह से, सर्वर से मिला 400 Bad Request स्टेटस कोड मिलता है.
    • केस सेंसिटिविटी — रेगुलर एक्सप्रेशन मैचिंग, केस-इनसेंसिटिव है.

फ़िल्टर संयोजित करना

OR और AND बूलियन लॉजिक का इस्तेमाल करके फ़िल्टर जोड़े जा सकते हैं. इसकी मदद से, किसी फ़िल्टर एक्सप्रेशन की 128 वर्ण की सीमा को असरदार तरीके से बढ़ाया जा सकता है.

OR

OR ऑपरेटर को कॉमा (,) का इस्तेमाल करके तय किया जाता है. इसे AND ऑपरेटर के मुकाबले प्राथमिकता दी जाती है. इसका इस्तेमाल एक ही एक्सप्रेशन में डाइमेंशन और मेट्रिक को जोड़ने के लिए नहीं किया जा सकता.

उदाहरण: (हर यूआरएल, कोड में बदला हुआ होना चाहिए)

देश इनमें से कोई एक है (अमेरिका OR कनाडा):
ga:country==United%20States,ga:country==Canada

(Windows या Macintosh) ऑपरेटिंग सिस्टम पर Firefox के उपयोगकर्ता:
ga:browser==Firefox;ga:operatingSystem==Windows,ga:operatingSystem==Macintosh

AND

AND ऑपरेटर को सेमी-कोलन (;) का इस्तेमाल करके तय किया जाता है. यह OR ऑपरेटर के पहले आता है. साथ ही, इसका इस्तेमाल एक ही एक्सप्रेशन में डाइमेंशन और मेट्रिक को जोड़ने के लिए किया जा सकता है.

उदाहरण: (हर यूआरएल, कोड में बदला हुआ होना चाहिए)

देश अमेरिका है और ब्राउज़र Firefox है:
ga:country==United%20States;ga:browser==Firefox

देश अमेरिका है और भाषा 'en' से शुरू नहीं होती है:
ga:country==United%20States;ga:language!~^en.*

ऑपरेटिंग सिस्टम (Windows या Macintosh) है और ब्राउज़र (Firefox या Chrome) है:
ga:operatingSystem==Windows,ga:operatingSystem==Macintosh;ga:browser==Firefox,ga:browser==Chrome

देश अमेरिका है और सेशन 5 से ज़्यादा हैं:
ga:country==United%20States;ga:sessions>5



सेगमेंट

segment=gaid::-10
segment=sessions::condition::ga:medium%3D%3Dreferral
segment=users::condition::ga:browser%3D%3DChrome
ज़रूरी नहीं.

Core Reporting API में किसी सेगमेंट का अनुरोध करने के तरीके से जुड़ी पूरी जानकारी के लिए, सेगमेंट की जानकारी देने वाली गाइड देखें.

सेगमेंट की सैद्धांतिक खास जानकारी के लिए, सहायता केंद्र में सेगमेंट सुविधा की जानकारी और सेगमेंट देखें.

सेगमेंट में मौजूद डाइमेंशन और मेट्रिक की अनुमति है.
सेगमेंट में सभी डाइमेंशन और मेट्रिक इस्तेमाल नहीं किए जा सकते. सेगमेंट में किन डाइमेंशन और मेट्रिक की अनुमति है, यह देखने के लिए डाइमेंशन और मेट्रिक्स एक्सप्लोरर पर जाएं.


samplingLevel

samplingLevel=DEFAULT
ज़रूरी नहीं.
इस पैरामीटर का इस्तेमाल करके, किसी रिपोर्टिंग क्वेरी के लिए सैंपलिंग का लेवल (जैसे, नतीजे की गिनती करने के लिए इस्तेमाल किए गए सेशन की संख्या) सेट करें. स्वीकार की गई वैल्यू, वेब इंटरफ़ेस के मुताबिक होती हैं. इनमें ये शामिल हैं:
  • DEFAULT — जवाब के तौर पर एक सैंपल साइज़ दिखाता है, जो रफ़्तार और सटीक साइज़ के बीच संतुलन बनाता है.
  • FASTER — छोटे साइज़ के सैंपल के साथ तेज़ी से रिस्पॉन्स देता है.
  • HIGHER_PRECISION — यह फ़ंक्शन बड़े सैंपल साइज़ का इस्तेमाल करके, ज़्यादा सटीक रिस्पॉन्स देता है. हालांकि, इस वजह से रिस्पॉन्स मिलने में समय लग सकता है.
अगर डेटा नहीं दिया जाता है, तो DEFAULT के सैंपल लेवल का इस्तेमाल किया जाएगा.
किसी क्वेरी के लिए इस्तेमाल किए गए सेशन के प्रतिशत की गिनती करने का तरीका जानने के लिए, सैंपलिंग सेक्शन देखें.

खाली पंक्तियाँ शामिल करें

include-empty-rows=true
ज़रूरी नहीं.
डिफ़ॉल्ट रूप से सही पर सेट होता है. अगर यह नीति गलत पर सेट होती है, तो जिन पंक्तियों में मेट्रिक की सभी वैल्यू शून्य होती हैं उन्हें रिस्पॉन्स में शामिल नहीं किया जाता. उदाहरण के लिए, अगर किसी क्वेरी में एक से ज़्यादा मेट्रिक शामिल की जाती हैं, तो पंक्तियां सिर्फ़ तब हटाई जाती हैं, जब सभी मेट्रिक की वैल्यू शून्य हो. यह तब काम का हो सकता है, जब अनुरोध करते समय यह उम्मीद की जाती हो कि मान्य पंक्तियों की संख्या, डाइमेंशन वैल्यू की अनुमानित संख्या से काफ़ी कम है.

start-index

start-index=10
ज़रूरी नहीं.
अगर दिया नहीं गया है, तो शुरुआती इंडेक्स 1 है. (नतीजों के इंडेक्स, 1 पर आधारित होते हैं. इसका मतलब है कि पहली लाइन, 1 है, न कि 0 लाइन.) जब totalResults की संख्या 10,000 से ज़्यादा हो जाती है और आपको 10,001 या उसके बाद इंडेक्स की गई लाइनों को फिर से हासिल करना है, तब max-results पैरामीटर के साथ-साथ इस पैरामीटर का इस्तेमाल, पेज पर नंबर डालने के तरीके के तौर पर करें.

max-results

max-results=100
ज़रूरी नहीं.
इस जवाब में शामिल की जाने वाली पंक्तियों की ज़्यादा से ज़्यादा संख्या. एलिमेंट के सबसेट को फिर से पाने के लिए, इसे start-index के साथ इस्तेमाल किया जा सकता है. इसके अलावा, पहले एलिमेंट से शुरू करते हुए, लौटाए गए एलिमेंट की संख्या को सीमित करने के लिए, इसका इस्तेमाल किया जा सकता है. अगर max-results नहीं दिया जाता है, तो क्वेरी डिफ़ॉल्ट तौर पर ज़्यादा से ज़्यादा 1,000 पंक्तियां दिखाती है.
Analytics Core Reporting API के हर अनुरोध में ज़्यादा से ज़्यादा 10,000 लाइनें दिखती हैं. भले ही, आपने कितनी भी लाइनें मांगी हों. अगर आपकी उम्मीद के मुताबिक डाइमेंशन सेगमेंट नहीं हैं, तो हो सकता है कि नतीजे में अनुरोध के मुकाबले कम लाइनें दिखें. उदाहरण के लिए, ga:country के लिए 300 से कम वैल्यू हो सकती हैं. इसलिए, सिर्फ़ देश के हिसाब से सेगमेंट करते समय, max-results को ज़्यादा वैल्यू पर सेट करने के बाद भी 300 से ज़्यादा लाइनें नहीं मिल सकतीं.

आउटपुट

output=dataTable
ज़रूरी नहीं.
इस पैरामीटर का इस्तेमाल करके, रिस्पॉन्स में दिखाए गए Analytics डेटा का आउटपुट टाइप सेट करें. मंज़ूर किए गए मान ये हैं:
  • json — रिस्पॉन्स में डिफ़ॉल्ट rows प्रॉपर्टी देता है, जिसमें एक JSON ऑब्जेक्ट होता है.
  • dataTable — रिस्पॉन्स में, dataTable प्रॉपर्टी दिखाता है, जिसमें डेटा टेबल ऑब्जेक्ट होता है. इस Data Table ऑब्जेक्ट को सीधे Google चार्ट विज़ुअलाइज़ेशन के साथ इस्तेमाल किया जा सकता है.
अगर डेटा नहीं दिया जाता है, तो डिफ़ॉल्ट JSON रिस्पॉन्स का इस्तेमाल किया जाएगा.

फ़ील्ड्स

fields=rows,columnHeaders(name,dataType)
ज़रूरी नहीं.

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

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

  • एक से ज़्यादा फ़ील्ड चुनने के लिए, कॉमा-सेपरेटेड लिस्ट का इस्तेमाल करें.
  • फ़ील्ड a में नेस्ट किए गए फ़ील्ड b को चुनने के लिए, a/b का इस्तेमाल करें. b में नेस्ट किए गए फ़ील्ड c को चुनने के लिए, a/b/c का इस्तेमाल करें.
  • सब-सिलेक्टर का इस्तेमाल करके, अरे या ऑब्जेक्ट के खास सब-फ़ील्ड के सेट का अनुरोध करें. इसके लिए, ब्रैकेट "( )" में एक्सप्रेशन रखें.
    उदाहरण के लिए: fields=columnHeaders(name,dataType), columnHeaders कलेक्शन में सिर्फ़ name और dataType फ़ील्ड दिखाता है. आपके पास एक सब-फ़ील्ड भी जोड़ने का विकल्प होता है, जहां fields=columnHeader(name), fields=columnHeader/name के बराबर होता है.

prettyPrint

prettyPrint=false
ज़रूरी नहीं.

अगर true होता है, तो इस फ़ॉर्मैट में जवाब देता है जिसे कोई भी व्यक्ति आसानी से पढ़ सके. डिफ़ॉल्ट वैल्यू: false.


quotaUser

quotaUser=4kh4r2h4
ज़रूरी नहीं.

उपयोगकर्ता के आईपी पते की जानकारी न होने पर भी, आपको सर्वर साइड ऐप्लिकेशन से हर उपयोगकर्ता के लिए कोटा लागू करने की सुविधा मिलती है. उदाहरण के लिए, ऐसा उन ऐप्लिकेशन में हो सकता है जो उपयोगकर्ता की ओर से App Engine पर क्रॉन जॉब चलाते हैं. कोई भी ऐसी आर्बिट्रेरी स्ट्रिंग चुनी जा सकती है जिससे किसी उपयोगकर्ता की खास पहचान होती हो. हालांकि, उस स्ट्रिंग में 40 से ज़्यादा वर्ण नहीं होने चाहिए.

अगर दोनों दिए जाते हैं, तो यह userIp को बदल देता है.


जवाब

अनुरोध पूरा होने पर, यह रिस्पॉन्स का मुख्य हिस्सा दिखाता है. इसमें, नीचे बताए गए JSON स्ट्रक्चर का इस्तेमाल किया जाता है. अगर आउटपुट पैरामीटर dataTable पर सेट है, तो अनुरोध, रिस्पॉन्स का मुख्य हिस्सा दिखाता है. इसमें JSON (डेटा टेबल) का स्ट्रक्चर होता है, जिसके बारे में नीचे बताया गया है.

ध्यान दें: "नतीजे" शब्द का मतलब क्वेरी से मैच करने वाली लाइनों के पूरे सेट से है, जबकि "रिस्पॉन्स" का मतलब नतीजों के मौजूदा पेज पर दिखने वाली लाइनों के सेट से है. अगर नतीजों की कुल संख्या, मौजूदा रिस्पॉन्स के लिए पेज के साइज़ से ज़्यादा है, तो ये अलग-अलग हो सकते हैं. इस बारे में, itemsPerPage में बताया गया है.

JSON
{
  "kind": "analytics#gaData",
  "id": string,
  "selfLink": string,
  "containsSampledData": boolean,
  "query": {
    "start-date": string,
    "end-date": string,
    "ids": string,
    "dimensions": [
      string
    ],
    "metrics": [
      string
    ],
    "include-empty-rows": boolean
    "samplingLevel": string,
    "sort": [
      string
    ],
    "filters": string,
    "segment": string,
    "start-index": integer,
    "max-results": integer
  },
  "itemsPerPage": integer,
  "totalResults": integer,
  "previousLink": string,
  "nextLink": string,
  "profileInfo": {
    "profileId": string,
    "accountId": string,
    "webPropertyId": string,
    "internalWebPropertyId": string,
    "profileName": string,
    "tableId": string
  },
  "columnHeaders": [
    {
      "name": string,
      "columnType": string,
      "dataType": string
    }
  ],
  "rows": [
    [
      string
    ]
  ],
  "sampleSize": string,
  "sampleSpace": string,
  "totalsForAllResults": [
    {
      metricName: string,
      ...
    }
  ]
}

जवाब के फ़ील्ड

रिस्पॉन्स बॉडी स्ट्रक्चर के गुणों को इस तरह परिभाषित किया गया है:

प्रॉपर्टी का नाम वैल्यू ब्यौरा
kind string संसाधन किस तरह का है. वैल्यू "analytics#gaData" है.
id string इस डेटा रिस्पॉन्स के लिए आईडी.
query object इस ऑब्जेक्ट में, क्वेरी को पैरामीटर के तौर पर पास की गई सभी वैल्यू शामिल हैं. हर फ़ील्ड का मतलब उससे जुड़े क्वेरी पैरामीटर के ब्यौरे में बताया जाता है.
query.start-date string शुरू होने की तारीख.
query.end-date string खत्म होने की तारीख.
query.ids string यूनीक टेबल आईडी.
query.dimensions[] list Analytics डाइमेंशन की सूची.
query.metrics[] list आंकड़ों की मेट्रिक की सूची.
query.samplingLevel string Requested sampling level.
query.include-empty-rows boolean डिफ़ॉल्ट तौर पर, यह सही पर सेट होता है. अगर यह नीति गलत पर सेट होती है, तो जिन पंक्तियों में मेट्रिक की सभी वैल्यू शून्य होती हैं उन्हें जवाब में शामिल नहीं किया जाता.
query.sort[] list उन मेट्रिक या डाइमेंशन की सूची जिन पर डेटा को क्रम से लगाया गया है.
query.filters string मेट्रिक या डाइमेंशन फ़िल्टर की कॉमा-सेपरेटेड लिस्ट.
query.segment string Analytics सेगमेंट.
query.start-index integer इंडेक्स शुरू करें.
query.max-results integer हर पेज पर ज़्यादा से ज़्यादा नतीजे.
startIndex integer पंक्तियों का शुरुआती इंडेक्स, जिसे start-index क्वेरी पैरामीटर से तय किया जाता है. डिफ़ॉल्ट वैल्यू 1 है.
itemsPerPage integer जवाब में ज़्यादा से ज़्यादा कितनी पंक्तियां हो सकती हैं, इससे कोई फ़र्क़ नहीं पड़ता कि जवाब में कितनी पंक्तियां मौजूद हैं. अगर max-results क्वेरी पैरामीटर के बारे में बताया गया है, तो itemsPerPage की वैल्यू, max-results या 10,000 से कम होगी. itemsPerPage की डिफ़ॉल्ट वैल्यू 1000 है.
totalResults integer क्वेरी के नतीजे में लाइनों की कुल संख्या, चाहे जवाब के तौर पर कितनी भी लाइनें दिखाई गई हों. जिन क्वेरी में बहुत ज़्यादा पंक्तियां होती हैं, उनके लिए totalResults की वैल्यू itemsPerPage से ज़्यादा हो सकती है. बड़ी क्वेरी के लिए, totalResults और itemsPerPage के बारे में ज़्यादा जानने के लिए, पेजिंग देखें.
startDate string डेटा क्वेरी के शुरू होने की तारीख, जैसा कि start-date पैरामीटर में बताया गया है.
endDate string डेटा क्वेरी के खत्म होने की तारीख, जिसे end-date पैरामीटर में बताया गया हो.
profileInfo object उस व्यू (प्रोफ़ाइल) के बारे में जानकारी, जिसके लिए डेटा का अनुरोध किया गया था. व्यू (प्रोफ़ाइल) का डेटा, Google Analytics Management API के ज़रिए उपलब्ध है.
profileInfo.profileId string प्रोफ़ाइल आईडी देखें, जैसे कि 1174.
profileInfo.accountId string वह खाता आईडी जिससे यह व्यू (प्रोफ़ाइल) जुड़ा है, जैसे कि 30481.
profileInfo.webPropertyId string वेब प्रॉपर्टी आईडी, जिससे यह व्यू (प्रोफ़ाइल) जुड़ा है, जैसे कि UA-30481-1.
profileInfo.internalWebPropertyId string उस वेब प्रॉपर्टी की आंतरिक आईडी जिससे यह व्यू (प्रोफ़ाइल) जुड़ा है, जैसे कि UA-30481-1.
profileInfo.profileName string व्यू का नाम (प्रोफ़ाइल).
profileInfo.tableId string व्यू (प्रोफ़ाइल) के लिए टेबल आईडी, जिसमें "ga:" के बाद व्यू (प्रोफ़ाइल) आईडी शामिल होता है.
containsSampledData boolean अगर जवाब में सैंपल डेटा शामिल है, तो वैल्यू 'सही' होगी.
sampleSize string सैंपल डेटा को कैलकुलेट करने के लिए, इस्तेमाल किए गए सैंपल की संख्या.
sampleSpace string सैंपलिंग स्पेस का कुल साइज़. यह सैंपल स्पेस का उपलब्ध कुल साइज़ बताता है, जिससे सैंपल चुने गए थे.
columnHeaders[] list ऐसे कॉलम हेडर जिनमें डाइमेंशन के नाम के बाद, मेट्रिक के नाम होते हैं. डाइमेंशन और मेट्रिक का क्रम वही होता है जो metrics और dimensions पैरामीटर के ज़रिए अनुरोध में तय किया गया होता है. हेडर की संख्या, डाइमेंशन की संख्या और मेट्रिक की संख्या होती है.
columnHeaders[].name string डाइमेंशन या मेट्रिक का नाम.
columnHeaders[].columnType string कॉलम का टाइप. "DIMENSION" या "METRIC".
columnHeaders[].dataType string डेटा टाइप. डाइमेंशन कॉलम के हेडर में डेटा टाइप के तौर पर सिर्फ़ STRING होने चाहिए. मेट्रिक कॉलम हेडर में INTEGER, PERCENT, TIME, CURRENCY, FLOAT वगैरह जैसी मेट्रिक वैल्यू के लिए, डेटा टाइप होते हैं. सभी संभावित डेटा टाइप के लिए, मेटाडेटा एपीआई रिस्पॉन्स देखें.
totalsForAllResults object अनुरोध की गई मेट्रिक की कुल वैल्यू, मेट्रिक के नामों और वैल्यू के की-वैल्यू पेयर के तौर पर. मेट्रिक की कुल संख्या का क्रम अनुरोध में बताए गए मेट्रिक के क्रम के जैसा ही होता है.
rows[] list Analytics की डेटा लाइन, जहां हर लाइन में डाइमेंशन वैल्यू की सूची और उसके बाद मेट्रिक वैल्यू होती हैं. डाइमेंशन और मेट्रिक का क्रम वही है जो अनुरोध में बताया गया है. हर लाइन में N फ़ील्ड की सूची होती है. इसमें N = डाइमेंशन की संख्या + मेट्रिक की संख्या होती है.
JSON (डेटा टेबल)
{
  "kind": "analytics#gaData",
  "id": string,
  "selfLink": string,
  "containsSampledData": boolean,
  "query": {
    "start-date": string,
    "end-date": string,
    "ids": string,
    "dimensions": [
      string
    ],
    "metrics": [
      string
    ],
    "samplingLevel": string,
    "include-empty-rows": boolean,
    "sort": [
      string
    ],
    "filters": string,
    "segment": string,
    "start-index": integer,
    "max-results": integer
  },
  "itemsPerPage": integer,
  "totalResults": integer,
  "previousLink": string,
  "nextLink": string,
  "profileInfo": {
    "profileId": string,
    "accountId": string,
    "webPropertyId": string,
    "internalWebPropertyId": string,
    "profileName": string,
    "tableId": string
  },
  "columnHeaders": [
    {
      "name": string,
      "columnType": string,
      "dataType": string
    }
  ],
  "dataTable": {
    "cols": [
      {
        "id": string,
        "label": string,
        "type": string
      }
    ],
    "rows": [
      {
        "c": [
          {    
            "v": string
          }
        ]
      }   
    ]
  },
  "sampleSize": string,
  "sampleSpace": string,
  "totalsForAllResults": [
    {
      metricName: string,
      ...
    }
  ]
}

जवाब के फ़ील्ड

रिस्पॉन्स बॉडी स्ट्रक्चर के गुणों को इस तरह परिभाषित किया गया है:

प्रॉपर्टी का नाम वैल्यू ब्यौरा
kind string संसाधन किस तरह का है. वैल्यू "analytics#gaData" है.
id string इस डेटा रिस्पॉन्स के लिए आईडी.
query object इस ऑब्जेक्ट में, क्वेरी को पैरामीटर के तौर पर पास की गई सभी वैल्यू शामिल हैं. हर फ़ील्ड का मतलब उससे जुड़े क्वेरी पैरामीटर के ब्यौरे में बताया जाता है.
query.start-date string शुरू होने की तारीख.
query.end-date string खत्म होने की तारीख.
query.ids string यूनीक टेबल आईडी.
query.dimensions[] list Analytics डाइमेंशन की सूची.
query.metrics[] list आंकड़ों की मेट्रिक की सूची.
query.samplingLevel string Requested sampling level.
query.include-empty-rows boolean डिफ़ॉल्ट तौर पर, यह सही पर सेट होता है. अगर यह नीति गलत पर सेट होती है, तो जिन पंक्तियों में मेट्रिक की सभी वैल्यू शून्य होती हैं उन्हें जवाब में शामिल नहीं किया जाता.
query.sort[] list उन मेट्रिक या डाइमेंशन की सूची जिन पर डेटा को क्रम से लगाया गया है.
query.filters string मेट्रिक या डाइमेंशन फ़िल्टर की कॉमा-सेपरेटेड लिस्ट.
query.segment string Analytics सेगमेंट.
query.start-index integer इंडेक्स शुरू करें.
query.max-results integer हर पेज पर ज़्यादा से ज़्यादा नतीजे.
startIndex integer पंक्तियों का शुरुआती इंडेक्स, जिसे start-index क्वेरी पैरामीटर से तय किया जाता है. डिफ़ॉल्ट वैल्यू 1 है.
itemsPerPage integer जवाब में ज़्यादा से ज़्यादा कितनी पंक्तियां हो सकती हैं, इससे कोई फ़र्क़ नहीं पड़ता कि जवाब में कितनी पंक्तियां मौजूद हैं. अगर max-results क्वेरी पैरामीटर के बारे में बताया गया है, तो itemsPerPage की वैल्यू, max-results या 10,000 से कम होगी. itemsPerPage की डिफ़ॉल्ट वैल्यू 1000 है.
totalResults integer क्वेरी के नतीजे में लाइनों की कुल संख्या, चाहे जवाब के तौर पर कितनी भी लाइनें दिखाई गई हों. जिन क्वेरी में बहुत ज़्यादा पंक्तियां होती हैं, उनके लिए totalResults की वैल्यू itemsPerPage से ज़्यादा हो सकती है. बड़ी क्वेरी के लिए, totalResults और itemsPerPage के बारे में ज़्यादा जानने के लिए, पेजिंग देखें.
startDate string डेटा क्वेरी के शुरू होने की तारीख, जैसा कि start-date पैरामीटर में बताया गया है.
endDate string डेटा क्वेरी के खत्म होने की तारीख, जिसे end-date पैरामीटर में बताया गया हो.
profileInfo object उस व्यू (प्रोफ़ाइल) के बारे में जानकारी, जिसके लिए डेटा का अनुरोध किया गया था. व्यू (प्रोफ़ाइल) का डेटा, Google Analytics Management API के ज़रिए उपलब्ध है.
profileInfo.profileId string प्रोफ़ाइल आईडी देखें, जैसे कि 1174.
profileInfo.accountId string वह खाता आईडी जिससे यह व्यू (प्रोफ़ाइल) जुड़ा है, जैसे कि 30481.
profileInfo.webPropertyId string वेब प्रॉपर्टी आईडी, जिससे यह व्यू (प्रोफ़ाइल) जुड़ा है, जैसे कि UA-30481-1.
profileInfo.internalWebPropertyId string उस वेब प्रॉपर्टी की आंतरिक आईडी जिससे यह व्यू (प्रोफ़ाइल) जुड़ा है, जैसे कि UA-30481-1.
profileInfo.profileName string व्यू का नाम (प्रोफ़ाइल).
profileInfo.tableId string व्यू (प्रोफ़ाइल) के लिए टेबल आईडी, जिसमें "ga:" के बाद व्यू (प्रोफ़ाइल) आईडी शामिल होता है.
containsSampledData boolean अगर जवाब में सैंपल डेटा शामिल है, तो वैल्यू 'सही' होगी.
sampleSize string सैंपल डेटा को कैलकुलेट करने के लिए, इस्तेमाल किए गए सैंपल की संख्या.
sampleSpace string सैंपलिंग स्पेस का कुल साइज़. यह सैंपल स्पेस का उपलब्ध कुल साइज़ बताता है, जिससे सैंपल चुने गए थे.
columnHeaders[] list ऐसे कॉलम हेडर जिनमें डाइमेंशन के नाम के बाद, मेट्रिक के नाम होते हैं. डाइमेंशन और मेट्रिक का क्रम वही होता है जो metrics और dimensions पैरामीटर के ज़रिए अनुरोध में तय किया गया होता है. हेडर की संख्या, डाइमेंशन की संख्या और मेट्रिक की संख्या होती है.
columnHeaders[].name string डाइमेंशन या मेट्रिक का नाम.
columnHeaders[].columnType string कॉलम का टाइप. "DIMENSION" या "METRIC".
columnHeaders[].dataType string डेटा टाइप. डाइमेंशन कॉलम के हेडर में डेटा टाइप के तौर पर सिर्फ़ STRING होने चाहिए. मेट्रिक कॉलम हेडर में INTEGER, PERCENT, TIME, CURRENCY, FLOAT वगैरह जैसी मेट्रिक वैल्यू के लिए, डेटा टाइप होते हैं. सभी संभावित डेटा टाइप के लिए, मेटाडेटा एपीआई रिस्पॉन्स देखें.
totalsForAllResults object अनुरोध की गई मेट्रिक की कुल वैल्यू, मेट्रिक के नामों और वैल्यू के की-वैल्यू पेयर के तौर पर. मेट्रिक की कुल संख्या का क्रम अनुरोध में बताए गए मेट्रिक के क्रम के जैसा ही होता है.
dataTable object एक डेटा टेबल ऑब्जेक्ट, जिसे Google चार्ट के साथ इस्तेमाल किया जा सकता है.
dataTable.cols[] list डाइमेंशन के कॉलम डिस्क्रिप्टर की सूची और उसके बाद मेट्रिक. डाइमेंशन और मेट्रिक का क्रम वही होता है जो metrics और dimensions पैरामीटर की मदद से, अनुरोध में बताए गए होते हैं. कॉलम की संख्या, डाइमेंशन की संख्या + मेट्रिक की संख्या होती है.
dataTable.cols[].id string ऐसा आईडी जिसका इस्तेमाल किसी खास कॉलम के बारे में बताने के लिए किया जा सकता है. कॉलम इंडेक्स के विकल्प के तौर पर इसका इस्तेमाल किया जा सकता है. डाइमेंशन या मेट्रिक आईडी का इस्तेमाल, इस वैल्यू को सेट करने के लिए किया जाता है.
dataTable.cols[].label string कॉलम के लिए एक लेबल (जो किसी विज़ुअलाइज़ेशन में दिखाया जा सकता है). डाइमेंशन या मेट्रिक आईडी का इस्तेमाल, यह वैल्यू सेट करने के लिए किया जाता है.
dataTable.cols[].type string इस कॉलम के लिए डेटा टाइप.
dataTable.rows[] list डेटा टेबल फ़ॉर्मैट में Analytics डेटा की पंक्तियां, जहां हर पंक्ति एक ऑब्जेक्ट है. इसमें डाइमेंशन के लिए सेल की वैल्यू की सूची के बाद, मेट्रिक होती हैं. डाइमेंशन और मेट्रिक का क्रम वही है जो अनुरोध में बताया गया है. हर सेल में N फ़ील्ड की सूची होती है, जहां N = डाइमेंशन की संख्या + मेट्रिक की संख्या होती है.

गड़बड़ी कोड

अनुरोध पूरा होने पर, Core Reporting API की मदद से 200 एचटीटीपी स्टेटस कोड दिखता है. अगर किसी क्वेरी को प्रोसेस करने के दौरान कोई गड़बड़ी होती है, तो एपीआई गड़बड़ी का कोड और जानकारी दिखाता है. Analytics एपीआई का इस्तेमाल करने वाले हर ऐप्लिकेशन के लिए, गड़बड़ी को ठीक करने का सही तरीका लागू करना ज़रूरी है. गड़बड़ी के कोड और उन्हें ठीक करने के तरीके के बारे में जानने के लिए, गड़बड़ी के जवाबों से जुड़ी गाइड पढ़ें.

इसे आज़माएं!

आपके पास Core Reporting API की क्वेरी आज़माने का विकल्प है.

  • किसी क्वेरी में मेट्रिक और डाइमेंशन के मान्य कॉम्बिनेशन देखने के लिए, क्वेरी एक्सप्लोरर में पैरामीटर के लिए सैंपल वैल्यू डालें. सैंपल क्वेरी के नतीजों को टेबल के तौर पर दिखाया जाता है. इसमें, सभी तय की गई मेट्रिक और डाइमेंशन के लिए वैल्यू शामिल होती हैं.

  • लाइव डेटा का अनुरोध करने और JSON फ़ॉर्मैट में रिस्पॉन्स देखने के लिए, Google Data API एक्सप्लोरर में analytics.data.ga.get तरीके का इस्तेमाल करें.

सैंपलिंग

Google Analytics, डाइमेंशन और मेट्रिक के कुछ कॉम्बिनेशन को तुरंत कैलकुलेट करता है. सही समय पर डेटा दिखाने के लिए, Google Analytics, डेटा के सिर्फ़ एक सैंपल को प्रोसेस कर सकता है.

किसी अनुरोध के लिए इस्तेमाल करने के लिए, सैंपलिंग का लेवल तय किया जा सकता है. ऐसा करने के लिए, samplingLevel पैरामीटर को सेट करें.

अगर कोर रिपोर्टिंग एपीआई के रिस्पॉन्स में सैंपल किया गया डेटा शामिल है, तो containsSampledData रिस्पॉन्स फ़ील्ड, true होगा. इसके अलावा, दो प्रॉपर्टी में क्वेरी के सैंपल के लेवल की जानकारी मिलेगी: sampleSize और sampleSpace. इन दो वैल्यू की मदद से, क्वेरी के लिए इस्तेमाल हुए सेशन के प्रतिशत का हिसाब लगाया जा सकता है. उदाहरण के लिए, अगर sampleSize 201,000 है और sampleSpace 220,000 है, तो रिपोर्ट (2,01,000 / 2,20,000) * 100 = 91.36% सेशन पर आधारित होगी.

सैंपलिंग के बारे में सामान्य जानकारी और Google Analytics में इसका इस्तेमाल कैसे किया जाता है, इसके बारे में जानने के लिए सैंपलिंग देखें.


डेटा से जुड़े बड़े नतीजों को मैनेज करना

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

प्रति क्वेरी आयाम कम करना

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

तारीख की सीमा के हिसाब से क्वेरी को बांटना

तारीख की एक लंबी सीमा के नतीजों को, तारीख के हिसाब से तय करने के बजाय, एक बार में एक हफ़्ते या एक दिन के लिए अलग-अलग क्वेरी बनाएं. हालांकि, बड़े डेटा सेट के लिए, किसी एक दिन के डेटा का अनुरोध करने पर भी max-results से ज़्यादा नतीजे दिख सकते हैं. ऐसे में, ऐसी स्थिति में पेजिंग से बचा नहीं जा सकता. हालांकि, किसी भी स्थिति में, अगर आपकी क्वेरी के लिए मेल खाने वाली लाइनों की संख्या max-results से ज़्यादा है, तो तारीख की सीमा को अलग करने पर नतीजों को वापस पाने में लगने वाला कुल समय कम हो सकता है. इस तरीके से, सिंगल-थ्रेड और पैरलल, दोनों तरह की क्वेरी की परफ़ॉर्मेंस बेहतर हो सकती है.

पृष्ठांकन

नतीजों को सिलसिलेवार तरीके से दिखाना, बड़े नतीजों के सेट को आसानी से मैनेज किए जा सकने वाले हिस्सों में बांटने का उपयोगी तरीका हो सकता है. totalResults फ़ील्ड से पता चलता है कि कितनी मिलती-जुलती पंक्तियां मौजूद हैं. साथ ही, itemsPerPage नतीजे में दिखाई जा सकने वाली ज़्यादा से ज़्यादा पंक्तियों की जानकारी देता है. अगर totalResults से itemsPerPage का अनुपात ज़्यादा है, तो अलग-अलग क्वेरी में ज़रूरत से ज़्यादा समय लग सकता है. अगर आपको डिसप्ले के लिए, सीमित पंक्तियों की ज़रूरत है, तो max-results पैरामीटर की मदद से रिस्पॉन्स साइज़ की सीमा तय करना आसान हो सकता है. हालांकि, अगर आपके ऐप्लिकेशन को नतीजों के एक बड़े सेट को पूरी तरह से प्रोसेस करना है, तो ज़्यादा से ज़्यादा पंक्तियों के लिए अनुरोध करना बेहतर हो सकता है.

gzip का उपयोग करना

हर अनुरोध के लिए ज़रूरी बैंडविड्थ को कम करने का एक आसान और आसान तरीका, gzip संपीड़न को चालू करना है. हालांकि, नतीजों को कंप्रेस करने में ज़्यादा समय लग सकता है, लेकिन नेटवर्क की कीमत को कम करने से फ़ायदा होता है. gzip की मदद से कोड में बदले गए जवाब पाने के लिए आपको दो काम करने होंगे: Accept-Encoding हेडर सेट करें और अपने उपयोगकर्ता एजेंट में बदलाव करें, ताकि उसमें gzip स्ट्रिंग शामिल हो जाए. gzip संपीड़न को चालू करने के लिए सही तरीके से बनाए गए HTTP हेडर का उदाहरण यहां दिया गया है:

Accept-Encoding: gzip
User-Agent: my program (gzip)