הפניה לרכיבים מובנים

המסמך הזה מתאר את האפשרויות, השיטות, הנכסים והאירועים של כל רכיבי ה-API המובנים.

אימות

gapi.analytics.auth

רכיב האימות הוא סינגל שניתן להשתמש בו כדי לתת הרשאה למשתמש.

שיטות
authorize(options:Object)	החזרות: gapi.analytics.auth המדיניות הזו מעבדת לחצן כניסה ל-Google Analytics בתוך המאגר שצוין. המשתמש יכול להיכנס עם חשבון Google שלו.
isAuthorized()	החזרות: boolean פונקציה זו מחזירה את המשתמש true אם המשתמש קיבל הרשאה, או false.
signOut()	החזרות: gapi.analytics.auth ניתוק המשתמשים הנוכחיים. ההפעלה היא גם האירוע signOut.
getAuthResponse()	החזרות: Object קבלת נתוני אימות שהוחזרו על ידי בקשת ההרשאה המקורית. האובייקט המוחזר כולל את אסימון הגישה. בדרך כלל המפתח הזה יכול לשמש לשליחת בקשות מאומתות באופן ידני.
getUserProfile()	החזרות: Object קבלת מידע בסיסי על הפרופיל של המשתמש המחובר כרגע. התוכן כולל את שם המשתמש, כתובת האימייל ותמונת הפרופיל הציבורי (אם הוגדר).

שיטות שעברו בירושה
on
once
off

אפשרויות
clientId	סוג: string מספר הלקוח של הפרויקט במסוף המפתחים.
container	סוג: string|HTMLElement המזהה של רכיב HTML ב-DOM שיארח את לחצן הכניסה. אפשר גם להעביר הפניה לאלמנט עצמו.
userInfoLabel	סוג: string הטקסט שיוצג לפני כתובת האימייל של המשתמש המחובר. ברירת המחדל היא 'You are logged in as: '.
scopes	סוג: Array רשימה של היקפי הרשאה לאימות ב-Google API שהבקשה שלך מבקשת. כדי לראות את כל ההיקפים הזמינים, יש לבקר במגרש המשחקים של OAuth 2.0. לטווחי האימות של Google Analytics API, יש לעיין במדריכים למפתחים בנושא משאבי הגדרה ודיווח.
overwriteDefaultScopes	סוג: boolean המדיניות מציינת אם האפשרות scopes מחליפה את היקפי ברירת המחדל של הטמעת ה-API או מוסיפה אליהם. ציון של false (ברירת המחדל) יוסיף להיקפי ברירת המחדל, והגדרה של true תחליף אותם בהיקפי ההרשאות שצוינו באפשרות scopes. ערך ברירת המחדל של ההיקפים הוא:['https://www.googleapis.com/auth/analytics.readonly']. הערה: אימות באמצעות ה-API של הטמעה מצריך גישה לפרופיל הבסיסי של המשתמש. לא ניתן להחליף את ההיקפים האלה.
serverAuth.access_token	סוג: string אם כבר יש לך אסימון גישה תקין, יש לך אפשרות להעביר אותו ישירות לשיטת האימות, והמשתמש לא יתבקש לאשר אותו. לפרטים על אופן האחזור של אסימון גישה, יש לעיין בתיעוד של OAuth 2.0.

אירועים
signIn	ארגומנטים: ללא מופעל כשהמשתמש נכנס לחשבון.
signOut	ארגומנטים: ללא מופעל כשהמשתמש התנתק בהצלחה.
needsAuthorization	ארגומנטים: ללא בזמן הפעלת השיטה gapi.analytics.auth.authorize, מתבצעת בדיקה ראשונית כדי לראות אם המשתמש מחובר כרגע. אם המשתמש לא מחובר, האירוע הזה מופעל כדי לציין שנדרשת הרשאה נוספת.
error	ארגומנטים: response מופעל כשמתרחשת שגיאה במהלך תהליך האימות. אם ברצונך לקבל את הודעת השגיאה מאובייקט התגובה, היא תופיע בכתובת response.error.message.

אירועים שהוצאו משימוש
success	ארגומנטים: response האירוע הזה מיועד לתאימות לאחור וייתכן שהוא יוסר בגרסה עתידית. במקומה, צריך להשתמש באירוע signIn.

דוגמה

// Standard client-side authorization.

gapi.analytics.auth.authorize({
  clientId: 'XXXXXX',
  container: 'auth-button'
});

gapi.analytics.auth.on('signIn', function() {
  console.log(gapi.analytics.auth.getUserProfile());
});

// Authorization using an access token obtained server-side.
// You do not need to register an event handler because
// authorization happens immediately.

gapi.analytics.auth.authorize({
  serverAuth: {
    access_token: 'XXXXXX'
  }
});

הערה: ההרשאה מתבצעת באופן מיידי כשמשתמשים ב-serverAuth.access_token, כך שאין צורך לרשום handler של אירוע.

חשוב: כשמשתמשים ב-serverAuth.access_token, צריך לוודא שהאסימון תקין והתוקף שלו לא פג. לפרטים על אופן הרענון של אסימון גישה שפג תוקפו, יש לעיין בתיעוד של OAuth 2.0.

נתונים

gapi.analytics.report.Data

יצרן
Data(options:Object)	רכיב הנתונים מאפשר לשלוח שאילתה ל-Core Reporting API של Google Analytics ולחזור לתוצאות.

אפשרויות
query	סוג: Object אובייקט שמכיל פרמטרים של שאילתה מ-Core Reporting API. ערכי ברירת המחדל הבאים משמשים בנוסף לברירות המחדל הרגילות של ה-API: { 'start-date': '7daysAgo', 'end-date': 'yesterday }

שיטות שעברו בירושה
get
set
execute
on
once
off
emit

אירועים
success	ארגומנטים: response מופעל כשהשאילתה הושלמה בהצלחה.
error	ארגומנטים: response מופעל כשמתרחשת שגיאה במהלך תהליך השאילתה. אם ברצונך לקבל את הודעת השגיאה מאובייקט התגובה, היא תופיע בכתובת response.error.message.

דוגמה

var report = new gapi.analytics.report.Data({
  query: {
    ids: 'ga:XXXX',
    metrics: 'ga:sessions',
    dimensions: 'ga:city'
  }
});

report.on('success', function(response) {
  console.log(response);
});

report.execute();

תרשים נתונים

gapi.analytics.googleCharts.DataChart

יצרן
DataChart(options:Object)	התרשים DataChart כולל תרשים Google רגיל ורכיב נתונים כדי שתוכלו ליצור בקלות תצוגה חזותית משאילתה בלי שתצטרכו לחבר אותה בעצמכם.

אפשרויות
query	סוג: Object יש לעיין באפשרות השאילתה של רכיבי נתונים.
chart	סוג: Object בהמשך מופיעים פרטים על אפשרויות התרשים הנפרדות.
chart.container	סוג: string|HTMLElement המזהה של רכיב HTML ב-DOM שיארח את תרשים הנתונים. אפשר גם להעביר הפניה לאלמנט עצמו.
chart.type	סוג: string סוג התרשים. האפשרויות האפשריות הן: LINE, COLUMN, BAR, TABLE ו-GEO.
chart.options	סוג: Object כל אפשרות שניתן להעביר לאובייקט Google תרשים המתאים.

שיטות שעברו בירושה
get
set
execute
on
once
off
emit

אירועים
success	ארגומנטים: result מופעל כשהשאילתה הושלמה בהצלחה והתרשים בוצע במלואו. result.chart – מופע התרשים של Google. result.data – תגובת הדוח בפורמט פרמטר נתונים. result.dataTable – המופע DataTable שנוצר מהאובייקט result.data. result.response – אובייקט התגובה הגולמי של ה-API.
error	ארגומנטים: response מופעל כשמתרחשת שגיאה במהלך השאילתה או תהליך הרינדור. אם ברצונך לקבל את הודעת השגיאה מאובייקט התגובה, היא תופיע בכתובת response.error.message.

דוגמה

var chart = new gapi.analytics.googleCharts.DataChart({
  query: {
    ids: 'ga:XXXX',
    metrics: 'ga:sessions',
    dimensions: 'ga:date'
  },
  chart: {
    type: 'LINE',
    container: 'line-chart',
    options: {
      title: 'Sessions over the past week.',
      fontSize: 12
    }
  }
});
chart.on('success', function(response) {
  // response.chart : the Google Chart instance.
  // response.data : the Google Chart data object.
});

chart.execute();

בורר צפיות

gapi.analytics.ViewSelector

יצרן
ViewSelector(options:Object)	הרכיב ViewSelector מאפשר לבחור את החשבון, הנכס והתצוגה המפורטת דרך תפריטים נפתחים.

אפשרויות
container	סוג: string|HTMLElement המזהה של רכיב HTML ב-DOM שיארח את ה-ViewSelector. אפשר גם להעביר הפניה לאלמנט עצמו.

שיטות שעברו בירושה
get
set
execute
on
once
off
emit

מאפייני מכונה
ids	סוג: string מזהה הטבלה הייחודי של הטופס ga:XXXX, כאשר XXXX הוא מזהה התצוגה המפורטת (הפרופיל) של Analytics.

אירועים
change	ארגומנטים: ids מופעל בכל פעם שהמשתמש בוחר תצוגה חדשה מהתפריטים הנפתחים. הוא גם מופעל כשהמכונה ViewSelector מעובדת לראשונה ותצוגת ברירת המחדל מוצגת.

דוגמה

var viewSelector = new gapi.analytics.ViewSelector({
  container: 'view-selector'
});

viewSelector.on('change', function(ids) {
  console.log(ids);
});

viewSelector.execute();

שיטות רכיבים משותפות

שיטות
set(options)	החזרות: this מגדיר או מעדכן את אפשרויות התצורה של הרכיב (ניתן לעשות זאת גם בזמן היצירה בבנייה).
get()	החזרות: Object מחזירה את אפשרויות התצורה הנוכחיות של רכיב.
execute()	החזרות: this מפעיל את הפעולה הראשית של הרכיב. בדרך כלל זהו עיבוד של דף או הרצת דוח (או שניהם).
on(event, handler)	החזרות: this רושם פונקציה שתופעל כאשר הרכיב יפיק את האירוע שצוין.
once(event, handler)	החזרות: this רישום הפונקציה שתופעל רק במופע הבא של האירוע שצוין. לאחר שה-handler מופעל, הוא מבטל את הרישום שלו באופן אוטומטי.
off(opt_event, opt_handler)	החזרות: undefined מסיר handler של אירוע מרכיב. אם אין handler שמעבירים, הוא מסיר את כל רכיבי ה-handler של האירוע שהועבר. אם לא מועבר אירוע, המערכת מסירה את כל רכיבי ה-handler של כל האירועים.
emit(event, ...opt_args)	החזרות: undefined פולט אירוע. אפשר לציין את הארגומנטים שיועברו לכל גורמי handler רשומים.

set

מגדיר או מעדכן את אפשרויות התצורה של הרכיב (ניתן לעשות זאת גם בזמן היצירה בבנייה).

שימוש

component.set(options);

פרמטרים

שם	סוג	תיאור
options	Object	אפשרויות ההגדרה לרכיב הזה. האפשרויות שיועברו ימוזגו עם האפשרויות הקיימות.

החזרות

this – מופע הרכיב.

---

get

מחזירה את אפשרויות התצורה הנוכחיות של רכיב.

החזרות

Object – אפשרויות התצורה הנוכחיות של הרכיב.

---

execute()

מפעיל את הפעולה הראשית של הרכיב. בדרך כלל זהו עיבוד של דף או הרצת דוח (או שניהם).

החזרות

this – מופע הרכיב.

---

on(event, handler)

רושם פונקציה שתופעל כאשר הרכיב יפיק את האירוע שצוין.

פרמטרים

שם	סוג	תיאור
event	string	שם האירוע.
handler	Function	הפונקציה שיש להפעיל כשהאירוע מתרחש. (לפרטים נוספים על אירועים, עיינו בהפניות לאירועים).

החזרות

this – מופע הרכיב.

---

once(event, handler)

רישום הפונקציה שתופעל רק במופע הבא של האירוע שצוין. לאחר שה-handler מופעל, הוא מבטל את הרישום שלו באופן אוטומטי.

פרמטרים

שם	סוג	תיאור
event	string	שם האירוע.
handler	Function	הפונקציה שיש להפעיל כשהאירוע מתרחש. (לפרטים נוספים על אירועים, עיינו בהפניות לאירועים).

החזרות

this – מופע הרכיב.

---

off(opt_event, opt_handler)

מסיר handler של אירוע מרכיב. אם אין handler שמעבירים, הוא מסיר את כל רכיבי ה-handler של האירוע שהועבר. אם לא מועבר אירוע, המערכת מסירה את כל רכיבי ה-handler של כל האירועים.

פרמטרים

שם	סוג	תיאור
opt_event	string	שם האירוע. אם לא מצוין אירוע, כל רכיבי ה-handler של כל האירועים יוסרו. אופציונלי.
opt_handler	Function	הפניה ל-handler של הפונקציה להסרה. אם לא מועברת פונקציה, כל רכיבי ה-handler נמחקים. אופציונלי.

החזרות

undefined

---

emit(event, ...opt_args)

פולט אירוע. אפשר לציין את הארגומנטים שיועברו לכל גורמי handler רשומים.

פרמטרים

שם	סוג	תיאור
event	string	שם האירוע.
...opt_args	*	ארגומנטים אופציונליים יועברו לכל גורמי handler רשומים של אירוע.

החזרות

undefined