Gemini Webhooks API

תגובות לפעולה מאתר אחר (webhook) מאפשרות ל-Gemini API לשלוח לשרת שלכם התראות בזמן אמת כשפעולות אסינכרוניות או פעולות ארוכות טווח (LRO) מסתיימות. כך לא צריך לשלוח בקשות API כדי לקבל עדכוני סטטוס, וזמן האחזור והתקורה קצרים יותר.

פתיחת הדף כ-Markdown פתיחת המפרט של OpenAPI

CreateWebhook

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

יצירת webhook חדש.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

name string  (אופציונלי)

אופציונלי. השם שהמשתמש נתן ל-webhook.

subscribed_events array (enum (string))  (required)

חובה. האירועים שה-webhook רשום אליהם. אירועים זמינים: - 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 string  (required)

חובה. כתובת ה-URI שאליה יישלחו אירועי ה-Webhook.

תשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

create_time string  (optional)

פלט בלבד. חותמת הזמן שבה נוצר ה-webhook.

id string  (אופציונלי)

פלט בלבד. המזהה של ה-webhook.

name string  (אופציונלי)

אופציונלי. השם שהמשתמש נתן ל-webhook.

new_signing_secret string  (optional)

פלט בלבד. הסוד החדש לחתימה על ה-webhook. השדה הזה מאוכלס רק בזמן היצירה.

signing_secrets array (SigningSecret)  (optional)

פלט בלבד. הסודות של החתימה שמשויכים ל-webhook הזה.

מייצג סוד חתימה שמשמש לאימות של מטען ייעודי (payload) של webhook.

שדות

‫expire_time string  (optional)

פלט בלבד. תאריך התפוגה של סוד החתימה.

truncated_secret string  (optional)

פלט בלבד. הגרסה הקטומה של הסוד לחתימה.

state enum (string)  (optional)

פלט בלבד. המצב של ה-webhook.

ערכים אפשריים:

  • enabled

    ה-webhook מופעל.

  • disabled

    המשתמש השבית את ה-webhook.

  • disabled_due_to_failed_deliveries

    ה-webhook מושבת בגלל מסירות שנכשלו.

subscribed_events array (enum (string))  (optional)

חובה. האירועים שה-webhook רשום אליהם. אירועים זמינים: - 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

    יצירת הסרטון הושלמה.

‫update_time ‫string ‫ (optional)

פלט בלבד. חותמת הזמן שבה ה-webhook עודכן לאחרונה.

‫uri מחרוזת  (אופציונלי)

חובה. כתובת ה-URI שאליה יישלחו אירועי ה-Webhook.

דוגמה

דוגמה לתשובה

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

שולח אירוע פינג ל-Webhook.

פרמטרים של נתיב או שאילתה

id string  (חובה)

חובה. המזהה של ה-webhook שצריך לשלוח לו פינג. פורמט: `{webhook_id}`

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

תשובה

אם הפעולה בוצעה ללא שגיאות, התגובה תהיה ריקה.

דוגמה

RotateSigningSecret

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

יוצר סוד חתימה חדש ל-Webhook.

פרמטרים של נתיב או שאילתה

id string  (חובה)

חובה. המזהה של ה-webhook שעבורו רוצים ליצור סוד לחתימה. פורמט: `{webhook_id}`

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

revocation_behavior enum (string)  (optional)

אופציונלי. התנהגות הביטול של סודות חתימה קודמים.

ערכים אפשריים:

  • revoke_previous_secrets_after_h24

    ליצור סוד חתימה חדש ולבטל את כל הסודות הקודמים אחרי 24 שעות. אפשרות ברירת המחדל והאפשרות הבטוחה ביותר להעברות.

  • revoke_previous_secrets_immediately

    ביטול מיידי של כל הסודות הקודמים. צריך להיזהר כי הפעולה הזו עלולה לשבש התראות פעילות.

תשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

‫secret string  (אופציונלי)

פלט בלבד. הסוד החדש שנוצר לחתימה.

דוגמה

דוגמה לתשובה

{
  "secret": "string"
}

ListWebhooks

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

מציגה רשימה של כל ה-Webhooks.

פרמטרים של נתיב או שאילתה

page_size integer  (optional)

אופציונלי. המספר המקסימלי של ווּבּהוּקים שיוחזרו. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא מציינים ערך, יוחזרו לכל היותר 50 ווּבּהוקים. הערך המקסימלי הוא 1,000.

page_token string  (optional)

אופציונלי. טוקן של דף שהתקבל מקריאה קודמת של ListWebhooks. צריך להזין את הטוקן כדי לאחזר את הדף הבא.

תשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

‫next_page_token string  (optional)

טוקן שאפשר לשלוח כ-`page_token` כדי לאחזר את הדף הבא. אם משמיטים את השדה הזה, לא יופיעו דפים נוספים.

webhooks מערך (Webhook)  (אופציונלי)

ה-webhooks.

דוגמה

דוגמה לתשובה

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

מקבלים Webhook ספציפי.

פרמטרים של נתיב או שאילתה

id string  (חובה)

חובה. המזהה של ה-webhook שרוצים לאחזר.

תשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

create_time string  (optional)

פלט בלבד. חותמת הזמן שבה נוצר ה-webhook.

id string  (אופציונלי)

פלט בלבד. המזהה של ה-webhook.

name string  (אופציונלי)

אופציונלי. השם שהמשתמש נתן ל-webhook.

new_signing_secret string  (optional)

פלט בלבד. הסוד החדש לחתימה על ה-webhook. השדה הזה מאוכלס רק בזמן היצירה.

signing_secrets array (SigningSecret)  (optional)

פלט בלבד. הסודות של החתימה שמשויכים ל-webhook הזה.

מייצג סוד חתימה שמשמש לאימות של מטען ייעודי (payload) של webhook.

שדות

‫expire_time string  (optional)

פלט בלבד. תאריך התפוגה של סוד החתימה.

truncated_secret string  (optional)

פלט בלבד. הגרסה הקטומה של הסוד לחתימה.

state enum (string)  (optional)

פלט בלבד. המצב של ה-webhook.

ערכים אפשריים:

  • enabled

    ה-webhook מופעל.

  • disabled

    המשתמש השבית את ה-webhook.

  • disabled_due_to_failed_deliveries

    ה-webhook מושבת בגלל מסירות שנכשלו.

subscribed_events array (enum (string))  (optional)

חובה. האירועים שה-webhook רשום אליהם. אירועים זמינים: - 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

    יצירת הסרטון הושלמה.

‫update_time ‫string ‫ (optional)

פלט בלבד. חותמת הזמן שבה ה-webhook עודכן לאחרונה.

‫uri מחרוזת  (אופציונלי)

חובה. כתובת ה-URI שאליה יישלחו אירועי ה-Webhook.

דוגמה

דוגמה לתשובה

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

עדכון של Webhook קיים.

פרמטרים של נתיב או שאילתה

id string  (חובה)

חובה. המזהה של ה-webhook שרוצים לעדכן.

update_mask string  (optional)

אופציונלי. רשימת השדות לעדכון.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

name string  (אופציונלי)

אופציונלי. השם שהמשתמש נתן ל-webhook.

state enum (string)  (optional)

אופציונלי. המצב של ה-webhook.

ערכים אפשריים:

  • enabled

    ה-webhook מופעל.

  • disabled

    המשתמש השבית את ה-webhook.

  • disabled_due_to_failed_deliveries

    ה-webhook מושבת בגלל מסירות שנכשלו.

subscribed_events array (enum (string))  (optional)

אופציונלי. האירועים שה-webhook רשום אליהם. אירועים זמינים: - 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 שאליה יישלחו אירועי ה-Webhook.

תשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

create_time string  (optional)

פלט בלבד. חותמת הזמן שבה נוצר ה-webhook.

id string  (אופציונלי)

פלט בלבד. המזהה של ה-webhook.

name string  (אופציונלי)

אופציונלי. השם שהמשתמש נתן ל-webhook.

new_signing_secret string  (optional)

פלט בלבד. הסוד החדש לחתימה על ה-webhook. השדה הזה מאוכלס רק בזמן היצירה.

signing_secrets array (SigningSecret)  (optional)

פלט בלבד. הסודות של החתימה שמשויכים ל-webhook הזה.

מייצג סוד חתימה שמשמש לאימות של מטען ייעודי (payload) של webhook.

שדות

‫expire_time string  (optional)

פלט בלבד. תאריך התפוגה של סוד החתימה.

truncated_secret string  (optional)

פלט בלבד. הגרסה הקטומה של הסוד לחתימה.

state enum (string)  (optional)

פלט בלבד. המצב של ה-webhook.

ערכים אפשריים:

  • enabled

    ה-webhook מופעל.

  • disabled

    המשתמש השבית את ה-webhook.

  • disabled_due_to_failed_deliveries

    ה-webhook מושבת בגלל מסירות שנכשלו.

subscribed_events array (enum (string))  (optional)

חובה. האירועים שה-webhook רשום אליהם. אירועים זמינים: - 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

    יצירת הסרטון הושלמה.

‫update_time ‫string ‫ (optional)

פלט בלבד. חותמת הזמן שבה ה-webhook עודכן לאחרונה.

‫uri מחרוזת  (אופציונלי)

חובה. כתובת ה-URI שאליה יישלחו אירועי ה-Webhook.

דוגמה

דוגמה לתשובה

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

פרמטרים של נתיב או שאילתה

id string  (חובה)

חובה. המזהה של ה-webhook שרוצים למחוק. פורמט: `{webhook_id}`

תשובה

אם הפעולה בוצעה ללא שגיאות, התגובה תהיה ריקה.

דוגמה

משאבים

Webhook

משאב webhook.

שדות

create_time string  (optional)

פלט בלבד. חותמת הזמן שבה נוצר ה-webhook.

id string  (אופציונלי)

פלט בלבד. המזהה של ה-webhook.

name string  (אופציונלי)

אופציונלי. השם שהמשתמש נתן ל-webhook.

new_signing_secret string  (optional)

פלט בלבד. הסוד החדש לחתימה על ה-webhook. השדה הזה מאוכלס רק בזמן היצירה.

signing_secrets array (SigningSecret)  (optional)

פלט בלבד. הסודות של החתימה שמשויכים ל-webhook הזה.

מייצג סוד חתימה שמשמש לאימות של מטען ייעודי (payload) של webhook.

שדות

‫expire_time string  (optional)

פלט בלבד. תאריך התפוגה של סוד החתימה.

truncated_secret string  (optional)

פלט בלבד. הגרסה הקטומה של הסוד לחתימה.

state enum (string)  (optional)

פלט בלבד. המצב של ה-webhook.

ערכים אפשריים:

  • enabled

    ה-webhook מופעל.

  • disabled

    המשתמש השבית את ה-webhook.

  • disabled_due_to_failed_deliveries

    ה-webhook מושבת בגלל מסירות שנכשלו.

subscribed_events array (enum (string))  (optional)

חובה. האירועים שה-webhook רשום אליהם. אירועים זמינים: - 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

    יצירת הסרטון הושלמה.

‫update_time ‫string ‫ (optional)

פלט בלבד. חותמת הזמן שבה ה-webhook עודכן לאחרונה.

‫uri מחרוזת  (אופציונלי)

חובה. כתובת ה-URI שאליה יישלחו אירועי ה-Webhook.