Subscriptions

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

Bu kaynakla ilgili yöntemlerin listesi için bu sayfanın sonuna bakın.

Kaynak temsilleri

Koleksiyondaki etkinliklerin aboneliği.

{
  "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önderileceği URL (https:// ile başlamalıdır). yazılabilir
collection string Abone olunacak koleksiyon. İzin verilen değerler şunlardır:
  • timeline - Ekleme, silme ve güncellemeler dahil olmak üzere zaman çizelgesindeki değişiklikler.
  • locations - Konum güncellemeleri.
  • settings - Ayar güncellemeleri.
 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ı nesne. 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 Kullanıcı tarafından bildirimi tetikleyen işlemlerin listesi.
notification.userActions[].payload string İşlem için isteğe bağlı 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 şu olabilir:
  • SHARE - kullanıcı bir öğe paylaştı.
  • REPLY - kullanıcı bir öğeye yanıt verdi.
  • 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ı sesli komut başlattı.
Gelecekte başka türler eklenebilir. Tanınmayan türlere sahip UserAction'lar yoksayılmalıdır.
notification.userToken string Bildirimler için abone olduğunda hizmet tarafından sağlanan kullanıcı jetonu.
notification.verifyToken string Bildirimler için abone olduğunda hizmet tarafından sağlanan gizli doğrulama jetonu.
operation[] list Abone olması gereken işlemlerin listesi. Boş liste, koleksiyondaki tüm işlemlerin abone olunması gerektiğini gösterir. İzin verilen değerler şunlardır:
  • UPDATE - Öğe güncellendi.
  • INSERT - Yeni bir öğe eklendi.
  • DELETE - Öğe silindi.
 yazılabilir
updated datetime RFC 3339'a göre bu aboneliğin son değiştirilme zamanı.
userToken string Kullanıcının kimliğini belirleyebilmesi için bildirimlerde aboneye gönderilen opak bir jeton. yazılabilir
verifyToken string Abonenin bildirimlerde gönderdiği ve bildirimin Google tarafından oluşturulduğunu doğrulayabildiği gizli jeton. yazılabilir

Yöntemler

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