Method: users.messages.modify

משנה את התוויות ואת הערכים של תוויות הסיווג בהודעה שצוינה. אדמינים שמשנים הודעות של משתמשים בארגון שלהם צריכים לבקש הרשאה באמצעות חשבון שירות שיש לו הרשאת העברה של סמכויות אדמין בכל הדומיין כדי להתחזות למשתמשים עם היקף ההרשאה https://www.googleapis.com/auth/gmail.modify.restricted.

בקשת HTTP

POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/{id}/modify

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

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

פרמטרים
userId

string

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

string

המזהה של ההודעה שרוצים לשנות.

גוף הבקשה

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

ייצוג ב-JSON 
{
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "addClassificationLabels": [
    {
      object (ClassificationLabelValue)
    }
  ],
  "removeClassificationLabelIds": [
    string
  ]
}
שדות
addLabelIds[]

string

רשימה של מזהי תוויות שרוצים להוסיף להודעה. אפשר להוסיף עד 100 תוויות בכל עדכון.
removeLabelIds[]

string

רשימה של מזהי תוויות שרוצים להסיר מההודעה. אפשר להסיר עד 100 תוויות בכל עדכון.
addClassificationLabels[]

object (ClassificationLabelValue)

רשימה של ערכים של תוויות סיווג שרוצים להוסיף. אם תווית סיווג עם אותו מזהה תווית כבר חלה על ההודעה, שדות עם מזהי שדות קיימים יעודכנו ושדות עם מזהי שדות חדשים יתווספו. יש מגבלה של 20 ערכים של תוויות סיווג לכל בקשה. אם ההודעה כבר סווגה ומספר הערכים הכולל הסופי של תוויות הסיווג חורג מהמספר המקסימלי המותר של ערכי תוויות סיווג לכל הודעה, השינוי נכשל.
removeClassificationLabelIds[]

string

רשימה של ערכי תוויות סיווג שצריך להסיר מההודעה הזו.

גוף התשובה

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

היקפי הרשאות

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

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

מידע נוסף זמין במדריך ההרשאות.