Method: users.messages.batchModify

Sửa đổi nhãn và giá trị Nhãn phân loại trên các thông báo được chỉ định. Đối với quản trị viên sửa đổi thư cho người dùng trong tổ chức của họ, các yêu cầu cần được uỷ quyền bằng một tài khoản dịch vụ có quyền uỷ quyền trên toàn miền để mạo danh người dùng có phạm vi https://www.googleapis.com/auth/gmail.modify.restricted.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Thông số
userId

string

Địa chỉ email của người dùng. Bạn có thể dùng giá trị đặc biệt me để cho biết người dùng đã xác thực.

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu với cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "ids": [
    string
  ],
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "addClassificationLabels": [
    {
      object (ClassificationLabelValue)
    }
  ],
  "removeClassificationLabelIds": [
    string
  ]
}
Trường
ids[]

string

Mã của những thư cần sửa đổi. Mỗi yêu cầu có tối đa 1.000 mã nhận dạng.
addLabelIds[]

string

Danh sách mã nhận dạng nhãn cần thêm vào thư.
removeLabelIds[]

string

Danh sách mã nhận dạng nhãn cần xoá khỏi thư.
addClassificationLabels[]

object (ClassificationLabelValue)

Danh sách các giá trị Nhãn phân loại cần thêm. Nếu một Nhãn phân loại có cùng mã nhận dạng nhãn đã được áp dụng cho thông báo, thì các trường có mã nhận dạng trường hiện có sẽ được cập nhật và các trường có mã nhận dạng trường mới sẽ được thêm vào. Mỗi yêu cầu có giới hạn 20 giá trị Nhãn phân loại. Nếu thông báo đã được phân loại và tổng số giá trị Nhãn phân loại cuối cùng vượt quá số lượng giá trị Nhãn phân loại tối đa được phép cho mỗi thông báo, thì quá trình sửa đổi sẽ không thành công.
removeClassificationLabelIds[]

string

Danh sách các giá trị Nhãn phân loại cần xoá khỏi thư.

Nội dung phản hồi

Nếu thành công, phần nội dung phản hồi sẽ trống.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.