मुख्य रिपोर्टिंग एपीआई - रेफ़रंस गाइड

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

इसके बारे में जानकारी

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

अनुरोध करें

एपीआई, डेटा का अनुरोध करने का एक तरीका देता है:

analytics.data.ga.get()

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

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

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

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

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

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

नाम वैल्यू ज़रूरी है खास जानकारी
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=ga:12345
ज़रूरी है.
Analytics डेटा फिर से पाने के लिए इस्तेमाल किया जाने वाला यूनीक आईडी. इस आईडी में, Analytics व्यू (प्रोफ़ाइल) आईडी के साथ नेमस्पेस ga: को जोड़ा जाता है. व्यू और प्रोफ़ाइल आईडी को फिर से पाने के लिए, analytics.management.profiles.list तरीका का इस्तेमाल करें. इससे Google Analytics मैनेजमेंट एपीआई में, व्यू (प्रोफ़ाइल) रिसॉर्स में 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=ga:sessions,ga:bounces
ज़रूरी है.
आपकी साइट पर होने वाली उपयोगकर्ता गतिविधि के लिए एग्रीगेट किए गए आंकड़े, जैसे कि क्लिक या पेज व्यू. अगर किसी क्वेरी में कोई dimensions पैरामीटर नहीं है, तो नतीजे में मिलने वाली मेट्रिक, अनुरोध की गई तारीख की सीमा के लिए कुल वैल्यू देती हैं, जैसे कि कुल पेज व्यू या कुल बाउंस. हालांकि, जब डाइमेंशन का अनुरोध किया जाता है, तब वैल्यू को डाइमेंशन वैल्यू के हिसाब से सेगमेंट किया जाता है. उदाहरण के लिए, ga:country के लिए अनुरोध किए गए ga:pageviews से, हर देश के हिसाब से पेज व्यू की कुल संख्या मिलती है. मेट्रिक का अनुरोध करते समय, इन बातों का ध्यान रखें:
  • किसी भी अनुरोध में कम से कम एक मेट्रिक शामिल होनी चाहिए; किसी अनुरोध में सिर्फ़ डाइमेंशन नहीं हो सकते हैं.
  • किसी भी क्वेरी के लिए ज़्यादा से ज़्यादा 10 मेट्रिक दी जा सकती हैं.
  • कई कैटगरी के मेट्रिक के ज़्यादातर कॉम्बिनेशन का इस्तेमाल एक साथ किया जा सकता है. हालांकि, कोई डाइमेंशन तय नहीं किया गया है.
  • किसी मेट्रिक का इस्तेमाल दूसरे डाइमेंशन या मेट्रिक के साथ किया जा सकता है. हालांकि, इसका इस्तेमाल सिर्फ़ उन मेट्रिक के लिए किया जा सकता है जिन पर मान्य कॉम्बिनेशन लागू हों. ज़्यादा जानकारी के लिए, डाइमेंशन और मेट्रिक का रेफ़रंस देखें.


क्रम से लगाएं

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

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

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

किसी क्वेरी के नतीजों को क्रम में लगाने से, आपको अपने डेटा के बारे में अलग-अलग सवाल पूछने में मदद मिलती है. उदाहरण के लिए, सवाल का जवाब देने के लिए [कोटेशन; मेरे प्रमुख देश कौनसे हैं, और वे किन ब्राउज़र का सबसे ज़्यादा इस्तेमाल करते हैं); आप इस पैरामीटर के साथ क्वेरी बना सकते हैं. यह पहले 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

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

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

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


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

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

मेट्रिक फ़िल्टर
ऑपरेटर जानकारी यूआरएल के लिए कोड में बदला गया फ़ॉर्म उदाहरण
== इसके बराबर है %3D%3D ऐसे नतीजे दिखाएं जिनमें पेज पर बिताया गया समय 10 सेकंड है:
filters=ga:timeOnPage%3D%3D10
!= इसके बराबर नहीं है !%3D ऐसे नतीजे दिखाएं जिनमें पेज पर बीता समय दस सेकंड नहीं है:
filters=ga:timeOnPage!%3D10
> इससे ज़्यादा %3E ऐसे नतीजे दिखाएं जिनमें पेज पर बीता समय दस सेकंड से ज़्यादा हो:
filters=ga:timeOnPage%3E10
< इससे कम %3C ऐसे नतीजे दिखाएं जिनमें पेज पर बीता समय दस सेकंड से कम है:
filters=ga:timeOnPage%3C10
>= इससे ज़्यादा या इसके बराबर %3E%3D ऐसे नतीजे दिखाएं जिनमें पेज पर बीता समय दस सेकंड या उससे ज़्यादा है:
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@ शहर के हिसाब से शहर की जानकारी देने वाली मेट्रिक इकट्ठा करें: York:
filters=ga:city%3D@York
!@ इसमें सबस्ट्रिंग नहीं है !@ ऐसी मेट्रिक इकट्ठा करना जहां शहर में 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 ऑपरेटर को कॉमा (,) इस्तेमाल करके तय किया जाता है. इसे AND ऑपरेटर पर प्राथमिकता दी जाती है. साथ ही, इसका इस्तेमाल एक ही एक्सप्रेशन में डाइमेंशन और मेट्रिक को मिलाने के लिए नहीं किया जा सकता.

उदाहरण: (हर यूआरएल का कोड में बदलना ज़रूरी है)

देश इनमें से कोई एक है (अमेरिका या कनाडा):
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&#39 से शुरू नहीं होती है::
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
ज़रूरी नहीं.

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

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

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


सैंपलिंग लेवल

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

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

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

स्टार्ट-इंडेक्स

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

ज़्यादा से ज़्यादा नतीजे

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

आउटपुट

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

फ़ील्ड्स

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

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

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

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

ब्यूटीप्रिंट

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

अगर रिस्पॉन्स true के तौर पर दिखता है, तो रिस्पॉन्स को ऐसे फ़ॉर्मैट में दिखाया जाता है जिसे आसानी से पढ़ा जा सके. डिफ़ॉल्ट मान: false.


कोटाउपयोगकर्ता

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

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

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


जवाब

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

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

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 Analytics मेट्रिक की सूची.
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 की डिफ़ॉल्ट वैल्यू 1,000 है.
totalResults integer क्वेरी के नतीजे में पंक्तियों की कुल संख्या, भले ही रिस्पॉन्स में कितनी भी पंक्तियां हों. उन क्वेरी के लिए जिनमें बहुत ज़्यादा लाइनें होती हैं, totalResults उनकी संख्या itemsPerPage से ज़्यादा हो सकती है. बड़ी क्वेरी के बारे में ज़्यादा जानकारी पाने के लिए, totalResults और itemsPerPage के बारे में ज़्यादा जानकारी के लिए, पेजिंग देखें.
startDate string start-date पैरामीटर के मुताबिक, डेटा क्वेरी शुरू होने की तारीख.
endDate string end-date पैरामीटर के हिसाब से, डेटा क्वेरी के खत्म होने की तारीख.
profileInfo object उस व्यू (प्रोफ़ाइल) के बारे में जानकारी जिसके लिए डेटा का अनुरोध किया गया था. व्यू (प्रोफ़ाइल) डेटा, Google Analytics मैनेजमेंट एपीआई से उपलब्ध है.
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 Analytics मेट्रिक की सूची.
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 की डिफ़ॉल्ट वैल्यू 1,000 है.
totalResults integer क्वेरी के नतीजे में पंक्तियों की कुल संख्या, भले ही रिस्पॉन्स में कितनी भी पंक्तियां हों. उन क्वेरी के लिए जिनमें बहुत ज़्यादा लाइनें होती हैं, totalResults उनकी संख्या itemsPerPage से ज़्यादा हो सकती है. बड़ी क्वेरी के बारे में ज़्यादा जानकारी पाने के लिए, totalResults और itemsPerPage के बारे में ज़्यादा जानकारी के लिए, पेजिंग देखें.
startDate string start-date पैरामीटर के मुताबिक, डेटा क्वेरी शुरू होने की तारीख.
endDate string end-date पैरामीटर के हिसाब से, डेटा क्वेरी के खत्म होने की तारीख.
profileInfo object उस व्यू (प्रोफ़ाइल) के बारे में जानकारी जिसके लिए डेटा का अनुरोध किया गया था. व्यू (प्रोफ़ाइल) डेटा, Google Analytics मैनेजमेंट एपीआई से उपलब्ध है.
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 = डाइमेंशन की संख्या + मेट्रिक की संख्या होती है.

गड़बड़ी कोड

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

इसे आज़माएं!

आप कोर रिपोर्टिंग एपीआई में क्वेरी आज़मा सकते हैं.

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

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

सैंपलिंग

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

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

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

gzip का इस्तेमाल करना

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

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