Method: users.watch

הגדרה או עדכון של מעקב אחרי התראות פוש בתיבת הדואר של המשתמש.

בקשת HTTP

POST https://gmail.googleapis.com/gmail/v1/users/{userId}/watch

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
userId

string

כתובת האימייל של המשתמש. אפשר להשתמש בערך המיוחד me כדי לציין את המשתמש המאומת.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "labelIds": [
    string
  ],
  "labelFilterAction": enum (LabelFilterAction),
  "labelFilterBehavior": enum (LabelFilterAction),
  "topicName": string
}
שדות
labelIds[]

string

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

enum (LabelFilterAction)

התנהגות הסינון של labelIds list שצוינה. השדה הזה הוצא משימוש כי הוא גרם להתנהגות שגויה במקרים מסוימים. במקומו צריך להשתמש ב-labelFilterBehavior.
labelFilterBehavior

enum (LabelFilterAction)

התנהגות הסינון של labelIds list שצוינה. השדה הזה מחליף את השדה labelFilterAction. אם הוא מוגדר, המערכת מתעלמת מהשדה labelFilterAction.
topicName

string

שם נושא מלא ב-Google Cloud Pub/Sub API לפרסום האירועים. שם הנושא הזה צריך כבר להיות קיים ב-Cloud Pub/Sub, וצריך שכבר הענקתם ל-Gmail הרשאת פרסום בו. לדוגמה, 'projects/my-project-identifier/topics/my-topic-name' (בפורמט של שמות נושאים ב-Cloud Pub/Sub 'v1').

חשוב לשים לב שהחלק my-project-identifier חייב להיות זהה למזהה הפרויקט שלכם ב-Google Developers (זה שמבצע את בקשת הצפייה הזו).

גוף התשובה

תגובה בהתראה בשעון.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "historyId": string,
  "expiration": string
}
שדות
historyId

string

המזהה של רשומת ההיסטוריה הנוכחית של תיבת הדואר.
expiration

string (int64 format)

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.metadata

ניתן למצוא מידע נוסף כאן: OAuth 2.0 Overview.

LabelFilterAction

הוגדר אופן הסינון של רשימת labelIds.

טיפוסים בני מנייה (enum)
include קבלת התראות פוש רק על שינויים בהודעות שקשורות ל-labelIds שצוינו.
exclude לקבל התראות פוש על כל השינויים בהודעות, חוץ מאלה שקשורים ל-labelIds שצוינו.