הפניה לשיטות ליבה

המאמר הזה מספק סקירה כללית על השיטות העיקריות של הטמעת ה-API, וסקירה כללית על האופן שבו השיטות האלה פועלות עם רכיבי ה-API של הטמעה ועל ספריית הלקוח הבסיסית ב-Analytics.

שיטות ליבה

השיטות המרכזיות של הטמעת ה-API' הן השיטות שנמצאו באובייקט gapi.analytics.

ready

תור ההקראה של פונקציית קריאה חוזרת שיופעל ברגע שספריית ה-API של ההטמעה תיטען במלואה. השיחות החוזרות מופעלות בסדר שבו הן נוספו.

הפונקציה ready מוגדרת על ידי קטע הקוד של הטמעת ה-API, כך שניתן להשתמש בה באופן מיידי. את כל הפונקציות האחרות צריך למקם בקריאה החוזרת (ready) כדי לוודא שהספרייה נטענת לפני שהיא מופעלת.

שימוש

gapi.analytics.ready(callback)

פרמטרים

שם סוג תיאור
callback Function הפונקציה תופעל ברגע שספריית ה-API של ההטמעה תיטען במלואה.

דוגמה

gapi.analytics.ready(function() {
  // Code in here will be invoked once the library fully loads.
});

createComponent

יוצר רכיב עם השם שצוין ושיטות אב-טיפוס. הרכיב שנוצר יאוחסן ב-gapi.analytics.ext עם השם שהועבר.

תמיד יש להפעיל את הפונקציה createCallback בתוך קריאה חוזרת (callback) מוכנה כדי להבטיח שספריית הלקוחות של הטמעת ה-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'.

});