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 بنية تحويل الترميز إلى gRPC.

مَعلمات المسار

المعلمات
userId

string

عنوان البريد الإلكتروني للمستخدم. يمكن استخدام القيمة الخاصة me للإشارة إلى المستخدم الذي تم التحقّق من هويته.

نص الطلب

يتضمن نص الطلب بيانات بالبنية التالية:

تمثيل JSON 
{
  "ids": [
    string
  ],
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "addClassificationLabels": [
    {
      object (ClassificationLabelValue)
    }
  ],
  "removeClassificationLabelIds": [
    string
  ]
}
الحقول
ids[]

string

أرقام تعريف الرسائل المطلوب تعديلها. يبلغ الحد الأقصى لأرقام التعريف في كل طلب 1000 رقم تعريف.
addLabelIds[]

string

قائمة بأرقام تعريف التصنيفات المطلوب إضافتها إلى الرسائل.
removeLabelIds[]

string

قائمة بأرقام تعريف التصنيفات المطلوب إزالتها من الرسائل.
addClassificationLabels[]

object (ClassificationLabelValue)

قائمة بقيم "تصنيف الرسالة" المطلوب إضافتها. إذا تم تطبيق "تصنيف رسالة" يتضمّن رقم تعريف التصنيف نفسه على الرسالة، سيتم تعديل الحقول التي تتضمّن أرقام تعريف الحقول الحالية وإضافة الحقول التي تتضمّن أرقام تعريف الحقول الجديدة. يبلغ الحد الأقصى لقيم "تصنيف الرسالة" في كل طلب 20 قيمة. إذا كانت الرسالة مصنّفة وكان العدد الإجمالي النهائي لقيم "تصنيف الرسالة" يتجاوز الحد الأقصى المسموح به لقيم "تصنيف الرسالة" لكل رسالة، سيفشل التعديل.
removeClassificationLabelIds[]

string

قائمة بقيم "تصنيف الرسالة" المطلوب إزالتها من الرسائل.

نص الاستجابة

إذا كانت الاستجابة ناجحة، يكون نص الاستجابة فارغًا.

نطاقات الأذونات

يجب توفير أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على دليل الأذونات.