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 |
通知を生成したオペレーションのタイプ。
有効な値は次のとおりです。
|
|
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 によって生成されたものであることを確認します。 | 書き込み可能 |