मल्टी चैनल फ़नल रिपोर्टिंग एपीआई - रेफ़रंस गाइड

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

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

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

एपीआई में, रिपोर्ट डेटा का अनुरोध करने का एक ही तरीका होता है: report.get. इस तरीके में, उस व्यू (प्रोफ़ाइल) से जुड़ा टेबल आईडी दें जिसके लिए आपको डेटा वापस लाना है. इसके अलावा, आपको यह जानकारी भी देनी होती है:

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

एपीआई, report.get तरीके को REST एंडपॉइंट पर उपलब्ध कराता है: https://www.googleapis.com/analytics/v3/data/mcf. यहां दिए गए सेक्शन में, सैंपल अनुरोध दिखता है और हर पैरामीटर के बारे में जानकारी दी गई है.

अनुरोध

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

analytics.data.mcf.get()

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

Authorization: Bearer {oauth2-token}

GET https://www.googleapis.com/analytics/v3/data/mcf
  ?ids=ga:12345
  &metrics=mcf:totalConversions,mcf:totalConversionValue
  &start-date=2011-10-01
  &end-date=2011-10-31

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

मल्टी-चैनल फ़नल रिपोर्टिंग एपीआई के सभी अनुरोधों को अनुमति दी जानी चाहिए. ज़्यादा से ज़्यादा OAuth 2.0 का इस्तेमाल किया जाना चाहिए.

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

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

नाम वैल्यू ज़रूरी है खास जानकारी
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 हाँ कॉमा लगाकर अलग की गई मेट्रिक की सूची, जैसे कि mcf:totalConversions,mcf:totalConversionValue. एक मान्य क्वेरी में कम से कम एक मेट्रिक मौजूद होनी चाहिए.
dimensions string no आपकी मल्टी चैनल फ़नल रिपोर्ट के लिए कॉमा से अलग किए गए डाइमेंशन की सूची, जैसे कि mcf:source,mcf:keyword.
sort string no यह कॉमा लगाकर अलग किए गए डाइमेंशन और मेट्रिक की सूची होती है. इस सूची में, लौटाए गए डेटा को क्रम से लगाने और क्रम से लगाने की दिशा के बारे में बताया जाता है.
filters string no डाइमेंशन या मेट्रिक फ़िल्टर, जो आपके अनुरोध के डेटा को दिखाने पर पाबंदी लगाते हैं.
samplingLevel string no पसंदीदा सैंपलिंग लेवल. अनुमति वाली वैल्यू:
  • DEFAULT — जवाब के तौर पर एक सैंपल साइज़ दिखाता है, जो रफ़्तार और सटीक साइज़ के बीच संतुलन बनाता है.
  • FASTER — छोटे साइज़ के सैंपल के साथ तेज़ी से रिस्पॉन्स देता है.
  • HIGHER_PRECISION — यह फ़ंक्शन बड़े सैंपल साइज़ का इस्तेमाल करके, ज़्यादा सटीक रिस्पॉन्स देता है. हालांकि, इस वजह से रिस्पॉन्स मिलने में समय लग सकता है.
start-index integer no वापस पाने के लिए डेटा की पहली पंक्ति, 1 से शुरू. इस पैरामीटर का इस्तेमाल, max-results पैरामीटर के साथ, पेज पर नंबर डालने के तरीके के तौर पर करें.
max-results integer no जवाब में शामिल की जाने वाली पंक्तियों की ज़्यादा से ज़्यादा संख्या.

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

ids

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

वापस सबसे ऊपर जाएं


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

start-date=2011-10-01
ज़रूरी है.
मल्टी चैनल फ़नल के डेटा के सभी अनुरोधों में, तारीख की सीमा तय होनी चाहिए. अगर आप अनुरोध में 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 2011-01-01 है. start-date के लिए कोई ऊपरी सीमा प्रतिबंध नहीं है.
मिलते-जुलते तारीख, हमेशा क्वेरी के समय की मौजूदा तारीख से जुड़े होते हैं और क्वेरी में बताए गए व्यू (प्रोफ़ाइल) के टाइमज़ोन के हिसाब से होते हैं.

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

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

वापस सबसे ऊपर जाएं


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

end-date=2011-10-31
ज़रूरी है.
मल्टी चैनल फ़नल के डेटा के सभी अनुरोधों में, तारीख की सीमा तय होनी चाहिए. अगर आप अनुरोध में 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=mcf:source,mcf:keyword
ज़रूरी नहीं.

डाइमेंशन पैरामीटर, आपकी मल्टी चैनल फ़नल रिपोर्ट के लिए प्राइमरी डेटा की तय करता है, जैसे कि mcf:source या mcf:medium. कन्वर्ज़न मेट्रिक को सेगमेंट में बांटने के लिए, डाइमेंशन का इस्तेमाल करें. उदाहरण के लिए, अपनी साइट पर हुए कन्वर्ज़न की कुल संख्या के बारे में पूछा जा सकता है. हालांकि, मीडियम के हिसाब से सेगमेंट किए गए कन्वर्ज़न की संख्या पूछना ज़्यादा दिलचस्प हो सकता है. इस मामले में, आपको ऑर्गैनिक, रेफ़रल, ईमेल वगैरह से मिले कन्वर्ज़न की संख्या दिखेगी.

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

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

अनुपलब्ध मान

अगर डाइमेंशन की वैल्यू तय नहीं की जा सकती, तो Analytics (not set) खास स्ट्रिंग का इस्तेमाल करता है.

वापस सबसे ऊपर जाएं


metrics

metrics=mcf:totalConversions,mcf:totalConversionValue
ज़रूरी है.

आपकी साइट पर उपयोगकर्ता गतिविधि के एग्रीगेट किए गए आंकड़े, जैसे कि कुल कन्वर्ज़न की संख्या या कुल कन्वर्ज़न वैल्यू. अगर किसी क्वेरी में dimensions पैरामीटर नहीं है, तो नतीजे के तौर पर दिखाई गई मेट्रिक, अनुरोध की गई तारीख की सीमा के लिए एग्रीगेट वैल्यू दिखाती हैं, जैसे कि कुल कन्वर्ज़न वैल्यू. हालांकि, डाइमेंशन का अनुरोध करने पर, वैल्यू को डाइमेंशन वैल्यू के हिसाब से सेगमेंट में बांटा जाता है. उदाहरण के लिए, mcf:totalConversions से अनुरोध किया गया mcf:source हर सोर्स से मिले कुल कन्वर्ज़न दिखाता है.

मेट्रिक के लिए अनुरोध करते समय इन बातों का ध्यान रखें:

  • किसी भी अनुरोध में कम से कम एक मेट्रिक दी जानी चाहिए. अनुरोध में सिर्फ़ डाइमेंशन शामिल नहीं किए जा सकते.
  • किसी भी क्वेरी के लिए ज़्यादा से ज़्यादा 10 मेट्रिक दी जा सकती हैं.

वापस सबसे ऊपर जाएं


क्रम से लगाएं

sort=mcf:source,mcf:medium
ज़रूरी नहीं.

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

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

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

sort=mcf:source,mcf:medium

"मेरे सबसे लोकप्रिय कन्वर्ज़न मीडियम और किन सोर्स से हो रहे हैं?", इस सवाल का जवाब देने के लिए, इस पैरामीटर की मदद से क्वेरी करें. यह पहले mcf:medium के हिसाब से और फिर mcf:source के मुताबिक, दोनों को बढ़ते क्रम में लगाता है:

sort=mcf:medium,mcf:source

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

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

वापस सबसे ऊपर जाएं


फ़िल्टर

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

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

https://www.googleapis.com/analytics/v3/data/mcf
?ids=mcf:12134
&dimensions=mcf:source
&metrics=mcf:totalConversions
&filters=mcf:medium%3D%3Dreferral
&start-date=2011-10-01
&end-date=2011-10-31

ज़्यादा जानकारी के लिए, Core Reporting API का रेफ़रंस पढ़ें.

वापस सबसे ऊपर जाएं


samplingLevel

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

वापस सबसे ऊपर जाएं


max-results

max-results=100
ज़रूरी नहीं.

इस जवाब में शामिल की जाने वाली पंक्तियों की ज़्यादा से ज़्यादा संख्या. एलिमेंट के सबसेट को फिर से पाने के लिए, इसे start-index के साथ इस्तेमाल किया जा सकता है. इसके अलावा, पहले एलिमेंट से शुरू करते हुए, लौटाए गए एलिमेंट की संख्या को सीमित करने के लिए, इसका इस्तेमाल किया जा सकता है. अगर max-results नहीं दिया जाता है, तो क्वेरी डिफ़ॉल्ट तौर पर ज़्यादा से ज़्यादा 1,000 पंक्तियां दिखाती है.

मल्टी चैनल फ़नल रिपोर्टिंग एपीआई हर अनुरोध में ज़्यादा से ज़्यादा 10,000 लाइनें दिखाता है. इससे कोई फ़र्क़ नहीं पड़ता कि आपने कितनी भी लाइनें मांगी हैं. अगर आपकी उम्मीद के मुताबिक डाइमेंशन सेगमेंट नहीं हैं, तो हो सकता है कि नतीजे में अनुरोध के मुकाबले कम लाइनें दिखें. उदाहरण के लिए, mcf:medium के लिए 300 से कम वैल्यू हो सकती हैं. इसलिए, सिर्फ़ मीडियम के आधार पर सेगमेंट में बांटने पर, max-results को ज़्यादा वैल्यू पर सेट करने के बाद भी, 300 से ज़्यादा लाइनें नहीं मिल सकतीं.

वापस सबसे ऊपर जाएं


जवाब

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

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

जवाब का फ़ॉर्मैट

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

वापस सबसे ऊपर जाएं

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

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

प्रॉपर्टी का नाम वैल्यू ब्यौरा
kind string संसाधन किस तरह का है. वैल्यू "analytics#mcfData" है.
id string इस डेटा रिस्पॉन्स के लिए आईडी.
query object इस ऑब्जेक्ट में, क्वेरी को पैरामीटर के तौर पर पास की गई सभी वैल्यू शामिल हैं. हर फ़ील्ड का मतलब उससे जुड़े क्वेरी पैरामीटर के ब्यौरे में बताया जाता है.
query.start-date string शुरू होने की तारीख.
query.end-date string खत्म होने की तारीख.
query.ids string यूनीक टेबल आईडी.
query.dimensions[] list Analytics डाइमेंशन की सूची.
query.metrics[] list आंकड़ों की मेट्रिक की सूची.
query.sort[] list उन मेट्रिक या डाइमेंशन की सूची जिन पर डेटा को क्रम से लगाया गया है.
query.filters string मेट्रिक या डाइमेंशन फ़िल्टर की कॉमा-सेपरेटेड लिस्ट.
query.samplingLevel string Requested sampling level.
query.start-index integer पंक्तियों का शुरुआती इंडेक्स. डिफ़ॉल्ट वैल्यू 1 है.
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 के बारे में ज़्यादा जानने के लिए, पेजिंग देखें.
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" या "MCF_SEQUENCE" होने चाहिए. मेट्रिक कॉलम हेडर में "INTEGER", "DOUBLE", "CURRENCY" वगैरह जैसी मेट्रिक वैल्यू के लिए, डेटा टाइप होते हैं.
totalsForAllResults object अनुरोध की गई मेट्रिक की कुल वैल्यू, मेट्रिक के नामों और वैल्यू के की-वैल्यू पेयर के तौर पर. मेट्रिक की कुल संख्या का क्रम अनुरोध में बताए गए मेट्रिक के क्रम के जैसा ही होता है.
rows[] list

रिपोर्ट की डेटा की लाइनें, जिनमें हर लाइन में Mcf.Rowsऑब्जेक्ट की सूची होती है. इस अंदरूनी सूची में डाइमेंशन वैल्यू के बाद, मेट्रिक की वैल्यू को उसी क्रम में दिखाया जाता है जिस क्रम में अनुरोध में बताया गया है. हर लाइन में N फ़ील्ड की सूची होती है. इसमें N = डाइमेंशन की संख्या + मेट्रिक की संख्या होती है.

Mcf.Rows ऑब्जेक्ट, दूसरे ऑब्जेक्ट को रैप करता है, जो primitiveValue या conversionPathValue टाइप का हो सकता है. डाइमेंशन की वैल्यू किसी भी तरह की हो सकती हैं, जबकि सभी मेट्रिक वैल्यू primitiveValue टाइप की होती हैं.

primitiveValue, किसी ऑब्जेक्ट में रैप की गई एक स्ट्रिंग होती है. उदाहरण के लिए:

{
  "primitiveValue": "2183"
}

conversionPathValue एक ऑब्जेक्ट होता है, जो ऑब्जेक्ट के कलेक्शन के चारों ओर रैप किया जाता है. इसमें हर ऑब्जेक्ट में, nodeValue स्ट्रिंग और एक वैकल्पिक interactionType स्ट्रिंग होती है. उदाहरण के लिए:

{
  "conversionPathValue": [
    {
      "interactionType" : "CLICK",
      "nodeValue" : "google"
    },
    {
      "interactionType" : "CLICK",
      "nodeValue" : "google"
    }
  ]
}

वापस सबसे ऊपर जाएं

गड़बड़ी कोड

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

वापस सबसे ऊपर जाएं

इसे आज़माएं!

लाइव डेटा पर इस तरीके को कॉल करने और रिस्पॉन्स देखने के लिए, नीचे दिया गया एपीआई एक्सप्लोरर इस्तेमाल करें.

वापस सबसे ऊपर जाएं

सैंपलिंग

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)