- HTTP 요청
- 경로 매개변수
- 쿼리 매개변수
- 요청 본문
- 응답 본문
- 승인 범위
- HistoryType
- 방문 기록
- MessageAdded
- MessageDeleted
- LabelAdded
- LabelRemoved
- 실습
지정된 편지함에 대한 모든 변경 기록을 나열합니다. 기록 결과는 시간순으로 반환됩니다 (historyId
부터 증가).
HTTP 요청
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/history
URL은 gRPC 트랜스코딩 구문을 사용합니다.
경로 매개변수
매개변수 | |
---|---|
userId |
사용자의 이메일 주소 특수 값 |
쿼리 매개변수
매개변수 | |
---|---|
maxResults |
반환할 기록 레코드의 최대 개수입니다. 이 필드의 기본값은 100입니다. 이 필드에 허용되는 최대값은 500입니다. |
pageToken |
목록에서 특정 결과 페이지를 검색하는 페이지 토큰입니다. |
startHistoryId |
필수 항목입니다. 지정된 |
labelId |
ID와 일치하는 라벨이 있는 메일만 반환합니다. |
historyTypes[] |
함수에서 반환할 기록 유형 |
요청 본문
요청 본문은 비어 있어야 합니다.
응답 본문
성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.
JSON 표현 |
---|
{
"history": [
{
object ( |
필드 | |
---|---|
history[] |
기록 기록 목록입니다. 응답에 포함된 모든 |
nextPageToken |
목록에서 다음 결과 페이지를 검색하는 페이지 토큰입니다. |
historyId |
편지함의 현재 기록 레코드 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
자세한 내용은 승인 가이드를 참고하세요.
HistoryType
열거형 | |
---|---|
messageAdded |
|
messageDeleted |
|
labelAdded |
|
labelRemoved |
기록
사용자의 편지함 변경 기록 기록의 각 변경사항은 다양한 방식으로 여러 메시지에 영향을 미칠 수 있습니다.
JSON 표현 |
---|
{ "id": string, "messages": [ { object ( |
필드 | |
---|---|
id |
편지함 시퀀스 ID입니다. |
messages[] |
이 기록 레코드에서 변경된 메시지 목록입니다. 특정 변경 유형(예: |
messagesAdded[] |
이 기록 레코드의 편지함에 추가된 메시지입니다. |
messagesDeleted[] |
이 기록 레코드에 있는 편지함에서 삭제된 메일 (휴지통으로 이동되지 않음)입니다. |
labelsAdded[] |
이 기록 레코드의 메시지에 라벨이 추가되었습니다. |
labelsRemoved[] |
이 기록 레코드의 메시지에서 라벨이 삭제되었습니다. |
MessageAdded
JSON 표현 |
---|
{
"message": {
object ( |
필드 | |
---|---|
message |
|
MessageDeleted
JSON 표현 |
---|
{
"message": {
object ( |
필드 | |
---|---|
message |
|
LabelAdded
JSON 표현 |
---|
{
"message": {
object ( |
필드 | |
---|---|
message |
|
labelIds[] |
메일에 추가된 라벨 ID입니다. |
LabelRemoved
JSON 표현 |
---|
{
"message": {
object ( |
필드 | |
---|---|
message |
|
labelIds[] |
메일에서 라벨 ID가 삭제되었습니다. |