Gemini Webhooks API

Webhook'lar, eşzamansız veya uzun süren işlemler (LRO'lar) tamamlandığında Gemini API'nin sunucunuza gerçek zamanlı bildirimler göndermesine olanak tanır. Bu sayede, durum güncellemeleri için API'nin yoklanmasına gerek kalmaz, gecikme ve ek yük azaltılır.

CreateWebhook

post https://generativelanguage.googleapis.com/v1beta/webhooks

Yeni bir Web kancası oluşturur.

İstek metni

İstek içeriği aşağıdaki yapıyla birlikte verileri içerir:

name string  (isteğe bağlı)

İsteğe bağlı. Webhook'un kullanıcı tarafından sağlanan adı.

subscribed_events array (enum (string))  (zorunlu)

Zorunlu. Webhook'un abone olduğu etkinlikler. Kullanılabilir etkinlikler: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Olası değerler:

  • batch.succeeded

    Toplu işleme başarıyla tamamlandı.

  • batch.expired

    Toplu işlem 48 saat içinde işlenmedi.

  • batch.failed

    Toplu iş başarısız oldu.

  • interaction.requires_action

    Etkileşim için işlem yapılması gerekir (ör. işlev çağrısı).

  • interaction.completed

    Etkileşim başarıyla tamamlandı.

  • interaction.failed

    Etkileşim başarısız oldu.

  • video.generated

    Video üretme işlemi tamamlandı.

uri dize  (zorunlu)

Zorunlu. Webhook etkinliklerinin gönderileceği URI.

Yanıt

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

create_time dize  (isteğe bağlı)

Yalnızca çıkış. Webhook'un oluşturulduğu zamanı gösteren zaman damgası.

id dize  (isteğe bağlı)

Yalnızca çıkış. Webhook'un kimliği.

name string  (isteğe bağlı)

İsteğe bağlı. Webhook'un kullanıcı tarafından sağlanan adı.

new_signing_secret dize  (isteğe bağlı)

Yalnızca çıkış. Webhook için yeni imzalama gizli anahtarı. Yalnızca oluşturma sırasında doldurulur.

signing_secrets array (SigningSecret)  (isteğe bağlı)

Yalnızca çıkış. Bu webhook ile ilişkili imzalama gizli anahtarları.

Webhook yüklerini doğrulamak için kullanılan bir imzalama gizli anahtarını temsil eder.

Alanlar

expire_time dize  (isteğe bağlı)

Yalnızca çıkış. İmza gizli anahtarının geçerlilik bitiş tarihi.

truncated_secret dize  (isteğe bağlı)

Yalnızca çıkış. İmzalama gizli anahtarının kısaltılmış sürümü.

state enum (string)  (isteğe bağlı)

Yalnızca çıkış. Webhook'un durumu.

Olası değerler:

  • enabled

    Webhook etkinleştirilmiş olmalıdır.

  • disabled

    Webhook, kullanıcı tarafından devre dışı bırakıldı.

  • disabled_due_to_failed_deliveries

    Webhook, teslimat başarısızlıkları nedeniyle devre dışı bırakıldı.

subscribed_events array (enum (string))  (isteğe bağlı)

Zorunlu. Webhook'un abone olduğu etkinlikler. Kullanılabilir etkinlikler: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Olası değerler:

  • batch.succeeded

    Toplu işleme başarıyla tamamlandı.

  • batch.expired

    Toplu işlem 48 saat içinde işlenmedi.

  • batch.failed

    Toplu iş başarısız oldu.

  • interaction.requires_action

    Etkileşim için işlem yapılması gerekir (ör. işlev çağrısı).

  • interaction.completed

    Etkileşim başarıyla tamamlandı.

  • interaction.failed

    Etkileşim başarısız oldu.

  • video.generated

    Video üretme işlemi tamamlandı.

update_time string  (isteğe bağlı)

Yalnızca çıkış. Webhook'un en son güncellendiği zaman damgası.

uri dize  (isteğe bağlı)

Zorunlu. Webhook etkinliklerinin gönderileceği URI.

Örnek

Örnek Yanıt

{
  "create_time": "string",
  "id": "string",
  "name": "string",
  "new_signing_secret": "string",
  "signing_secrets": [
    {
      "expire_time": "string",
      "truncated_secret": "string"
    }
  ],
  "state": "enabled",
  "subscribed_events": [
    "batch.succeeded"
  ],
  "update_time": "string",
  "uri": "string"
}

PingWebhook

post https://generativelanguage.googleapis.com/v1beta/webhooks/{id}:ping

Bir webhook'a ping etkinliği gönderir.

Yol / Sorgu Parametreleri

id dize  (zorunlu)

Zorunlu. Ping gönderilecek webhook'un kimliği. Biçim: `{webhook_id}`

İstek metni

İstek içeriği aşağıdaki yapıyla birlikte verileri içerir:

Yanıt

Başarılı olursa yanıt boş olur.

Örnek

RotateSigningSecret

post https://generativelanguage.googleapis.com/v1beta/webhooks/{id}:rotateSigningSecret

Webhook için yeni bir imzalama sırrı oluşturur.

Yol / Sorgu Parametreleri

id dize  (zorunlu)

Zorunlu. İmza gizli anahtarı oluşturulacak webhook'un kimliği. Biçim: `{webhook_id}`

İstek metni

İstek içeriği aşağıdaki yapıyla birlikte verileri içerir:

revocation_behavior enum (string)  (isteğe bağlı)

İsteğe bağlı. Önceki imzalama gizli anahtarları için iptal davranışı.

Olası değerler:

  • revoke_previous_secrets_after_h24

    Yeni bir imzalama gizli anahtarı oluşturun ve 24 saat sonra önceki tüm gizli anahtarları iptal edin. Taşımalar için varsayılan ve en güvenli seçenektir.

  • revoke_previous_secrets_immediately

    Önceki tüm sırları hemen iptal edin. Devam eden bildirimleri kesintiye uğratabileceğinden dikkatli kullanın.

Yanıt

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

secret dize  (isteğe bağlı)

Yalnızca çıkış. Yeni oluşturulan imzalama gizli anahtarı.

Örnek

Örnek Yanıt

{
  "secret": "string"
}

ListWebhooks

get https://generativelanguage.googleapis.com/v1beta/webhooks

Tüm webhook'ları listeler.

Yol / Sorgu Parametreleri

page_size integer  (isteğe bağlı)

İsteğe bağlı. Döndürülecek maksimum webhook sayısı. Hizmet, bu değerden daha az sonuç döndürebilir. Belirtilmemişse en fazla 50 webhook döndürülür. Maksimum değer 1.000'dir.

page_token dize  (isteğe bağlı)

İsteğe bağlı. Önceki bir "ListWebhooks" çağrısından alınan sayfa jetonu. Sonraki sayfayı almak için bunu sağlayın.

Yanıt

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

next_page_token dize  (isteğe bağlı)

Sonraki sayfayı almak için "page_token" olarak gönderilebilen bir jeton. Bu alan atlanırsa sonraki sayfa yoktur.

webhooks array (Webhook)  (isteğe bağlı)

Webhook'lar.

Örnek

Örnek Yanıt

{
  "next_page_token": "string",
  "webhooks": [
    {
      "create_time": "string",
      "id": "string",
      "name": "string",
      "new_signing_secret": "string",
      "signing_secrets": [
        {
          "expire_time": "string",
          "truncated_secret": "string"
        }
      ],
      "state": "enabled",
      "subscribed_events": [
        "batch.succeeded"
      ],
      "update_time": "string",
      "uri": "string"
    }
  ]
}

GetWebhook

get https://generativelanguage.googleapis.com/v1beta/webhooks/{id}

Belirli bir Web kancasını alır.

Yol / Sorgu Parametreleri

id dize  (zorunlu)

Zorunlu. Alınacak webhook'un kimliği.

Yanıt

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

create_time dize  (isteğe bağlı)

Yalnızca çıkış. Webhook'un oluşturulduğu zamanı gösteren zaman damgası.

id dize  (isteğe bağlı)

Yalnızca çıkış. Webhook'un kimliği.

name string  (isteğe bağlı)

İsteğe bağlı. Webhook'un kullanıcı tarafından sağlanan adı.

new_signing_secret dize  (isteğe bağlı)

Yalnızca çıkış. Webhook için yeni imzalama gizli anahtarı. Yalnızca oluşturma sırasında doldurulur.

signing_secrets array (SigningSecret)  (isteğe bağlı)

Yalnızca çıkış. Bu webhook ile ilişkili imzalama gizli anahtarları.

Webhook yüklerini doğrulamak için kullanılan bir imzalama gizli anahtarını temsil eder.

Alanlar

expire_time dize  (isteğe bağlı)

Yalnızca çıkış. İmza gizli anahtarının geçerlilik bitiş tarihi.

truncated_secret dize  (isteğe bağlı)

Yalnızca çıkış. İmzalama gizli anahtarının kısaltılmış sürümü.

state enum (string)  (isteğe bağlı)

Yalnızca çıkış. Webhook'un durumu.

Olası değerler:

  • enabled

    Webhook etkinleştirilmiş olmalıdır.

  • disabled

    Webhook, kullanıcı tarafından devre dışı bırakıldı.

  • disabled_due_to_failed_deliveries

    Webhook, teslimat başarısızlıkları nedeniyle devre dışı bırakıldı.

subscribed_events array (enum (string))  (isteğe bağlı)

Zorunlu. Webhook'un abone olduğu etkinlikler. Kullanılabilir etkinlikler: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Olası değerler:

  • batch.succeeded

    Toplu işleme başarıyla tamamlandı.

  • batch.expired

    Toplu işlem 48 saat içinde işlenmedi.

  • batch.failed

    Toplu iş başarısız oldu.

  • interaction.requires_action

    Etkileşim için işlem yapılması gerekir (ör. işlev çağrısı).

  • interaction.completed

    Etkileşim başarıyla tamamlandı.

  • interaction.failed

    Etkileşim başarısız oldu.

  • video.generated

    Video üretme işlemi tamamlandı.

update_time string  (isteğe bağlı)

Yalnızca çıkış. Webhook'un en son güncellendiği zaman damgası.

uri dize  (isteğe bağlı)

Zorunlu. Webhook etkinliklerinin gönderileceği URI.

Örnek

Örnek Yanıt

{
  "create_time": "string",
  "id": "string",
  "name": "string",
  "new_signing_secret": "string",
  "signing_secrets": [
    {
      "expire_time": "string",
      "truncated_secret": "string"
    }
  ],
  "state": "enabled",
  "subscribed_events": [
    "batch.succeeded"
  ],
  "update_time": "string",
  "uri": "string"
}

UpdateWebhook

patch https://generativelanguage.googleapis.com/v1beta/webhooks/{id}

Mevcut bir Web kancasını günceller.

Yol / Sorgu Parametreleri

id dize  (zorunlu)

Zorunlu. Güncellenecek webhook'un kimliği.

update_mask string  (isteğe bağlı)

İsteğe bağlı. Güncellenecek alanların listesi.

İstek metni

İstek içeriği aşağıdaki yapıyla birlikte verileri içerir:

name string  (isteğe bağlı)

İsteğe bağlı. Webhook'un kullanıcı tarafından sağlanan adı.

state enum (string)  (isteğe bağlı)

İsteğe bağlı. Webhook'un durumu.

Olası değerler:

  • enabled

    Webhook etkinleştirilmiş olmalıdır.

  • disabled

    Webhook, kullanıcı tarafından devre dışı bırakıldı.

  • disabled_due_to_failed_deliveries

    Webhook, teslimat başarısızlıkları nedeniyle devre dışı bırakıldı.

subscribed_events array (enum (string))  (isteğe bağlı)

İsteğe bağlı. Webhook'un abone olduğu etkinlikler. Kullanılabilir etkinlikler: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Olası değerler:

  • batch.succeeded

    Toplu işleme başarıyla tamamlandı.

  • batch.expired

    Toplu işlem 48 saat içinde işlenmedi.

  • batch.failed

    Toplu iş başarısız oldu.

  • interaction.requires_action

    Etkileşim için işlem yapılması gerekir (ör. işlev çağrısı).

  • interaction.completed

    Etkileşim başarıyla tamamlandı.

  • interaction.failed

    Etkileşim başarısız oldu.

  • video.generated

    Video üretme işlemi tamamlandı.

uri dize  (isteğe bağlı)

İsteğe bağlı. Webhook etkinliklerinin gönderileceği URI.

Yanıt

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

create_time dize  (isteğe bağlı)

Yalnızca çıkış. Webhook'un oluşturulduğu zamanı gösteren zaman damgası.

id dize  (isteğe bağlı)

Yalnızca çıkış. Webhook'un kimliği.

name string  (isteğe bağlı)

İsteğe bağlı. Webhook'un kullanıcı tarafından sağlanan adı.

new_signing_secret dize  (isteğe bağlı)

Yalnızca çıkış. Webhook için yeni imzalama gizli anahtarı. Yalnızca oluşturma sırasında doldurulur.

signing_secrets array (SigningSecret)  (isteğe bağlı)

Yalnızca çıkış. Bu webhook ile ilişkili imzalama gizli anahtarları.

Webhook yüklerini doğrulamak için kullanılan bir imzalama gizli anahtarını temsil eder.

Alanlar

expire_time dize  (isteğe bağlı)

Yalnızca çıkış. İmza gizli anahtarının geçerlilik bitiş tarihi.

truncated_secret dize  (isteğe bağlı)

Yalnızca çıkış. İmzalama gizli anahtarının kısaltılmış sürümü.

state enum (string)  (isteğe bağlı)

Yalnızca çıkış. Webhook'un durumu.

Olası değerler:

  • enabled

    Webhook etkinleştirilmiş olmalıdır.

  • disabled

    Webhook, kullanıcı tarafından devre dışı bırakıldı.

  • disabled_due_to_failed_deliveries

    Webhook, teslimat başarısızlıkları nedeniyle devre dışı bırakıldı.

subscribed_events array (enum (string))  (isteğe bağlı)

Zorunlu. Webhook'un abone olduğu etkinlikler. Kullanılabilir etkinlikler: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Olası değerler:

  • batch.succeeded

    Toplu işleme başarıyla tamamlandı.

  • batch.expired

    Toplu işlem 48 saat içinde işlenmedi.

  • batch.failed

    Toplu iş başarısız oldu.

  • interaction.requires_action

    Etkileşim için işlem yapılması gerekir (ör. işlev çağrısı).

  • interaction.completed

    Etkileşim başarıyla tamamlandı.

  • interaction.failed

    Etkileşim başarısız oldu.

  • video.generated

    Video üretme işlemi tamamlandı.

update_time string  (isteğe bağlı)

Yalnızca çıkış. Webhook'un en son güncellendiği zaman damgası.

uri dize  (isteğe bağlı)

Zorunlu. Webhook etkinliklerinin gönderileceği URI.

Örnek

Örnek Yanıt

{
  "create_time": "string",
  "id": "string",
  "name": "string",
  "new_signing_secret": "string",
  "signing_secrets": [
    {
      "expire_time": "string",
      "truncated_secret": "string"
    }
  ],
  "state": "enabled",
  "subscribed_events": [
    "batch.succeeded"
  ],
  "update_time": "string",
  "uri": "string"
}

DeleteWebhook

delete https://generativelanguage.googleapis.com/v1beta/webhooks/{id}

Webhook'u siler.

Yol / Sorgu Parametreleri

id dize  (zorunlu)

Zorunlu. Silinecek webhook'un kimliği. Biçim: `{webhook_id}`

Yanıt

Başarılı olursa yanıt boş olur.

Örnek

Kaynaklar

Webhook

Webhook kaynağı.

Alanlar

create_time dize  (isteğe bağlı)

Yalnızca çıkış. Webhook'un oluşturulduğu zamanı gösteren zaman damgası.

id dize  (isteğe bağlı)

Yalnızca çıkış. Webhook'un kimliği.

name string  (isteğe bağlı)

İsteğe bağlı. Webhook'un kullanıcı tarafından sağlanan adı.

new_signing_secret dize  (isteğe bağlı)

Yalnızca çıkış. Webhook için yeni imzalama gizli anahtarı. Yalnızca oluşturma sırasında doldurulur.

signing_secrets array (SigningSecret)  (isteğe bağlı)

Yalnızca çıkış. Bu webhook ile ilişkili imzalama gizli anahtarları.

Webhook yüklerini doğrulamak için kullanılan bir imzalama gizli anahtarını temsil eder.

Alanlar

expire_time dize  (isteğe bağlı)

Yalnızca çıkış. İmza gizli anahtarının geçerlilik bitiş tarihi.

truncated_secret dize  (isteğe bağlı)

Yalnızca çıkış. İmzalama gizli anahtarının kısaltılmış sürümü.

state enum (string)  (isteğe bağlı)

Yalnızca çıkış. Webhook'un durumu.

Olası değerler:

  • enabled

    Webhook etkinleştirilmiş olmalıdır.

  • disabled

    Webhook, kullanıcı tarafından devre dışı bırakıldı.

  • disabled_due_to_failed_deliveries

    Webhook, teslimat başarısızlıkları nedeniyle devre dışı bırakıldı.

subscribed_events array (enum (string))  (isteğe bağlı)

Zorunlu. Webhook'un abone olduğu etkinlikler. Kullanılabilir etkinlikler: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Olası değerler:

  • batch.succeeded

    Toplu işleme başarıyla tamamlandı.

  • batch.expired

    Toplu işlem 48 saat içinde işlenmedi.

  • batch.failed

    Toplu iş başarısız oldu.

  • interaction.requires_action

    Etkileşim için işlem yapılması gerekir (ör. işlev çağrısı).

  • interaction.completed

    Etkileşim başarıyla tamamlandı.

  • interaction.failed

    Etkileşim başarısız oldu.

  • video.generated

    Video üretme işlemi tamamlandı.

update_time string  (isteğe bağlı)

Yalnızca çıkış. Webhook'un en son güncellendiği zaman damgası.

uri dize  (isteğe bağlı)

Zorunlu. Webhook etkinliklerinin gönderileceği URI.