पहले से मौजूद कॉम्पोनेंट के बारे में जानकारी

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

प्रमाणीकरण

gapi.analytics.auth

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

तरीके
authorize(options:Object)	लौटाए जाने वाले प्रॉडक्ट:  gapi.analytics.auth बताए गए कंटेनर में, Google Analytics साइन-इन बटन को रेंडर करता है, ताकि उपयोगकर्ता अपने Google खाते से साइन इन कर सके.
isAuthorized()	लौटाए जाने वाले प्रॉडक्ट:  boolean उपयोगकर्ता की अनुमति मिलने पर true दिखाता है. अगर ऐसा नहीं है, तो false दिखाता है.
signOut()	लौटाए जाने वाले प्रॉडक्ट:  gapi.analytics.auth मौजूदा उपयोगकर्ता को साइन आउट करता है. signOut इवेंट भी ट्रिगर करता है.
getAuthResponse()	लौटाए जाने वाले प्रॉडक्ट:  Object पुष्टि करने का वह डेटा भी मिलता है जो पुष्टि करने के लिए अनुरोध किए गए मूल अनुरोध पर मिला था. लौटाए गए ऑब्जेक्ट में ऐक्सेस टोकन शामिल होता है. आम तौर पर, इसका इस्तेमाल मैन्युअल तरीके से पुष्टि किए गए अनुरोध करने के लिए किया जा सकता है.
getUserProfile()	लौटाए जाने वाले प्रॉडक्ट:  Object इसमें, साइन इन किए हुए मौजूदा उपयोगकर्ता की प्रोफ़ाइल की बुनियादी जानकारी मिलती है. इसमें उपयोगकर्ता का नाम, ईमेल पता, और सार्वजनिक प्रोफ़ाइल इमेज (अगर सेट हो) शामिल है.

इनहेरिट किए गए तरीके
on
once
off

विकल्प
clientId	टाइप:  string Developers कंसोल में आपके प्रोजेक्ट का क्लाइंट आईडी.
container	टाइप:  string|HTMLElement डीओएम में ऐसे एचटीएमएल एलिमेंट का आईडी जो साइन इन बटन को होस्ट करेगा. आप एलिमेंट के लिए भी रेफ़रंस पास कर सकते हैं.
userInfoLabel	टाइप:  string उपयोगकर्ता के ईमेल पते में लॉग इन करने से पहले दिखाया जाने वाला टेक्स्ट. डिफ़ॉल्ट वैल्यू 'You are logged in as: ' होती है.
scopes	टाइप:  Array Google API की पुष्टि करने के उन दायरों की सूची जिनका अनुरोध आपका ऐप्लिकेशन कर रहा है. उपलब्ध सभी दायरे देखने के लिए, OAuth 2.0 Playground पर जाएं. Google Analytics API की पुष्टि के दायरे के लिए, कॉन्फ़िगरेशन और रिपोर्टिंग संसाधनों की डेवलपर गाइड देखें.
overwriteDefaultScopes	टाइप:  boolean इससे पता चलता है कि scopes विकल्प, डिफ़ॉल्ट एम्बेड एपीआई के स्कोप को बदलता है या उनमें कुछ जोड़ता है. false (डिफ़ॉल्ट) को तय करने से, डिफ़ॉल्ट दायरों में जुड़ जाएगा और true को तय करने से, उन्हें scopes विकल्प में तय किए गए दायरों से बदल दिया जाएगा. स्कोप की डिफ़ॉल्ट वैल्यू यह है:['https://www.googleapis.com/auth/analytics.readonly']. ध्यान दें: एम्बेड एपीआई से पुष्टि करने के लिए, उपयोगकर्ता की बुनियादी प्रोफ़ाइल का ऐक्सेस होना ज़रूरी है. उन दायरों को ओवरराइट नहीं किया जा सकता.
serverAuth.access_token	टाइप:  string अगर आपके पास पहले से ही मान्य ऐक्सेस टोकन है, तो उसे सीधे अनुमति देने वाले तरीके को भेजा जा सकता है. इसके बाद, उपयोगकर्ता को अनुमति देने के लिए नहीं कहा जाएगा. ऐक्सेस टोकन को फिर से पाने के तरीके के बारे में जानने के लिए, OAuth 2.0 दस्तावेज़ देखें.

इवेंट
signIn	आर्ग्यूमेंट: कोई नहीं उपयोगकर्ता के साइन इन करने पर सक्रिय होता है.
signOut	आर्ग्यूमेंट: कोई नहीं उपयोगकर्ता के साइन आउट होने पर सक्रिय होता है.
needsAuthorization	आर्ग्यूमेंट: कोई नहीं gapi.analytics.auth.authorize तरीके को शुरू करते समय, शुरुआती जांच की जाती है कि क्या उपयोगकर्ता ने अभी साइन इन किया है. अगर उपयोगकर्ता ने साइन इन नहीं किया है, तो यह इवेंट यह बताने के लिए ट्रिगर होता है कि अनुमति की ज़रूरत है या नहीं.
error	आर्ग्यूमेंट:  response पुष्टि करने की प्रोसेस के दौरान कोई गड़बड़ी होने पर ट्रिगर होता है. अगर आपको रिस्पॉन्स ऑब्जेक्ट से गड़बड़ी का मैसेज पाना है, तो यह response.error.message पर होगा.

रोके गए इवेंट
success	आर्ग्यूमेंट:  response यह इवेंट, पुराने सिस्टम के साथ काम करने की सुविधा के लिए मौजूद है और आने वाले वर्शन में इसे हटाया जा सकता है. इसके बजाय, signIn इवेंट का इस्तेमाल करें.

उदाहरण

// Standard client-side authorization.

gapi.analytics.auth.authorize({
  clientId: 'XXXXXX',
  container: 'auth-button'
});

gapi.analytics.auth.on('signIn', function() {
  console.log(gapi.analytics.auth.getUserProfile());
});

// Authorization using an access token obtained server-side.
// You do not need to register an event handler because
// authorization happens immediately.

gapi.analytics.auth.authorize({
  serverAuth: {
    access_token: 'XXXXXX'
  }
});

ध्यान दें: serverAuth.access_token का इस्तेमाल करने पर, अनुमति तुरंत मिल जाती है. इसलिए, इवेंट हैंडलर को रजिस्टर करने की कोई ज़रूरत नहीं होती.

अहम जानकारी: serverAuth.access_token का इस्तेमाल करते समय, यह पक्का करना आपकी ज़िम्मेदारी है कि टोकन मान्य है और उसकी समयसीमा खत्म नहीं हुई है. ऐसे ऐक्सेस टोकन को रीफ़्रेश करने का तरीका जानने के लिए जिसकी समयसीमा खत्म हो चुकी है, OAuth 2.0 का दस्तावेज़ देखें.

डेटा

gapi.analytics.report.Data

निर्माता
Data(options:Object)	डेटा कॉम्पोनेंट की मदद से, Google Analytics के Core Reporting API के बारे में क्वेरी की जा सकती है और नतीजे वापस पाए जा सकते हैं.

विकल्प
query	टाइप:  Object एक ऑब्जेक्ट, जिसमें Core Reporting API के क्वेरी पैरामीटर होते हैं. एपीआई से मिलने वाले सामान्य डिफ़ॉल्ट वैल्यू के साथ-साथ, इन डिफ़ॉल्ट वैल्यू का इस्तेमाल किया जाता है: { 'start-date': '7daysAgo', 'end-date': 'yesterday }

इनहेरिट किए गए तरीके
get
set
execute
on
once
off
emit

इवेंट
success	आर्ग्यूमेंट:  response क्वेरी पूरी होने पर सक्रिय किया जाता है.
error	आर्ग्यूमेंट:  response क्वेरी प्रोसेस के दौरान कोई गड़बड़ी होने पर ट्रिगर होता है. अगर आपको रिस्पॉन्स ऑब्जेक्ट से गड़बड़ी का मैसेज पाना है, तो यह response.error.message पर होगा.

उदाहरण

var report = new gapi.analytics.report.Data({
  query: {
    ids: 'ga:XXXX',
    metrics: 'ga:sessions',
    dimensions: 'ga:city'
  }
});

report.on('success', function(response) {
  console.log(response);
});

report.execute();

DataChart

gapi.analytics.googleCharts.DataChart

निर्माता
DataChart(options:Object)	DataChart, स्टैंडर्ड Google चार्ट और डेटा कॉम्पोनेंट को रैप करता है. इससे किसी क्वेरी से विज़ुअलाइज़ेशन बनाने में आसानी होती है. इसके लिए, आपको अलग-अलग क्वेरी को एक साथ जोड़ने की ज़रूरत नहीं होती.

विकल्प
query	टाइप:  Object डेटा कॉम्पोनेंट क्वेरी का विकल्प देखें.
chart	टाइप:  Object अलग-अलग चार्ट के विकल्प की जानकारी नीचे देखें.
chart.container	टाइप:  string|HTMLElement DOM में उस एचटीएमएल एलिमेंट का आईडी जो DataChart को होस्ट करेगा. आप एलिमेंट के लिए भी रेफ़रंस पास कर सकते हैं.
chart.type	टाइप:  string चार्ट टाइप. ये विकल्प हो सकते हैं: LINE, COLUMN, BAR, TABLE, और GEO.
chart.options	टाइप:  Object ऐसा कोई भी विकल्प जिसे उससे जुड़े Google Chart ऑब्जेक्ट को पास किया जा सकता है.

इनहेरिट किए गए तरीके
get
set
execute
on
once
off
emit

इवेंट
success	आर्ग्यूमेंट:  result क्वेरी तब सक्रिय होती है, जब क्वेरी पूरी हो जाती है और चार्ट पूरी तरह रेंडर हो जाता है. result.chart – Google चार्ट इंस्टेंस. result.data – डेटा पैरामीटर फ़ॉर्मैट में रिपोर्ट रिस्पॉन्स. result.dataTable – result.data ऑब्जेक्ट से बनाया गया DataTable इंस्टेंस. result.response – रॉ एपीआई रिस्पॉन्स ऑब्जेक्ट.
error	आर्ग्यूमेंट:  response क्वेरी या रेंडरिंग की प्रोसेस के दौरान कोई गड़बड़ी होने पर ट्रिगर होता है. अगर आपको रिस्पॉन्स ऑब्जेक्ट से गड़बड़ी का मैसेज पाना है, तो यह response.error.message पर होगा.

उदाहरण

var chart = new gapi.analytics.googleCharts.DataChart({
  query: {
    ids: 'ga:XXXX',
    metrics: 'ga:sessions',
    dimensions: 'ga:date'
  },
  chart: {
    type: 'LINE',
    container: 'line-chart',
    options: {
      title: 'Sessions over the past week.',
      fontSize: 12
    }
  }
});
chart.on('success', function(response) {
  // response.chart : the Google Chart instance.
  // response.data : the Google Chart data object.
});

chart.execute();

ViewSelector

gapi.analytics.ViewSelector

निर्माता
ViewSelector(options:Object)	ViewSelector कॉम्पोनेंट की मदद से, ड्रॉपडाउन मेन्यू के ज़रिए अपना खाता, प्रॉपर्टी, और व्यू चुना जा सकता है.

विकल्प
container	टाइप:  string|HTMLElement डीओएम में उस एचटीएमएल एलिमेंट का आईडी जो ViewSelector को होस्ट करेगा. आप एलिमेंट के लिए भी रेफ़रंस पास कर सकते हैं.

इनहेरिट किए गए तरीके
get
set
execute
on
once
off
emit

इंस्टेंस प्रॉपर्टी
ids	टाइप:  string ga:XXXX फ़ॉर्म का यूनीक टेबल आईडी, जिसमें XXXX Analytics व्यू (प्रोफ़ाइल) आईडी होता है.

इवेंट
change	आर्ग्यूमेंट:  ids जब भी उपयोगकर्ता ड्रॉपडाउन मेन्यू से कोई नया व्यू चुनता है, तब ट्रिगर होता है. यह तब भी सक्रिय होता है, जब ViewSelector इंस्टेंस पहली बार रेंडर होता है और डिफ़ॉल्ट व्यू दिखता है.

उदाहरण

var viewSelector = new gapi.analytics.ViewSelector({
  container: 'view-selector'
});

viewSelector.on('change', function(ids) {
  console.log(ids);
});

viewSelector.execute();

शेयर किए गए कॉम्पोनेंट के तरीके

तरीके
set(options)	लौटाए जाने वाले प्रॉडक्ट: this कॉम्पोनेंट के कॉन्फ़िगरेशन के विकल्पों को सेट या अपडेट करता है. कंस्ट्रक्टर में बनाते समय भी ऐसा किया जा सकता है.
get()	लौटाए जाने वाले प्रॉडक्ट: Object यह फ़ंक्शन किसी कॉम्पोनेंट के मौजूदा कॉन्फ़िगरेशन के विकल्प दिखाता है.
execute()	लौटाए जाने वाले प्रॉडक्ट: this कॉम्पोनेंट की मुख्य कार्रवाई को शुरू करता है. आम तौर पर, इसका मतलब पेज पर कोई चीज़ रेंडर करना या कोई रिपोर्ट चलाना (या दोनों) होता है.
on(event, handler)	लौटाए जाने वाले प्रॉडक्ट: this जब कॉम्पोनेंट किसी तय इवेंट का उत्सर्जन करता है, तब लागू किया जाने वाला फ़ंक्शन रजिस्टर करता है.
once(event, handler)	लौटाए जाने वाले प्रॉडक्ट: this बताए गए इवेंट की सिर्फ़ अगली बार होने पर इस्तेमाल किए जाने वाले फ़ंक्शन को रजिस्टर करता है. हैंडलर के चलने के बाद, उसका रजिस्ट्रेशन अपने-आप रद्द हो जाता है.
off(opt_event, opt_handler)	लौटाए जाने वाले प्रॉडक्ट: undefined कॉम्पोनेंट से इवेंट हैंडलर को हटाता है. अगर कोई भी हैंडलर पास नहीं किया जाता है, तो यह पास किए गए इवेंट के सभी हैंडलर को हटा देता है. अगर कोई भी इवेंट पास नहीं किया जाता है, तो यह सभी इवेंट के लिए सभी हैंडलर को हटा देता है.
emit(event, ...opt_args)	लौटाए जाने वाले प्रॉडक्ट: undefined इससे कोई इवेंट निकलेगा. आपके पास यह विकल्प भी है कि रजिस्टर किए गए किसी भी हैंडलर को पास किए जाने वाले आर्ग्युमेंट, वैकल्पिक तौर पर तय किए जाएं.

set

कॉम्पोनेंट के कॉन्फ़िगरेशन के विकल्पों को सेट या अपडेट करता है. कंस्ट्रक्टर में बनाते समय भी ऐसा किया जा सकता है.

इस्तेमाल का तरीका

component.set(options);

पैरामीटर

नाम	टाइप	ब्यौरा
options	Object	इस कॉम्पोनेंट के लिए कॉन्फ़िगरेशन के विकल्प. पास हो चुके विकल्पों को मौजूदा विकल्पों के साथ मर्ज कर दिया जाएगा.

रिटर्न

this – कॉम्पोनेंट इंस्टेंस.

---

get

यह फ़ंक्शन किसी कॉम्पोनेंट के मौजूदा कॉन्फ़िगरेशन के विकल्प दिखाता है.

रिटर्न

Object – कॉम्पोनेंट के मौजूदा कॉन्फ़िगरेशन विकल्प.

---

execute()

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

रिटर्न

this – कॉम्पोनेंट इंस्टेंस.

---

on(event, handler)

जब कॉम्पोनेंट किसी तय इवेंट का उत्सर्जन करता है, तब लागू किया जाने वाला फ़ंक्शन रजिस्टर करता है.

पैरामीटर

नाम	टाइप	ब्यौरा
event	string	इवेंट का नाम.
handler	Function	इवेंट होने पर लागू किया जाने वाला फ़ंक्शन. (पैरामीटर की जानकारी के लिए, अलग-अलग इवेंट के रेफ़रंस देखें.)

रिटर्न

this – कॉम्पोनेंट इंस्टेंस.

---

once(event, handler)

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

पैरामीटर

नाम	टाइप	ब्यौरा
event	string	इवेंट का नाम.
handler	Function	इवेंट होने पर लागू किया जाने वाला फ़ंक्शन. (पैरामीटर की जानकारी के लिए, अलग-अलग इवेंट के रेफ़रंस देखें.)

रिटर्न

this – कॉम्पोनेंट इंस्टेंस.

---

off(opt_event, opt_handler)

कॉम्पोनेंट से इवेंट हैंडलर को हटाता है. अगर कोई भी हैंडलर पास नहीं किया जाता है, तो यह पास किए गए इवेंट के सभी हैंडलर को हटा देता है. अगर कोई भी इवेंट पास नहीं किया जाता है, तो यह सभी इवेंट के लिए सभी हैंडलर को हटा देता है.

पैरामीटर

नाम	टाइप	ब्यौरा
opt_event	string	इवेंट का नाम. अगर किसी इवेंट के बारे में नहीं बताया गया है, तो सभी इवेंट के लिए सभी हैंडलर हटा दिए जाते हैं. ज़रूरी नहीं.
opt_handler	Function	हटाए जाने वाले फ़ंक्शन हैंडलर का रेफ़रंस. अगर कोई भी फ़ंक्शन पास नहीं किया जाता है, तो सभी हैंडलर हटा दिए जाते हैं. ज़रूरी नहीं.

रिटर्न

undefined

---

emit(event, ...opt_args)

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

पैरामीटर

नाम	टाइप	ब्यौरा
event	string	इवेंट का नाम.
...opt_args	*	रजिस्टर किए गए किसी भी इवेंट हैंडलर को पास किए जाने वाले वैकल्पिक तर्क.

रिटर्न

undefined