ממשק ה-API של ההטמעה מספק למפתחים מספר רכיבים מובנים לביצוע שאילתות ולהצגה של נתוני דוחות. כל הרכיבים מבוססים על בסיס משותף, ולכן יש הרבה שיטות זהות. קטע זה מספק סקירה כללית של אופן השימוש בשיטות משותפות אלה. למידע נוסף על הרכיבים הספציפיים, עיינו בחומר העזר בנושא רכיבים.
אפשרויות של רכיבים
אפשרויות הרכיבים מוגדרות בזמן היצירה באמצעות הפונקציה של ה-constructor על ידי הפעלה של השיטה set במכונה. כדי לקבל את המצב של מופע רכיב בכל שלב, אפשר לקרוא לפונקציה get ולהחזיר את האפשרויות הקיימות שלו.
אינטראקציה עם רכיב
רכיבים פולטים אירועים כשמשהו חשוב מתרחש, מה שמאפשר לרכיבים אחרים להגיב כשאירועים כאלה מתרחשים. כדי לרשום handler לאירוע מסוים, פשוט צריך לקרוא ל-method on. לחלופין, אפשר להשתמש בשיטה once, כמו on, אבל ה-handler שלה יופעל רק בפעם הראשונה ולאחר מכן יוסר באופן אוטומטי. כדי להסיר handler אפשר להשתמש בשיטה off.
בדרך כלל, פשוט מאזינים לאירועי ברירת המחדל שהרכיבים מפיקים, אבל אם אתם צריכים לשדר אירוע משלכם, אפשר לעשות זאת באמצעות השיטה emit.
ספריית הלקוח של Analytics
embed API גם טוען את ספריית הלקוח של Google Analytics, שמעניקה לך גישה לממשקי API רבים אחרים של Google Analytics אם תזדקק להם.
ממשקי ה-API הבאים זמינים במרחבי השמות האלה:
gapi.client.analytics.data.ga gapi.client.analytics.data.mcf gapi.client.analytics.data.realtime gapi.client.analytics.management gapi.client.analytics.metadata