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

수정할 메시지의 ID입니다. 요청당 ID는 1,000개로 제한됩니다.
addLabelIds[]

string

메일에 추가할 라벨 ID 목록입니다.
removeLabelIds[]

string

메일에서 삭제할 라벨 ID 목록입니다.
addClassificationLabels[]

object (ClassificationLabelValue)

추가할 분류 라벨 값 목록입니다. 동일한 라벨 ID의 분류 라벨이 이미 메시지에 적용된 경우 기존 필드 ID가 있는 필드가 업데이트되고 새 필드 ID가 있는 필드가 추가됩니다. 요청당 분류 라벨 값은 20개로 제한됩니다. 메일이 이미 분류되어 있고 최종 총 분류 라벨 값이 메일당 허용되는 최대 분류 라벨 값을 초과하는 경우 수정이 실패합니다.
removeClassificationLabelIds[]

string

메일에서 삭제할 분류 라벨 값 목록입니다.

응답 본문

성공한 경우 응답 본문은 비어 있습니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

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

자세한 내용은 승인 가이드를 참고하세요.