Method: users.messages.batchModify

لتعديل التصنيفات على الرسائل المحدَّدة.

طلب HTTP

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

يستخدم عنوان URL بنية gRPC Transcode.

معلّمات المسار

المعلّمات
userId

string

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

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON
{
  "ids": [
    string
  ],
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ]
}
الحقول
ids[]

string

أرقام تعريف الرسائل المطلوب تعديلها. الحد الأقصى لكل طلب هو 1,000 معرّف.

addLabelIds[]

string

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

removeLabelIds[]

string

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

نص الاستجابة

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

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

يتطلب ذلك أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، اطّلِع على دليل التفويض.