푸시 알림 받기

이 문서에서는 리소스가 변경될 때 애플리케이션에 알리는 푸시 알림을 사용하는 방법을 설명합니다.

개요

Google Calendar API는 리소스 변경사항을 모니터링할 수 있는 푸시 알림을 제공합니다. 이 기능을 사용하여 애플리케이션의 성능을 개선할 수 있습니다. 이 기능을 사용하면 리소스가 변경되었는지 확인하기 위해 리소스를 폴링하는 데 드는 추가 네트워크 및 컴퓨팅 비용을 절감할 수 있습니다. 감시 중인 리소스가 변경될 때마다 Google Calendar API는 애플리케이션에 알립니다.

푸시 알림을 사용하려면 다음 두 가지 작업을 실행해야 합니다.

  • 수신 URL 또는 '웹훅' 콜백 수신기를 설정합니다.

    리소스가 변경될 때 트리거되는 API 알림 메시지를 처리하는 HTTPS 서버입니다.

  • 감시하려는 각 리소스 엔드포인트에 (알림 채널)을 설정합니다.

    채널은 알림 메시지의 라우팅 정보를 지정합니다. 채널 설정의 일부로 알림을 수신하려는 특정 URL을 식별해야 합니다. 채널의 리소스가 변경될 때마다 Google Calendar API는 알림 메시지를 해당 URL에 POST 요청으로 전송합니다.

현재 Google Calendar API는 ACL, CalendarList, Events, Settings 리소스의 변경사항에 대한 알림을 지원합니다.

알림 채널 만들기

푸시 알림을 요청하려면 모니터링하려는 각 리소스에 알림 채널 을 설정해야 합니다. 알림 채널이 설정되면 Google Calendar API는 감시 중인 리소스가 변경될 때 애플리케이션에 알립니다.

감시 요청 만들기

감시 가능한 각 Google Calendar API 리소스에는 다음 형식의 URI에 연결된 watch 메서드가 있습니다.

https://www.googleapis.com/API_NAME/API_VERSION/RESOURCE_PATH/watch

특정 리소스의 변경사항에 관한 메시지의 알림 채널을 설정하려면 리소스의 watch 메서드에 POST 요청을 전송합니다.

각 알림 채널은 특정 사용자 및 특정 리소스 (또는 리소스 집합)와 연결됩니다. 현재 사용자가 이 리소스를 소유하거나 액세스할 수 있는 권한이 없는 경우 watch 요청은 성공하지 않습니다.

예

지정된 캘린더의 일정 모음 변경사항 감시를 시작합니다.

POST https://www.googleapis.com/calendar/v3/calendars/my_calendar@gmail.com/events/watch
Authorization: Bearer auth_token_for_current_user
Content-Type: application/json

{
  "id": "01234567-89ab-cdef-0123456789ab",
  "type": "web_hook",
  "address": "https://mydomain.com/notifications",
  ...
  "token": "target=myApp-myCalendarChannelDest",
  "expiration": 1426325213000
}

요청 본문에서 채널 id, type을 web_hook로, 수신 URL을 address에 제공합니다. 선택적으로 다음을 제공할 수도 있습니다.

  • 채널 토큰으로 사용할 token
  • 요청된 채널 만료 시간의 expiration 시간(밀리초)

필수 속성

각 watch 요청에는 다음 필드를 제공해야 합니다.

  • 프로젝트 내에서 이 새 알림 채널을 고유하게 식별하는 id 속성 문자열 범용 고유 식별자(UUID) 또는 유사한 고유 문자열을 사용하는 것이 좋습니다. 최대 길이는 64자(영문 기준)입니다.

    설정한 ID 값은 이 채널에 수신하는 모든 알림 메시지의 X-Goog-Channel-Id HTTP 헤더에 다시 표시됩니다.

  • type 속성 문자열이 값으로 설정되었습니다web_hook.

  • 이 알림 채널의 알림을 수신 대기하고 응답하는 URL로 설정된 address 속성 문자열 웹훅 콜백 URL이며 HTTPS를 사용해야 합니다.

    Google Calendar API는 웹 서버에 유효한 SSL 인증서가 설치되어 있는 경우에만 이 HTTPS 주소로 알림을 전송할 수 있습니다. 다음 인증서는 유효하지 않습니다.

    • 자체 서명된 인증서
    • 신뢰할 수 없는 출처에서 서명한 인증서
    • 취소된 인증서
    • 대상 호스트 이름과 일치하지 않는 주체가 있는 인증서

선택 속성

` watch` 요청으로 이러한 선택적 필드를 지정할 수도 있습니다.

  • 채널 토큰으로 사용할 임의 문자열 값을 지정하는 token 속성 알림 채널 토큰은 다양한 용도로 사용할 수 있습니다. 예를 들어 토큰을 사용하여 각 받은 메시지가 애플리케이션에서 만든 채널에 대한 것인지 확인하여 알림이 스푸핑되지 않도록 하거나 이 채널의 목적에 따라 애플리케이션 내의 올바른 대상으로 메시지를 라우팅할 수 있습니다. 최대 길이는 256자(영문 기준)입니다.

    토큰은 애플리케이션이 이 채널에 수신하는 모든 알림 메시지의 X-Goog-Channel-Token HTTP 헤더에 포함됩니다.

    알림 채널 토큰을 사용하는 경우 다음을 실행하는 것이 좋습니다.

    • URL 쿼리 매개변수와 같은 확장 가능한 인코딩 형식을 사용합니다. 예: forwardTo=hr&createdBy=mobile

    • OAuth 토큰과 같은 민감한 정보는 포함하지 마세요.

  • Google Calendar API가 이 알림 채널의 메시지 전송을 중지할 날짜와 시간의 Unix 타임스탬프(밀리초)로 설정된 expiration 속성 문자열

    채널에 만료 시간이 있는 경우 애플리케이션이 이 채널에 수신하는 모든 알림 메시지의 X-Goog-Channel-Expiration HTTP 헤더에 사람이 읽을 수 있는 형식으로 값이 포함됩니다.

요청에 관한 자세한 내용은 API 참조의 ACL, CalendarList, Events, Settings 리소스의 watch 메서드 를 참고하세요.

감시 응답

watch 요청이 알림 채널을 성공적으로 만들면 HTTP 200 OK 상태 코드를 반환합니다.

감시 응답의 메시지 본문은 아래 예와 같이 방금 만든 알림 채널에 관한 정보를 제공합니다.

{
  "kind": "api#channel",
  "id": "01234567-89ab-cdef-0123456789ab",
  "resourceId": "o3hgv1538sdjfh",
  "resourceUri": "https://www.googleapis.com/calendar/v3/calendars/my_calendar@gmail.com/events",
  "token": "target=myApp-myCalendarChannelDest",
  "expiration": 1426325213000
}

응답 본문은 다음과 같은 채널 세부정보를 제공합니다.

  • kind: API 채널 리소스로 식별합니다.
  • id: 이 채널에 지정한 ID입니다.
  • resourceId: 감시 중인 리소스의 ID입니다.
  • resourceUri: 감시 중인 리소스의 버전별 ID입니다.
  • token: 요청 본문에 제공된 토큰입니다.
  • expiration: 채널 만료 시간(Unix 타임스탬프, 밀리초)

요청의 일부로 전송한 속성 외에도 반환된 정보에는 이 알림 채널에서 감시 중인 리소스를 식별하는 resourceId 및 resourceUri도 포함됩니다.

반환된 정보를 알림 채널 작업(예: 알림 수신 중지 )에 전달할 수 있습니다.

응답에 관한 자세한 내용은 API 참조의 ACL, CalendarList, Events, Settings 리소스의 watch 메서드를 참고하세요.

동기화 메시지

리소스 감시를 위한 알림 채널을 만든 후 Google Calendar API는 sync 메시지를 전송하여 알림이 시작됨을 나타냅니다. 이러한 메시지의 X-Goog-Resource-State HTTP 헤더 값은 sync입니다. 네트워크 타이밍 문제로 인해 watch 메서드 응답을 수신하기 전에 sync 메시지 를 수신할 수 있습니다.

sync 알림은 무시해도 되지만 사용할 수도 있습니다. 예를 들어 채널을 유지하지 않기로 결정한 경우 알림 수신 중지 호출에서 X-Goog-Channel-ID 및 X-Goog-Resource-ID 값을 사용할 수 있습니다. 후속 이벤트를 준비하기 위한 초기화를 실행하기 위해 sync 알림을 사용할 수도 있습니다.

Google Calendar API가 수신 URL로 전송하는 sync 메시지의 형식은 아래와 같습니다.

POST https://mydomain.com/notifications // Your receiving URL.
X-Goog-Channel-ID: channel-ID-value
X-Goog-Channel-Token: channel-token-value
X-Goog-Channel-Expiration: expiration-date-and-time // In human-readable format. Present only if the channel expires.
X-Goog-Resource-ID: identifier-for-the-watched-resource
X-Goog-Resource-URI: version-specific-URI-of-the-watched-resource
X-Goog-Resource-State: sync
X-Goog-Message-Number: 1

동기화 메시지에는 항상 X-Goog-Message-Number HTTP 헤더 값이 1입니다. 이 채널의 후속 알림에는 이전 알림보다 큰 메시지 번호가 있지만 메시지 번호는 순차적이지 않습니다.

알림 채널 갱신

알림 채널에는 요청 또는 Google Calendar API 내부 제한 또는 기본값에 의해 결정되는 값이 있는 만료 시간이 있을 수 있습니다 (더 제한적인 값이 사용됨). 채널의 만료 시간(있는 경우)은 watch 메서드에서 반환된 정보에 Unix 타임스탬프(밀리초)로 포함됩니다. 또한 만료 날짜와 시간은 애플리케이션이 이 채널에 수신하는 모든 알림 메시지의 X-Goog-Channel-Expiration HTTP 헤더에 사람이 읽을 수 있는 형식으로 포함됩니다.

현재 알림 채널을 자동으로 갱신하는 방법은 없습니다. 채널이 만료에 가까워지면 `watch` 메서드를 호출하여 새 채널로 바꿔야 합니다.watch 항상 새 채널의 id 속성에 고유한 값을 사용해야 합니다. 동일한 리소스의 두 알림 채널이 활성 상태인 "겹침" 기간이 있을 수 있습니다.

알림 수신

감시 중인 리소스가 변경될 때마다 애플리케이션은 변경사항을 설명하는 알림 메시지를 수신합니다. Google Calendar API는 이러한 메시지를 이 알림 채널의 address 속성으로 지정한 URL에 HTTPS POST 요청으로 전송합니다.

알림 메시지 형식 해석

모든 알림 메시지에는 X-Goog- 프리픽스가 있는 HTTP 헤더 집합이 포함됩니다. 일부 유형의 알림에는 메시지 본문도 포함될 수 있습니다.

헤더

Google Calendar API가 수신 URL에 게시하는 알림 메시지에는 다음 HTTP 헤더가 포함됩니다.

헤더 설명
항상 있음
X-Goog-Channel-ID 이 알림 채널을 식별하기 위해 제공한 UUID 또는 기타 고유 문자열입니다.
X-Goog-Message-Number 이 알림 채널의 이 메시지를 식별하는 정수입니다. sync 메시지의 값은 항상 1입니다. 채널의 후속 메시지마다 메시지 번호가 증가하지만 순차적이지는 않습니다.
X-Goog-Resource-ID 감시 중인 리소스를 식별하는 불투명 값입니다. 이 ID는 API 버전 전반에서 안정적입니다.
X-Goog-Resource-State 알림을 트리거한 새 리소스 상태입니다. 가능한 값: sync, exists, 또는 not_exists.
X-Goog-Resource-URI 감시 중인 리소스의 API 버전별 식별자입니다.
때때로 있음
X-Goog-Channel-Expiration 알림 채널 만료 날짜 및 시간( 사람이 읽을 수 있는 형식으로 표현) 정의된 경우에만 있습니다.
X-Goog-Channel-Token 애플리케이션에서 설정한 알림 채널 토큰으로 알림 소스를 확인하는 데 사용할 수 있습니다. 정의된 경우에만 있습니다.

Calendar API가 수신 URL에 게시하는 알림 메시지에는 메시지 본문이 포함되지 않습니다. 이러한 메시지에는 업데이트된 리소스에 관한 구체적인 정보가 포함되어 있지 않습니다. 전체 변경 세부정보를 보려면 다른 API 호출을 실행해야 합니다.

예

수정된 일정 모음의 변경 알림 메시지:

POST https://mydomain.com/notifications
Content-Type: application/json; utf-8
Content-Length: 0
X-Goog-Channel-ID: 4ba78bf0-6a47-11e2-bcfd-0800200c9a66
X-Goog-Channel-Token: 398348u3tu83ut8uu38
X-Goog-Channel-Expiration: Tue, 19 Nov 2013 01:13:52 GMT
X-Goog-Resource-ID:  ret08u3rv24htgh289g
X-Goog-Resource-URI: https://www.googleapis.com/calendar/v3/calendars/my_calendar@gmail.com/events
X-Goog-Resource-State:  exists
X-Goog-Message-Number: 10

알림에 대한 응답

성공을 나타내려면 다음 상태 코드 중 하나를 반환하면 됩니다. 200, 201, 202, 204, 또는 102.

서비스에서 Google의 API 클라이언트 라이브러리 를 사용하고 500,502, 503, 504를 반환하는 경우 Google Calendar API 는 지수 백오프로 재시도합니다. 다른 모든 반환 상태 코드는 메시지 실패로 간주됩니다.

Google Calendar API 알림 이벤트 이해

이 섹션에서는 Google Calendar API와 함께 푸시 알림을 사용할 때 수신할 수 있는 알림 메시지에 관한 세부정보를 제공합니다.

X-Goog-Resource-State 적용 대상 전송 시점
sync ACL, 캘린더 목록, 일정, 설정 새 채널이 생성되었습니다. 이제 알림을 수신할 수 있습니다.
exists ACL, 캘린더 목록, 일정, 설정 리소스가 변경되었습니다. 가능한 변경사항에는 새 리소스 만들기, 기존 리소스 수정 또는 삭제가 포함됩니다.

알림 중지

expiration 속성은 알림이 자동으로 중지되는 시점을 제어합니다. 다음 URI에서 stop 메서드를 호출하여 만료되기 전에 특정 채널의 알림 수신을 중지하도록 선택할 수 있습니다.

https://www.googleapis.com/workspace/calendar/api/v3/reference/channels/stop

이 메서드를 사용하려면 아래 예와 같이 채널의 id 및 resourceId 속성을 제공해야 합니다. Google Calendar API에 watch 메서드가 있는 여러 유형의 리소스가 있는 경우 stop 메서드는 하나만 있습니다.

올바른 권한이 있는 사용자만 채널을 중지할 수 있습니다. 구체적인 방법은 다음과 같습니다.

  • 채널이 일반 사용자 계정으로 생성된 경우 채널을 만든 동일한 클라이언트의 동일한 사용자 (인증 토큰의 OAuth 2.0 클라이언트 ID로 식별됨)만 채널을 중지할 수 있습니다.
  • 채널이 서비스 계정으로 생성된 경우 동일한 클라이언트의 모든 사용자가 채널을 중지할 수 있습니다.

다음 코드 샘플은 알림 수신을 중지하는 방법을 보여줍니다.

POST https://www.googleapis.com/workspace/calendar/api/v3/reference/channels/stop
  
Authorization: Bearer CURRENT_USER_AUTH_TOKEN
Content-Type: application/json

{
  "id": "4ba78bf0-6a47-11e2-bcfd-0800200c9a66",
  "resourceId": "ret08u3rv24htgh289g"
}