Method: users.messages.batchModify

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

درخواست 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
  ]
}
فیلدها
ids[]

string

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

addLabelIds[]

string

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

removeLabelIds[]

string

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

بدن پاسخگو

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

محدوده مجوز

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

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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.