Gemini 3.7 Flash është tani në dispozicion. Provojeni .

Kjo faqe është përkthyer nga Cloud Translation API.

Gemini Webhooks API

Webhook-et i lejojnë API-t Gemini të dërgojë njoftime në kohë reale në serverin tuaj kur përfundojnë Operacionet asinkrone ose Operacionet me Ekzekutim të Gjatë (LRO). Kjo zëvendëson nevojën për të pyetur API-n për përditësimet e statusit, duke zvogëluar vonesën dhe mbingarkesën.

Shiko si ulje Shikoni Specifikimin OpenAPI

Krijo Webhook

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

Krijon një Webhook të ri.

Trupi i kërkesës
Përgjigje

Trupi i kërkesës

Trupi i kërkesës përmban të dhëna me strukturën e mëposhtme:

varg emri (opsional)

Opsionale. Emri i dhënë nga përdoruesi i webhook-ut.

vargu i ngjarjeve_të_subscribed (enum (string)) (i detyrueshëm)

E detyrueshme. Ngjarjet në të cilat është abonuar webhook-u. Ngjarjet e disponueshme: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Vlerat e mundshme:

batch.succeeded
Përpunimi i serisë përfundoi me sukses.
batch.expired
Grupi nuk është përpunuar brenda afatit kohor 48-orësh.
batch.failed
Puna në grup dështoi.
interaction.requires_action
Ndërveprimi kërkon veprim (p.sh., thirrje funksioni).
interaction.completed
Ndërveprimi përfundoi me sukses.
interaction.failed
Ndërveprimi dështoi.
video.generated
Gjenerimi i videos përfundoi.

vargu uri (i detyrueshëm)

E detyrueshme. URI-ja ku do të dërgohen ngjarjet e webhook-ut.

Përgjigje

Nëse është i suksesshëm, trupi i përgjigjes përmban të dhëna me strukturën e mëposhtme:

vargu create_time (opsional)

Vetëm rezultati. Vula kohore kur u krijua webhook-u.

vargu i identifikimit (opsional)

Vetëm rezultate. ID-ja e webhook-ut.

varg emri (opsional)

Opsionale. Emri i dhënë nga përdoruesi i webhook-ut.

vargu new_signing_secret (opsional)

Vetëm rezultate. Sekreti i ri i nënshkrimit për webhook-un. Plotësohet vetëm në create.

vargu signing_secrets (SigningSecret) (opsional)

Vetëm rezultate. Sekretet e nënshkrimit të lidhura me këtë webhook.

Fushat

vargu expire_time (opsional)

Vetëm rezultate. Data e skadimit të sekretit të nënshkrimit.

vargu i cruncated_secret (opsional)

Vetëm rezultati. Versioni i shkurtuar i sekretit të nënshkrimit.

enum i gjendjes (string) (opsionale)

Vetëm rezultati. Gjendja e webhook-ut.

Vlerat e mundshme:

enabled
Webhook është aktivizuar.
disabled
Webhook është çaktivizuar nga përdoruesi.
disabled_due_to_failed_deliveries
Webhook është çaktivizuar për shkak të dërgesave të dështuara.

vargu subscribed_events (enum (string)) (opsionale)

Vlerat e mundshme:

batch.succeeded
Përpunimi i serisë përfundoi me sukses.
batch.expired
Grupi nuk është përpunuar brenda afatit kohor 48-orësh.
batch.failed
Puna në grup dështoi.
interaction.requires_action
Ndërveprimi kërkon veprim (p.sh., thirrje funksioni).
interaction.completed
Ndërveprimi përfundoi me sukses.
interaction.failed
Ndërveprimi dështoi.
video.generated
Gjenerimi i videos përfundoi.

vargu i kohës_përditësimit (opsional)

Vetëm rezultati. Vula kohore kur u përditësua webhook-u për herë të fundit.

vargu uri (opsional)

E detyrueshme. URI-ja ku do të dërgohen ngjarjet e webhook-ut.

Shembull

Shembull Përgjigjeje

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

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

Dërgon një ngjarje ping në një Webhook.

Parametrat e shtegut / pyetjes
Trupi i kërkesës
Përgjigje

Parametrat e Shtegut / Pyetjes

vargu i identifikimit (i detyrueshëm)

E detyrueshme. ID-ja e webhook-ut që do të pingohet. Formati: `{webhook_id}`

Trupi i kërkesës

Trupi i kërkesës përmban të dhëna me strukturën e mëposhtme:

Përgjigje

Nëse ka sukses, përgjigja është bosh.

Shembull

RotateSigningSecret

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

Gjeneron një sekret të ri nënshkrimi për një Webhook.

Parametrat e shtegut / pyetjes
Trupi i kërkesës
Përgjigje

Parametrat e Shtegut / Pyetjes

vargu i identifikimit (i detyrueshëm)

E detyrueshme. ID-ja e webhook-ut për të cilin do të gjenerohet një sekret nënshkrimi. Formati: `{webhook_id}`

Trupi i kërkesës

Trupi i kërkesës përmban të dhëna me strukturën e mëposhtme:

enum i sjelljes_revokimit (string) (opsionale)

Opsionale. Sjellja e revokimit për sekretet e nënshkrimit të mëparshëm.

Vlerat e mundshme:

revoke_previous_secrets_after_h24
Gjeneroni një sekret të ri nënshkrimi dhe anuloni të gjitha sekretet e mëparshme pas 24 orësh. Opsioni parazgjedhur dhe më i sigurt për migrimet.
revoke_previous_secrets_immediately
Anulo menjëherë të gjitha sekretet e mëparshme. Përdore me kujdes pasi kjo mund të ndërpresë njoftimet në vazhdim.

Përgjigje

Nëse është i suksesshëm, trupi i përgjigjes përmban të dhëna me strukturën e mëposhtme:

varg sekret (opsional)

Vetëm rezultate. Sekreti i nënshkrimit i gjeneruar rishtazi.

Shembull

Shembull Përgjigjeje

{
  "secret": "string"
}

ListWebhooks

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

Liston të gjitha Webhook-et.

Parametrat e shtegut / pyetjes
Përgjigje

Parametrat e Shtegut / Pyetjes

numër i plotë i madhësisë së faqes (opsional)

Opsionale. Numri maksimal i webhook-eve që duhen kthyer. Shërbimi mund të kthejë më pak se kjo vlerë. Nëse nuk specifikohet, do të kthehen maksimumi 50 webhook-e. Vlera maksimale është 1000.

vargu i shenjës së faqes (opsional)

Opsionale. Një shenjë faqeje, e marrë nga një thirrje e mëparshme `ListWebhooks`. Jepni këtë për të marrë faqen pasuese.

Përgjigje

Nëse është i suksesshëm, trupi i përgjigjes përmban të dhëna me strukturën e mëposhtme:

vargu i shenjës së faqes_next_page (opsional)

Një shenjë, e cila mund të dërgohet si `page_token` për të marrë faqen tjetër. Nëse kjo fushë lihet jashtë, nuk ka faqe pasuese.

vargu webhooks ( Webhook ) (opsional)

Webhook-et.

Shembull

Shembull Përgjigjeje

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

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

Merr një Webhook specifik.

Parametrat e shtegut / pyetjes
Përgjigje

Parametrat e Shtegut / Pyetjes

vargu i identifikimit (i detyrueshëm)

E detyrueshme. ID-ja e webhook-ut që do të rikuperohet.

Përgjigje

Nëse është i suksesshëm, trupi i përgjigjes përmban të dhëna me strukturën e mëposhtme:

vargu create_time (opsional)

Vetëm rezultati. Vula kohore kur u krijua webhook-u.

vargu i identifikimit (opsional)

Vetëm rezultate. ID-ja e webhook-ut.

varg emri (opsional)

Opsionale. Emri i dhënë nga përdoruesi i webhook-ut.

vargu new_signing_secret (opsional)

Vetëm rezultate. Sekreti i ri i nënshkrimit për webhook-un. Plotësohet vetëm në create.

vargu signing_secrets (SigningSecret) (opsional)

Vetëm rezultate. Sekretet e nënshkrimit të lidhura me këtë webhook.

Fushat

vargu expire_time (opsional)

Vetëm rezultate. Data e skadimit të sekretit të nënshkrimit.

vargu i cruncated_secret (opsional)

Vetëm rezultati. Versioni i shkurtuar i sekretit të nënshkrimit.

enum i gjendjes (string) (opsionale)

Vetëm rezultati. Gjendja e webhook-ut.

Vlerat e mundshme:

enabled
Webhook është aktivizuar.
disabled
Webhook është çaktivizuar nga përdoruesi.
disabled_due_to_failed_deliveries
Webhook është çaktivizuar për shkak të dërgesave të dështuara.

vargu subscribed_events (enum (string)) (opsionale)

Vlerat e mundshme:

batch.succeeded
Përpunimi i serisë përfundoi me sukses.
batch.expired
Grupi nuk është përpunuar brenda afatit kohor 48-orësh.
batch.failed
Puna në grup dështoi.
interaction.requires_action
Ndërveprimi kërkon veprim (p.sh., thirrje funksioni).
interaction.completed
Ndërveprimi përfundoi me sukses.
interaction.failed
Ndërveprimi dështoi.
video.generated
Gjenerimi i videos përfundoi.

vargu i kohës_përditësimit (opsional)

Vetëm rezultati. Vula kohore kur u përditësua webhook-u për herë të fundit.

vargu uri (opsional)

E detyrueshme. URI-ja ku do të dërgohen ngjarjet e webhook-ut.

Shembull

Shembull Përgjigjeje

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

Përditëso Webhook-un

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

Përditëson një Webhook ekzistues.

Parametrat e shtegut / pyetjes
Trupi i kërkesës
Përgjigje

Parametrat e Shtegut / Pyetjes

vargu i identifikimit (i detyrueshëm)

E detyrueshme. ID-ja e webhook-ut që do të përditësohet.

vargu i maskës_përditësim (opsional)

Opsionale. Lista e fushave që do të përditësohen.

Trupi i kërkesës

Trupi i kërkesës përmban të dhëna me strukturën e mëposhtme:

varg emri (opsional)

Opsionale. Emri i dhënë nga përdoruesi i webhook-ut.

enum i gjendjes (string) (opsionale)

Opsionale. Gjendja e webhook-ut.

Vlerat e mundshme:

enabled
Webhook është aktivizuar.
disabled
Webhook është çaktivizuar nga përdoruesi.
disabled_due_to_failed_deliveries
Webhook është çaktivizuar për shkak të dërgesave të dështuara.

vargu subscribed_events (enum (string)) (opsionale)

Opsionale. Ngjarjet në të cilat është abonuar webhook-u. Ngjarjet e disponueshme: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Vlerat e mundshme:

batch.succeeded
Përpunimi i serisë përfundoi me sukses.
batch.expired
Grupi nuk është përpunuar brenda afatit kohor 48-orësh.
batch.failed
Puna në grup dështoi.
interaction.requires_action
Ndërveprimi kërkon veprim (p.sh., thirrje funksioni).
interaction.completed
Ndërveprimi përfundoi me sukses.
interaction.failed
Ndërveprimi dështoi.
video.generated
Gjenerimi i videos përfundoi.

vargu uri (opsional)

Opsionale. URI-ja ku do të dërgohen ngjarjet e webhook-ut.

Përgjigje

Nëse është i suksesshëm, trupi i përgjigjes përmban të dhëna me strukturën e mëposhtme:

vargu create_time (opsional)

Vetëm rezultati. Vula kohore kur u krijua webhook-u.

vargu i identifikimit (opsional)

Vetëm rezultate. ID-ja e webhook-ut.

varg emri (opsional)

Opsionale. Emri i dhënë nga përdoruesi i webhook-ut.

vargu new_signing_secret (opsional)

Vetëm rezultate. Sekreti i ri i nënshkrimit për webhook-un. Plotësohet vetëm në create.

vargu signing_secrets (SigningSecret) (opsional)

Vetëm rezultate. Sekretet e nënshkrimit të lidhura me këtë webhook.

Fushat

vargu expire_time (opsional)

Vetëm rezultate. Data e skadimit të sekretit të nënshkrimit.

vargu i cruncated_secret (opsional)

Vetëm rezultati. Versioni i shkurtuar i sekretit të nënshkrimit.

enum i gjendjes (string) (opsionale)

Vetëm rezultati. Gjendja e webhook-ut.

Vlerat e mundshme:

enabled
Webhook është aktivizuar.
disabled
Webhook është çaktivizuar nga përdoruesi.
disabled_due_to_failed_deliveries
Webhook është çaktivizuar për shkak të dërgesave të dështuara.

vargu subscribed_events (enum (string)) (opsionale)

Vlerat e mundshme:

batch.succeeded
Përpunimi i serisë përfundoi me sukses.
batch.expired
Grupi nuk është përpunuar brenda afatit kohor 48-orësh.
batch.failed
Puna në grup dështoi.
interaction.requires_action
Ndërveprimi kërkon veprim (p.sh., thirrje funksioni).
interaction.completed
Ndërveprimi përfundoi me sukses.
interaction.failed
Ndërveprimi dështoi.
video.generated
Gjenerimi i videos përfundoi.

vargu i kohës_përditësimit (opsional)

Vetëm rezultati. Vula kohore kur u përditësua webhook-u për herë të fundit.

vargu uri (opsional)

E detyrueshme. URI-ja ku do të dërgohen ngjarjet e webhook-ut.

Shembull

Shembull Përgjigjeje

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

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

Fshin një Webhook.

Parametrat e shtegut / pyetjes
Përgjigje

Parametrat e Shtegut / Pyetjes

vargu i identifikimit (i detyrueshëm)

E detyrueshme. ID-ja e webhook-ut që do të fshihet. Formati: `{webhook_id}`

Përgjigje

Nëse ka sukses, përgjigja është bosh.

Shembull

Burimet

Webhook

Një burim Webhook.

Fushat

vargu create_time (opsional)

Vetëm rezultati. Vula kohore kur u krijua webhook-u.

vargu i identifikimit (opsional)

Vetëm rezultate. ID-ja e webhook-ut.

varg emri (opsional)

Opsionale. Emri i dhënë nga përdoruesi i webhook-ut.

vargu new_signing_secret (opsional)

Vetëm rezultate. Sekreti i ri i nënshkrimit për webhook-un. Plotësohet vetëm në create.

vargu signing_secrets (SigningSecret) (opsional)

Vetëm rezultate. Sekretet e nënshkrimit të lidhura me këtë webhook.

Fushat

vargu expire_time (opsional)

Vetëm rezultate. Data e skadimit të sekretit të nënshkrimit.

vargu i cruncated_secret (opsional)

Vetëm rezultati. Versioni i shkurtuar i sekretit të nënshkrimit.

enum i gjendjes (string) (opsionale)

Vetëm rezultati. Gjendja e webhook-ut.

Vlerat e mundshme:

enabled
Webhook është aktivizuar.
disabled
Webhook është çaktivizuar nga përdoruesi.
disabled_due_to_failed_deliveries
Webhook është çaktivizuar për shkak të dërgesave të dështuara.

vargu subscribed_events (enum (string)) (opsionale)

Vlerat e mundshme:

batch.succeeded
Përpunimi i serisë përfundoi me sukses.
batch.expired
Grupi nuk është përpunuar brenda afatit kohor 48-orësh.
batch.failed
Puna në grup dështoi.
interaction.requires_action
Ndërveprimi kërkon veprim (p.sh., thirrje funksioni).
interaction.completed
Ndërveprimi përfundoi me sukses.
interaction.failed
Ndërveprimi dështoi.
video.generated
Gjenerimi i videos përfundoi.

vargu i kohës_përditësimit (opsional)

Vetëm rezultati. Vula kohore kur u përditësua webhook-u për herë të fundit.

vargu uri (opsional)

E detyrueshme. URI-ja ku do të dërgohen ngjarjet e webhook-ut.