REST Resource: subscriptions

{
  "name": string,
  "uid": string,
  "targetResource": string,
  "eventTypes": [
    string
  ],
  "payloadOptions": {
    object (PayloadOptions)
  },
  "notificationEndpoint": {
    object (NotificationEndpoint)
  },
  "state": enum (State),
  "suspensionReason": enum (ErrorType),
  "authority": string,
  "createTime": string,
  "updateTime": string,
  "reconciling": boolean,
  "etag": string,

  // Union field expiration can be only one of the following:
  "expireTime": string,
  "ttl": string
  // End of list of possible types for union field expiration.
}

string

(Facoltativo) Immutabile. Identificatore. Nome della risorsa della sottoscrizione.

Formato: subscriptions/{subscription}

string

Solo output. Identificatore univoco assegnato dal sistema per l'abbonamento.

string

Obbligatorio. Immutabile. La risorsa Google Workspace che viene monitorata per gli eventi, formattata come nome completo della risorsa. Per scoprire di più sulle risorse di destinazione e sugli eventi che supportano, vedi Eventi di Google Workspace supportati.

Un utente può autorizzare l'app solo a creare un 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 ALREADY_EXISTS.

string

Obbligatorio. Immutabile. Elenco non ordinato. Input per la creazione di una sottoscrizione. In caso contrario, solo output. Uno o più tipi di eventi da ricevere sulla risorsa di destinazione. Formattato 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 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 400 Bad Request.

object (PayloadOptions)

(Facoltativo) Opzioni sui dati da includere nel payload evento. Funzionalità supportata solo per gli eventi di Google Chat.

object (NotificationEndpoint)

Obbligatorio. Immutabile. L'endpoint in cui la sottoscrizione distribuisce eventi, ad esempio un argomento Pub/Sub.

enum (State)

Solo output. Stato della sottoscrizione. Determina se la sottoscrizione può ricevere eventi e consegnarli all'endpoint di notifica.

enum (ErrorType)

Solo output. L'errore che ha sospeso l'abbonamento.

Per riattivare l'abbonamento, risolvi l'errore e chiama il metodo subscriptions.reactivate.

string

Solo output. L'utente che ha autorizzato la creazione dell'abbonamento.

Formato: users/{user}

Per gli utenti di Google Workspace, il valore {user} è il campo user.id dell'API Directory.

string (Timestamp format)

Solo output. L'ora in cui viene creata la sottoscrizione.

string (Timestamp format)

Solo output. L'ultimo aggiornamento dell'abbonamento.

boolean

Solo output. Se true, l'abbonamento è in fase di aggiornamento.

string

(Facoltativo) Questo checksum viene calcolato dal server in base al valore di altri campi e potrebbe essere inviato durante le richieste di aggiornamento per garantire che il client abbia un valore aggiornato prima di procedere.

string (Timestamp format)

Valore predefinito non vuoto. Il timestamp in UTC di scadenza dell'abbonamento. Viene sempre visualizzato nell'output, indipendentemente da quello utilizzato nell'input.

string (Duration format)

Solo input. La durata (TTL) o la durata dell'abbonamento. Se non specificato o impostato su 0, viene utilizzata la durata massima possibile.

{
  "includeResource": boolean,
  "fieldMask": string
}

boolean

(Facoltativo) Indica se il payload dell'evento include dati sulla risorsa che è stata modificata. Ad esempio, per un evento in cui è stato creato un messaggio di Google Chat, se il payload contiene dati sulla risorsa Message. Se il valore è false, il payload dell'evento include solo il nome della risorsa modificata.

string (FieldMask format)

(Facoltativo) Se includeResource è impostato su true, l'elenco dei campi da includere nel payload dell'evento. Separa i campi con una virgola. Ad esempio, per includere il mittente di un messaggio di Google Chat e creare l'ora, inserisci message.sender,message.createTime. Se omesso, il payload include tutti i campi per la risorsa.

Se specifichi un campo che non esiste per la risorsa, il sistema lo ignora.

{

  // Union field endpoint can be only one of the following:
  "pubsubTopic": string
  // End of list of possible types for union field endpoint.
}

string

Immutabile. L'argomento Cloud Pub/Sub che riceve gli eventi per la sottoscrizione.

Formato: projects/{project}/topics/{topic}

Devi creare l'argomento nello stesso progetto Google Cloud in cui crei questa sottoscrizione.

Quando l'argomento riceve eventi, questi vengono codificati come messaggi Cloud Pub/Sub. Per maggiori dettagli, consulta Associazione di protocolli Google Cloud Pub/Sub per CloudEvents.