Method: users.messages.batchModify

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

בקשת HTTP

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

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

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

פרמטרים
userId

string

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

גוף הבקשה

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

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

string

המזהים של ההודעות שרוצים לשנות. יש מגבלה של 1,000 מזהים לכל בקשה.
addLabelIds[]

string

רשימה של מזהי תוויות להוספה להודעות.
removeLabelIds[]

string

רשימה של מזהי תוויות להסרה מההודעות.
addClassificationLabels[]

object (ClassificationLabelValue)

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

string

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

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יהיה ריק.

היקפי הרשאות

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

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

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