Method: users.messages.batchModify

Mengubah label dan nilai Label Klasifikasi pada pesan tertentu. Untuk administrator yang mengubah pesan bagi pengguna di organisasi mereka, permintaan memerlukan otorisasi dengan akun layanan yang memiliki otoritas delegasi di seluruh domain untuk meniru identitas pengguna dengan cakupan https://www.googleapis.com/auth/gmail.modify.restricted.

Permintaan HTTP

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

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
userId

string

Alamat email pengguna. Nilai khusus me dapat digunakan untuk menunjukkan pengguna terautentikasi.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "ids": [
    string
  ],
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "addClassificationLabels": [
    {
      object (ClassificationLabelValue)
    }
  ],
  "removeClassificationLabelIds": [
    string
  ]
}
Kolom
ids[]

string

ID pesan yang akan diubah. Ada batas 1.000 ID per permintaan.
addLabelIds[]

string

Daftar ID label yang akan ditambahkan ke pesan.
removeLabelIds[]

string

Daftar ID label yang akan dihapus dari pesan.
addClassificationLabels[]

object (ClassificationLabelValue)

Daftar nilai Label Klasifikasi yang akan ditambahkan. Jika Label Klasifikasi dengan ID label yang sama sudah diterapkan ke pesan, kolom dengan ID kolom yang ada akan diperbarui dan kolom dengan ID kolom baru akan ditambahkan. Ada batas 20 nilai Label Klasifikasi per permintaan. Jika pesan sudah diklasifikasikan dan jumlah akhir total nilai Label Klasifikasi melebihi jumlah maksimum nilai Label Klasifikasi yang diizinkan per pesan, modifikasi akan gagal.
removeClassificationLabelIds[]

string

Daftar nilai Label Klasifikasi yang akan dihapus dari pesan.

Isi respons

Jika berhasil, isi respons akan kosong.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.