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

푸시 알림

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

개요

Directory API는 푸시 알림을 제공하여 리소스 변경 등이 있습니다 이 기능을 사용하여 애플리케이션 성능을 개선할 수 있습니다. 이를 통해 리소스가 변경되었는지 확인하기 위해 리소스를 폴링하는 데 드는 추가 네트워크 및 컴퓨팅 비용을 없앨 수 있습니다. 감시 중인 리소스가 변경될 때마다 Directory API가 이를 알려줍니다. 애플리케이션입니다.

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

수신 URL 또는 '웹훅' 설정 콜백 수신자입니다.
이 HTTP(S) 요청을 통해 전송된 API 알림 메시지를 트리거될 수 있습니다
원하는 각 리소스 엔드포인트마다 (알림 채널)을 설정합니다. 있습니다.
채널은 알림 메시지의 라우팅 정보를 지정합니다. 채널 설정의 일환으로 알림을 받을 특정 URL을 식별해야 합니다. 채널의 리소스가 변경될 때마다 Directory API가 알림 메시지를 POST로 전송합니다. 해당 URL에 요청을 보냅니다.

현재 Directory API는 사용자 리소스 변경에 관한 알림을 지원합니다.

알림 채널 만들기

푸시 알림을 요청하려면 알림 채널을 설정해야 합니다. 모니터링하려는 각 리소스에 대한 설정을 정의할 수 있습니다 알림 채널을 설정한 후 디렉터리 API는 감시 중인 리소스가 발견되면 있습니다.

보기 요청

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

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

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

각 알림 채널은 특정 사용자와 특정 리소스(또는 리소스 집합)와 모두 연결됩니다. watch 요청 현재 사용자가 서비스 계정을 사용하여 이 리소스를 소유하거나 액세스할 권한이 있습니다.

예

단일 도메인의 User 리소스에 대한 모든 보기 요청의 일반적인 형식은 다음과 같습니다.

POST https://admin.googleapis.com/admin/directory/v1/users/watch?domain=domain&event=event
Authorization: Bearer auth_token_for_current_user
Content-Type: application/json

{
  "id": "01234567-89ab-cdef-0123456789ab", // Your channel ID.
  "type": "web_hook",
  "address": "https://mydomain.com/notifications", // Your receiving URL.
  ...
  "token": "target=myApp-myFilesChannelDest", // (Optional) Your channel token.
  "params": {
    "ttl": 3600 // (Optional) Your requested time-to-live for this channel.
  }
}

domain 및 event 매개변수를 사용하여 알림을 받을 이벤트의 도메인과 유형을 지정합니다.

고객의 사용자 리소스에 대한 모든 감시 요청의 일반적인 형식은 다음과 같습니다.

POST https://admin.googleapis.com/admin/directory/users/v1/watch?customer=customer&event=event
Authorization: Bearer auth_token_for_current_user
Content-Type: application/json

{
  "id": "01234567-89ab-cdef-0123456789ab", // Your channel ID.
  "type": "web_hook",
  "address": "https://mydomain.com/notifications", // Your receiving URL.
  ...
  "token": "target=myApp-myFilesChannelDest", // (Optional) Your channel token.
  "params": {
    "ttl": 3600 // (Optional) Your requested time-to-live for this channel.
  }
}

customer 및 event 매개변수를 사용하여 고객 Google 계정의 고유 ID와 알림을 받을 이벤트 유형을 지정합니다.

event에 가능한 값은 다음과 같습니다.

add: 사용자가 만든 이벤트
delete: 사용자가 삭제한 이벤트
makeAdmin: 사용자 관리자 상태 변경 이벤트
undelete: 사용자가 이벤트 삭제를 취소했습니다.
update: 사용자가 업데이트한 이벤트

참고: 다음 예에서는 명확성을 위해 요청 본문을 생략합니다.

도메인 mydomain.com의 사용자 생성 이벤트 확인:

POST https://admin.googleapis.com/admin/directory/v1/users/watch?domain=mydomain.com&event=add

고객(my_customer)의 사용자가 만든 이벤트 확인:

POST https://admin.googleapis.com/admin/directory/v1/users/watch?customer=my_customer&event=add

필수 속성

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

이 속성을 고유하게 식별하는 id 속성 문자열입니다. 새 알림 채널을 생성합니다. 이때 범용 고유 식별자 (UUID) 또는 이와 유사한 고유 문자열입니다. 최대 길이: 64자(영문 기준)

설정한 ID 값은 이 채널에 대해 수신하는 모든 알림 메시지의 X-Goog-Channel-Id HTTP 헤더에 다시 반영됩니다.
값으로 설정된 type 속성 문자열 web_hook
수신 대기하는 URL로 설정된 address 속성 문자열 이 알림 채널의 알림에 응답합니다. 이것은 웹훅을 설정하고, HTTPS를 사용해야 합니다.

Directory API는 유효한 SSL 인증서가 설치된 경우에만 이 HTTPS 주소를 웹 서버에서 실행되는 것입니다 다음 인증서는 유효하지 않습니다.
- 자체 서명된 인증서
- 신뢰할 수 없는 출처에서 서명한 인증서
- 취소된 인증서
- 대상 호스트 이름과 일치하지 않는 주체가 있는 인증서

선택 속성

이러한 선택 입력란을 watch 요청:

임의의 문자열을 지정하는 token 속성 채널 토큰으로 사용할 값입니다. 알림 채널을 사용하면 사용할 수 있습니다 예를 들어 토큰을 사용하여 각 수신 메시지가 애플리케이션 만들기가 실행되는 동안 알림이 스푸핑되어 메일을 올바른 목적지로 라우팅하거나 이 채널의 목적에 따라 신청서를 제출해야 합니다. 최대 길이: 256자(영문 기준)
토큰은 애플리케이션이 이 채널에 대해 수신하는 모든 알림 메시지의 X-Goog-Channel-Token HTTP 헤더에 포함됩니다.

알림 채널 토큰을 사용하는 경우 다음을 권장합니다.
- URL 쿼리 매개변수와 같은 확장 가능한 인코딩 형식을 사용합니다. 예: forwardTo=hr&createdBy=mobile
- OAuth 토큰과 같은 민감한 정보는 포함하지 마세요.
를 통해 개인정보처리방침을 정의할 수 있습니다.
참고: 매우 민감한 정보를 전송해야 하는 경우 데이터가 암호화되었는지 확인한 후에 토큰입니다.
Directory API가 이 알림 채널의 메시지 전송을 중지할 날짜와 시간의 Unix 타임스탬프(밀리초 단위)로 설정된 expiration 속성 문자열입니다.

채널에 만료 시간이 있는 경우 만료 시간이 값으로 포함됩니다. X-Goog-Channel-Expiration HTTP 헤더의 호출 (사람이 읽을 수 있음) 모든 알림 메시지에서 찾을 수 있습니다. 애플리케이션이 이 채널에 대해 수신합니다.

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

대답 보기

watch 요청으로 알림 채널이 생성되면 HTTP 200 OK 상태 코드가 반환됩니다.

시계 응답의 메시지 본문은 알림 채널을 만듭니다.

{
  "kind": "api#channel",
  "id": "01234567-89ab-cdef-0123456789ab", // ID you specified for this channel.
  "resourceId": "B4ibMJiIhTjAQd7Ff2K2bexk8G4", // ID of the watched resource.
  "resourceUri": "https://admin.googleapis.com/admin/directory/v1/users?domain=domain&event=event", // Version-specific ID of the watched resource.
  "token": "target=myApp-myFilesChannelDest", // Present only if one was provided.
  "expiration": 1384823632000, // Actual expiration time as Unix timestamp (in ms), if applicable.
}

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

참고: resourceId 속성은 버전 독립성이 있는 안정적인 리소스 식별자를 제공합니다. resourceUri 속성은 현재 API 버전 컨텍스트에서 감시 리소스의 표준 URI이므로 버전별입니다.

반환된 정보를 다른 알림 채널에 전달할 수 있습니다. 예를 들어 수신을 중단하고 알림을 받을 수 있습니다.

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

동기화 메시지

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

sync 알림은 무시해도 되지만 사용할 수도 있습니다. 예를 들어 채널을 유지하지 않으려는 경우 호출에서 X-Goog-Channel-ID 및 X-Goog-Resource-ID 값을 사용하여 알림 수신을 중지할 수 있습니다. 또한 준비를 위해 초기화를 실행하는 sync 알림 확인할 수 있습니다.

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

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 이 채널에 대한 이후의 각 알림에는 메시지 번호가 더 크고 숫자는 순차적이지 않습니다.

알림 채널 갱신

알림 채널에는 만료 시간이 있을 수 있으며 이 값은 요청 또는 Directory API 내부 제한 또는 기본값에 따라 결정됩니다(더 제한적인 값이 사용됨). 채널 만료 시간(있는 경우)은 Unix 타임스탬프로 포함됩니다. (밀리초 단위)를 watch 메서드에서 반환한 정보에서 확인할 수 있습니다. 또한 만료일 및 시간이 (사람이 읽을 수 있는 형식으로) 포함된 이 채널에 대해 애플리케이션이 수신하는 알림 메시지를 X-Goog-Channel-Expiration HTTP 헤더.

현재 알림 채널을 자동으로 갱신하는 방법은 없습니다. 날짜 만료가 임박한 경우 다음을 호출하여 채널을 새 채널로 대체해야 합니다. watch 메서드를 사용하여 지도 가장자리에 패딩을 추가할 수 있습니다. 항상 그렇듯이 새 채널의 id 속성입니다. 동일한 리소스에 대한 두 알림 채널이 활성화되어 있는 경우 '중복' 기간이 있을 수 있습니다.

알림 수신

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

참고: 알림 전달 HTTPS 요청 사용자 에이전트를 APIs-Google로 지정하고 robots.txt를 준수 지시어를 사용할 수 있습니다. API Google 사용자 에이전트

알림 메시지 형식 해석

모든 알림 메시지에는 X-Goog- 프리픽스. 일부 알림 유형에는 메일 본문입니다.

헤더

Directory 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` 또는 이벤트 이름입니다.
`X-Goog-Resource-URI`	감시 중인 리소스의 API 버전별 식별자입니다.
가끔 발생
`X-Goog-Channel-Expiration`	알림 채널 만료 날짜 및 시간( 인간이 읽을 수 있는 형식입니다. 정의된 경우에만 표시됩니다.
`X-Goog-Channel-Token`	애플리케이션에서 설정한 알림 채널 토큰 알림 소스를 확인하는 데 사용할 수 있습니다. 다음 경우에만 표시됩니다. 정의할 수 있습니다

사용자를 위한 알림 메시지의 요청 본문에는 다음 정보가 포함됩니다.

속성	설명
`kind`	이 항목을 사용자 리소스로 식별합니다. 값은 고정 문자열 '`admin#directory#user`'입니다.
`id`	사용자 리소스의 고유 식별자입니다.
`etag`	알림 메시지의 ETag입니다. User 리소스의 ETag와 다릅니다.
`primaryEmail`	사용자의 기본 이메일 주소입니다.

예

User 리소스 이벤트에 대한 알림 메시지의 일반적인 형식은 다음과 같습니다.

POST https://mydomain.com/notifications // Your receiving URL.
Content-Type: application/json; utf-8
Content-Length: 0
X-Goog-Channel-ID: directoryApiId
X-Goog-Channel-Token: 398348u3tu83ut8uu38
X-Goog-Channel-Expiration: Tue, 29 Oct 2013 20:32:02 GMT
X-Goog-Resource-ID:  ret08u3rv24htgh289g
X-Goog-Resource-URI: 'https://admin.googleapis.com/admin/directory/v1/users?domain=domain&event=event
X-Goog-Resource-State:  event
X-Goog-Message-Number: 10

{
  "kind": "admin#directory#user",
  "id": long,
  "etag": string,
  "primaryEmail": string
}

사용자가 삭제한 이벤트의 예는 다음과 같습니다.

POST https://mydomain.com/notifications // Your receiving URL.
Content-Type: application/json; utf-8
Content-Length: 189
X-Goog-Channel-ID: deleteChannel
X-Goog-Channel-Token: 245t1234tt83trrt333
X-Goog-Channel-Expiration: Mon, 09 Dec 2013 22:24:23 GMT
X-Goog-Resource-ID:  B4ibMJiIhTjAQd7Ff2K2bexk8G4
X-Goog-Resource-URI: https://admin.googleapis.com/admin/directory/v1/users?domain=mydomain.com&event=delete&alt=json
X-Goog-Resource-State:  delete
X-Goog-Message-Number: 236440

{
  "kind": "admin#directory#user",
  "id": "111220860655841818702",
  "etag": "\"Mf8RAmnABsVfQ47MMT_18MHAdRE/evLIDlz2Fd9zbAqwvIp7Pzq8UAw\"",
  "primaryEmail": "user@mydomain.com"
}

알림에 대한 응답

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

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

알림 중지

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

https://www.googleapis.com/admin/directory_v1/channels/stop

이 메서드를 사용하려면 아래 예와 같이 채널의 id 및 resourceId 속성은 최소한 제공해야 합니다. 디렉토리 API에 여러 유형의 watch 메서드가 있는 경우 이 메서드는 하나뿐입니다. stop 메서드를 사용하여 지도 가장자리에 패딩을 추가할 수 있습니다.

적절한 권한이 있는 사용자만 채널을 중지할 수 있습니다. 특히 다음 항목이 중요합니다.

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

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

POST https://www.googleapis.com/admin/directory_v1/channels/stop
  
Authorization: Bearer CURRENT_USER_AUTH_TOKEN
Content-Type: application/json

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