Method: users.messages.batchModify

שינוי התוויות בהודעות שצוינו.

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

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

פרמטרים
userId

string

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

גוף הבקשה

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

ייצוג JSON 
{
  "ids": [
    string
  ],
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ]
}
שדות
ids[]

string

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

string

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

string

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

גוף התגובה

אם הביצוע יהיה תקין, גוף התגובה יהיה ריק.

היקפי הרשאות

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

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

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