Risorsa: sottoscrizione
Un abbonamento per ricevere eventi relativi a una risorsa di Google Workspace. Per scoprire di più sugli abbonamenti, consulta la panoramica dell'API Google Workspace Eventi.
Rappresentazione JSON |
---|
{ "name": string, "uid": string, "targetResource": string, "eventTypes": [ string ], "payloadOptions": { object ( |
Campi | |
---|---|
name |
Campo facoltativo. Immutabile. Identificatore. Nome risorsa della sottoscrizione. Formato: |
uid |
Solo output. Identificatore univoco assegnato dal sistema per l'abbonamento. |
targetResource |
obbligatorio. Immutabile. La risorsa Google Workspace monitorata per gli eventi, formattata come nome completo della risorsa. Per saperne di più sulle risorse di destinazione e sugli eventi supportati, vedi Eventi di Google Workspace supportati. Un utente può autorizzare la tua app a creare un solo abbonamento per una determinata risorsa di destinazione. Se la tua app tenta di creare un altro abbonamento con le stesse credenziali utente, la richiesta restituisce un errore |
eventTypes[] |
obbligatorio. Immutabile. Elenco non ordinato. Input per la creazione di un abbonamento. In caso contrario, solo output. Uno o più tipi di eventi da ricevere relativi alla risorsa di destinazione. Formattati in base alla specifica CloudEvents. I tipi di eventi supportati dipendono dalla risorsa di destinazione della sottoscrizione. Per maggiori dettagli, vedi Eventi Google Workspace supportati. Per impostazione predefinita, ricevi anche eventi relativi al ciclo di vita dell'abbonamento. Non è necessario specificare gli eventi del ciclo di vita per questo campo. Se specifichi un tipo di evento che non esiste per la risorsa di destinazione, la richiesta restituisce un codice di stato HTTP |
payloadOptions |
Campo facoltativo. Opzioni su quali dati includere nel payload degli eventi. Funzionalità supportata solo per gli eventi di Google Chat. |
notificationEndpoint |
obbligatorio. Immutabile. L'endpoint in cui la sottoscrizione fornisce eventi, ad esempio un argomento Pub/Sub. |
state |
Solo output. Lo stato dell'abbonamento. Determina se l'abbonamento può ricevere eventi e li consegna all'endpoint di notifica. |
suspensionReason |
Solo output. L'errore che ha sospeso l'abbonamento. Per riattivare l'abbonamento, risolvi l'errore e chiama il metodo |
authority |
Solo output. L'utente che ha autorizzato la creazione dell'abbonamento. Formato: Per gli utenti di Google Workspace, il valore |
createTime |
Solo output. La data e l'ora di creazione dell'abbonamento. |
updateTime |
Solo output. L'ultimo aggiornamento dell'abbonamento. |
reconciling |
Solo output. Se |
etag |
Campo facoltativo. Questo checksum viene calcolato dal server in base al valore di altri campi e potrebbe essere inviato in caso di richieste di aggiornamento per garantire che il client abbia un valore aggiornato prima di procedere. |
Campo di unione La scadenza massima dipende dal fatto che l'abbonamento includa i dati delle risorse nei payload di eventi (specificati nel campo
Alla scadenza, l'abbonamento viene eliminato automaticamente. Ricevi eventi del ciclo di vita per Per evitare che un abbonamento scada, puoi utilizzare il metodo |
|
expireTime |
Valore predefinito non vuoto. Il timestamp in UTC della scadenza dell'abbonamento. Viene sempre visualizzato nell'output, indipendentemente da ciò che è stato utilizzato nell'input. |
ttl |
Solo input. La durata (TTL) o la durata dell'abbonamento. Se il criterio non viene specificato o viene impostato su |
PayloadOptions
Opzioni su quali dati includere nel payload degli eventi. Funzionalità supportata solo per gli eventi di Google Chat.
Rappresentazione JSON |
---|
{ "includeResource": boolean, "fieldMask": string } |
Campi | |
---|---|
includeResource |
Campo facoltativo. Indica se il payload dell'evento include dati sulla risorsa modificata. Ad esempio, nel caso di un evento in cui è stato creato un messaggio di Google Chat, se il payload contiene dati relativi alla risorsa |
fieldMask |
Campo facoltativo. Se il criterio Se specifichi un campo che non esiste per la risorsa, il sistema lo ignora. |
NotificationEndpoint
L'endpoint in cui la sottoscrizione pubblica gli eventi.
Rappresentazione JSON |
---|
{ // Union field |
Campi | |
---|---|
Campo di unione
|
|
pubsubTopic |
Immutabile. L'argomento Cloud Pub/Sub che riceve eventi per la sottoscrizione. Formato: Devi creare l'argomento nello stesso progetto Google Cloud in cui crei la sottoscrizione. Quando l'argomento riceve eventi, questi vengono codificati come messaggi Cloud Pub/Sub. Per i dettagli, consulta l'articolo sull'associazione del protocollo Google Cloud Pub/Sub per CloudEvents. |
Stato
Possibili stati dell'abbonamento.
Enum | |
---|---|
STATE_UNSPECIFIED |
Valore predefinito. Questo valore non è utilizzato. |
ACTIVE |
L'abbonamento è attivo e può ricevere e inviare eventi al relativo endpoint di notifica. |
SUSPENDED |
L'abbonamento non può ricevere eventi a causa di un errore. Per identificare l'errore, consulta il campo . |
DELETED |
L'abbonamento è stato eliminato. |
ErrorType
Possibili errori relativi a un abbonamento.
Enum | |
---|---|
ERROR_TYPE_UNSPECIFIED |
Valore predefinito. Questo valore non è utilizzato. |
USER_SCOPE_REVOKED |
L'utente che ha concesso l'autorizzazione ha revocato la concessione di uno o più ambiti OAuth. Per saperne di più sull'autorizzazione per Google Workspace, vedi Configurare la schermata per il consenso OAuth. |
RESOURCE_DELETED |
La risorsa di destinazione per la sottoscrizione non esiste più. |
USER_AUTHORIZATION_FAILURE |
L'utente che ha autorizzato la creazione dell'abbonamento non ha più accesso alla risorsa di destinazione dell'abbonamento. |
ENDPOINT_PERMISSION_DENIED |
L'applicazione Google Workspace non dispone dell'accesso per la consegna di eventi all'endpoint di notifica del tuo abbonamento. |
ENDPOINT_NOT_FOUND |
L'endpoint di notifica dell'abbonamento non esiste oppure non è possibile trovare l'endpoint nel progetto Google Cloud in cui hai creato l'abbonamento. |
ENDPOINT_RESOURCE_EXHAUSTED |
L'endpoint di notifica dell'abbonamento non è riuscito a ricevere eventi a causa di una quota insufficiente o del raggiungimento della limitazione di frequenza. |
OTHER |
Si è verificato un errore non identificato. |
Metodi |
|
---|---|
|
Crea un abbonamento a Google Workspace. |
|
Elimina un abbonamento a Google Workspace. |
|
Recupera i dettagli di un abbonamento a Google Workspace. |
|
Elenca gli abbonamenti a Google Workspace. |
|
Consente di aggiornare o rinnovare un abbonamento a Google Workspace. |
|
Riattiva un abbonamento a Google Workspace sospeso. |