사용자의 캘린더 목록에 있는 캘린더를 반환합니다. 지금 사용해 보기
요청
HTTP 요청
GET https://www.googleapis.com/calendar/v3/users/me/calendarList
매개변수
매개변수 이름 | 값 | 설명 |
---|---|---|
선택적 쿼리 매개변수 | ||
maxResults |
integer |
하나의 결과 페이지에 반환되는 최대 항목 수입니다. 기본값은 항목 100개입니다. 페이지 크기는 항목 250개를 초과할 수 없습니다. 선택사항입니다. |
minAccessRole |
string |
반환된 항목에서 사용자의 최소 액세스 역할입니다. 선택사항입니다. 기본값은 제한이 없습니다.
허용되는 값은 다음과 같습니다.
|
pageToken |
string |
반환할 결과 페이지를 지정하는 토큰입니다. 선택사항입니다. |
showDeleted |
boolean |
삭제된 캘린더 목록 항목을 결과에 포함할지 여부입니다. 선택사항입니다. 기본값은 False입니다. |
showHidden |
boolean |
숨겨진 항목을 표시할지 여부입니다. 선택사항입니다. 기본값은 False입니다. |
syncToken |
string |
이전 목록 요청의 결과 마지막 페이지에서 반환된 nextSyncToken 필드에서 가져온 토큰입니다. 이렇게 하면 이 목록 요청의 결과에 그 이후에 변경된 항목만 포함됩니다. 캘린더 속성 또는 ACL과 같은 읽기 전용 필드만 변경된 경우 항목이 반환되지 않습니다. 이전 목록 요청 이후에 삭제되고 숨겨진 모든 항목은 항상 결과 세트에 포함되며 showDeleted 또는 showHidden 를 False로 설정할 수 없습니다. 클라이언트 상태 일관성을 보장하기 위해 minAccessRole 쿼리 매개변수를 nextSyncToken 와 함께 지정할 수 없습니다. syncToken 가 만료되면 서버는 410 GONE 응답 코드로 응답하고 클라이언트는 저장소를 지우고 syncToken 없이 전체 동기화를 실행해야 합니다. 증분 동기화에 대해 자세히 알아보기 선택사항입니다. 기본값은 모든 항목을 반환하는 것입니다. |
승인
이 요청에는 다음 범위 중 하나 이상에 대한 승인이 필요합니다.
범위 |
---|
https://www.googleapis.com/auth/calendar.readonly |
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.calendarlist |
https://www.googleapis.com/auth/calendar.calendarlist.readonly |
자세한 내용은 인증 및 승인 페이지를 참고하세요.
요청 본문
이 메소드를 사용할 때는 요청 본문을 제공하지 마세요.
응답
요청에 성공할 경우 이 메소드는 다음과 같은 구조의 응답 본문을 반환합니다.
{ "kind": "calendar#calendarList", "etag": etag, "nextPageToken": string, "nextSyncToken": string, "items": [ calendarList Resource ] }
속성 이름 | 값 | 설명 | 참고 |
---|---|---|---|
kind |
string |
컬렉션 유형 ("calendar#calendarList ")입니다. |
|
etag |
etag |
컬렉션의 ETag입니다. | |
nextPageToken |
string |
이 결과의 다음 페이지에 액세스하는 데 사용되는 토큰입니다. 더 이상 결과를 사용할 수 없는 경우 생략되며 이 경우 nextSyncToken 이 제공됩니다. |
|
items[] |
list |
사용자의 캘린더 목록에 있는 캘린더입니다. | |
nextSyncToken |
string |
이 결과가 반환된 이후 변경된 항목만 검색하는 데 나중에 사용되는 토큰입니다. 추가 결과를 사용할 수 있는 경우 생략되며 이 경우 nextPageToken 이 제공됩니다. |
사용해 보기
아래의 API 탐색기를 사용하여 실시간 데이터를 대상으로 이 메소드를 호출하고 응답을 확인해 보세요.