Method: users.history.list

지정된 편지함의 모든 변경 기록을 나열합니다. 기록 결과는 시간순으로 반환됩니다 (historyId 증가).

HTTP 요청

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/history

URL은 gRPC 트랜스코딩 구문을 사용합니다.

경로 매개변수

매개변수
userId

string

사용자의 이메일 주소 특수 값 me는 인증된 사용자를 나타내는 데 사용할 수 있습니다.

쿼리 매개변수

매개변수
maxResults

integer (uint32 format)

반환할 최대 기록 레코드 수입니다. 이 필드의 기본값은 100입니다. 이 입력란에 허용되는 최댓값은 500입니다.

pageToken

string

목록의 특정 결과 페이지를 가져오는 페이지 토큰입니다.

startHistoryId

string

필수 항목입니다. 지정된 startHistoryId 이후의 기록 레코드를 반환합니다. 제공된 startHistoryId는 메시지, 스레드 또는 이전 list 응답의 historyId에서 가져와야 합니다. 기록 ID는 시간순으로 늘어나지만 유효한 ID 사이의 임의 간격이 연속되지 않습니다. 잘못되거나 오래된 startHistoryId를 제공하면 일반적으로 HTTP 404 오류 코드가 반환됩니다. historyId은 일반적으로 최소 1주일 동안 유효하지만, 몇 시간 동안만 유효한 경우도 있습니다. HTTP 404 오류 응답이 수신되면 애플리케이션이 전체 동기화를 수행해야 합니다. 응답에 nextPageToken를 수신하지 않으면 검색할 업데이트가 없는 것이며, 향후 요청을 위해 반환된 historyId을 저장할 수 있습니다.

labelId

string

ID와 일치하는 라벨이 있는 메시지만 반환합니다.

historyTypes[]

enum (HistoryType)

함수에서 반환할 기록 유형

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현
{
  "history": [
    {
      object (History)
    }
  ],
  "nextPageToken": string,
  "historyId": string
}
필드
history[]

object (History)

기록 기록 목록입니다. 응답에 포함된 모든 messages에는 일반적으로 idthreadId 필드만 채워집니다.

nextPageToken

string

목록의 다음 결과 페이지를 검색하는 페이지 토큰입니다.

historyId

string

편지함의 현재 기록 레코드 ID입니다.

승인 범위

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

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

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

기록 유형

열거형
messageAdded
messageDeleted
labelAdded
labelRemoved

기록

사용자의 편지함 변경 기록 각 변경 내역은 여러 메일에 다양한 영향을 미칠 수 있습니다.

JSON 표현
{
  "id": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "messagesAdded": [
    {
      object (MessageAdded)
    }
  ],
  "messagesDeleted": [
    {
      object (MessageDeleted)
    }
  ],
  "labelsAdded": [
    {
      object (LabelAdded)
    }
  ],
  "labelsRemoved": [
    {
      object (LabelRemoved)
    }
  ]
}
필드
id

string

편지함 순서 ID입니다.

messages[]

object (Message)

기록 기록에서 메시지 목록이 변경되었습니다. 특정 변경 유형의 필드(예: messagesAdded)가 이 필드의 메시지를 복제할 수 있습니다. 이 유형 대신 특정 변경 유형 필드를 사용하는 것이 좋습니다.

messagesAdded[]

object (MessageAdded)

기록 기록의 편지함에 메시지가 추가되었습니다.

messagesDeleted[]

object (MessageDeleted)

이 기록의 편지함에서 메일이 삭제되지 않고 휴지통으로 이동되지 않았습니다.

labelsAdded[]

object (LabelAdded)

이 기록 레코드의 메시지에 라벨이 추가되었습니다.

labelsRemoved[]

object (LabelRemoved)

이 기록 레코드의 메시지에서 라벨이 삭제되었습니다.

메시지 추가됨

JSON 표현
{
  "message": {
    object (Message)
  }
}
필드
message

object (Message)

MessageDeleted

JSON 표현
{
  "message": {
    object (Message)
  }
}
필드
message

object (Message)

라벨 추가됨

JSON 표현
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
필드
message

object (Message)

labelIds[]

string

메일에 추가된 라벨 ID입니다.

라벨 삭제됨

JSON 표현
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
필드
message

object (Message)

labelIds[]

string

메일에서 삭제된 라벨 ID입니다.