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

Opcional. Imutável. Identificador. Nome do recurso da assinatura.

Formato: subscriptions/{subscription}

string

Apenas saída. Identificador exclusivo atribuído pelo sistema para a assinatura.

string

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 compatíveis do Google Workspace.

Um usuário só pode autorizar o app a criar uma assinatura para determinado recurso de destino. Se o app tentar criar outra assinatura com as mesmas credenciais de usuário, a solicitação retornará um erro ALREADY_EXISTS.

string

Obrigatório. Imutável. Lista não ordenada. Entrada para criar uma assinatura. Caso contrário, somente saída. Um ou mais tipos de eventos a serem recebidos sobre o recurso de destino. Formatado de acordo com a especificação CloudEvents.

Os tipos de evento compatíveis dependem do recurso de destino da sua assinatura. Veja mais detalhes em Eventos compatíveis do Google Workspace.

Por padrão, você também recebe eventos sobre o ciclo de vida da assinatura. Não é necessário especificar eventos de 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 retornará um código de status HTTP 400 Bad Request.

object (PayloadOptions)

Opcional. Opções sobre quais dados incluir no payload do evento. Compatível apenas com eventos do Google Chat.

object (NotificationEndpoint)

Obrigatório. Imutável. O endpoint em que a assinatura entrega eventos, como um tópico do Pub/Sub.

enum (State)

Apenas saída. O estado da assinatura. Determina se a assinatura pode receber eventos e entregá-los ao endpoint de notificação.

enum (ErrorType)

Apenas saída. O erro que suspendeu a assinatura.

Para reativar a assinatura, resolva o erro e chame o método subscriptions.reactivate.

string

Apenas saída. O usuário que autorizou a criação da assinatura.

Formato: users/{user}

Para usuários do Google Workspace, o valor {user} é o campo user.id da API Directory.

string (Timestamp format)

Apenas saída. A hora em que a assinatura é criada.

string (Timestamp format)

Apenas saída. A última vez em que a assinatura é atualizada.

boolean

Apenas saída. Se o valor for true, significa que a assinatura está em processo de atualização.

string

Opcional. Essa soma de verificação é 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 prosseguir.

string (Timestamp format)

Padrão não vazio. É o carimbo de data/hora em UTC de quando a assinatura expira. Sempre exibido na saída, independentemente do que foi usado na entrada.

string (Duration format)

Somente entrada. O time to live (TTL) ou a duração da assinatura. Se não especificada ou definida como 0, usa a duração máxima possível.

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

boolean

Opcional. Se o payload do evento inclui dados sobre o recurso que foi alterado. Por exemplo, para um evento em que uma mensagem do Google Chat foi criada, se o payload contém dados sobre o recurso Message. Se for falso, o payload do evento incluirá apenas o nome do recurso alterado.

string (FieldMask format)

Opcional. Se includeResource for definido como true, a lista de campos a serem incluídos no payload do evento. Separe os campos com uma vírgula. Por exemplo, para incluir o remetente de uma mensagem do Google Chat e o horário de criação, digite message.sender,message.createTime. Se omitido, o payload inclui todos os campos do recurso.

Se você especificar um campo que não existe para o recurso, o sistema vai ignorar esse campo.

{

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

string

Imutável. O tópico do Cloud Pub/Sub que recebe eventos para a assinatura.

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

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.