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 از سینتکس Transcoding در gRPC استفاده می‌کند.

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

پارامترها
userId

string

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

درخواست بدنه

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

نمایش JSON 
{
  "ids": [
    string
  ],
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "addClassificationLabels": [
    {
      object (ClassificationLabelValue)
    }
  ],
  "removeClassificationLabelIds": [
    string
  ]
}
فیلدها
ids[]

string

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

addLabelIds[]

string

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

removeLabelIds[]

string

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

addClassificationLabels[]

object ( ClassificationLabelValue )

فهرستی از مقادیر برچسب طبقه‌بندی برای افزودن. اگر یک برچسب طبقه‌بندی با شناسه برچسب مشابه از قبل به پیام اعمال شده باشد، فیلدهایی با شناسه‌های فیلد موجود به‌روزرسانی می‌شوند و فیلدهایی با شناسه‌های فیلد جدید اضافه می‌شوند. محدودیت ۲۰ مقدار برچسب طبقه‌بندی برای هر درخواست وجود دارد. اگر پیام از قبل طبقه‌بندی شده باشد و تعداد کل مقادیر برچسب طبقه‌بندی نهایی از حداکثر تعداد مجاز مقادیر برچسب طبقه‌بندی برای هر پیام بیشتر شود، اصلاح با شکست مواجه می‌شود.

removeClassificationLabelIds[]

string

فهرستی از مقادیر برچسب طبقه‌بندی که باید از پیام‌ها حذف شوند.

بدنه پاسخ

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

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

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

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

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