Recurso: Subscription
Uma assinatura para receber eventos sobre um recurso do Google Workspace. Para saber mais sobre as assinaturas, consulte a Visão geral da API Google Workspace Events.
Representação JSON |
---|
{ "name": string, "uid": string, "targetResource": string, "eventTypes": [ string ], "payloadOptions": { object ( |
Campos | |
---|---|
name |
Identificador. Nome do recurso da assinatura. Formato: |
uid |
Apenas saída. Identificador exclusivo atribuído pelo sistema para a assinatura. |
targetResource |
Obrigatório. Imutável. O recurso do Google Workspace monitorado para eventos, formatado como o nome completo do recurso. Para saber mais sobre os recursos de destino e os eventos compatíveis, consulte Eventos do Google Workspace compatíveis. Um usuário só pode autorizar seu app a criar uma assinatura para um determinado recurso de destino. Se o app tentar criar outra assinatura com as mesmas credenciais do usuário, a solicitação vai retornar um erro |
eventTypes[] |
Obrigatório. Lista não ordenada. Entrada para criar uma assinatura. Caso contrário, apenas saída. Um ou mais tipos de eventos para receber sobre o recurso de destino. Formatado de acordo com a especificação do CloudEvents. Os tipos de evento compatíveis dependem do recurso de destino da sua assinatura. Confira mais detalhes em Eventos do Google Workspace com suporte. Por padrão, você também recebe eventos sobre o ciclo de vida da assinatura. Não é necessário especificar eventos do ciclo de vida para esse campo. Se você especificar um tipo de evento que não existe para o recurso de destino, a solicitação vai retornar um código de status HTTP |
payloadOptions |
Opcional. Opções sobre quais dados incluir no payload do evento. Somente para eventos do Google Chat. |
notificationEndpoint |
Obrigatório. Imutável. O endpoint em que a assinatura entrega eventos, como um tópico do Pub/Sub. |
state |
Apenas saída. O estado da assinatura. Determina se a assinatura pode receber eventos e enviá-los ao endpoint de notificação. |
suspensionReason |
Apenas saída. O erro que suspendeu a assinatura. Para reativar a assinatura, resolva o erro e chame o método |
authority |
Apenas saída. O usuário que autorizou a criação da assinatura. Formato: Para usuários do Google Workspace, o valor |
createTime |
Apenas saída. O horário em que a assinatura foi criada. |
updateTime |
Apenas saída. A última vez que a assinatura foi atualizada. |
reconciling |
Apenas saída. Se |
etag |
Opcional. Essa checksum é calculada pelo servidor com base no valor de outros campos e pode ser enviada em solicitações de atualização para garantir que o cliente tenha um valor atualizado antes de continuar. |
Campo de união O tempo máximo de expiração depende se a assinatura inclui dados de recursos nos payloads de eventos (especificados no campo
Depois que uma assinatura expira, ela é excluída automaticamente. Você vai receber eventos de ciclo de vida para o Para evitar que uma assinatura expire, use o método |
|
expireTime |
Padrão não vazio. O carimbo de data/hora em UTC quando a assinatura expira. Sempre exibido na saída, independentemente do que foi usado na entrada. |
ttl |
Somente entrada. O time to live (TTL) ou a duração da assinatura. Se não for especificado ou definido como |
PayloadOptions
Opções sobre quais dados incluir no payload do evento. Somente para eventos do Google Chat.
Representação JSON |
---|
{ "includeResource": boolean, "fieldMask": string } |
Campos | |
---|---|
includeResource |
Opcional. Informa se o payload do evento inclui dados sobre o recurso que foi alterado. Por exemplo, em um evento em que uma mensagem do Google Chat foi criada, se o payload contém dados sobre o recurso |
fieldMask |
Opcional. Se Se você especificar um campo que não existe para o recurso, o sistema vai ignorá-lo. |
NotificationEndpoint
O endpoint em que a assinatura entrega eventos.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união
|
|
pubsubTopic |
Imutável. O tópico do Cloud Pub/Sub que recebe eventos para a assinatura. Formato: Você precisa criar o tópico no mesmo projeto do Google Cloud em que criou a assinatura. Quando o tópico recebe eventos, eles são codificados como mensagens do Cloud Pub/Sub. Para mais detalhes, consulte Vinculação de protocolo do Google Cloud Pub/Sub para CloudEvents. |
Estado
Estados possíveis para a assinatura.
Enums | |
---|---|
STATE_UNSPECIFIED |
Valor padrão. Esse valor não é usado. |
ACTIVE |
A assinatura está ativa e pode receber e enviar eventos para o endpoint de notificação. |
SUSPENDED |
A assinatura não pode receber eventos devido a um erro. Para identificar o erro, consulte o campo . |
DELETED |
A assinatura é excluída. |
ErrorType
Possíveis erros em uma assinatura.
Enums | |
---|---|
ERROR_TYPE_UNSPECIFIED |
Valor padrão. Esse valor não é usado. |
USER_SCOPE_REVOKED |
O usuário autorizado revogou a concessão de um ou mais escopos do OAuth. Para saber mais sobre a autorização para o Google Workspace, consulte Configurar a tela de permissão OAuth. |
RESOURCE_DELETED |
O recurso de destino da assinatura não existe mais. |
USER_AUTHORIZATION_FAILURE |
O usuário que autorizou a criação da assinatura não tem mais acesso ao recurso de destino da assinatura. |
ENDPOINT_PERMISSION_DENIED |
O aplicativo Google Workspace não tem acesso para entregar eventos ao endpoint de notificação da sua assinatura. |
ENDPOINT_NOT_FOUND |
O endpoint de notificação da assinatura não existe ou não pode ser encontrado no projeto do Google Cloud em que você criou a assinatura. |
ENDPOINT_RESOURCE_EXHAUSTED |
O endpoint de notificação da assinatura não recebeu eventos devido à cota insuficiente ou à limitação de taxa. |
OTHER |
Ocorreu um erro não identificado. |
Métodos |
|
---|---|
|
Cria uma assinatura do Google Workspace. |
|
Exclui uma assinatura do Google Workspace. |
|
Recebe detalhes sobre uma assinatura do Google Workspace. |
|
Lista as assinaturas do Google Workspace. |
|
Atualiza ou renova uma assinatura do Google Workspace. |
|
Reativar uma assinatura suspensa do Google Workspace. |