Method: users.messages.batchModify

برچسب‌های روی پیام‌های مشخص‌شده را تغییر می‌دهد.

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

پارامترهای مسیر

پارامترها
userId

string

آدرس ایمیل کاربر. مقدار ویژه me می‌تواند برای نشان دادن کاربر احراز هویت شده استفاده شود.

درخواست بدنه

بدنه درخواست شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "ids": [
    string
  ],
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ]
}
فیلدها
ids[]

string

شناسه‌های پیام‌هایی که باید تغییر کنند. محدودیت ۱۰۰۰ شناسه برای هر درخواست وجود دارد.

addLabelIds[]

string

فهرستی از شناسه‌های برچسب برای افزودن به پیام‌ها.

removeLabelIds[]

string

فهرستی از شناسه‌های برچسب برای حذف از پیام‌ها.

بدنه پاسخ

در صورت موفقیت، بدنه پاسخ خالی است.

دامنه‌های مجوز

به یکی از حوزه‌های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .