Model Gemini 4 Argon jest już dostępny. Przećwicz to samodzielnie.

Google używa technologii AI do tłumaczenia treści na Twój preferowany język. Tłumaczenia wygenerowane przez AI mogą zawierać błędy.

Gemini Webhooks API

Webhooki umożliwiają interfejsowi Gemini API wysyłanie powiadomień w czasie rzeczywistym na Twój serwer po zakończeniu operacji asynchronicznych lub długotrwałych. Zastępuje to konieczność odpytywania interfejsu API o aktualizacje stanu, co zmniejsza opóźnienia i obciążenie.

Wyświetl jako Markdown Wyświetl specyfikację OpenAPI

CreateWebhook

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

Tworzy nowy webhook.

Treść żądania
Odpowiedź

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

name ciąg znaków (opcjonalny)

Opcjonalnie. Nazwa webhooka podana przez użytkownika.

subscribed_events tablica (wyliczenie (ciąg)) (wymagane)

Wymagane. Zdarzenia, na które subskrybuje webhook. Dostępne zdarzenia: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Możliwe wartości:

batch.succeeded
Przetwarzanie wsadowe zostało zakończone.
batch.expired
Partia nie została przetworzona w ciągu 48 godzin.
batch.failed
Nie udało się wykonać zadania wsadowego.
interaction.requires_action
Interakcja wymaga działania (np. wywołania funkcji).
interaction.completed
Interakcja została zakończona.
interaction.failed
Interakcja nie powiodła się.
video.generated
Generowanie filmu zostało zakończone.

uri ciąg znaków (wymagany)

Wymagane. Identyfikator URI, na który będą wysyłane zdarzenia z webhooka.

Odpowiedź

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

create_time ciąg (opcjonalny)

Tylko dane wyjściowe. Sygnatura czasowa utworzenia webhooka.

id ciąg znaków (opcjonalny)

Tylko dane wyjściowe. Identyfikator webhooka.

name ciąg znaków (opcjonalny)

Opcjonalnie. Nazwa webhooka podana przez użytkownika.

new_signing_secret ciąg (opcjonalny)

Tylko dane wyjściowe. Nowy klucz podpisywania webhooka. Wartość jest podawana tylko podczas tworzenia.

signing_secrets tablica (SigningSecret) (opcjonalnie)

Tylko dane wyjściowe. Klucze podpisywania powiązane z tym webhookiem.

Pola

expire_time string (opcjonalny)

Tylko dane wyjściowe. Data ważności tajnego klucza podpisywania.

truncated_secret ciąg (opcjonalny)

Tylko dane wyjściowe. Skrócona wersja klucza tajnego podpisywania.

state enum (string) (opcjonalnie)

Tylko dane wyjściowe. Stan webhooka.

Możliwe wartości:

enabled
Webhook jest włączony.
disabled
Webhook został wyłączony przez użytkownika.
disabled_due_to_failed_deliveries
Webhook jest wyłączony z powodu nieudanych dostaw.

subscribed_events tablica (wyliczenie (ciąg znaków)) (opcjonalnie)

Możliwe wartości:

batch.succeeded
Przetwarzanie wsadowe zostało zakończone.
batch.expired
Partia nie została przetworzona w ciągu 48 godzin.
batch.failed
Nie udało się wykonać zadania wsadowego.
interaction.requires_action
Interakcja wymaga działania (np. wywołania funkcji).
interaction.completed
Interakcja została zakończona.
interaction.failed
Interakcja nie powiodła się.
video.generated
Generowanie filmu zostało zakończone.

update_time ciąg znaków (opcjonalny)

Tylko dane wyjściowe. Sygnatura czasowa ostatniej aktualizacji webhooka.

uri string (opcjonalnie)

Wymagane. Identyfikator URI, na który będą wysyłane zdarzenia z webhooka.

Przykład

Przykładowa odpowiedź

{
  "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

Wysyła zdarzenie ping do webhooka.

Parametry ścieżki lub zapytania
Treść żądania
Odpowiedź

Parametry ścieżki lub zapytania

id ciąg znaków (wymagany)

Wymagane. Identyfikator webhooka, do którego chcesz wysłać ping. Format: `{webhook_id}`

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Odpowiedź

Jeśli operacja się uda, odpowiedź będzie pusta.

Przykład

RotateSigningSecret

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

Generuje nowy klucz podpisu dla webhooka.

Parametry ścieżki lub zapytania
Treść żądania
Odpowiedź

Parametry ścieżki lub zapytania

id ciąg znaków (wymagany)

Wymagane. Identyfikator webhooka, dla którego chcesz wygenerować klucz podpisu. Format: `{webhook_id}`

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

revocation_behavior enum (string) (opcjonalny)

Opcjonalnie. Sposób unieważniania poprzednich obiektów tajnych podpisywania.

Możliwe wartości:

revoke_previous_secrets_after_h24
Wygeneruj nowy tajny klucz podpisywania i po 24 godzinach cofnij wszystkie poprzednie klucze. Domyślna i najbezpieczniejsza opcja migracji.
revoke_previous_secrets_immediately
Natychmiast odwołaj wszystkie poprzednie obiekty tajne. Używaj tej opcji z rozwagą, ponieważ może ona przerwać bieżące powiadomienia.

Odpowiedź

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

secret string (opcjonalnie)

Tylko dane wyjściowe. Nowo wygenerowany tajny klucz podpisywania.

Przykład

Przykładowa odpowiedź

{
  "secret": "string"
}

ListWebhooks

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

Wyświetla listę wszystkich webhooków.

Parametry ścieżki lub zapytania
Odpowiedź

Parametry ścieżki lub zapytania

page_size integer (optional)

Opcjonalnie. Maksymalna liczba webhooków do zwrócenia. Usługa może zwrócić mniej niż tę wartość. Jeśli nie podano inaczej, zwracanych jest maksymalnie 50 webhooków. Maksymalna wartość to 1000.

page_token ciąg (opcjonalny)

Opcjonalnie. Token strony otrzymany z poprzedniego wywołania `ListWebhooks`. Podaj ten token, aby pobrać kolejną stronę.

Odpowiedź

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

next_page_token ciąg (opcjonalny)

Token, który można wysłać jako `page_token`, aby pobrać następną stronę. Jeśli pominiesz to pole, nie będzie kolejnych stron.

webhooks tablica (Webhook) (opcjonalnie)

Webhooki.

Przykład

Przykładowa odpowiedź

{
  "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}

Pobiera określony webhook.

Parametry ścieżki lub zapytania
Odpowiedź

Parametry ścieżki lub zapytania

id ciąg znaków (wymagany)

Wymagane. Identyfikator webhooka do pobrania.

Odpowiedź

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

create_time ciąg (opcjonalny)

Tylko dane wyjściowe. Sygnatura czasowa utworzenia webhooka.

id ciąg znaków (opcjonalny)

Tylko dane wyjściowe. Identyfikator webhooka.

name ciąg znaków (opcjonalny)

Opcjonalnie. Nazwa webhooka podana przez użytkownika.

new_signing_secret ciąg (opcjonalny)

Tylko dane wyjściowe. Nowy klucz podpisywania webhooka. Wartość jest podawana tylko podczas tworzenia.

signing_secrets tablica (SigningSecret) (opcjonalnie)

Tylko dane wyjściowe. Klucze podpisywania powiązane z tym webhookiem.

Pola

expire_time string (opcjonalny)

Tylko dane wyjściowe. Data ważności tajnego klucza podpisywania.

truncated_secret ciąg (opcjonalny)

Tylko dane wyjściowe. Skrócona wersja klucza tajnego podpisywania.

state enum (string) (opcjonalnie)

Tylko dane wyjściowe. Stan webhooka.

Możliwe wartości:

enabled
Webhook jest włączony.
disabled
Webhook został wyłączony przez użytkownika.
disabled_due_to_failed_deliveries
Webhook jest wyłączony z powodu nieudanych dostaw.

subscribed_events tablica (wyliczenie (ciąg znaków)) (opcjonalnie)

Możliwe wartości:

batch.succeeded
Przetwarzanie wsadowe zostało zakończone.
batch.expired
Partia nie została przetworzona w ciągu 48 godzin.
batch.failed
Nie udało się wykonać zadania wsadowego.
interaction.requires_action
Interakcja wymaga działania (np. wywołania funkcji).
interaction.completed
Interakcja została zakończona.
interaction.failed
Interakcja nie powiodła się.
video.generated
Generowanie filmu zostało zakończone.

update_time ciąg znaków (opcjonalny)

Tylko dane wyjściowe. Sygnatura czasowa ostatniej aktualizacji webhooka.

uri string (opcjonalnie)

Wymagane. Identyfikator URI, na który będą wysyłane zdarzenia z webhooka.

Przykład

Przykładowa odpowiedź

{
  "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}

Aktualizuje istniejący webhook.

Parametry ścieżki lub zapytania
Treść żądania
Odpowiedź

Parametry ścieżki lub zapytania

id ciąg znaków (wymagany)

Wymagane. Identyfikator webhooka, który ma zostać zaktualizowany.

update_mask string (opcjonalny)

Opcjonalnie. Lista pól do zaktualizowania.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

name ciąg znaków (opcjonalny)

Opcjonalnie. Nazwa webhooka podana przez użytkownika.

state enum (string) (opcjonalnie)

Opcjonalnie. Stan webhooka.

Możliwe wartości:

enabled
Webhook jest włączony.
disabled
Webhook został wyłączony przez użytkownika.
disabled_due_to_failed_deliveries
Webhook jest wyłączony z powodu nieudanych dostaw.

subscribed_events tablica (wyliczenie (ciąg znaków)) (opcjonalnie)

Opcjonalnie. Zdarzenia, na które subskrybuje webhook. Dostępne zdarzenia: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Możliwe wartości:

batch.succeeded
Przetwarzanie wsadowe zostało zakończone.
batch.expired
Partia nie została przetworzona w ciągu 48 godzin.
batch.failed
Nie udało się wykonać zadania wsadowego.
interaction.requires_action
Interakcja wymaga działania (np. wywołania funkcji).
interaction.completed
Interakcja została zakończona.
interaction.failed
Interakcja nie powiodła się.
video.generated
Generowanie filmu zostało zakończone.

uri string (opcjonalnie)

Opcjonalnie. Identyfikator URI, na który będą wysyłane zdarzenia z webhooka.

Odpowiedź

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

create_time ciąg (opcjonalny)

Tylko dane wyjściowe. Sygnatura czasowa utworzenia webhooka.

id ciąg znaków (opcjonalny)

Tylko dane wyjściowe. Identyfikator webhooka.

name ciąg znaków (opcjonalny)

Opcjonalnie. Nazwa webhooka podana przez użytkownika.

new_signing_secret ciąg (opcjonalny)

Tylko dane wyjściowe. Nowy klucz podpisywania webhooka. Wartość jest podawana tylko podczas tworzenia.

signing_secrets tablica (SigningSecret) (opcjonalnie)

Tylko dane wyjściowe. Klucze podpisywania powiązane z tym webhookiem.

Pola

expire_time string (opcjonalny)

Tylko dane wyjściowe. Data ważności tajnego klucza podpisywania.

truncated_secret ciąg (opcjonalny)

Tylko dane wyjściowe. Skrócona wersja klucza tajnego podpisywania.

state enum (string) (opcjonalnie)

Tylko dane wyjściowe. Stan webhooka.

Możliwe wartości:

enabled
Webhook jest włączony.
disabled
Webhook został wyłączony przez użytkownika.
disabled_due_to_failed_deliveries
Webhook jest wyłączony z powodu nieudanych dostaw.

subscribed_events tablica (wyliczenie (ciąg znaków)) (opcjonalnie)

Możliwe wartości:

batch.succeeded
Przetwarzanie wsadowe zostało zakończone.
batch.expired
Partia nie została przetworzona w ciągu 48 godzin.
batch.failed
Nie udało się wykonać zadania wsadowego.
interaction.requires_action
Interakcja wymaga działania (np. wywołania funkcji).
interaction.completed
Interakcja została zakończona.
interaction.failed
Interakcja nie powiodła się.
video.generated
Generowanie filmu zostało zakończone.

update_time ciąg znaków (opcjonalny)

Tylko dane wyjściowe. Sygnatura czasowa ostatniej aktualizacji webhooka.

uri string (opcjonalnie)

Wymagane. Identyfikator URI, na który będą wysyłane zdarzenia z webhooka.

Przykład

Przykładowa odpowiedź

{
  "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}

Usuwa webhooka.

Parametry ścieżki lub zapytania
Odpowiedź

Parametry ścieżki lub zapytania

id ciąg znaków (wymagany)

Wymagane. Identyfikator webhooka do usunięcia. Format: `{webhook_id}`

Odpowiedź

Jeśli operacja się uda, odpowiedź będzie pusta.

Przykład

Zasoby

Webhook

Zasób webhooka.

Pola

create_time ciąg (opcjonalny)

Tylko dane wyjściowe. Sygnatura czasowa utworzenia webhooka.

id ciąg znaków (opcjonalny)

Tylko dane wyjściowe. Identyfikator webhooka.

name ciąg znaków (opcjonalny)

Opcjonalnie. Nazwa webhooka podana przez użytkownika.

new_signing_secret ciąg (opcjonalny)

Tylko dane wyjściowe. Nowy klucz podpisywania webhooka. Wartość jest podawana tylko podczas tworzenia.

signing_secrets tablica (SigningSecret) (opcjonalnie)

Tylko dane wyjściowe. Klucze podpisywania powiązane z tym webhookiem.

Pola

expire_time string (opcjonalny)

Tylko dane wyjściowe. Data ważności tajnego klucza podpisywania.

truncated_secret ciąg (opcjonalny)

Tylko dane wyjściowe. Skrócona wersja klucza tajnego podpisywania.

state enum (string) (opcjonalnie)

Tylko dane wyjściowe. Stan webhooka.

Możliwe wartości:

enabled
Webhook jest włączony.
disabled
Webhook został wyłączony przez użytkownika.
disabled_due_to_failed_deliveries
Webhook jest wyłączony z powodu nieudanych dostaw.

subscribed_events tablica (wyliczenie (ciąg znaków)) (opcjonalnie)

Możliwe wartości:

batch.succeeded
Przetwarzanie wsadowe zostało zakończone.
batch.expired
Partia nie została przetworzona w ciągu 48 godzin.
batch.failed
Nie udało się wykonać zadania wsadowego.
interaction.requires_action
Interakcja wymaga działania (np. wywołania funkcji).
interaction.completed
Interakcja została zakończona.
interaction.failed
Interakcja nie powiodła się.
video.generated
Generowanie filmu zostało zakończone.

update_time ciąg znaków (opcjonalny)

Tylko dane wyjściowe. Sygnatura czasowa ostatniej aktualizacji webhooka.

uri string (opcjonalnie)

Wymagane. Identyfikator URI, na który będą wysyłane zdarzenia z webhooka.