이 페이지는 Cloud Translation API를 통해 번역되었습니다.

Events: list

지정된 캘린더의 일정을 반환합니다. 지금 사용해 보기 또는 예시 보기

요청

HTTP 요청

GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events

매개변수

매개변수 이름	값	설명
경로 매개변수
`calendarId`	`string`	캘린더 식별자입니다. 캘린더 ID를 가져오려면 calendarList.list 메서드를 호출합니다. 현재 로그인한 사용자의 기본 캘린더에 액세스하려면 '`primary`' 키워드를 사용하세요.
선택적 쿼리 매개변수
`alwaysIncludeEmail`	`boolean`	지원 중단되고 무시됩니다.
`eventTypes`	`string`	반환할 이벤트 유형입니다. 선택사항입니다. 이 매개변수를 여러 번 반복하여 다양한 유형의 이벤트를 반환할 수 있습니다. 설정하지 않으면 모든 이벤트 유형이 반환됩니다. 허용되는 값은 다음과 같습니다. '`birthday`': 연간 반복되는 특별 종일 일정입니다. '`default`': 일반 이벤트입니다. '`focusTime`': 방해 금지 시간 일정 '`fromGmail`': Gmail에 포함된 일정 '`outOfOffice`': 부재중 일정 '`workingLocation`': 근무 위치 이벤트입니다.
`iCalUID`	`string`	응답에 제공할 iCalendar 형식의 이벤트 ID를 지정합니다. 선택사항입니다. iCalendar ID로 일정을 검색하려면 이 필드를 사용하세요.
`maxAttendees`	`integer`	응답에 포함할 참석자 최대 수입니다. 참석자가 지정된 수보다 많으면 참석자만 반환됩니다. 선택사항입니다.
`maxResults`	`integer`	하나의 결과 페이지에 반환되는 최대 이벤트 수입니다. 검색어와 일치하는 이벤트가 더 많더라도 결과 페이지의 이벤트 수가 이 값보다 적거나 아예 없을 수 있습니다. 응답의 `nextPageToken` 필드가 비어 있지 않으면 불완전한 페이지를 감지할 수 있습니다. 기본값은 250개 이벤트입니다. 페이지 크기는 2,500개 이벤트를 초과할 수 없습니다. 선택사항입니다.
`orderBy`	`string`	결과에 반환된 이벤트의 순서입니다. 선택사항입니다. 기본값은 지정되지 않은 안정적인 순서입니다. 허용되는 값은 다음과 같습니다. '`startTime`': 시작 날짜/시간순으로 정렬합니다 (오름차순). 단일 이벤트를 쿼리하는 경우에만 사용할 수 있습니다 (즉, 매개변수 `singleEvents`가 true임). '`updated`': 마지막 수정 시간순으로 정렬 (오름차순)
`pageToken`	`string`	반환할 결과 페이지를 지정하는 토큰입니다. 선택사항입니다.
`privateExtendedProperty`	`string`	propertyName=value로 지정된 확장 속성 제약조건 비공개 속성만 일치시킵니다. 이 매개변수는 모든 지정된 제약 조건과 일치하는 이벤트를 반환하기 위해 여러 번 반복될 수 있습니다.
`q`	`string`	다음 필드에서 검색어와 일치하는 이벤트를 찾는 검색어입니다. `summary` `description` `location` 참석자 `displayName` 참석자 `email` 주최자의 `displayName` 주최자의 `email` `workingLocationProperties.officeLocation.buildingId` `workingLocationProperties.officeLocation.deskId` `workingLocationProperties.officeLocation.label` `workingLocationProperties.customLocation.label` 또한 이러한 검색어는 사전 정의된 키워드와 근무 위치, 부재중, 집중 시간 이벤트의 모든 표시 제목 번역을 일치시킵니다. 예를 들어 '사무실' 또는 'Bureau'를 검색하면 `officeLocation` 유형의 근무 위치 이벤트가 반환되지만 '부재중' 또는 'Abwesend'를 검색하면 부재중 이벤트가 반환됩니다. 선택사항입니다.
`sharedExtendedProperty`	`string`	propertyName=value로 지정된 확장 속성 제약조건 공유 속성만 일치합니다. 이 매개변수는 모든 지정된 제약 조건과 일치하는 이벤트를 반환하기 위해 여러 번 반복될 수 있습니다.
`showDeleted`	`boolean`	결과에 삭제된 이벤트 (`status`이 '`cancelled`'인 경우)를 포함할지 여부입니다. `showDeleted` 및 `singleEvents`가 모두 False인 경우 반복 일정의 취소된 인스턴스 (기본 반복 일정 제외)는 계속 포함됩니다. `showDeleted` 및 `singleEvents`가 모두 true인 경우 삭제된 이벤트의 단일 인스턴스만 반환되고 기본 반복 이벤트는 반환되지 않습니다. 선택사항입니다. 기본값은 False입니다.
`showHiddenInvitations`	`boolean`	결과에 숨겨진 초대를 포함할지 여부입니다. 선택사항입니다. 기본값은 False입니다.
`singleEvents`	`boolean`	반복 일정을 인스턴스로 확장하고 단일 일회성 일정 및 반복 일정의 인스턴스만 반환하고 기본 반복 일정 자체는 반환하지 여부입니다. 선택사항입니다. 기본값은 False입니다.
`syncToken`	`string`	이전 목록 요청의 결과 마지막 페이지에서 반환된 `nextSyncToken` 필드에서 가져온 토큰입니다. 이렇게 하면 이 목록 요청의 결과에 그 이후에 변경된 항목만 포함됩니다. 이전 목록 요청 이후 삭제된 모든 이벤트는 항상 결과 집합에 포함되며 `showDeleted`를 False로 설정할 수 없습니다. 클라이언트 상태의 일관성을 보장하기 위해 `nextSyncToken`와 함께 지정할 수 없는 몇 가지 쿼리 매개변수가 있습니다. 다음과 같습니다. `iCalUID` `orderBy` `privateExtendedProperty` `q` `sharedExtendedProperty` `timeMin` `timeMax` `updatedMin` 정의되지 않은 동작을 방지하려면 다른 모든 쿼리 매개변수가 초기 동기화와 동일해야 합니다. `syncToken`가 만료되면 서버는 410 GONE 응답 코드로 응답하고 클라이언트는 저장소를 지우고 `syncToken` 없이 전체 동기화를 실행해야 합니다. 증분 동기화에 대해 자세히 알아보기 선택사항입니다. 기본값은 모든 항목을 반환하는 것입니다.
`timeMax`	`datetime`	필터링할 이벤트 시작 시간의 상한 (제외)입니다. 선택사항입니다. 기본적으로 시작 시간으로 필터링하지 않습니다. 필수 시간대 오프셋이 있는 RFC3339 타임스탬프여야 합니다(예: 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z). 밀리초는 제공할 수 있지만 무시됩니다. `timeMin`가 설정된 경우 `timeMax`가 `timeMin`보다 커야 합니다.
`timeMin`	`datetime`	필터링할 이벤트 종료 시간의 하한 (제외)입니다. 선택사항입니다. 기본적으로 종료 시간으로 필터링하지 않습니다. 필수 시간대 오프셋이 있는 RFC3339 타임스탬프여야 합니다(예: 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z). 밀리초는 제공할 수 있지만 무시됩니다. `timeMax`가 설정된 경우 `timeMin`는 `timeMax`보다 작아야 합니다.
`timeZone`	`string`	응답에 사용된 시간대입니다. 선택사항입니다. 기본값은 캘린더의 시간대입니다.
`updatedMin`	`datetime`	필터링할 이벤트의 마지막 수정 시간 하한값 (RFC3339 타임스탬프로 표시됨)입니다. 지정된 경우 이 시간 이후에 삭제된 항목은 `showDeleted`와 관계없이 항상 포함됩니다. 선택사항입니다. 기본적으로 마지막 수정 시간을 기준으로 필터링하지 않습니다.

승인

이 요청은 다음 범위 중 하나 이상으로 승인할 수 있습니다.

범위
`https://www.googleapis.com/auth/calendar.readonly`
`https://www.googleapis.com/auth/calendar`
`https://www.googleapis.com/auth/calendar.events.readonly`
`https://www.googleapis.com/auth/calendar.events`
`https://www.googleapis.com/auth/calendar.app.created`
`https://www.googleapis.com/auth/calendar.events.freebusy`
`https://www.googleapis.com/auth/calendar.events.owned`
`https://www.googleapis.com/auth/calendar.events.owned.readonly`
`https://www.googleapis.com/auth/calendar.events.public.readonly`

자세한 내용은 인증 및 승인 페이지를 참고하세요.

요청 본문

이 메소드를 사용할 때는 요청 본문을 제공하지 마세요.

응답

요청에 성공할 경우 이 메소드는 다음과 같은 구조의 응답 본문을 반환합니다.

{
  "kind": "calendar#events",
  "etag": etag,
  "summary": string,
  "description": string,
  "updated": datetime,
  "timeZone": string,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    events Resource
  ]
}

속성 이름	값	설명	참고
`kind`	`string`	컬렉션 유형 ("`calendar#events`")입니다.
`etag`	`etag`	컬렉션의 ETag입니다.
`summary`	`string`	캘린더의 제목입니다. 읽기 전용입니다.
`description`	`string`	캘린더에 대한 설명입니다. 읽기 전용입니다.
`updated`	`datetime`	캘린더의 마지막 수정 시간입니다 (RFC3339 타임스탬프로 표시됨). 읽기 전용입니다.
`timeZone`	`string`	캘린더의 시간대입니다. 읽기 전용입니다.
`accessRole`	`string`	이 캘린더에 대한 사용자의 액세스 역할입니다. 읽기 전용입니다. 가능한 값은 다음과 같습니다. '`none`' - 사용자에게 액세스 권한이 없습니다. '`freeBusyReader`' - 사용자에게 한가함/바쁨 정보에 대한 읽기 액세스 권한이 있습니다. '`reader`' - 사용자에게 캘린더에 대한 읽기 액세스 권한이 있습니다. 비공개 일정은 독자 액세스 권한이 있는 사용자에게 표시되지만 일정 세부정보는 숨겨집니다. '`writer`': 사용자에게 캘린더에 대한 읽기 및 쓰기 액세스 권한이 있습니다. 비공개 일정은 작성자 액세스 권한이 있는 사용자에게 표시되며 일정 세부정보가 표시됩니다. '`owner`': 사용자가 캘린더의 소유권을 보유합니다. 이 역할에는 ACL을 보고 조작하는 추가 기능이 있는 작성자 역할의 모든 권한이 있습니다.
`defaultReminders[]`	`list`	인증된 사용자의 캘린더에 있는 기본 리마인더입니다. 이러한 리마인더는 이 캘린더의 모든 일정에 적용되며, 이 일정은 리마인더를 명시적으로 재정의하지 않습니다 (즉, `reminders.useDefault`가 True로 설정되지 않음).
`defaultReminders[].method`	`string`	이 리마인더에서 사용하는 메서드입니다. 가능한 값은 다음과 같습니다. '`email`' - 알림이 이메일을 통해 전송됩니다. '`popup`' - UI 팝업을 통해 리마인더가 전송됩니다. 리마인더를 추가할 때 필요합니다.	쓰기 가능
`defaultReminders[].minutes`	`integer`	리마인더가 트리거되어야 하는 이벤트 시작 전까지의 분입니다. 유효한 값은 0~40320(4주(분))입니다. 리마인더를 추가할 때 필요합니다.	쓰기 가능
`nextPageToken`	`string`	이 결과의 다음 페이지에 액세스하는 데 사용되는 토큰입니다. 더 이상 결과를 사용할 수 없는 경우 생략되며 이 경우 `nextSyncToken`이 제공됩니다.
`items[]`	`list`	캘린더의 일정 목록입니다.
`nextSyncToken`	`string`	이 결과가 반환된 이후 변경된 항목만 검색하는 데 나중에 사용되는 토큰입니다. 추가 결과를 사용할 수 있는 경우 생략되며 이 경우 `nextPageToken`이 제공됩니다.

예

참고: 이 메서드에 제공되는 코드 예시가 지원되는 모든 프로그래밍 언어를 나타내는 것은 아닙니다. 지원되는 언어 목록은 클라이언트 라이브러리 페이지를 참조하세요.

자바

Java 클라이언트 라이브러리를 사용합니다.

import com.google.api.services.calendar.Calendar;
import com.google.api.services.calendar.model.Event;
import com.google.api.services.calendar.model.Events;

// ...

// Initialize Calendar service with valid OAuth credentials
Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials)
    .setApplicationName("applicationName").build();

// Iterate over the events in the specified calendar
String pageToken = null;
do {
  Events events = service.events().list('primary').setPageToken(pageToken).execute();
  List<Event> items = events.getItems();
  for (Event event : items) {
    System.out.println(event.getSummary());
  }
  pageToken = events.getNextPageToken();
} while (pageToken != null);

Python

Python 클라이언트 라이브러리를 사용합니다.

page_token = None
while True:
  events = service.events().list(calendarId='primary', pageToken=page_token).execute()
  for event in events['items']:
    print event['summary']
  page_token = events.get('nextPageToken')
  if not page_token:
    break

PHP

PHP 클라이언트 라이브러리를 사용합니다.

$events = $service->events->listEvents('primary');

while(true) {
  foreach ($events->getItems() as $event) {
    echo $event->getSummary();
  }
  $pageToken = $events->getNextPageToken();
  if ($pageToken) {
    $optParams = array('pageToken' => $pageToken);
    $events = $service->events->listEvents('primary', $optParams);
  } else {
    break;
  }
}

Ruby

Ruby 클라이언트 라이브러리를 사용합니다.

page_token = nil
begin
  result = client.list_events('primary', page_token: page_token)
  result.items.each do |e|
    print e.summary + "\n"
  end
  if result.next_page_token != page_token
    page_token = result.next_page_token
  else
    page_token = nil
  end
end while !page_token.nil?

사용해 보기

아래의 API 탐색기를 사용하여 실시간 데이터를 대상으로 이 메소드를 호출하고 응답을 확인해 보세요.