Mirror API를 사용하면 사용자가 타임라인 항목에서 특정 작업을 수행할 때 또는 사용자 위치가 업데이트되었을 때 전송되는 알림을 구독할 수 있습니다.
이 리소스에 대한 메소드 목록은 이 페이지의 하단에 나와 있습니다.
리소스 표현
컬렉션의 이벤트에 대한 구독입니다.
{
"kind": "mirror#subscription",
"id": string,
"updated": datetime,
"collection": string,
"operation": [
string
],
"callbackUrl": string,
"verifyToken": string,
"userToken": string,
"notification": {
"collection": string,
"itemId": string,
"operation": string,
"userActions": [
{
"type": string,
"payload": string
}
],
"verifyToken": string,
"userToken": string
}
}
| 속성 이름 | 값 | 설명 | 참고 |
|---|---|---|---|
callbackUrl |
string |
알림이 전송되어야 하는 URL입니다 (https://로 시작해야 함). |
쓰기 가능 |
collection |
string |
구독할 컬렉션입니다. 허용되는 값은 다음과 같습니다.
|
쓰기 가능 |
id |
string |
정기 결제의 ID입니다. | |
kind |
string |
리소스 유형 항상 mirror#subscription입니다. |
|
notification |
nested object |
알림의 컨테이너 객체입니다. Subscription 리소스에서 채워지지 않습니다. |
|
notification.collection |
string |
알림을 생성한 컬렉션입니다. | |
notification.itemId |
string |
알림을 생성한 항목의 ID입니다. | |
notification.operation |
string |
알림을 생성한 작업의 유형입니다.
사용 가능한 값은 다음과 같습니다. <ph type="x-smartling-placeholder">
|
|
notification.userActions[] |
list |
알림을 트리거한 사용자가 수행한 작업 목록입니다. | |
notification.userActions[].payload |
string |
작업의 페이로드(선택사항)CUSTOM 유형의 작업의 경우 선택된 맞춤 메뉴 항목의 ID입니다. |
|
notification.userActions[].type |
string |
작업의 유형입니다. 이 값은 다음과 같을 수 있습니다.
|
|
notification.userToken |
string |
알림을 구독할 때 서비스가 제공한 사용자 토큰입니다. | |
notification.verifyToken |
string |
알림을 구독했을 때 서비스에서 제공한 보안 비밀 확인 토큰입니다. | |
operation[] |
list |
구독해야 하는 작업의 목록입니다. 빈 목록은 컬렉션의 모든 작업을 구독해야 함을 나타냅니다. 허용되는 값은 다음과 같습니다.
|
쓰기 가능 |
updated |
datetime |
이 구독이 마지막으로 수정된 시간으로, RFC 3339에 따른 형식으로 지정됩니다. | |
userToken |
string |
사용자 ID를 파악할 수 있도록 알림에서 구독자에게 전송되는 불투명 토큰입니다. | 쓰기 가능 |
verifyToken |
string |
Google에서 알림을 생성했는지 확인할 수 있도록 구독자에게 알림을 통해 전송되는 비밀 토큰입니다. | 쓰기 가능 |