Subscriptions

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 登録するコレクション。使用できる値:
  • timeline - 挿入、削除、更新など、タイムラインの変更。
  • locations - 位置情報の更新。
  • settings - 設定を更新しました。
 書き込み可能
id string サブスクリプションの ID。
kind string リソースのタイプ。これは常に mirror#subscription です。
notification nested object 通知用のコンテナ オブジェクト。これは、Subscription リソースには挿入されません。
notification.collection string 通知を生成したコレクション。
notification.itemId string 通知を生成したアイテムの ID。
notification.operation string 通知を生成したオペレーションのタイプ。

有効な値は次のとおりです。
  • "DELETE"
  • "INSERT"
  • "MENU_ACTION"
  • 「UPDATE」
notification.userActions[] list 通知をトリガーしたユーザーが行った操作のリスト。
notification.userActions[].payload string アクションのオプションのペイロード。

CUSTOM タイプのアクションの場合、これは選択されたカスタム メニュー項目の ID です。
notification.userActions[].type string アクションのタイプ。この値は次のいずれかです。
  • SHARE - ユーザーがアイテムを共有しました。
  • REPLY - ユーザーがアイテムに返信しました。
  • REPLY_ALL - ユーザーがアイテムのすべての受信者に返信しました。
  • CUSTOM - ユーザーがタイムライン アイテムでカスタム メニュー項目を選択したとき。
  • DELETE - ユーザーがアイテムを削除した。
  • PIN - ユーザーがアイテムを固定しました。
  • UNPIN - ユーザーがアイテムの固定を解除しました。
  • LAUNCH - ユーザーが音声コマンドを開始しました。
今後、他のタイプが追加される可能性があります。認識できないタイプの UserActions は無視する必要があります。
notification.userToken string 通知の登録時にサービスによって提供されるユーザー トークン。
notification.verifyToken string 通知の登録時にサービスによって提供されたシークレット検証トークン。
operation[] list 登録すべきオペレーションのリスト。空のリストは、コレクションに対するすべてのオペレーションをサブスクライブする必要があることを示します。使用できる値:
  • UPDATE - アイテムは更新されています。
  • INSERT - 新しいアイテムが挿入されました。
  • DELETE - アイテムは削除されています。
 書き込み可能
updated datetime このサブスクリプションが最後に変更された時刻（RFC 3339 形式）。
userToken string ユーザーの ID を判断できるように、通知で定期購入者に送信される不透明なトークン。 書き込み可能
verifyToken string 通知が Google によって生成されたものであることを確認できるように、通知で購読者に送信されるシークレット トークン。 書き込み可能

メソッド

delete
サブスクリプションを削除します。
insert
新しいサブスクリプションを作成します。
list
認証されたユーザーとサービスのサブスクリプションのリストを取得します。
update
既存のサブスクリプションを更新します。