Method: users.messages.batchModify
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Mengubah label pada pesan yang ditentukan.
Permintaan HTTP
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/batchModify
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
| Parameter |
userId |
string
Alamat email pengguna. Nilai khusus me dapat digunakan untuk menunjukkan pengguna yang diautentikasi.
|
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
| Representasi JSON |
{
"ids": [
string
],
"addLabelIds": [
string
],
"removeLabelIds": [
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.
|
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
Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-07-25 UTC.
[null,null,["Terakhir diperbarui pada 2025-07-25 UTC."],[],[],null,["# Method: users.messages.batchModify\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nModifies the labels on the specified messages.\n\n### HTTP request\n\n`POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/batchModify`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-----------------------------------------------------------------------------------------------------------|\n| `userId` | `string` The user's email address. The special value `me` can be used to indicate the authenticated user. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------|\n| ``` { \"ids\": [ string ], \"addLabelIds\": [ string ], \"removeLabelIds\": [ string ] } ``` |\n\n| Fields ||\n|--------------------|---------------------------------------------------------------------------------------|\n| `ids[]` | `string` The IDs of the messages to modify. There is a limit of 1000 ids per request. |\n| `addLabelIds[]` | `string` A list of label IDs to add to messages. |\n| `removeLabelIds[]` | `string` A list of label IDs to remove from messages. |\n\n### Response body\n\nIf successful, the response body is empty.\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://mail.google.com/`\n- `\n https://www.googleapis.com/auth/gmail.modify`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
