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에는 일반적으로 id 및 threadId 필드만 채워집니다.
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

자세한 내용은 OAuth 2.0 Overview를 참조하세요.

HistoryType

열거형
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)

이 기록의 메일에서 삭제된 라벨입니다.

MessageAdded

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

object (Message)

MessageDeleted

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

object (Message)

LabelAdded

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

object (Message)
labelIds[]

string

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

LabelRemoved

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

object (Message)
labelIds[]

string

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