इस दस्तावेज़ में, एपीआई एम्बेड करने के मुख्य तरीकों के बारे में बताया गया है. साथ ही, यह भी बताया गया है कि ये तरीके, एम्बेड किए गए एपीआई कॉम्पोनेंट और बुनियादी Analytics क्लाइंट लाइब्रेरी के साथ कैसे इंटरैक्ट करते हैं.
मुख्य तरीके
Embed API के मुख्य तरीके, gapi.analytics ऑब्जेक्ट पर मिलते हैं.
ready
एम्बेड एपीआई लाइब्रेरी के पूरी तरह लोड होते ही, कॉलबैक फ़ंक्शन को सूची में डाल देता है, ताकि इसे शुरू किया जा सके. कॉलबैक को उसी क्रम में शुरू किया जाता है जिस क्रम में उन्हें जोड़ा गया था.
ready फ़ंक्शन को एपीआई स्निपेट एम्बेड करके तय किया जाता है. इसलिए, इसका तुरंत इस्तेमाल किया जा सकता है. अन्य सभी फ़ंक्शन को ready कॉलबैक के अंदर रखा जाना चाहिए, ताकि यह पक्का किया जा सके कि लाइब्रेरी को शुरू करने से पहले, उन्हें लोड किया जाए.
इस्तेमाल का तरीका
gapi.analytics.ready(callback)
पैरामीटर
| नाम | टाइप | ब्यौरा |
|---|---|---|
callback |
Function |
एम्बेड एपीआई लाइब्रेरी के पूरी तरह लोड होने के बाद, लागू किया जाने वाला फ़ंक्शन. |
उदाहरण
gapi.analytics.ready(function() {
// Code in here will be invoked once the library fully loads.
});
createComponent
तय किए गए नाम और प्रोटोटाइप के तरीकों के साथ कॉम्पोनेंट बनाता है. बनाया गया कॉम्पोनेंट, पास किए गए नाम के साथ gapi.analytics.ext में सेव किया जाएगा.
createCallback फ़ंक्शन को हमेशा एक रेडी कॉलबैक में शुरू करना चाहिए, ताकि यह पक्का किया जा सके कि Embed API क्लाइंट लाइब्रेरी लोड हो गई है.
इस्तेमाल का तरीका
gapi.analytics.createComponent(name, prototypeMethods)
पैरामीटर
| नाम | टाइप | ब्यौरा |
|---|---|---|
name |
string |
कॉम्पोनेंट का नाम. |
prototypeMethods |
Object |
एक ऐसा ऑब्जेक्ट जिसकी प्रॉपर्टी और तरीकों को कॉम्पोनेंट के प्रोटोटाइप में सेव किया जाएगा. |
उदाहरण
gapi.analytics.ready(function() {
gapi.analytics.createComponent('MyComponent', {
foo: function() {
alert('foo');
},
bar: function() {
alert('bar');
}
});
var myComponentInstance = new gapi.analytics.ext.MyComponent();
myComponentInstance.foo(); // Alerts 'foo'.
});