Subscriptions

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

לקבלת רשימה של שיטות עבור המשאב הזה, אפשר לעיין בסוף הדף.

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

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

{
  "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
מאחזר רשימת מינויים של המשתמש והשירותים המאומתים.
עדכון
מעדכן מינוי קיים.