इस दस्तावेज़ में, एम्बेड किए गए एपीआई के मुख्य तरीकों के बारे में बताया गया है. साथ ही, इस बारे में भी बताया गया है कि वे तरीके, एम्बेड एपीआई के कॉम्पोनेंट और पहले से मौजूद Analytics क्लाइंट लाइब्रेरी के साथ कैसे इंटरैक्ट करते हैं.
मुख्य तरीके
एंबेड एपीआई और मुख्य तौर पर इस्तेमाल होने वाले तरीके 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 फ़ंक्शन को हमेशा, तैयार कॉलबैक में शुरू किया जाना चाहिए, ताकि यह पक्का किया जा सके कि एम्बेड एपीआई क्लाइंट लाइब्रेरी लोड हो.
इस्तेमाल का तरीका
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'.
});