Subscriptions

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

רשימה של ה-methods במשאב הזה מופיעה בסוף הדף.

ייצוגי משאבים

מינוי לאירועים באוסף.

{
  "kind": "mirror#subscription",
  "id": string,
  "updated": datetime,
  "collection": string,
  "operation": [
    string
  ],
  "callbackUrl": string,
  "verifyToken": string,
  "userToken": string,
  "notification": {
    "collection": string,
    "itemId": string,
    "operation": string,
    "userActions": [
      {
        "type": string,
        "payload": string
      }
    ],
    "verifyToken": string,
    "userToken": string
  }
}
שם הנכס ערך תיאור הערות
callbackUrl string כתובת ה-URL שאליה יש לשלוח התראות (חייבת להתחיל ב-https://). ניתן לכתיבה
collection string האוסף שאליו אפשר להירשם. הערכים המותרים הם:
  • timeline – שינויים בציר הזמן, כולל הוספה, מחיקה ועדכונים.
  • locations – עדכוני מיקום.
  • settings – עדכוני הגדרות.
 ניתן לכתיבה
id string מזהה המינוי.
kind string סוג המשאב. הערך הוא תמיד mirror#subscription.
notification nested object אובייקט קונטיינר להתראות. השדה הזה לא מאוכלס במשאב Subscription.
notification.collection string האוסף שממנו נוצרה ההתראה.
notification.itemId string המזהה של הפריט שיצר את ההתראה.
notification.operation string סוג הפעולה שגרמה לשליחת ההתראה.

הערכים הקבילים הם:
  • "DELETE"
  • "INSERT"
  • "MENU_ACTION"
  • "UPDATE"
notification.userActions[] list רשימת הפעולות שהמשתמש ביצע והפעילו את ההתראה.
notification.userActions[].payload string מטען ייעודי (payload) אופציונלי לפעולה.

עבור פעולות מסוג CUSTOM, זהו המזהה של האפשרות בהתאמה אישית שנבחרה בתפריט.
notification.userActions[].type string סוג הפעולה. הערך של זה יכול להיות:
  • SHARE - המשתמש שיתף פריט.
  • REPLY – המשתמש השיב לפריט.
  • REPLY_ALL – המשתמש השיב לכל הנמענים של פריט.
  • CUSTOM – המשתמש בחר אפשרות בתפריט בהתאמה אישית בפריט בציר הזמן.
  • DELETE – המשתמש מחק את הפריט.
  • PIN - המשתמש הצמיד את הפריט.
  • UNPIN - המשתמש ביטל את ההצמדה של הפריט.
  • LAUNCH - המשתמש הפעיל פקודה קולית.
בעתיד יכול להיות שיתווספו סוגים נוספים. יש להתעלם מפעולות משתמש עם סוגים לא מזוהים.
notification.userToken string אסימון המשתמש שסופק על ידי השירות בזמן ההרשמה לקבלת התראות.
notification.verifyToken string אסימון האימות הסודי שסופק על ידי השירות בזמן ההרשמה לקבלת התראות.
operation[] list רשימת פעולות שצריך להירשם אליהן. רשימה ריקה מציינת שצריך להירשם לכל הפעולות באוסף. הערכים המותרים הם:
  • UPDATE – הפריט עודכן.
  • INSERT – פריט חדש נוסף.
  • DELETE – הפריט נמחק.
 ניתן לכתיבה
updated datetime השעה שבה בוצע השינוי האחרון במינוי הזה, בפורמט שתואם ל-RFC 3339.
userToken string אסימון אטום שנשלח למנוי בהתראות כדי לאפשר לו לזהות את מזהה המשתמש. ניתן לכתיבה
verifyToken string אסימון סודי שנשלח למנוי בהתראות כדי לאפשר לו לאמת שההתראה נוצרה על ידי Google. ניתן לכתיבה

שיטות

מחיקה
מחיקת מינוי.
הוספה
יצירת מינוי חדש.
list
מאחזר רשימת מינויים למשתמש ולשירות המאומתים.
עדכון
מעדכן מינוי קיים.