Push bildirimleri

Zorunlu özellikler

Her watch isteğiyle birlikte şu alanları girmeniz gerekir:

• Bunu benzersiz şekilde tanımlayan bir id özellik dizesi yeni bir bildirim kanalı oluşturabilirsiniz. Önerilerimiz evrensel olarak benzersiz bir tanımlayıcı (UUID) veya benzer bir benzersiz dize. Maksimum uzunluk: 64 karakter.

  Ayarladığınız kimlik değeri, X-Goog-Channel-Id Her bildirimin HTTP başlığı size bir mesaj gönderecektir.

• type özellik dizesi değere ayarlandı web_hook.

• Şunları dinleyen URL'ye bir address özellik dizesi ayarlandı ve bu bildirim kanalındaki bildirimlere yanıt verir. Bu ve HTTPS kullanmalıdır.

  Admin SDK API'nin Bu HTTPS adresi yalnızca yüklü bir SSL sertifikası varsa sunucu. Geçersiz sertifikalar şunlardır:

  • Kendinden imzalı sertifikalar.
  • Güvenilmeyen bir kaynağın imzaladığı sertifikalar.
  • İptal edilmiş sertifikalar.
  • Konuyla eşleşmeyen sertifikalar ana makine adı.

İsteğe bağlı özellikler

Bu isteğe bağlı alanları watch isteği:

• Rastgele bir dize belirten token özelliği kullanılacak değer. Bildirim kanalını kullanabilirsiniz kullanıma sunuyoruz. Örneğin, e-posta adresinize gönderilen her mesajın bildirimin gönderilmediğinden emin olmak için veya iletiyi bu kanalın amacına göre yeniden gönderin. Maksimum uzunluk: 256 karakter.

  Jeton, Her bildirimde X-Goog-Channel-Token HTTP başlığı uygulamanızın bu kanal için aldığı mesaj.

  Bildirim kanalı jetonlarını kullanıyorsanız şunları yapmanızı öneririz:

  • URL sorgusu gibi genişletilebilir bir kodlama biçimi kullanın parametreleridir. Örnek: forwardTo=hr&createdBy=mobile

  • OAuth jetonları gibi hassas verileri eklemeyin.

  ziyaret edin.

• expiration özellik dizesi Unix zaman damgası Admin SDK API'nin API'yi kullanmasını istediğiniz tarih ve saati (milisaniye cinsinden) bu bildirim kanalı için mesaj göndermeyi durdur.

  Bir kanalın geçerlilik süresi varsa bu, değer olarak dahil edilir. X-Goog-Channel-Expiration HTTP başlığının (kullanıcıların okuyabileceği bir biçimde) biçimi) ekleyebilirsiniz. aldığı tüm bildirimler de dahildir.

Yanıtı izle

watch isteği başarıyla bildirim oluşturursa kanalından bir HTTP 200 OK durum kodu döndürür.

Saat yanıtının ileti gövdesi, aşağıdaki örnekte gösterildiği gibi, yeni oluşturduğunuz bir bildirim kanalını kullanın.

{
  "kind": "api#channel",
  "id": "reportsApiId", // ID you specified for this channel.
  "resourceId": "o3hgv1538sdjfh", // ID of the watched resource.
  "resourceUri": "https://admin.googleapis.com/admin/reports/v1/activity/userKey/applications/applicationName", // Version-specific ID of the watched resource.
  "token": "target=myApp-myFilesChannelDest", // Present only if one was provided.
  "expiration": 3600, // Actual expiration time as Unix timestamp (in ms), if applicable.
}

İsteğiniz kapsamında gönderdiğiniz özelliklere ek olarak şunları da içerir: resourceId ve İzlenen kaynağı belirlemek için resourceUri bildirim kanalı.

Döndürülen bilgileri başka bir bildirim kanalına aktarabilirsiniz işlemlerinize devam edebilir, örneğin almayı durdurmak istediğinizde bildirimlerine bakın.

Yanıtla ilgili daha ayrıntılı bilgiyi watch sayfasında bulabilirsiniz. yöntemini çağırın.

İletiyi senkronize et

Bir kaynağı izlemek için bildirim kanalı oluşturduktan sonra Admin SDK API, şunu belirtmek için bir sync mesajı gönderir: bildirimler başlıyor. X-Goog-Resource-State HTTP bu iletilerin üstbilgi değeri sync. Ağa bağlı zamanlama sorunları varsa sync mesajı alabilirsiniz hem de watch yöntemi yanıtını almadan önce.

sync bildirimini yoksayabilirsiniz ancak değerlendirebilirsiniz. Örneğin, Yeşil Ofis projenizde Bunun için X-Goog-Channel-ID ve Şuna yapılan çağrıda X-Goog-Resource-ID değer: bildirim almayı durdur. Ayrıca şunu da kullanabilirsiniz: hazırlanmak amacıyla bazı başlatma işlemlerinin yapılması için sync bildirim etkinlikleri takip edebilirsiniz.

Admin SDK API'nin gönderdiği sync mesajlarının biçimi alıcı URL'niz aşağıda gösterilmiştir.

POST https://mydomain.com/notifications // Your receiving URL.
X-Goog-Channel-ID: channel-ID-value
X-Goog-Channel-Token: channel-token-value
X-Goog-Channel-Expiration: expiration-date-and-time // In human-readable format. Present only if the channel expires.
X-Goog-Resource-ID: identifier-for-the-watched-resource
X-Goog-Resource-URI: version-specific-URI-of-the-watched-resource
X-Goog-Resource-State: sync
X-Goog-Message-Number: 1

Senkronizasyon iletilerinde her zaman X-Goog-Message-Number HTTP olur başlık değeri (1). Bu kanal için takip eden her bildirimde daha büyük bir ileti numarası; örneğin sayılar sıralı olmaz.

Bildirim kanallarını yenile

Bildirim kanalının, bir değere sahip geçerlilik süresi olabilir. isteğiniz veya herhangi bir Admin SDK API dahili sınırı tarafından belirlenir veya varsayılan değerler (daha kısıtlayıcı değer kullanılır). Kanalın geçerlilik bitiş tarihi zamanı (varsa) Unix zaman damgası olarak eklenir. (milisaniye cinsinden) watch yönteminin döndürdüğü bilgilerde bulunur. Ayrıca, geçerlilik bitiş tarihi ve saati eklenir (kullanıcılar tarafından okunabilir biçimde) uygulamanızın bu kanal için aldığı bildirim mesajı X-Goog-Channel-Expiration HTTP üst bilgisi.

Şu anda bildirim kanallarını otomatik olarak yenilemenin bir yolu yoktur. Zaman bir kanalın kullanım süresi dolmak üzereyse, bunu yapmak için watch yöntemi. Her zaman olduğu gibi, yeni kanalın id özelliği. Herhangi bir riskin bir "örtüşme" olması 2 bildirim kanalının 24 saat veya 24 saat uzunluğunda etkin olduğundan emin olun.

Bildirim mesajı biçimini yorumlama

Tüm bildirim mesajları bir dizi HTTP üstbilgisini içerir ve X-Goog- ön ek. Bazı bildirim türleri şunları da içerebilir: e-posta mesajı

Etkinlikler için bildirim mesajları, istek gövdesinde aşağıdaki bilgileri içerir:

POST https://mydomain.com/notifications // Your receiving URL.
Content-Type: application/json; utf-8
Content-Length: 0
X-Goog-Channel-ID: reportsApiId
X-Goog-Channel-Token: 398348u3tu83ut8uu38
X-Goog-Channel-Expiration: Tue, 29 Oct 2013 20:32:02 GMT
X-Goog-Resource-ID:  ret08u3rv24htgh289g
X-Goog-Resource-URI: https://admin.googleapis.com/admin/reports/v1/activity/userKey/applications/applicationName
X-Goog-Resource-State:  eventName
X-Goog-Message-Number: 10

{
  "kind": "admin#reports#activity",
  "id": {
    "time": datetime,
    "uniqueQualifier": long,
    "applicationName": string,
    "customerId": string
  },
  "actor": {
    "callerType": string,
    "email": string,
    "profileId": long
  },
  "ownerDomain": string,
  "ipAddress": string,
  "events": [
    {
      "type": string,
      "name": string,
      "parameters": [
        {
          "name": string,
          "value": string,
          "intValue": long,
          "boolValue": boolean
        }
      ]
    }
  ]
}

POST https://mydomain.com/notifications // Your receiving URL.
Content-Type: application/json; utf-8
Content-Length: 596
X-Goog-Channel-ID: reportsApiId
X-Goog-Channel-Token: 245t1234tt83trrt333
X-Goog-Channel-Expiration: Tue, 29 Oct 2013 20:32:02 GMT
X-Goog-Resource-ID:  ret987df98743md8g
X-Goog-Resource-URI: https://admin.googleapis.com/admin/reports/v1/activity/users/all/applications/admin?alt=json
X-Goog-Resource-State:  CREATE_USER
X-Goog-Message-Number: 23

{
  "kind": "admin#reports#activity",
  "id": {
    "time": "2013-09-10T18:23:35.808Z",
    "uniqueQualifier": "-0987654321",
    "applicationName": "admin",
    "customerId": "ABCD012345"
  },
  "actor": {
    "callerType": "USER",
    "email": "admin@example.com",
    "profileId": "0123456789987654321"
  },
  "ownerDomain": "apps-reporting.example.com",
  "ipAddress": "192.0.2.0",
  "events": [
    {
      "type": "USER_SETTINGS",
      "name": "CREATE_USER",
      "parameters": [
        {
          "name": "USER_EMAIL",
          "value": "liz@example.com"
        }
      ]
    }
  ]
}

Bildirimleri yanıtlama

Başarılı olduğunu belirtmek için aşağıdaki durum kodlarından herhangi birini döndürebilirsiniz: 200, 201, 202, 204 veya 102.

Hizmetiniz Google'ın API istemci kitaplığını kullanıyorsa ve Admin SDK API'si olan 500,502, 503 veya 504 değerini döndürür eksponansiyel geri yükleme ile yeniden deneme yapar. Diğer tüm iade durum kodları, mesaj hatası olarak değerlendirilir.

Admin SDK API bildirim etkinliklerini anlama

Bu bölümde, hangi bildirimler için gönderebileceğiniz .

Reports API push bildirimleri iki tür mesaj içerir: senkronizasyon mesajları ve etkinlik bildirimleri. Mesaj türü, X-Goog-Resource-State HTTP üst bilgisinde belirtilir. Etkinlik bildirimleri için olası değerler activities.list yöntemiyle aynıdır. Her uygulamanın benzersiz etkinlikleri vardır:

• yönetici
• takvim
• sürücü
• gruplar
• login
• mobil
• jeton
• user_accounts