Флэш-память Gemini 3.7 теперь доступна. Попробуйте!

Эта страница переведена с помощью Cloud Translation API.

Gemini Webhooks API

Веб-хуки позволяют API Gemini отправлять на ваш сервер уведомления в режиме реального времени о завершении асинхронных операций или длительных операций (LRO). Это избавляет от необходимости опрашивать API для получения обновлений статуса, снижая задержку и накладные расходы.

Просмотреть в формате Markdown Просмотреть спецификацию OpenAPI

Создать веб-перехватчик

ссылка: https://generativelanguage.googleapis.com/v1beta/webhooks

Создает новый веб-перехватчик.

Текст запроса
Ответ

Текст запроса

Тело запроса содержит данные следующей структуры:

строковое имя (необязательно)

Необязательно. Имя веб-перехватчика, указанное пользователем.

массив subscribed_events (перечисление (строка)) (обязательно)

Обязательно. События, на которые подписан веб-хук. Доступные события: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Возможные значения:

batch.succeeded
Пакетная обработка успешно завершена.
batch.expired
Обработка партии не была завершена в течение 48 часов.
batch.failed
Пакетное задание не выполнено.
interaction.requires_action
Взаимодействие требует совершения действия (например, вызова функции).
interaction.completed
Взаимодействие успешно завершено.
interaction.failed
Взаимодействие не удалось.
video.generated
Создание видео завершено.

строка URI (обязательно)

Обязательно. URI, на который будут отправляться события веб-перехватчика.

Ответ

В случае успеха тело ответа будет содержать данные следующей структуры:

create_time string (необязательно)

Только вывод. Отметка времени создания веб-перехватчика.

строка идентификатора (необязательно)

Только вывод. Идентификатор веб-перехватчика.

строковое имя (необязательно)

Необязательно. Имя веб-перехватчика, указанное пользователем.

new_signing_secret string (необязательно)

Только для вывода. Новый секретный ключ для веб-перехватчика. Заполняется только при создании.

массив signing_secrets (SigningSecret) (необязательно)

Только вывод. Секретные данные для подписи, связанные с этим веб-хуком.

Поля

expire_time строка (необязательно)

Только для вывода. Срок действия секретного ключа подписи.

усеченная секретная строка (необязательно)

Только вывод. Сокращенная версия секретного ключа подписи.

перечисление состояний (строка) (необязательно)

Только вывод. Состояние веб-хука.

Возможные значения:

enabled
Веб-перехватчик включен.
disabled
Пользователь отключил веб-перехватчик.
disabled_due_to_failed_deliveries
Веб-хук отключен из-за неудачных доставок.

массив subscribed_events (перечисление (строка)) (необязательно)

Возможные значения:

batch.succeeded
Пакетная обработка успешно завершена.
batch.expired
Обработка партии не была завершена в течение 48 часов.
batch.failed
Пакетное задание не выполнено.
interaction.requires_action
Взаимодействие требует совершения действия (например, вызова функции).
interaction.completed
Взаимодействие успешно завершено.
interaction.failed
Взаимодействие не удалось.
video.generated
Создание видео завершено.

строка update_time (необязательно)

Только вывод. Отметка времени последнего обновления веб-перехватчика.

строка URI (необязательно)

Обязательно. URI, на который будут отправляться события веб-перехватчика.

Пример

Пример ответа

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

Отправляет событие ping на веб-перехватчик.

Путь / Параметры запроса
Текст запроса
Ответ

Путь / Параметры запроса

строковый идентификатор (обязательно)

Обязательно. Идентификатор веб-хука для пинга. Формат: `{webhook_id}`

Текст запроса

Тело запроса содержит данные следующей структуры:

Ответ

В случае успеха ответ будет пустым.

Пример

RotateSigningSecret

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

Генерирует новый секретный ключ для подписи веб-перехватчика.

Путь / Параметры запроса
Текст запроса
Ответ

Путь / Параметры запроса

строковый идентификатор (обязательно)

Обязательно. Идентификатор веб-перехватчика, для которого необходимо сгенерировать секретный ключ для подписи. Формат: `{webhook_id}`

Текст запроса

Тело запроса содержит данные следующей структуры:

revocation_behavior enum (string) (optional)

Необязательно. Порядок отзыва ранее подписанных секретных ключей.

Возможные значения:

revoke_previous_secrets_after_h24
Сгенерировать новый секретный ключ для подписи и аннулировать все предыдущие через 24 часа. Вариант по умолчанию и наиболее безопасный вариант для миграции.
revoke_previous_secrets_immediately
Немедленно аннулируйте все ранее полученные секреты. Используйте с осторожностью, так как это может прервать текущие уведомления.

Ответ

В случае успеха тело ответа будет содержать данные следующей структуры:

секретная строка (необязательно)

Только вывод. Вновь сгенерированный секретный ключ для подписи.

Пример

Пример ответа

{
  "secret": "string"
}

ListWebhooks

получить https://generativelanguage.googleapis.com/v1beta/webhooks

Отображает список всех веб-хуков.

Путь / Параметры запроса
Ответ

Путь / Параметры запроса

page_size — целое число (необязательно)

Необязательный параметр. Максимальное количество возвращаемых веб-хуков. Сервис может вернуть меньше этого значения. Если параметр не указан, будет возвращено не более 50 веб-хуков. Максимальное значение — 1000.

строка page_token (необязательно)

Необязательный параметр. Токен страницы, полученный из предыдущего вызова `ListWebhooks`. Укажите его, чтобы получить следующую страницу.

Ответ

В случае успеха тело ответа будет содержать данные следующей структуры:

строка next_page_token (необязательно)

Токен, который можно отправить в качестве `page_token` для получения следующей страницы. Если это поле опущено, последующих страниц не будет.

массив веб-хуков ( Webhook ) (необязательно)

Веб-хуки.

Пример

Пример ответа

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

получить https://generativelanguage.googleapis.com/v1beta/webhooks/{id}

Получает конкретный веб-хук.

Путь / Параметры запроса
Ответ

Путь / Параметры запроса

строковый идентификатор (обязательно)

Обязательно. Идентификатор веб-перехватчика для получения данных.

Ответ

В случае успеха тело ответа будет содержать данные следующей структуры:

create_time string (необязательно)

Только вывод. Отметка времени создания веб-перехватчика.

строка идентификатора (необязательно)

Только вывод. Идентификатор веб-перехватчика.

строковое имя (необязательно)

Необязательно. Имя веб-перехватчика, указанное пользователем.

new_signing_secret string (необязательно)

Только для вывода. Новый секретный ключ для веб-перехватчика. Заполняется только при создании.

массив signing_secrets (SigningSecret) (необязательно)

Только вывод. Секретные данные для подписи, связанные с этим веб-хуком.

Поля

expire_time строка (необязательно)

Только для вывода. Срок действия секретного ключа подписи.

усеченная секретная строка (необязательно)

Только вывод. Сокращенная версия секретного ключа подписи.

перечисление состояний (строка) (необязательно)

Только вывод. Состояние веб-хука.

Возможные значения:

enabled
Веб-перехватчик включен.
disabled
Пользователь отключил веб-перехватчик.
disabled_due_to_failed_deliveries
Веб-хук отключен из-за неудачных доставок.

массив subscribed_events (перечисление (строка)) (необязательно)

Возможные значения:

batch.succeeded
Пакетная обработка успешно завершена.
batch.expired
Обработка партии не была завершена в течение 48 часов.
batch.failed
Пакетное задание не выполнено.
interaction.requires_action
Взаимодействие требует совершения действия (например, вызова функции).
interaction.completed
Взаимодействие успешно завершено.
interaction.failed
Взаимодействие не удалось.
video.generated
Создание видео завершено.

строка update_time (необязательно)

Только вывод. Отметка времени последнего обновления веб-перехватчика.

строка URI (необязательно)

Обязательно. URI, на который будут отправляться события веб-перехватчика.

Пример

Пример ответа

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

патч https://generativelanguage.googleapis.com/v1beta/webhooks/{id}

Обновляет существующий веб-перехватчик.

Путь / Параметры запроса
Текст запроса
Ответ

Путь / Параметры запроса

строковый идентификатор (обязательно)

Обязательно. Идентификатор веб-перехватчика для обновления.

update_mask string (необязательно)

Необязательный параметр. Список полей для обновления.

Текст запроса

Тело запроса содержит данные следующей структуры:

строковое имя (необязательно)

Необязательно. Имя веб-перехватчика, указанное пользователем.

перечисление состояний (строка) (необязательно)

Необязательно. Состояние веб-хука.

Возможные значения:

enabled
Веб-перехватчик включен.
disabled
Пользователь отключил веб-перехватчик.
disabled_due_to_failed_deliveries
Веб-хук отключен из-за неудачных доставок.

массив subscribed_events (перечисление (строка)) (необязательно)

Необязательно. События, на которые подписан веб-хук. Доступные события: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Возможные значения:

batch.succeeded
Пакетная обработка успешно завершена.
batch.expired
Обработка партии не была завершена в течение 48 часов.
batch.failed
Пакетное задание не выполнено.
interaction.requires_action
Взаимодействие требует совершения действия (например, вызова функции).
interaction.completed
Взаимодействие успешно завершено.
interaction.failed
Взаимодействие не удалось.
video.generated
Создание видео завершено.

строка URI (необязательно)

Необязательный параметр. URI, на который будут отправляться события веб-перехватчика.

Ответ

В случае успеха тело ответа будет содержать данные следующей структуры:

create_time string (необязательно)

Только вывод. Отметка времени создания веб-перехватчика.

строка идентификатора (необязательно)

Только вывод. Идентификатор веб-перехватчика.

строковое имя (необязательно)

Необязательно. Имя веб-перехватчика, указанное пользователем.

new_signing_secret string (необязательно)

Только для вывода. Новый секретный ключ для веб-перехватчика. Заполняется только при создании.

массив signing_secrets (SigningSecret) (необязательно)

Только вывод. Секретные данные для подписи, связанные с этим веб-хуком.

Поля

expire_time строка (необязательно)

Только для вывода. Срок действия секретного ключа подписи.

усеченная секретная строка (необязательно)

Только вывод. Сокращенная версия секретного ключа подписи.

перечисление состояний (строка) (необязательно)

Только вывод. Состояние веб-хука.

Возможные значения:

enabled
Веб-перехватчик включен.
disabled
Пользователь отключил веб-перехватчик.
disabled_due_to_failed_deliveries
Веб-хук отключен из-за неудачных доставок.

массив subscribed_events (перечисление (строка)) (необязательно)

Возможные значения:

batch.succeeded
Пакетная обработка успешно завершена.
batch.expired
Обработка партии не была завершена в течение 48 часов.
batch.failed
Пакетное задание не выполнено.
interaction.requires_action
Взаимодействие требует совершения действия (например, вызова функции).
interaction.completed
Взаимодействие успешно завершено.
interaction.failed
Взаимодействие не удалось.
video.generated
Создание видео завершено.

строка update_time (необязательно)

Только вывод. Отметка времени последнего обновления веб-перехватчика.

строка URI (необязательно)

Обязательно. URI, на который будут отправляться события веб-перехватчика.

Пример

Пример ответа

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

удалить https://generativelanguage.googleapis.com/v1beta/webhooks/{id}

Удаляет веб-перехватчик.

Путь / Параметры запроса
Ответ

Путь / Параметры запроса

строковый идентификатор (обязательно)

Обязательно. Идентификатор веб-хука для удаления. Формат: `{webhook_id}`

Ответ

В случае успеха ответ будет пустым.

Пример

Ресурсы

Вебхук

Ресурс веб-перехватчика.

Поля

create_time string (необязательно)

Только вывод. Отметка времени создания веб-перехватчика.

строка идентификатора (необязательно)

Только вывод. Идентификатор веб-перехватчика.

строковое имя (необязательно)

Необязательно. Имя веб-перехватчика, указанное пользователем.

new_signing_secret string (необязательно)

Только для вывода. Новый секретный ключ для веб-перехватчика. Заполняется только при создании.

массив signing_secrets (SigningSecret) (необязательно)

Только вывод. Секретные данные для подписи, связанные с этим веб-хуком.

Поля

expire_time строка (необязательно)

Только для вывода. Срок действия секретного ключа подписи.

усеченная секретная строка (необязательно)

Только вывод. Сокращенная версия секретного ключа подписи.

перечисление состояний (строка) (необязательно)

Только вывод. Состояние веб-хука.

Возможные значения:

enabled
Веб-перехватчик включен.
disabled
Пользователь отключил веб-перехватчик.
disabled_due_to_failed_deliveries
Веб-хук отключен из-за неудачных доставок.

массив subscribed_events (перечисление (строка)) (необязательно)

Возможные значения:

batch.succeeded
Пакетная обработка успешно завершена.
batch.expired
Обработка партии не была завершена в течение 48 часов.
batch.failed
Пакетное задание не выполнено.
interaction.requires_action
Взаимодействие требует совершения действия (например, вызова функции).
interaction.completed
Взаимодействие успешно завершено.
interaction.failed
Взаимодействие не удалось.
video.generated
Создание видео завершено.

строка update_time (необязательно)

Только вывод. Отметка времени последнего обновления веб-перехватчика.

строка URI (необязательно)

Обязательно. URI, на который будут отправляться события веб-перехватчика.