מסמך זה מספק חומר עזר על שיטות הליבה של Embed API, וכן סקירה כללית על האופן שבו שיטות אלה מקיימות אינטראקציה עם רכיבי embed API ועם ספריית הלקוח הבסיסית של Analytics.
שיטות ליבה
השיטות העיקריות של embed API הן השיטות שנמצאות באובייקט gapi.analytics
.
ready
משהה פונקציית קריאה חוזרת שתופעל מיד לאחר שספריית ממשק ה-API להטמעה נטענת במלואה. הקריאות החוזרות מופעלות לפי סדר ההוספה שלהן.
הפונקציה ready
מוגדרת על ידי קטע הקוד של ממשק ה-API של הטמעה, כך שניתן להשתמש בה באופן מיידי. יש למקם את כל שאר הפונקציות בתוך הקריאה החוזרת (callback) של ready
כדי להבטיח שהספרייה תיטען לפני ההפעלה.
Usage
gapi.analytics.ready(callback)
פרמטרים
שם | סוג | תיאור |
---|---|---|
callback |
Function |
הפונקציה שתופעל ברגע שהספרייה של embed API נטענת במלואה. |
דוגמה
gapi.analytics.ready(function() { // Code in here will be invoked once the library fully loads. });
createComponent
יוצר רכיב עם השיטות של השם ואב הטיפוס שצוינו. הרכיב שנוצר יאוחסן ב-gapi.analytics.ext
עם השם שהועבר.
יש להפעיל תמיד את הפונקציה createCallback
בתוך קריאה חוזרת מוכנה כדי להבטיח שספריית הלקוח של Implement API נטענת.
Usage
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'. });