Subscriptions

Mirror API, kullanıcı bir zaman çizelgesi öğesinde belirli işlemler yaptığında veya kullanıcı konumu güncellendiğinde gönderilen bildirimlere abone olmanıza olanak tanır.

Bu kaynağa yönelik yöntem listesi için bu sayfanın sonuna bakın.

Kaynak temsilleri

Bir koleksiyondaki etkinliklere abonelik.

{
  "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
  }
}
Mülk adı Değer Açıklama Notlar
callbackUrl string Bildirimlerin gönderilmesi gereken URL (https:// ile başlamalıdır). yazılabilir
collection string Abone olunacak koleksiyon. İzin verilen değerler:
  • timeline: Ekleme, silme ve güncellemeler dahil olmak üzere zaman çizelgesindeki değişiklikler.
  • locations: Konum güncellemeleri.
  • settings - Ayarlarla ilgili güncellemeler.
 yazılabilir
id string Aboneliğin kimliği.
kind string Kaynağın türü. Bu her zaman mirror#subscription.
notification nested object Bildirimler için kapsayıcı nesnesi. Bu alan, Subscription kaynağında doldurulmaz.
notification.collection string Bildirimi oluşturan koleksiyon.
notification.itemId string Bildirimi oluşturan öğenin kimliği.
notification.operation string Bildirimi oluşturan işlemin türü.

Kabul edilen değerler şunlardır:
  • "DELETE"
  • "INSERT"
  • "MENU_ACTION"
  • "UPDATE"
notification.userActions[] list Bildirimi tetikleyen kullanıcının gerçekleştirdiği işlemlerin listesi.
notification.userActions[].payload string İşlem için isteğe bağlı bir yük.

CUSTOM türündeki işlemler için bu, seçilen özel menü öğesinin kimliğidir.
notification.userActions[].type string İşlemin türü. Bunun değeri şöyle olabilir:
  • SHARE - Kullanıcı bir öğe paylaştı.
  • REPLY: Kullanıcı bir öğeyi yanıtladı.
  • REPLY_ALL: Kullanıcı, bir öğenin tüm alıcılarına yanıt verdi.
  • CUSTOM: Kullanıcı, zaman çizelgesi öğesinde özel bir menü öğesi seçti.
  • DELETE: Kullanıcı, öğeyi sildi.
  • PIN: Kullanıcı, öğeyi sabitledi.
  • UNPIN - kullanıcı, öğenin sabitlemesini kaldırdı.
  • LAUNCH: Kullanıcı bir sesli komut başlattı.
Gelecekte başka türler eklenebilir. Tanınmayan türlere sahip UserActions yoksayılmalıdır.
notification.userToken string Hizmetin bildirimlere abone olurken sağladığı kullanıcı jetonu.
notification.verifyToken string Hizmetin bildirimlere abone olurken sağladığı gizli doğrulama jetonu.
operation[] list Abone olması gereken işlemlerin listesi. Boş liste, koleksiyondaki tüm işlemlere abone olması gerektiğini gösterir. İzin verilen değerler:
  • UPDATE - Öğe güncellendi.
  • INSERT: Yeni bir öğe eklendi.
  • DELETE - Öğe silindi.
 yazılabilir
updated datetime Bu aboneliğin son değiştirilme zamanı. RFC 3339'a göre biçimlendirilmiştir.
userToken string Abonenin kimliğini belirleyebilmesi için bildirimlerde aboneye gönderilen opak bir jeton. yazılabilir
verifyToken string Aboneye bildirimlerde gönderilen gizli jetondur. Bu jeton, bildirimin Google tarafından oluşturulduğunu doğrulayabilmek için kullanılır. yazılabilir

Yöntemler

sil
Bir aboneliği siler.
ekle
Yeni bir abonelik oluşturur.
list
Kimliği doğrulanmış kullanıcı ve hizmet için abonelik listesini alır.
güncelle
Mevcut bir aboneliği günceller.