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
Yeni bir Web kancası oluşturur.
İstek metni
İstek içeriği aşağıdaki yapıyla birlikte verileri içerir:
İsteğe bağlı. Webhook'un kullanıcı tarafından sağlanan adı.
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.succeededToplu işleme başarıyla tamamlandı.
-
batch.expiredToplu işlem 48 saat içinde işlenmedi.
-
batch.failedToplu iş başarısız oldu.
-
interaction.requires_actionEtkileşim için işlem yapılması gerekir (ör. işlev çağrısı).
-
interaction.completedEtkileşim başarıyla tamamlandı.
-
interaction.failedEtkileşim başarısız oldu.
-
video.generatedVideo üretme işlemi tamamlandı.
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:
Yalnızca çıkış. Webhook'un oluşturulduğu zamanı gösteren zaman damgası.
Yalnızca çıkış. Webhook'un kimliği.
İsteğe bağlı. Webhook'un kullanıcı tarafından sağlanan adı.
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ı.
Alanlar
Yalnızca çıkış. İmza gizli anahtarının geçerlilik bitiş tarihi.
Yalnızca çıkış. İmzalama gizli anahtarının kısaltılmış sürümü.
Yalnızca çıkış. Webhook'un durumu.
Olası değerler:
-
enabledWebhook etkinleştirilmiş olmalıdır.
-
disabledWebhook, kullanıcı tarafından devre dışı bırakıldı.
-
disabled_due_to_failed_deliveriesWebhook, teslimat başarısızlıkları nedeniyle devre dışı bırakıldı.
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.succeededToplu işleme başarıyla tamamlandı.
-
batch.expiredToplu işlem 48 saat içinde işlenmedi.
-
batch.failedToplu iş başarısız oldu.
-
interaction.requires_actionEtkileşim için işlem yapılması gerekir (ör. işlev çağrısı).
-
interaction.completedEtkileşim başarıyla tamamlandı.
-
interaction.failedEtkileşim başarısız oldu.
-
video.generatedVideo üretme işlemi tamamlandı.
Yalnızca çıkış. Webhook'un en son güncellendiği zaman damgası.
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
Bir webhook'a ping etkinliği gönderir.
Yol / Sorgu Parametreleri
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
Webhook için yeni bir imzalama sırrı oluşturur.
Yol / Sorgu Parametreleri
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:
İsteğe bağlı. Önceki imzalama gizli anahtarları için iptal davranışı.
Olası değerler:
-
revoke_previous_secrets_after_h24Yeni 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:
Yalnızca çıkış. Yeni oluşturulan imzalama gizli anahtarı.
Örnek
Örnek Yanıt
{ "secret": "string" }
ListWebhooks
Tüm webhook'ları listeler.
Yol / Sorgu Parametreleri
İ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.
İ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:
Sonraki sayfayı almak için "page_token" olarak gönderilebilen bir jeton. Bu alan atlanırsa sonraki sayfa yoktur.
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
Belirli bir Web kancasını alır.
Yol / Sorgu Parametreleri
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:
Yalnızca çıkış. Webhook'un oluşturulduğu zamanı gösteren zaman damgası.
Yalnızca çıkış. Webhook'un kimliği.
İsteğe bağlı. Webhook'un kullanıcı tarafından sağlanan adı.
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ı.
Alanlar
Yalnızca çıkış. İmza gizli anahtarının geçerlilik bitiş tarihi.
Yalnızca çıkış. İmzalama gizli anahtarının kısaltılmış sürümü.
Yalnızca çıkış. Webhook'un durumu.
Olası değerler:
-
enabledWebhook etkinleştirilmiş olmalıdır.
-
disabledWebhook, kullanıcı tarafından devre dışı bırakıldı.
-
disabled_due_to_failed_deliveriesWebhook, teslimat başarısızlıkları nedeniyle devre dışı bırakıldı.
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.succeededToplu işleme başarıyla tamamlandı.
-
batch.expiredToplu işlem 48 saat içinde işlenmedi.
-
batch.failedToplu iş başarısız oldu.
-
interaction.requires_actionEtkileşim için işlem yapılması gerekir (ör. işlev çağrısı).
-
interaction.completedEtkileşim başarıyla tamamlandı.
-
interaction.failedEtkileşim başarısız oldu.
-
video.generatedVideo üretme işlemi tamamlandı.
Yalnızca çıkış. Webhook'un en son güncellendiği zaman damgası.
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
Mevcut bir Web kancasını günceller.
Yol / Sorgu Parametreleri
Zorunlu. Güncellenecek webhook'un kimliği.
İsteğe bağlı. Güncellenecek alanların listesi.
İstek metni
İstek içeriği aşağıdaki yapıyla birlikte verileri içerir:
İsteğe bağlı. Webhook'un kullanıcı tarafından sağlanan adı.
İsteğe bağlı. Webhook'un durumu.
Olası değerler:
-
enabledWebhook etkinleştirilmiş olmalıdır.
-
disabledWebhook, kullanıcı tarafından devre dışı bırakıldı.
-
disabled_due_to_failed_deliveriesWebhook, teslimat başarısızlıkları nedeniyle devre dışı bırakıldı.
İ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.succeededToplu işleme başarıyla tamamlandı.
-
batch.expiredToplu işlem 48 saat içinde işlenmedi.
-
batch.failedToplu iş başarısız oldu.
-
interaction.requires_actionEtkileşim için işlem yapılması gerekir (ör. işlev çağrısı).
-
interaction.completedEtkileşim başarıyla tamamlandı.
-
interaction.failedEtkileşim başarısız oldu.
-
video.generatedVideo üretme işlemi tamamlandı.
İ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:
Yalnızca çıkış. Webhook'un oluşturulduğu zamanı gösteren zaman damgası.
Yalnızca çıkış. Webhook'un kimliği.
İsteğe bağlı. Webhook'un kullanıcı tarafından sağlanan adı.
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ı.
Alanlar
Yalnızca çıkış. İmza gizli anahtarının geçerlilik bitiş tarihi.
Yalnızca çıkış. İmzalama gizli anahtarının kısaltılmış sürümü.
Yalnızca çıkış. Webhook'un durumu.
Olası değerler:
-
enabledWebhook etkinleştirilmiş olmalıdır.
-
disabledWebhook, kullanıcı tarafından devre dışı bırakıldı.
-
disabled_due_to_failed_deliveriesWebhook, teslimat başarısızlıkları nedeniyle devre dışı bırakıldı.
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.succeededToplu işleme başarıyla tamamlandı.
-
batch.expiredToplu işlem 48 saat içinde işlenmedi.
-
batch.failedToplu iş başarısız oldu.
-
interaction.requires_actionEtkileşim için işlem yapılması gerekir (ör. işlev çağrısı).
-
interaction.completedEtkileşim başarıyla tamamlandı.
-
interaction.failedEtkileşim başarısız oldu.
-
video.generatedVideo üretme işlemi tamamlandı.
Yalnızca çıkış. Webhook'un en son güncellendiği zaman damgası.
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
Webhook'u siler.
Yol / Sorgu Parametreleri
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
Yalnızca çıkış. Webhook'un oluşturulduğu zamanı gösteren zaman damgası.
Yalnızca çıkış. Webhook'un kimliği.
İsteğe bağlı. Webhook'un kullanıcı tarafından sağlanan adı.
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ı.
Alanlar
Yalnızca çıkış. İmza gizli anahtarının geçerlilik bitiş tarihi.
Yalnızca çıkış. İmzalama gizli anahtarının kısaltılmış sürümü.
Yalnızca çıkış. Webhook'un durumu.
Olası değerler:
-
enabledWebhook etkinleştirilmiş olmalıdır.
-
disabledWebhook, kullanıcı tarafından devre dışı bırakıldı.
-
disabled_due_to_failed_deliveriesWebhook, teslimat başarısızlıkları nedeniyle devre dışı bırakıldı.
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.succeededToplu işleme başarıyla tamamlandı.
-
batch.expiredToplu işlem 48 saat içinde işlenmedi.
-
batch.failedToplu iş başarısız oldu.
-
interaction.requires_actionEtkileşim için işlem yapılması gerekir (ör. işlev çağrısı).
-
interaction.completedEtkileşim başarıyla tamamlandı.
-
interaction.failedEtkileşim başarısız oldu.
-
video.generatedVideo üretme işlemi tamamlandı.
Yalnızca çıkış. Webhook'un en son güncellendiği zaman damgası.
Zorunlu. Webhook etkinliklerinin gönderileceği URI.