Method: users.messages.modify

برچسب‌ها و مقادیر برچسب طبقه‌بندی را در پیام مشخص‌شده تغییر می‌دهد. برای مدیرانی که پیام را برای کاربران سازمان خود تغییر می‌دهند، درخواست‌ها نیاز به مجوز با یک حساب کاربری سرویس دارند که دارای اختیار واگذاری دامنه برای جعل هویت کاربران با دامنه https://www.googleapis.com/auth/gmail.modify.restricted .

درخواست HTTP

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

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

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

پارامترها
userId

string

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

id

string

شناسه پیامی که باید تغییر کند.

درخواست بدنه

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

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

string

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

removeLabelIds[]

string

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

addClassificationLabels[]

object ( ClassificationLabelValue )

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

removeClassificationLabelIds[]

string

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

بدنه پاسخ

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

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

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

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

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