Push bildirimleri

Zorunlu özellikler

Her watch isteğiyle birlikte şu alanları sağlamanız gerekir:

• Projenizde bu yeni bildirim kanalını benzersiz şekilde tanımlayan bir id mülk dizesi. Evrensel olarak benzersiz bir tanımlayıcı (UUID) veya benzer bir benzersiz dize kullanmanızı öneririz. 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, webhook geri çağırma URL'nizdir ve HTTPS kullanmalıdır.

  Yönetici SDK'sı API'sinin bu HTTPS adresine bildirim gönderebilmesi için web sunucunuzda geçerli bir SSL sertifikasının yüklü olması gerektiğini unutmayın. 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

watch isteğinizle birlikte aşağıdaki isteğe bağlı alanları da belirtebilirsiniz:

• Kanal jetonu olarak kullanılacak rastgele bir dize değerini belirten bir token özelliği. Bildirim kanalı jetonlarını çeşitli amaçlarla kullanabilirsiniz. Ö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, uygulamanızın bu kanal için aldığı her bildirim mesajındaki X-Goog-Channel-Token HTTP üstbilgisinin içine eklenir.

  Bildirim kanalı jetonları 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.

• 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 süre, uygulamanızın bu kanal için aldığı her bildirim mesajına X-Goog-Channel-Expiration HTTP başlığının değeri olarak (kullanıcı tarafından okunabilir biçimde) dahil edilir.

Yanıtı izleme

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

İzleme yanıtının mesaj gövdesinde, aşağıdaki örnekte gösterildiği gibi, yeni oluşturduğunuz bildirim kanalı hakkında bilgi sağlanır.

{
  "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ıt hakkında daha fazla bilgi için API Referansı'ndaki Etkinlikler kaynağının watch yöntemine bakı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 bu bildirimi kullanabilirsiniz. Ö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.

Yönetici SDK'sı API'sinin alıcı URL'nize gönderdiği sync mesajlarının biçimi 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 mesajlarının X-Goog-Message-Number HTTP başlığı değeri her zaman 1 olur. 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ı yenileme

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 yenileme seçeneği yoktur. Bir kanalın süresi dolmak üzereyse watch yöntemini çağırarak kanalı yeni bir kanalla değiştirmeniz gerekir. 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ıyı belirtmek için aşağıdaki durum kodlarından 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
• calendar
• drive
• gruplar
• login
• mobil
• token
• user_accounts