Package google.chat.v1

Índice

ChatService

Permite que os desenvolvedores criem apps e integrações do Chat na plataforma do Google Chat.

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

Conclui o processo de importação do espaço especificado e o torna visível para os usuários.

Exige autenticação do usuário e delegação em todo o domínio com o escopo de autorização:

  • https://www.googleapis.com/auth/chat.import

Para mais informações, consulte Autorizar apps do Google Chat a importar dados.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/chat.import

Para mais informações, consulte o guia de autorização.
CreateCustomEmoji

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

Cria um emoji personalizado.

Os emojis personalizados só estão disponíveis para contas do Google Workspace, e o administrador precisa ativá-los para a organização. Para mais informações, consulte Saiba mais sobre os emojis personalizados no Google Chat e Gerenciar permissões de emojis personalizados.

Exige autenticação do usuário com o escopo de autorização:

  • https://www.googleapis.com/auth/chat.customemojis
Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/chat.customemojis

Para mais informações, consulte o guia de autorização.
CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

Cria uma associação para o app de chat que faz a chamada, um usuário ou um grupo do Google. Não é possível criar assinaturas para outros apps de chat. Ao criar uma assinatura, se o membro especificado tiver a política de aceitação automática desativada, ele vai receber um convite e precisará aceitá-lo antes de entrar no espaço. Caso contrário, a criação de uma assinatura adiciona o membro diretamente ao espaço especificado.

Aceita os seguintes tipos de autenticação:

  • Autenticação de app com aprovação do administrador e o escopo de autorização:

    • https://www.googleapis.com/auth/chat.app.memberships

  • Autenticação de usuário com um dos seguintes escopos de autorização:

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.memberships.app (para adicionar o app de chamada ao espaço)
    • https://www.googleapis.com/auth/chat.import (somente espaços do modo de importação)
    • A autenticação de usuário concede privilégios de administrador quando uma conta de administrador é autenticada, use_admin_access é true e o seguinte escopo de autorização é usado:
      • https://www.googleapis.com/auth/chat.admin.memberships

A autenticação de app não é compatível com os seguintes casos de uso:

  • Convidar usuários externos à organização do Workspace proprietária do espaço.
  • Adicionar um grupo do Google a um espaço.
  • Adicionar um app do Chat a um espaço.

Para exemplos de uso, consulte:

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

Para mais informações, consulte o guia de autorização.
CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message)

Cria uma mensagem em um espaço do Google Chat. Para ver um exemplo, consulte Enviar uma mensagem.

Aceita os seguintes tipos de autenticação:

  • Autenticação do app com o escopo de autorização:
    • https://www.googleapis.com/auth/chat.bot
  • Autenticação do usuário com um dos seguintes escopos de autorização:
    • https://www.googleapis.com/auth/chat.messages.create
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (somente espaços do modo de importação)

O Chat atribui o remetente da mensagem de maneira diferente, dependendo do tipo de autenticação usado na solicitação.

A imagem a seguir mostra como o Chat atribui uma mensagem quando você usa a autenticação do app. O Chat mostra o app do Chat como o remetente da mensagem. O conteúdo da mensagem pode ter texto (text), cards (cardsV2) e widgets acessórios (accessoryWidgets).

Mensagem enviada com autenticação de app

A imagem a seguir mostra como o Chat atribui uma mensagem quando você usa a autenticação do usuário. O Chat mostra o usuário como o remetente da mensagem e atribui o app do Chat à mensagem mostrando o nome dele. O conteúdo da mensagem só pode conter texto (text).

Mensagem enviada com autenticação do usuário

O tamanho máximo da mensagem, incluindo o conteúdo, é de 32.000 bytes.

Para solicitações de webhook, a resposta não contém a mensagem completa. A resposta preenche apenas os campos name e thread.name, além das informações que estavam na solicitação.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

Para mais informações, consulte o guia de autorização.
CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

Cria uma reação e a adiciona a uma mensagem. Para ver um exemplo, consulte Adicionar uma reação a uma mensagem.

Requer autenticação do usuário com um dos seguintes escopos de autorização:

  • https://www.googleapis.com/auth/chat.messages.reactions.create
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (somente espaços do modo de importação)
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.create

Para mais informações, consulte o guia de autorização.
CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

Cria um espaço. Pode ser usado para criar um espaço nomeado ou um chat em grupo no Import mode. Para ver um exemplo, consulte Criar um espaço.

Aceita os seguintes tipos de autenticação:

  • Autenticação de app com aprovação do administrador e um dos seguintes escopos de autorização:

    • https://www.googleapis.com/auth/chat.app.spaces.create
    • https://www.googleapis.com/auth/chat.app.spaces

  • Autenticação de usuário com um dos seguintes escopos de autorização:

    • https://www.googleapis.com/auth/chat.spaces.create
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import (somente espaços do modo de importação)

Ao autenticar como um app, o campo space.customer precisa ser definido na solicitação.

Ao autenticar como um app, o app do Chat é adicionado como participante do espaço. No entanto, ao contrário da autenticação humana, o app do Chat não é adicionado como administrador do espaço. Por padrão, todos os participantes podem remover o app Chat do espaço. Para permitir que apenas administradores do espaço removam o app, defina space.permission_settings.manage_apps como managers_allowed.

A assinatura do espaço no momento da criação depende de onde ele foi criado: Import mode:

  • Modo de importação:nenhum participante é criado.
  • Todos os outros modos:o usuário que faz a chamada é adicionado como participante. Isso é:
    • O próprio app ao usar a autenticação de app.
    • O usuário humano ao usar a autenticação de usuário.

Se você receber a mensagem de erro ALREADY_EXISTS ao criar um espaço, tente usar outro displayName. Um espaço na organização do Google Workspace já pode usar esse nome de exibição.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.app.spaces.create
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

Para mais informações, consulte o guia de autorização.
DeleteCustomEmoji

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

Exclui um emoji personalizado. Por padrão, os usuários só podem excluir os emojis personalizados que criaram. Os gerenciadores de emojis atribuídos pelo administrador podem excluir qualquer emoji personalizado na organização. Consulte Saiba mais sobre os emojis personalizados no Google Chat.

Os emojis personalizados só estão disponíveis para contas do Google Workspace, e o administrador precisa ativá-los para a organização. Para mais informações, consulte Saiba mais sobre os emojis personalizados no Google Chat e Gerenciar permissões de emojis personalizados.

Exige autenticação do usuário com o escopo de autorização:

  • https://www.googleapis.com/auth/chat.customemojis
Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/chat.customemojis

Para mais informações, consulte o guia de autorização.
DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

Exclui uma assinatura. Por exemplo, consulte Remover um usuário ou um app do Google Chat de um espaço.

Aceita os seguintes tipos de autenticação:

  • Autenticação de app com aprovação do administrador e o escopo de autorização:

    • https://www.googleapis.com/auth/chat.app.memberships

  • Autenticação de usuário com um dos seguintes escopos de autorização:

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.memberships.app (para remover o app de chamadas do espaço)
    • https://www.googleapis.com/auth/chat.import (somente espaços do modo de importação)
    • A autenticação de usuário concede privilégios de administrador quando uma conta de administrador é autenticada, use_admin_access é true e o seguinte escopo de autorização é usado:
      • https://www.googleapis.com/auth/chat.admin.memberships

A autenticação de app não é compatível com os seguintes casos de uso:

  • Remover um grupo do Google de um espaço.
  • Remover um app do Chat de um espaço.

Para excluir assinaturas de administradores do espaço, o solicitante precisa ser um administrador do espaço. Se você estiver usando a autenticação de app, o app Chat precisa ser o criador do espaço.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

Para mais informações, consulte o guia de autorização.
DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

Exclui uma mensagem. Para ver um exemplo, consulte Excluir uma mensagem.

Aceita os seguintes tipos de autenticação:

  • Autenticação do app com o escopo de autorização:

    • https://www.googleapis.com/auth/chat.bot

  • Autenticação de usuário com um dos seguintes escopos de autorização:

    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (somente espaços do modo de importação)

Ao usar a autenticação de app, as solicitações só podem excluir mensagens criadas pelo app de chat que fez a chamada.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

Para mais informações, consulte o guia de autorização.
DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

Exclui uma reação a uma mensagem. Para ver um exemplo, consulte Excluir uma reação.

Requer autenticação do usuário com um dos seguintes escopos de autorização:

  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (somente espaços do modo de importação)
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions

Para mais informações, consulte o guia de autorização.
DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

Exclui um espaço nomeado. Sempre realiza uma exclusão em cascata, o que significa que os recursos filhos do espaço, como mensagens postadas e participações, também são excluídos. Para conferir um exemplo, consulte Excluir um espaço.

Aceita os seguintes tipos de autenticação:

  • Autenticação de app com aprovação do administrador e o escopo de autorização:

    • https://www.googleapis.com/auth/chat.app.delete (apenas nos espaços criados pelo app)

  • Autenticação de usuário com um dos seguintes escopos de autorização:

    • https://www.googleapis.com/auth/chat.delete
    • https://www.googleapis.com/auth/chat.import (somente espaços do modo de importação)
    • A autenticação de usuário concede privilégios de administrador quando uma conta de administrador é autenticada, use_admin_access é true e o seguinte escopo de autorização é usado:
      • https://www.googleapis.com/auth/chat.admin.delete
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.app.delete
  • https://www.googleapis.com/auth/chat.admin.delete
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.delete

Para mais informações, consulte o guia de autorização.
FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

Retorna a mensagem direta com o usuário especificado. Se nenhum espaço de mensagem direta for encontrado, vai retornar um erro 404 NOT_FOUND. Para ver um exemplo, consulte Encontrar uma mensagem direta.

Com a autenticação de app, retorna o espaço de mensagem direta entre o usuário especificado e o app do Chat que faz a chamada.

Com a autenticação do usuário, retorna o espaço de mensagem direta entre o usuário especificado e o usuário autenticado.

Aceita os seguintes tipos de autenticação:

  • Autenticação do app com o escopo de autorização:

    • https://www.googleapis.com/auth/chat.bot

  • Autenticação de usuário com um dos seguintes escopos de autorização:

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

Para mais informações, consulte o guia de autorização.
GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

Recebe os metadados de um anexo de mensagem. Os dados do anexo são buscados usando a API Media. Para ver um exemplo, consulte Receber metadados sobre um anexo de mensagem.

Requer autenticação do app com o escopo de autorização:

  • https://www.googleapis.com/auth/chat.bot
Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/chat.bot

Para mais informações, consulte o guia de autorização.
GetCustomEmoji

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

Retorna detalhes sobre um emoji personalizado.

Os emojis personalizados só estão disponíveis para contas do Google Workspace, e o administrador precisa ativá-los para a organização. Para mais informações, consulte Saiba mais sobre os emojis personalizados no Google Chat e Gerenciar permissões de emojis personalizados.

Requer autenticação do usuário com um dos seguintes escopos de autorização:

  • https://www.googleapis.com/auth/chat.customemojis.readonly
  • https://www.googleapis.com/auth/chat.customemojis
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

Para mais informações, consulte o guia de autorização.
GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

Retorna detalhes sobre uma assinatura. Por exemplo, consulte Receber detalhes sobre a associação de um usuário ou app do Google Chat.

Aceita os seguintes tipos de autenticação:

  • Autenticação do app com um dos seguintes escopos de autorização:

  • Autenticação de usuário com um dos seguintes escopos de autorização:

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • A autenticação de usuário concede privilégios de administrador quando uma conta de administrador é autenticada, use_admin_access é true e um dos seguintes escopos de autorização é usado:
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

Para mais informações, consulte o guia de autorização.
GetMessage

rpc GetMessage(GetMessageRequest) returns (Message)

Retorna detalhes sobre uma mensagem. Para ver um exemplo, consulte Receber detalhes sobre uma mensagem.

Aceita os seguintes tipos de autenticação:

  • Autenticação do app com um dos seguintes escopos de autorização:

    • https://www.googleapis.com/auth/chat.bot: ao usar esse escopo de autorização, esse método retorna detalhes sobre uma mensagem a que o app do Chat tem acesso, como mensagens diretas e comandos de barra que invocam o app do Chat.
    • https://www.googleapis.com/auth/chat.app.messages.readonly com aprovação do administrador (disponível na prévia para desenvolvedores). Ao usar esse escopo de autenticação, esse método retorna detalhes sobre uma mensagem pública em um espaço.

  • Autenticação de usuário com um dos seguintes escopos de autorização:

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages

Observação: pode retornar uma mensagem de um participante ou espaço bloqueado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly

Para mais informações, consulte o guia de autorização.
GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

Retorna detalhes sobre um espaço. Por exemplo, consulte Receber detalhes sobre um espaço.

Aceita os seguintes tipos de autenticação:

  • Autenticação do app com um dos seguintes escopos de autorização:

  • Autenticação de usuário com um dos seguintes escopos de autorização:

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • A autenticação de usuário concede privilégios de administrador quando uma conta de administrador é autenticada, use_admin_access é true e um dos seguintes escopos de autorização é usado:
      • https://www.googleapis.com/auth/chat.admin.spaces.readonly
      • https://www.googleapis.com/auth/chat.admin.spaces

A autenticação de app tem as seguintes limitações:

  • space.access_settings só é preenchido ao usar o escopo chat.app.spaces.
  • space.predefind_permission_settings e space.permission_settings só são preenchidos quando o escopo chat.app.spaces é usado e apenas para espaços criados pelo app.
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.app.spaces

Para mais informações, consulte o guia de autorização.
GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

Retorna um evento de um espaço do Google Chat. O payload do evento contém a versão mais recente do recurso que mudou. Por exemplo, se você solicitar um evento sobre uma nova mensagem, mas ela for atualizada depois, o servidor vai retornar o recurso Message atualizado no payload do evento.

Observação: o campo permissionSettings não é retornado no objeto "Space" dos dados de eventos do espaço para essa solicitação.

Aceita os seguintes tipos de autenticação com um escopo de autorização adequado para ler os dados solicitados:

  • Autenticação de app com aprovação do administrador na Prévia para desenvolvedores com um dos seguintes escopos de autorização:

    • https://www.googleapis.com/auth/chat.app.spaces
    • https://www.googleapis.com/auth/chat.app.messages.readonly
    • https://www.googleapis.com/auth/chat.app.memberships

  • Autenticação de usuário com um dos seguintes escopos de autorização:

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.messages.reactions.readonly
    • https://www.googleapis.com/auth/chat.messages.reactions
    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships

Para receber um evento, o autor da chamada autenticado precisa ser membro do espaço.

Por exemplo, consulte Receber detalhes sobre um evento de um espaço do Google Chat.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Para mais informações, consulte o guia de autorização.
GetSpaceNotificationSetting

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

Recebe a configuração de notificação do espaço. Para um exemplo, consulte Receber a configuração de notificação do espaço do autor da chamada.

Exige autenticação do usuário com o escopo de autorização:

  • https://www.googleapis.com/auth/chat.users.spacesettings
Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/chat.users.spacesettings

Para mais informações, consulte o guia de autorização.
GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

Retorna detalhes sobre o estado de leitura de um usuário em um espaço, usado para identificar mensagens lidas e não lidas. Por exemplo, consulte Receber detalhes sobre o estado de leitura de um espaço de um usuário.

Requer autenticação do usuário com um dos seguintes escopos de autorização:

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

Para mais informações, consulte o guia de autorização.
GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

Retorna detalhes sobre o estado de leitura de um usuário em uma conversa, usado para identificar mensagens lidas e não lidas. Por exemplo, consulte Receber detalhes sobre o estado de leitura de uma conversa de um usuário.

Requer autenticação do usuário com um dos seguintes escopos de autorização:

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

Para mais informações, consulte o guia de autorização.
ListCustomEmojis

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

Lista os emojis personalizados visíveis para o usuário autenticado.

Os emojis personalizados só estão disponíveis para contas do Google Workspace, e o administrador precisa ativá-los para a organização. Para mais informações, consulte Saiba mais sobre os emojis personalizados no Google Chat e Gerenciar permissões de emojis personalizados.

Requer autenticação do usuário com um dos seguintes escopos de autorização:

  • https://www.googleapis.com/auth/chat.customemojis.readonly
  • https://www.googleapis.com/auth/chat.customemojis
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

Para mais informações, consulte o guia de autorização.
ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

Lista as assinaturas em um espaço. Por exemplo, consulte Listar usuários e apps do Google Chat em um espaço. A listagem de assinaturas com autenticação de app mostra as assinaturas em espaços a que o app Chat tem acesso, mas exclui as assinaturas do app Chat, incluindo a dele mesmo. A listagem de assinaturas com Autenticação de usuário mostra as assinaturas em espaços a que o usuário autenticado tem acesso.

Aceita os seguintes tipos de autenticação:

  • Autenticação do app com um dos seguintes escopos de autorização:

  • Autenticação de usuário com um dos seguintes escopos de autorização:

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import (somente espaços do modo de importação)
    • A autenticação de usuário concede privilégios de administrador quando uma conta de administrador é autenticada, use_admin_access é true e um dos seguintes escopos de autorização é usado:
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

Para mais informações, consulte o guia de autorização.
ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

Lista as mensagens em um espaço de que o usuário é participante, incluindo mensagens de participantes e espaços bloqueados. As mensagens do sistema, como as que anunciam novos participantes do espaço, não são incluídas. Se você listar mensagens de um espaço sem mensagens, a resposta será um objeto vazio. Ao usar uma interface REST/HTTP, a resposta contém um objeto JSON vazio, {}. Para ver um exemplo, consulte Listar mensagens.

Aceita os seguintes tipos de autenticação:

  • Autenticação de app com aprovação do administrador na Prévia para desenvolvedores com o escopo de autorização:

    • https://www.googleapis.com/auth/chat.app.messages.readonly. Ao usar esse escopo de autenticação, esse método retorna apenas mensagens públicas em um espaço. Ele não inclui mensagens particulares.

  • Autenticação de usuário com um dos seguintes escopos de autorização:

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (somente espaços do modo de importação)
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly

Para mais informações, consulte o guia de autorização.
ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

Lista as reações a uma mensagem. Para ver um exemplo, consulte Listar reações de uma mensagem.

Requer autenticação do usuário com um dos seguintes escopos de autorização:

  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Para mais informações, consulte o guia de autorização.
ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

Lista eventos de um espaço do Google Chat. Para cada evento, o payload contém a versão mais recente do recurso "Chat". Por exemplo, se você listar eventos sobre novos membros do espaço, o servidor vai retornar recursos Membership que contêm os detalhes mais recentes da associação. Se novos membros foram removidos durante o período solicitado, o payload do evento vai conter um recurso Membership vazio.

Aceita os seguintes tipos de autenticação com um escopo de autorização adequado para ler os dados solicitados:

  • Autenticação de app com aprovação do administrador na Prévia para desenvolvedores com um dos seguintes escopos de autorização:

    • https://www.googleapis.com/auth/chat.app.spaces
    • https://www.googleapis.com/auth/chat.app.messages.readonly
    • https://www.googleapis.com/auth/chat.app.memberships

  • Autenticação de usuário com um dos seguintes escopos de autorização:

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.messages.reactions.readonly
    • https://www.googleapis.com/auth/chat.messages.reactions
    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships

Para listar eventos, o autor da chamada autenticado precisa ser membro do espaço.

Por exemplo, consulte Listar eventos de um espaço do Google Chat.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Para mais informações, consulte o guia de autorização.
ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

Lista os espaços de que o autor da chamada é membro. Os chats em grupo e as mensagens diretas não são listados até que a primeira mensagem seja enviada. Para ver um exemplo, consulte Listar espaços.

Aceita os seguintes tipos de autenticação:

  • Autenticação do app com o escopo de autorização:

    • https://www.googleapis.com/auth/chat.bot

  • Autenticação de usuário com um dos seguintes escopos de autorização:

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces

Para listar todos os espaços nomeados por organização do Google Workspace, use o método spaces.search() com privilégios de administrador do Workspace.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

Para mais informações, consulte o guia de autorização.
SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

Retorna uma lista de espaços em uma organização do Google Workspace com base na pesquisa de um administrador. Na solicitação, defina use_admin_access como true. Por exemplo, consulte Pesquisar e gerenciar espaços.

Requer autenticação de usuário com privilégios de administrador e um dos seguintes escopos de autorização:

  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.admin.spaces
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly

Para mais informações, consulte o guia de autorização.
SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

Cria um espaço e adiciona os usuários especificados a ele. O usuário que faz a chamada é adicionado automaticamente ao espaço e não precisa ser especificado como uma participação na solicitação. Por exemplo, consulte Configurar um espaço com participantes iniciais.

Para especificar os membros humanos a serem adicionados, adicione associações com o membership.member.name adequado. Para adicionar um usuário humano, use users/{user}, em que {user} pode ser o endereço de e-mail do usuário. Para usuários na mesma organização do Workspace, {user} também pode ser o id da pessoa na API People ou o id do usuário na API Directory. Por exemplo, se o ID do perfil da API People para [email protected] for 123456789, adicione o usuário ao espaço definindo membership.member.name como users/[email protected] ou users/123456789.

Para especificar os grupos do Google que serão adicionados, inclua associações com o membership.group_member.name adequado. Para adicionar ou convidar um grupo do Google, use groups/{group}, em que {group} é o id do grupo na API Cloud Identity Groups. Por exemplo, você pode usar a API de pesquisa do Cloud Identity Groups para recuperar o ID 123456789 do e-mail do grupo [email protected] e adicionar o grupo ao espaço definindo membership.group_member.name como groups/123456789. O e-mail em grupo não é aceito, e os grupos do Google só podem ser adicionados como participantes em espaços nomeados.

Em um espaço nomeado ou chat em grupo, se o autor da chamada bloquear ou for bloqueado por alguns participantes ou não tiver permissão para adicionar alguns participantes, essas pessoas não serão adicionadas ao espaço criado.

Para criar uma mensagem direta (DM) entre o usuário que faz a chamada e outro usuário humano, especifique exatamente uma associação para representar o usuário humano. Se um usuário bloquear o outro, a solicitação vai falhar e a mensagem direta não será criada.

Para criar uma mensagem direta entre o usuário e o app que fez a chamada, defina Space.singleUserBotDm como true e não especifique nenhuma assinatura. Só é possível usar esse método para configurar uma mensagem direta com o app de chamadas. Para adicionar o app de chamadas como participante de um espaço ou de uma mensagem direta entre dois usuários humanos, consulte Convidar ou adicionar um usuário ou app a um espaço.

Se uma mensagem direta já existir entre dois usuários, mesmo que um bloqueie o outro no momento em que uma solicitação é feita, a mensagem direta existente será retornada.

Não é possível usar espaços com respostas em linha. Se você receber a mensagem de erro ALREADY_EXISTS ao configurar um espaço, tente usar outro displayName. Um espaço na organização do Google Workspace já pode usar esse nome de exibição.

Requer autenticação do usuário com um dos seguintes escopos de autorização:

  • https://www.googleapis.com/auth/chat.spaces.create
  • https://www.googleapis.com/auth/chat.spaces
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

Para mais informações, consulte o guia de autorização.
UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

Atualiza uma assinatura. Para ver um exemplo, consulte Atualizar a participação de um usuário em um espaço.

Aceita os seguintes tipos de autenticação:

  • Autenticação de app com aprovação do administrador e o escopo de autorização:

    • https://www.googleapis.com/auth/chat.app.memberships (apenas nos espaços criados pelo app)

  • Autenticação de usuário com um dos seguintes escopos de autorização:

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import (somente espaços do modo de importação)
    • A autenticação de usuário concede privilégios de administrador quando uma conta de administrador é autenticada, use_admin_access é true e o seguinte escopo de autorização é usado:
      • https://www.googleapis.com/auth/chat.admin.memberships
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships

Para mais informações, consulte o guia de autorização.
UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

Atualiza uma mensagem. Há uma diferença entre os métodos patch e update. O método patch usa uma solicitação patch, enquanto o método update usa uma solicitação put. Recomendamos usar o método patch. Para ver um exemplo, consulte Atualizar uma mensagem.

Aceita os seguintes tipos de autenticação:

  • Autenticação do app com o escopo de autorização:

    • https://www.googleapis.com/auth/chat.bot

  • Autenticação de usuário com um dos seguintes escopos de autorização:

    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (somente espaços do modo de importação)

Ao usar a autenticação de app, as solicitações só podem atualizar mensagens criadas pelo app de chat que fez a chamada.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

Para mais informações, consulte o guia de autorização.
UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

Atualiza um espaço. Para conferir um exemplo, consulte Atualizar um espaço.

Se você estiver atualizando o campo displayName e receber a mensagem de erro ALREADY_EXISTS, tente usar outro nome de exibição. Um espaço na organização do Google Workspace já pode usar esse nome de exibição.

Aceita os seguintes tipos de autenticação:

  • Autenticação de app com aprovação do administrador e um dos seguintes escopos de autorização:

    • https://www.googleapis.com/auth/chat.app.spaces

  • Autenticação de usuário com um dos seguintes escopos de autorização:

    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import (somente espaços do modo de importação)
    • A autenticação de usuário concede privilégios de administrador quando uma conta de administrador é autenticada, use_admin_access é true e os seguintes escopos de autorização são usados:
      • https://www.googleapis.com/auth/chat.admin.spaces

A autenticação de app tem as seguintes limitações:

  • Para atualizar space.predefined_permission_settings ou space.permission_settings, o app precisa ser o criador do espaço.
  • Não é possível atualizar o space.access_settings.audience para autenticação de apps.
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

Para mais informações, consulte o guia de autorização.
UpdateSpaceNotificationSetting

rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

Atualiza a configuração de notificação do espaço. Para ver um exemplo, consulte Atualizar a configuração de notificação de espaço do autor da chamada.

Exige autenticação do usuário com o escopo de autorização:

  • https://www.googleapis.com/auth/chat.users.spacesettings
Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/chat.users.spacesettings

Para mais informações, consulte o guia de autorização.
UpdateSpaceReadState

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

Atualiza o estado de leitura de um usuário em um espaço, usado para identificar mensagens lidas e não lidas. Para um exemplo, consulte Atualizar o estado de leitura de um espaço de um usuário.

Exige autenticação do usuário com o escopo de autorização:

  • https://www.googleapis.com/auth/chat.users.readstate
Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/chat.users.readstate

Para mais informações, consulte o guia de autorização.

AccessoryWidget

Um ou mais widgets interativos que aparecem na parte de baixo de uma mensagem. Para mais detalhes, consulte Adicionar widgets interativos na parte de baixo de uma mensagem.

Campos
Campo de união action. O tipo de ação. action pode ser apenas de um dos tipos a seguir:
button_list

ButtonList

Uma lista de botões.

ActionResponse

Parâmetros que um app de chat pode usar para configurar como a resposta é postada.

Campos
type

ResponseType

Somente entrada. O tipo de resposta do app Chat.
url

string

Somente entrada. URL para os usuários autenticarem ou configurarem. (Somente para tipos de resposta REQUEST_CONFIG.)
dialog_action

DialogAction

Somente entrada. Uma resposta a um evento de interação relacionado a uma caixa de diálogo. Precisa ser acompanhado de ResponseType.Dialog.
updated_widget

UpdatedWidget

Somente entrada. A resposta do widget atualizado.

ResponseType

O tipo de resposta do app Chat.

Tipos enumerados
TYPE_UNSPECIFIED Tipo padrão processado como NEW_MESSAGE.
NEW_MESSAGE Postar como uma nova mensagem no tópico.
UPDATE_MESSAGE Atualize a mensagem do app Chat. Isso só é permitido em um evento CARD_CLICKED em que o tipo de remetente da mensagem é BOT.
UPDATE_USER_MESSAGE_CARDS Atualiza os cards em uma mensagem de um usuário. Isso só é permitido como resposta a um evento MESSAGE com um URL correspondente ou a um evento CARD_CLICKED em que o tipo de remetente da mensagem é HUMAN. O texto é ignorado.
REQUEST_CONFIG Pedir ao usuário, de forma privada, autenticação ou configuração adicional.
DIALOG Apresenta uma caixa de diálogo.
UPDATE_WIDGET Consulta de opções de preenchimento automático de texto do widget.

SelectionItems

Lista de resultados de preenchimento automático do widget.

Campos
items[]

SelectionItem

Uma matriz de objetos SelectionItem.

UpdatedWidget

Para widgets selectionInput, retorna sugestões de preenchimento automático para um menu de seleção múltipla.

Campos
widget

string

O ID do widget atualizado. O ID precisa corresponder ao do widget que acionou a solicitação de atualização.
Campo de união updated_widget. O widget foi atualizado em resposta a uma ação do usuário. updated_widget pode ser apenas de um dos tipos a seguir:
suggestions

SelectionItems

Lista de resultados de preenchimento automático do widget

ActionStatus

Representa o status de uma solicitação para invocar ou enviar uma caixa de diálogo.

Campos
status_code

Code

O código de status.
user_facing_message

string

A mensagem a ser enviada aos usuários sobre o status da solicitação. Se não for definido, uma mensagem genérica com base no status_code será enviada.

Nota

Apenas saída. As anotações podem ser associadas ao corpo de texto simples da mensagem ou a chips que vinculam recursos do Google Workspace, como Documentos ou Planilhas Google, com start_index e length de 0. Para adicionar formatação básica a uma mensagem de texto, consulte Formatar mensagens de texto.

Exemplo de corpo de mensagem de texto simples:

Hello @FooBot how are you!"

Os metadados de anotações correspondentes:

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
Campos
type

AnnotationType

O tipo desta anotação.
length

int32

Comprimento da substring no corpo da mensagem de texto simples a que esta anotação corresponde. Se não estiver presente, indica um comprimento de 0.
start_index

int32

Índice inicial (com base em zero, inclusive) no corpo da mensagem de texto simples a que esta anotação corresponde.
Campo de união metadata. Metadados adicionais sobre a anotação. metadata pode ser apenas de um dos tipos a seguir:
user_mention

UserMentionMetadata

Os metadados da menção ao usuário.
slash_command

SlashCommandMetadata

Os metadados de um comando de barra.
custom_emoji_metadata

CustomEmojiMetadata

Os metadados de um emoji personalizado.

AnnotationType

Tipo da anotação.

Tipos enumerados
ANNOTATION_TYPE_UNSPECIFIED Valor padrão para a enumeração. Não use.
USER_MENTION Um usuário é mencionado.
SLASH_COMMAND Um comando de barra é invocado.
CUSTOM_EMOJI Uma anotação de emoji personalizado.

AppCommandMetadata

Metadados sobre um comando do app do Chat.

Campos
app_command_id

int32

O ID do comando especificado na configuração da API Chat.
app_command_type

AppCommandType

O tipo de comando do app Chat.

AppCommandType

O tipo de comando do app Chat. Para mais detalhes, consulte Tipos de comandos de apps do Chat.

Tipos enumerados
APP_COMMAND_TYPE_UNSPECIFIED Valor padrão. Não especificado.
SLASH_COMMAND Um comando de barra. O usuário envia o comando em uma mensagem do Chat.
QUICK_COMMAND Um comando rápido. O usuário seleciona o comando no menu do Chat na área de resposta da mensagem.

AttachedGif

Uma imagem GIF especificada por um URL.

Campos
uri

string

Apenas saída. O URL que hospeda a imagem GIF.

Anexo

Um anexo no Google Chat.

Campos
name

string

Opcional. Nome do recurso do anexo, no formato spaces/{space}/messages/{message}/attachments/{attachment}.
content_name

string

Apenas saída. O nome original do arquivo do conteúdo, não o caminho completo.
content_type

string

Apenas saída. O tipo de conteúdo (tipo MIME) do arquivo.
thumbnail_uri

string

Apenas saída. O URL da miniatura que deve ser usado para visualizar o anexo para um usuário humano. Os apps de chat não podem usar esse URL para baixar conteúdo de anexos.
download_uri

string

Apenas saída. O URL de download que deve ser usado para permitir que um usuário humano faça o download do anexo. Os apps de chat não podem usar esse URL para baixar conteúdo de anexos.
source

Source

Apenas saída. A origem do anexo.
Campo de união data_ref. A referência de dados ao anexo. data_ref pode ser apenas de um dos tipos a seguir:
attachment_data_ref

AttachmentDataRef

Opcional. Uma referência aos dados do anexo. Esse campo é usado para criar ou atualizar mensagens com anexos ou com a API Media para baixar os dados do anexo.
drive_data_ref

DriveDataRef

Apenas saída. Uma referência ao anexo do Google Drive. Esse campo é usado com a API Google Drive.

Origem

A origem do anexo.

Tipos enumerados
SOURCE_UNSPECIFIED Reservado.
DRIVE_FILE O arquivo é do Google Drive.
UPLOADED_CONTENT O arquivo é enviado para o Chat.

AttachmentDataRef

Uma referência aos dados do anexo.

Campos
resource_name

string

Opcional. O nome do recurso dos dados do anexo. Esse campo é usado com a API Media para fazer o download dos dados do anexo.
attachment_upload_token

string

Opcional. Token opaco que contém uma referência a um anexo enviado. Tratado pelos clientes como uma string opaca e usado para criar ou atualizar mensagens do chat com anexos.

CalendarEventLinkData

Dados de links de eventos da Agenda.

Campos
calendar_id

string

O identificador da Agenda da Agenda vinculada.
event_id

string

O identificador do evento do evento vinculado da Agenda.

CardWithId

Um card em uma mensagem do Google Chat.

Somente os apps do Chat podem criar cards. Se o app Chat autenticar como um usuário, a mensagem não poderá conter cards.

Crie e visualize cards com o Card Builder.

Abrir o Criador de cards

Campos
card_id

string

Obrigatório se a mensagem tiver vários cards. Um identificador exclusivo de um card em uma mensagem.
card

Card

Um cartão. O tamanho máximo é de 32 KB.

ChatSpaceLinkData

Dados de links de espaços do Chat.

Campos
space

string

O espaço do recurso vinculado do espaço do Chat.

Formato: spaces/{space}
thread

string

A conversa do recurso de espaço do Chat vinculado.

Formato: spaces/{space}/threads/{thread}
message

string

A mensagem do recurso de espaço do Chat vinculado.

Formato: spaces/{space}/messages/{message}

CompleteImportSpaceRequest

Mensagem de solicitação para concluir o processo de importação de um espaço.

Campos
name

string

Obrigatório. Nome do recurso do espaço do modo de importação.

Formato: spaces/{space}

CompleteImportSpaceResponse

Mensagem de resposta para concluir o processo de importação de um espaço.

Campos
space

Space

O espaço do modo de importação.

ContextualAddOnMarkup

Esse tipo não tem campos.

A marcação para desenvolvedores especificarem o conteúdo de um complemento contextual.

Cartas

Um card é um elemento da interface que pode conter widgets, como texto e imagens.

Campos
header

CardHeader

O cabeçalho do card. Um cabeçalho geralmente contém um título e uma imagem.
sections[]

Section

As seções são separadas por um divisor de linha.
card_actions[]

CardAction

As ações deste card.
name

string

Nome do card.

CardAction

Uma ação do card é a ação associada a ele. Para um card de fatura, uma ação típica seria: excluir fatura, enviar fatura por e-mail ou abrir a fatura no navegador.

Não é compatível com apps do Google Chat.

Campos
action_label

string

O rótulo usado para ser exibido no item do menu de ações.
on_click

OnClick

A ação onclick para essa ação necessária.

CardHeader

Campos
title

string

O título precisa ser especificado. O cabeçalho tem uma altura fixa: se um título e um subtítulo forem especificados, cada um ocupará uma linha. Se apenas o título for especificado, ele vai ocupar as duas linhas.
subtitle

string

O subtítulo do cabeçalho do card.
image_style

ImageStyle

O tipo da imagem (por exemplo, borda quadrada ou circular).
image_url

string

O URL da imagem no cabeçalho do card.

ImageStyle

Tipos enumerados
IMAGE_STYLE_UNSPECIFIED
IMAGE Borda quadrada.
AVATAR Borda circular.

Seção

Uma seção contém uma coleção de widgets renderizados (verticalmente) na ordem em que são especificados. Em todas as plataformas, os cards têm uma largura fixa estreita. Portanto, não há necessidade de propriedades de layout (por exemplo, "float").

Campos
header

string

O cabeçalho da seção. O texto formatado é aceito. Para mais informações sobre como formatar texto, consulte Formatar texto nos apps do Google Chat e Formatar texto nos complementos do Google Workspace.
widgets[]

WidgetMarkup

Uma seção precisa conter pelo menos um widget.

CreateCustomEmojiRequest

Uma solicitação para criar um emoji personalizado.

Campos
custom_emoji

CustomEmoji

Obrigatório. O emoji personalizado a ser criado.

CreateMembershipRequest

Mensagem de solicitação para criar uma assinatura.

Campos
parent

string

Obrigatório. O nome do recurso do espaço para o qual a associação será criada.

Formato: spaces/{space}
membership

Membership

Obrigatório. A relação de associação a ser criada.

O campo memberType precisa conter um usuário com os campos user.name e user.type preenchidos. O servidor vai atribuir um nome de recurso e substituir tudo o que foi especificado.

Quando um app de chat cria uma relação de associação para um usuário humano, ele precisa usar determinados escopos de autorização e definir valores específicos para alguns campos:

  • Ao autenticar como um usuário, o escopo de autorização chat.memberships é necessário.

  • Ao autenticar como um app, o escopo de autorização chat.app.memberships é necessário.

  • Defina user.type como HUMAN e user.name com o formato users/{user}, em que {user} pode ser o endereço de e-mail do usuário. Para usuários na mesma organização do Workspace, {user} também pode ser o id da pessoa na API People ou o id do usuário na API Directory. Por exemplo, se o ID do perfil da API People para [email protected] for 123456789, adicione o usuário ao espaço definindo membership.member.name como users/[email protected] ou users/123456789.

Para convidar usuários externos à organização do Workspace proprietária do espaço, é necessário fazer a autenticação de usuário.

Quando um app do Chat cria uma relação de associação para si mesmo, ele precisa autenticar como um usuário e usar o escopo chat.memberships.app, definir user.type como BOT e definir user.name como users/app.
use_admin_access

bool

Opcional. Quando true, o método é executado usando os privilégios de administrador do Google Workspace do usuário.

O usuário que faz a chamada precisa ser um administrador do Google Workspace com o privilégio de gerenciar conversas no Chat e nos espaços.

Requer o escopo do OAuth 2.0 chat.admin.memberships.

Não é possível criar assinaturas de apps ou para usuários fora da organização do Google Workspace do administrador usando o acesso de administrador.

CreateMessageRequest

Cria uma mensagem.

Campos
parent

string

Obrigatório. O nome do recurso do espaço em que uma mensagem será criada.

Formato: spaces/{space}
message

Message

Obrigatório. Corpo da mensagem.
thread_key
(deprecated)

string

Opcional. Descontinuado: use thread.thread_key. ID da conversa. Aceita até 4.000 caracteres. Para iniciar ou adicionar a uma conversa, crie uma mensagem e especifique um threadKey ou o thread.name. Para ver um exemplo de uso, consulte Iniciar ou responder a uma conversa por mensagem.
request_id

string

Opcional. Um ID de solicitação exclusivo para esta mensagem. Especificar um ID de solicitação existente retorna a mensagem criada com esse ID em vez de criar uma nova.
message_reply_option

MessageReplyOption

Opcional. Especifica se uma mensagem inicia ou responde a uma conversa. Compatível apenas com espaços nomeados.

Ao responder às interações do usuário, esse campo é ignorado. Para interações em uma conversa, a resposta é criada na mesma conversa. Caso contrário, a resposta será criada como uma nova conversa.
message_id

string

Opcional. Um ID personalizado para uma mensagem. Permite que os apps do Chat recebam, atualizem ou excluam uma mensagem sem precisar armazenar o ID atribuído pelo sistema no nome do recurso da mensagem (representado no campo name da mensagem).

O valor desse campo precisa atender aos seguintes requisitos:

  • Começa com client-. Por exemplo, client-custom-name é um ID personalizado válido, mas custom-name não é.
  • Contém até 63 caracteres e apenas letras minúsculas, números e hífens.
  • É exclusivo em um espaço. Um app de chat não pode usar o mesmo ID personalizado para mensagens diferentes.

Para mais detalhes, consulte Nomear uma mensagem.

MessageReplyOption

Especifica como responder a uma mensagem. Outros estados podem ser adicionados no futuro.

Tipos enumerados
MESSAGE_REPLY_OPTION_UNSPECIFIED Padrão. Inicia uma nova conversa. Usar essa opção ignora qualquer thread ID ou thread_key incluído.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD Cria a mensagem como uma resposta à conversa especificada por thread ID ou thread_key. Se isso não acontecer, a mensagem vai iniciar uma nova conversa.
REPLY_MESSAGE_OR_FAIL Cria a mensagem como uma resposta à conversa especificada por thread ID ou thread_key. Se um novo thread_key for usado, uma nova linha de execução será criada. Se a criação da mensagem falhar, um erro NOT_FOUND será retornado.

CreateReactionRequest

Cria uma reação a uma mensagem.

Campos
parent

string

Obrigatório. A mensagem em que a reação é criada.

Formato: spaces/{space}/messages/{message}
reaction

Reaction

Obrigatório. A reação a ser criada.

CreateSpaceRequest

Uma solicitação para criar um espaço nomeado sem participantes.

Campos
space

Space

Obrigatório. Os campos displayName e spaceType precisam ser preenchidos. Somente SpaceType.SPACE e SpaceType.GROUP_CHAT são aceitos. SpaceType.GROUP_CHAT só pode ser usado se importMode estiver definido como "true".

Se você receber a mensagem de erro ALREADY_EXISTS, tente usar um displayName diferente. Um espaço na organização do Google Workspace já pode usar esse nome de exibição.

O espaço name é atribuído no servidor, então tudo que for especificado nesse campo será ignorado.
request_id

string

Opcional. Um identificador exclusivo para esta solicitação. Recomendamos um UUID aleatório. Especificar um ID de solicitação existente retorna o espaço criado com esse ID em vez de criar um novo. Especificar um ID de solicitação existente do mesmo app do Chat com um usuário autenticado diferente retorna um erro.

CustomEmoji

Representa um emoji personalizado.

Campos
name

string

Identificador. O nome do recurso do emoji personalizado, atribuído pelo servidor.

Formato: customEmojis/{customEmoji}
uid

string

Apenas saída. Chave exclusiva do recurso de emoji personalizado.
emoji_name

string

Opcional. Imutável. Nome fornecido pelo usuário para o emoji personalizado, que é exclusivo na organização.

Obrigatório quando o emoji personalizado é criado. Caso contrário, é somente saída.

Os nomes de emojis precisam começar e terminar com dois pontos, estar em letras minúsculas e só podem conter caracteres alfanuméricos, hífens e sublinhados. Use hífens e sublinhados para separar palavras e nunca consecutivamente.

Exemplo: :valid-emoji-name:
temporary_image_uri

string

Apenas saída. Um URL de imagem temporário para o emoji personalizado, válido por pelo menos 10 minutos. Essa informação não é preenchida na resposta quando o emoji personalizado é criado.
payload

CustomEmojiPayload

Opcional. Somente entrada. Dados de payload. Obrigatório quando o emoji personalizado é criado.

CustomEmojiPayload

Dados de payload do emoji personalizado.

Campos
file_content

bytes

Obrigatório. Somente entrada. A imagem usada para o emoji personalizado.

O payload precisa ter menos de 256 KB, e a dimensão da imagem precisa ser quadrada e estar entre 64 e 500 pixels. As restrições estão sujeitas a mudanças.
filename

string

Obrigatório. Somente entrada. O nome do arquivo de imagem.

Extensões de arquivo aceitas: .png, .jpg, .gif.

CustomEmojiMetadata

Metadados de anotação para emojis personalizados.

Campos
custom_emoji

CustomEmoji

O emoji personalizado.

DeleteCustomEmojiRequest

Solicitação para excluir um emoji personalizado.

Campos
name

string

Obrigatório. Nome do recurso do emoji personalizado a ser excluído.

Formato: customEmojis/{customEmoji}

Você pode usar o nome do emoji como um alias para {customEmoji}. Por exemplo, customEmojis/:example-emoji:, em que :example-emoji: é o nome de um emoji personalizado.

DeleteMembershipRequest

Solicitação para excluir uma associação em um espaço.

Campos
name

string

Obrigatório. Nome do recurso da assinatura a ser excluída. Os apps de chat podem excluir as assinaturas dos usuários humanos ou as próprias. Os apps de chat não podem excluir assinaturas de outros apps.

Ao excluir uma assinatura humana, é necessário o escopo chat.memberships com autenticação do usuário ou o escopo chat.memberships.app com autenticação do app e o formato spaces/{space}/members/{member}. Você pode usar o e-mail como um alias para {member}. Por exemplo, spaces/{space}/members/[email protected], em que [email protected] é o e-mail do usuário do Google Chat.

Ao excluir uma assinatura de app, exige o escopo chat.memberships.app e o formato spaces/{space}/members/app.

Formato: spaces/{space}/members/{member} ou spaces/{space}/members/app.
use_admin_access

bool

Opcional. Quando true, o método é executado usando os privilégios de administrador do Google Workspace do usuário.

O usuário que faz a chamada precisa ser um administrador do Google Workspace com o privilégio de gerenciar conversas no Chat e nos espaços.

Requer o escopo do OAuth 2.0 chat.admin.memberships.

Não é possível excluir as associações de apps em um espaço usando o acesso de administrador.

DeleteMessageRequest

Solicitação para excluir uma mensagem.

Campos
name

string

Obrigatório. Nome do recurso da mensagem.

Formato: spaces/{space}/messages/{message}

Se você tiver definido um ID personalizado para sua mensagem, use o valor do campo clientAssignedMessageId para {message}. Para mais detalhes, consulte Nomear uma mensagem.
force

bool

Opcional. Quando true, excluir uma mensagem também exclui as respostas em linha dela. Quando false, se uma mensagem tiver respostas em conversa, a exclusão vai falhar.

Aplicável somente ao se autenticar como um usuário. Não tem efeito ao autenticar como um app do Chat.

DeleteReactionRequest

Exclui uma reação a uma mensagem.

Campos
name

string

Obrigatório. Nome da reação a ser excluída.

Formato: spaces/{space}/messages/{message}/reactions/{reaction}

DeleteSpaceRequest

Solicitação para excluir um espaço.

Campos
name

string

Obrigatório. Nome do recurso do espaço a ser excluído.

Formato: spaces/{space}
use_admin_access

bool

Opcional. Quando true, o método é executado usando os privilégios de administrador do Google Workspace do usuário.

O usuário que faz a chamada precisa ser um administrador do Google Workspace com o privilégio de gerenciar conversas no Chat e nos espaços.

Requer o escopo do OAuth 2.0 chat.admin.delete.

DeletionMetadata

Informações sobre uma mensagem excluída. Uma mensagem é excluída quando delete_time é definido.

Campos
deletion_type

DeletionType

Indica quem excluiu a mensagem.

DeletionType

Quem e como a mensagem foi excluída. Mais valores podem ser adicionados no futuro. Consulte Editar ou excluir uma mensagem no Google Chat para saber quando as mensagens podem ser excluídas.

Tipos enumerados
DELETION_TYPE_UNSPECIFIED Esse valor não é usado.
CREATOR O usuário excluiu a própria mensagem.
SPACE_OWNER Um administrador do espaço excluiu a mensagem.
ADMIN Um administrador do Google Workspace excluiu a mensagem. Os administradores podem excluir qualquer mensagem no espaço, incluindo as enviadas por qualquer participante ou pelo app Chat.
APP_MESSAGE_EXPIRY Um app do Chat excluiu a própria mensagem quando ela expirou.
CREATOR_VIA_APP Um app de chat excluiu a mensagem em nome do criador (usando a autenticação do usuário).
SPACE_OWNER_VIA_APP Um app do Chat excluiu a mensagem em nome de um administrador do espaço (usando a autenticação do usuário).
SPACE_MEMBER Um participante do espaço excluiu a mensagem. Os usuários podem excluir mensagens enviadas por apps.

Caixa de diálogo

Wrapper ao redor do corpo do card da caixa de diálogo.

Campos
body

Card

Somente entrada. Corpo da caixa de diálogo, renderizado em um modal. Os apps do Google Chat não são compatíveis com as seguintes entidades de card: DateTimePicker e OnChangeAction.

DialogAction

Contém um diálogo e um código de status da solicitação.

Campos
action_status

ActionStatus

Somente entrada. Status de uma solicitação para invocar ou enviar um diálogo. Mostra um status e uma mensagem aos usuários, se necessário. Por exemplo, em caso de erro ou sucesso.
Campo de união action. Ação a ser realizada. action pode ser apenas de um dos tipos a seguir:
dialog

Dialog

Somente entrada. Dialog para a solicitação.

DriveDataRef

Uma referência aos dados de um anexo do Drive.

Campos
drive_file_id

string

O ID do arquivo do Drive. Use com a API Drive.

DriveLinkData

Dados para links do Google Drive.

Campos
drive_data_ref

DriveDataRef

Um DriveDataRef que faz referência a um arquivo do Google Drive.
mime_type

string

O tipo MIME do recurso vinculado do Google Drive.

Emoji

Um emoji usado como reação a uma mensagem.

Campos
Campo de união content. Obrigatório. O conteúdo do emoji. content pode ser apenas de um dos tipos a seguir:
unicode

string

Opcional. Um emoji básico representado por uma string Unicode.
custom_emoji

CustomEmoji

Um emoji personalizado.

EmojiReactionSummary

O número de pessoas que reagiram a uma mensagem com um emoji específico.

Campos
emoji

Emoji

Apenas saída. Emoji associado às reações.
reaction_count

int32

Apenas saída. O número total de reações usando o emoji associado.

FindDirectMessageRequest

Uma solicitação para receber o espaço de mensagem direta com base no recurso do usuário.

Campos
name

string

Obrigatório. Nome do recurso do usuário para encontrar a mensagem direta.

Formato: users/{user}, em que {user} é o id da pessoa na API People ou o id do usuário na API Directory. Por exemplo, se o ID do perfil da API People for 123456789, você poderá encontrar uma mensagem direta com essa pessoa usando users/123456789 como name. Quando autenticado como um usuário, você pode usar o e-mail como um alias para {user}. Por exemplo, users/[email protected], em que [email protected] é o e-mail do usuário do Google Chat.

GetAttachmentRequest

Solicitação para receber um anexo.

Campos
name

string

Obrigatório. Nome do recurso do anexo, no formato spaces/{space}/messages/{message}/attachments/{attachment}.

GetCustomEmojiRequest

Uma solicitação para retornar um único emoji personalizado.

Campos
name

string

Obrigatório. Nome do recurso do emoji personalizado.

Formato: customEmojis/{customEmoji}

Você pode usar o nome do emoji como um alias para {customEmoji}. Por exemplo, customEmojis/:example-emoji:, em que :example-emoji: é o nome de um emoji personalizado.

GetMembershipRequest

Solicitação para receber uma participação em um espaço.

Campos
name

string

Obrigatório. Nome do recurso da assinatura a ser recuperada.

Para receber a assinatura do app usando a autenticação do usuário, você pode usar spaces/{space}/members/app (link em inglês) de maneira opcional.

Formato: spaces/{space}/members/{member} ou spaces/{space}/members/app

Você pode usar o e-mail do usuário como um alias para {member}. Por exemplo, spaces/{space}/members/[email protected], em que [email protected] é o e-mail do usuário do Google Chat.
use_admin_access

bool

Opcional. Quando true, o método é executado usando os privilégios de administrador do Google Workspace do usuário.

O usuário que faz a chamada precisa ser um administrador do Google Workspace com o privilégio de gerenciar conversas no Chat e nos espaços.

Requer os escopos do OAuth 2.0 chat.admin.memberships ou chat.admin.memberships.readonly.

Não é possível acessar as assinaturas de apps em um espaço usando o acesso de administrador.

GetMessageRequest

Solicitação para receber uma mensagem.

Campos
name

string

Obrigatório. Nome do recurso da mensagem.

Formato: spaces/{space}/messages/{message}

Se você tiver definido um ID personalizado para sua mensagem, use o valor do campo clientAssignedMessageId para {message}. Para mais detalhes, consulte Nomear uma mensagem.

GetSpaceEventRequest

Mensagem de solicitação para receber um evento de espaço.

Campos
name

string

Obrigatório. O nome do recurso do evento do espaço.

Formato: spaces/{space}/spaceEvents/{spaceEvent}

GetSpaceNotificationSettingRequest

Mensagem de solicitação para receber a configuração de notificação do espaço. Só é possível receber a configuração de notificação do usuário que fez a chamada.

Campos
name

string

Obrigatório. Formato: users/{user}/spaces/{space}/spaceNotificationSetting

  • users/me/spaces/{space}/spaceNotificationSetting, OU
  • users/[email protected]/spaces/{space}/spaceNotificationSetting, OU
  • users/123456789/spaces/{space}/spaceNotificationSetting. Observação: apenas o ID do usuário ou o e-mail do autor da chamada são permitidos no caminho.

GetSpaceReadStateRequest

Mensagem de solicitação para a API GetSpaceReadState.

Campos
name

string

Obrigatório. Nome do recurso do estado de leitura do espaço a ser recuperado.

Só é possível receber o estado de leitura do usuário que faz a chamada.

Para se referir ao usuário que está fazendo a chamada, defina uma das seguintes opções:

  • O alias me. Por exemplo, users/me/spaces/{space}/spaceReadState.

  • O endereço de e-mail do Workspace. Por exemplo, users/[email protected]/spaces/{space}/spaceReadState.

  • O ID do usuário. Por exemplo, users/123456789/spaces/{space}/spaceReadState.

Formato: users/{user}/spaces/{space}/spaceReadState

GetSpaceRequest

Uma solicitação para retornar um único espaço.

Campos
name

string

Obrigatório. Nome do recurso do espaço, no formato spaces/{space}.

Formato: spaces/{space}
use_admin_access

bool

Opcional. Quando true, o método é executado usando os privilégios de administrador do Google Workspace do usuário.

O usuário que faz a chamada precisa ser um administrador do Google Workspace com o privilégio de gerenciar conversas no Chat e nos espaços.

Requer os escopos do OAuth 2.0 chat.admin.spaces ou chat.admin.spaces.readonly.

GetThreadReadStateRequest

Mensagem de solicitação para a API GetThreadReadStateRequest.

Campos
name

string

Obrigatório. Nome do recurso do estado de leitura da conversa a ser recuperado.

Só é possível receber o estado de leitura do usuário que faz a chamada.

Para se referir ao usuário que está fazendo a chamada, defina uma das seguintes opções:

  • O alias me. Por exemplo, users/me/spaces/{space}/threads/{thread}/threadReadState.

  • O endereço de e-mail do Workspace. Por exemplo, users/[email protected]/spaces/{space}/threads/{thread}/threadReadState.

  • O ID do usuário. Por exemplo, users/123456789/spaces/{space}/threads/{thread}/threadReadState.

Formato: users/{user}/spaces/{space}/threads/{thread}/threadReadState

Grupo

Um grupo do Google no Google Chat.

Campos
name

string

Nome do recurso de um Grupo do Google.

Representa um grupo na API Cloud Identity Groups.

Formato: groups/{group}

HistoryState

O estado do histórico de mensagens e espaços. Especifica por quanto tempo as mensagens e as conversas são mantidas após a criação.

Tipos enumerados
HISTORY_STATE_UNSPECIFIED Valor padrão. Não use.
HISTORY_OFF Histórico desativado. As mensagens e conversas são mantidas por 24 horas.
HISTORY_ON O histórico está ativado. As regras de retenção do Vault da organização especificam por quanto tempo as mensagens e conversas são mantidas.

ListCustomEmojisRequest

Uma solicitação para retornar uma lista de emojis personalizados.

Campos
page_size

int32

Opcional. O número máximo de emojis personalizados retornados. O serviço pode retornar menos emojis personalizados do que esse valor. Se não for especificado, o valor padrão será 25. O valor máximo é 200. Valores acima de 200 são alterados para 200.
page_token

string

Opcional. (Se você estiver retomando de uma consulta anterior.)

Um token de página recebido de uma chamada anterior para listar emojis personalizados. Forneça isso para recuperar a página subsequente.

Ao paginar, o valor do filtro precisa corresponder à chamada que forneceu o token da página. Passar um valor diferente pode levar a resultados inesperados.
filter

string

Opcional. Um filtro de consulta.

Permite filtrar por criador de conteúdo.

Para filtrar por criador de conteúdo, especifique um valor válido. No momento, apenas creator("users/me") e NOT creator("users/me") são aceitos para filtrar emojis personalizados e saber se eles foram criados pelo usuário que fez a chamada ou não.

Por exemplo, a consulta a seguir retorna emojis personalizados criados pelo autor da chamada:

creator("users/me")

Consultas inválidas são rejeitadas com um erro INVALID_ARGUMENT.

ListCustomEmojisResponse

Uma resposta para listar emojis personalizados.

Campos
custom_emojis[]

CustomEmoji

Lista não ordenada. Lista de emojis personalizados.
next_page_token

string

Um token que pode ser enviado como pageToken para recuperar a próxima página de resultados. Se estiver vazio, não haverá páginas subsequentes.

ListMembershipsRequest

Mensagem de solicitação para listar assinaturas.

Campos
parent

string

Obrigatório. O nome do recurso do espaço para o qual uma lista de assinaturas será buscada.

Formato: spaces/{space}
page_size

int32

Opcional. O número máximo de assinaturas a serem retornadas. O serviço pode retornar um valor inferior a este.

Se não for especificado, no máximo 100 assinaturas serão retornadas.

O valor máximo é 1.000. Se você usar um valor maior que 1.000, ele será mudado automaticamente para 1.000.

Valores negativos retornam um erro INVALID_ARGUMENT.
page_token

string

Opcional. Um token de página recebido de uma chamada anterior para listar assinaturas. Forneça esse parâmetro para recuperar a página seguinte.

Ao paginar, todos os outros parâmetros fornecidos precisam corresponder à chamada que forneceu o token da página. Transmitir valores diferentes para os outros parâmetros pode gerar resultados inesperados.
filter

string

Opcional. Um filtro de consulta.

É possível filtrar as assinaturas pelo papel (role) e tipo (member.type) de um membro.

Para filtrar por função, defina role como ROLE_MEMBER ou ROLE_MANAGER.

Para filtrar por tipo, defina member.type como HUMAN ou BOT. Também é possível filtrar member.type usando o operador !=.

Para filtrar por função e tipo, use o operador AND. Para filtrar por função ou tipo, use o operador OR.

É necessário member.type = "HUMAN" ou member.type != "BOT" quando use_admin_access está definido como verdadeiro. Outros filtros de tipo de membro serão rejeitados.

Por exemplo, as consultas a seguir são válidas:

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

As consultas a seguir são inválidas:

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

Consultas inválidas são rejeitadas pelo servidor com um erro INVALID_ARGUMENT.
show_groups

bool

Opcional. Quando true, também retorna as assinaturas associadas a um Google Group, além de outros tipos de assinaturas. Se um filter for definido, as associações Google Group que não corresponderem aos critérios de filtro não serão retornadas.
show_invited

bool

Opcional. Quando true, também retorna as assinaturas associadas aos membros invited, além de outros tipos de assinaturas. Se um filtro for definido, as assinaturas do invited que não corresponderem aos critérios do filtro não serão retornadas.

No momento, exige autenticação do usuário.
use_admin_access

bool

Opcional. Quando true, o método é executado usando os privilégios de administrador do Google Workspace do usuário.

O usuário que faz a chamada precisa ser um administrador do Google Workspace com o privilégio de gerenciar conversas no Chat e nos espaços.

Requer o escopo do OAuth 2.0 chat.admin.memberships.readonly ou chat.admin.memberships.

Não é possível listar as associações a apps em um espaço usando o acesso de administrador.

ListMembershipsResponse

Resposta para listar as participações no espaço.

Campos
memberships[]

Membership

Lista não ordenada. Lista de assinaturas na página solicitada (ou na primeira).
next_page_token

string

Um token que pode ser enviado como pageToken para recuperar a próxima página de resultados. Se estiver vazio, não haverá páginas subsequentes.

ListMessagesRequest

Lista as mensagens no espaço especificado de que o usuário é membro.

Campos
parent

string

Obrigatório. O nome do recurso do espaço para listar mensagens.

Formato: spaces/{space}
page_size

int32

Opcional. O número máximo de mensagens retornadas. O serviço pode retornar menos mensagens do que esse valor.

Se não for especificado, no máximo 25 serão retornados.

O valor máximo é 1.000. Se você usar um valor maior que 1.000, ele será mudado automaticamente para 1.000.

Valores negativos retornam um erro INVALID_ARGUMENT.
page_token

string

Opcional. Um token de página recebido de uma chamada "list messages" anterior. Forneça esse parâmetro para recuperar a página seguinte.

Ao paginar, todos os outros parâmetros fornecidos precisam corresponder à chamada que forneceu o token da página. Transmitir valores diferentes para os outros parâmetros pode gerar resultados inesperados.
filter

string

Opcional. Um filtro de consulta.

É possível filtrar as mensagens por data (create_time) e conversa (thread.name).

Para filtrar mensagens pela data de criação, especifique o create_time com um carimbo de data/hora no formato RFC-3339 e aspas duplas. Por exemplo, "2023-04-21T11:30:00-04:00". Você pode usar o operador maior que > para listar mensagens criadas após um carimbo de data/hora ou o operador menor que < para listar mensagens criadas antes de um carimbo de data/hora. Para filtrar mensagens em um intervalo de tempo, use o operador AND entre dois carimbos de data/hora.

Para filtrar por conversa, especifique o thread.name, formatado como spaces/{space}/threads/{thread}. É possível especificar apenas um thread.name por consulta.

Para filtrar por conversa e data, use o operador AND na consulta.

Por exemplo, as consultas a seguir são válidas:

create_time > "2012-04-21T11:30:00-04:00"

create_time > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

create_time > "2012-04-21T11:30:00+00:00" AND

create_time < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

Consultas inválidas são rejeitadas pelo servidor com um erro INVALID_ARGUMENT.
order_by

string

Opcional. Como a lista de mensagens é ordenada. Especifique um valor para ordenar por uma operação de ordenação. Estes são os valores válidos para a operação de ordenação:

  • ASC para crescente.

  • DESC para ordem decrescente.

A ordem padrão é create_time ASC.
show_deleted

bool

Opcional. Se as mensagens excluídas devem ser incluídas. As mensagens excluídas incluem a hora e os metadados da exclusão, mas o conteúdo da mensagem não está disponível.

ListMessagesResponse

Mensagem de resposta para listar mensagens.

Campos
messages[]

Message

Lista de mensagens.
next_page_token

string

É possível enviar um token como pageToken para recuperar a próxima página de resultados. Se estiver vazio, não haverá páginas subsequentes.

ListReactionsRequest

Lista as reações a uma mensagem.

Campos
parent

string

Obrigatório. A mensagem que recebeu a reação dos usuários.

Formato: spaces/{space}/messages/{message}
page_size

int32

Opcional. O número máximo de reações retornadas. O serviço pode retornar menos reações do que esse valor. Se não for especificado, o valor padrão será 25. O valor máximo é 200. Valores acima de 200 são alterados para 200.
page_token

string

Opcional. (Se você estiver retomando de uma consulta anterior.)

Um token de página recebido de uma chamada "list reactions" anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, o valor do filtro precisa corresponder à chamada que forneceu o token da página. Passar um valor diferente pode levar a resultados inesperados.
filter

string

Opcional. Um filtro de consulta.

É possível filtrar as reações por emoji (emoji.unicode ou emoji.custom_emoji.uid) e usuário (user.name).

Para filtrar reações de vários emojis ou usuários, combine campos semelhantes com o operador OR, como emoji.unicode = "🙂" OR emoji.unicode = "👍" e user.name = "users/AAAAAA" OR user.name = "users/BBBBBB".

Para filtrar reações por emoji e usuário, use o operador AND, como emoji.unicode = "🙂" AND user.name = "users/AAAAAA".

Se a consulta usar AND e OR, agrupe-os com parênteses.

Por exemplo, as consultas a seguir são válidas:

user.name = "users/{user}"
emoji.unicode = "🙂"
emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" AND user.name = "users/{user}"
(emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
AND user.name = "users/{user}"

As consultas a seguir são inválidas:

emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
AND user.name = "users/{user}"

Consultas inválidas são rejeitadas com um erro INVALID_ARGUMENT.

ListReactionsResponse

Resposta a uma solicitação de lista de reações.

Campos
reactions[]

Reaction

Lista de reações na página solicitada (ou na primeira).
next_page_token

string

Token de continuação para recuperar a próxima página de resultados. Ele fica vazio na última página de resultados.

ListSpaceEventsRequest

Mensagem de solicitação para listar eventos de espaço.

Campos
parent

string

Obrigatório. Nome do recurso do espaço do Google Chat em que os eventos ocorreram.

Formato: spaces/{space}.
page_size

int32

Opcional. O número máximo de eventos de espaço retornados. O serviço pode retornar um valor inferior a este.

Valores negativos retornam um erro INVALID_ARGUMENT.
page_token

string

Opcional. Um token de página recebido de uma chamada "list space events" anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para listar eventos do espaço precisam corresponder à chamada que forneceu o token da página. Transmitir valores diferentes para os outros parâmetros pode gerar resultados inesperados.
filter

string

Obrigatório. Um filtro de consulta.

É necessário especificar pelo menos um tipo de evento (event_type) usando o operador tem :. Para filtrar por vários tipos de eventos, use o operador OR. Omita os tipos de eventos em lote no seu filtro. A solicitação retorna automaticamente todos os eventos de lote relacionados. Por exemplo, se você filtrar por novas reações (google.workspace.chat.reaction.v1.created), o servidor também vai retornar eventos de novas reações em lote (google.workspace.chat.reaction.v1.batchCreated). Para conferir uma lista dos tipos de eventos aceitos, consulte a documentação de referência SpaceEvents.

Se quiser, filtre por horário de início (start_time) e horário de término (end_time):

  • start_time: carimbo de data/hora exclusivo a partir do qual começar a listar eventos de espaço. É possível listar eventos que ocorreram até 28 dias atrás. Se não for especificado, vai listar eventos de espaço dos últimos 28 dias.
  • end_time: carimbo de data/hora inclusivo até o qual os eventos de espaço são listados. Se não for especificado, listará eventos até o momento da solicitação.

Para especificar um horário de início ou de término, use o operador igual a = e o formato RFC-3339. Para filtrar por start_time e end_time, use o operador AND.

Por exemplo, as consultas a seguir são válidas:

start_time="2023-08-23T19:20:33+00:00" AND
end_time="2023-08-23T19:21:54+00:00"

start_time="2023-08-23T19:20:33+00:00" AND
(event_types:"google.workspace.chat.space.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created")

As consultas a seguir são inválidas:

start_time="2023-08-23T19:20:33+00:00" OR
end_time="2023-08-23T19:21:54+00:00"

event_types:"google.workspace.chat.space.v1.updated" AND
event_types:"google.workspace.chat.message.v1.created"

Consultas inválidas são rejeitadas pelo servidor com um erro INVALID_ARGUMENT.

ListSpaceEventsResponse

Mensagem de resposta para listar eventos do espaço.

Campos
space_events[]

SpaceEvent

Os resultados são retornados em ordem cronológica (o evento mais antigo primeiro). Observação: o campo permissionSettings não é retornado no objeto "Space" para solicitações de lista.
next_page_token

string

Token de continuação usado para buscar mais eventos. Se esse campo for omitido, não haverá páginas subsequentes.

ListSpacesRequest

Uma solicitação para listar os espaços de que o autor da chamada é membro.

Campos
page_size

int32

Opcional. O número máximo de espaços a serem retornados. O serviço pode retornar um valor inferior a este.

Se não for especificado, no máximo 100 espaços serão retornados.

O valor máximo é 1.000. Se você usar um valor maior que 1.000, ele será mudado automaticamente para 1.000.

Valores negativos retornam um erro INVALID_ARGUMENT.
page_token

string

Opcional. Um token de página recebido de uma chamada "list spaces" anterior. Forneça esse parâmetro para recuperar a página seguinte.

Ao paginar, o valor do filtro precisa corresponder à chamada que forneceu o token da página. Passar um valor diferente pode levar a resultados inesperados.
filter

string

Opcional. Um filtro de consulta.

É possível filtrar os espaços por tipo (space_type).

Para filtrar por tipo de espaço, especifique um valor de enumeração válido, como SPACE ou GROUP_CHAT (o space_type não pode ser SPACE_TYPE_UNSPECIFIED). Para consultar vários tipos de espaço, use o operador OR.

Por exemplo, as consultas a seguir são válidas:

space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

Consultas inválidas são rejeitadas pelo servidor com um erro INVALID_ARGUMENT.

ListSpacesResponse

A resposta para uma solicitação de lista de espaços.

Campos
spaces[]

Space

Lista de espaços na página solicitada (ou na primeira). Observação: o campo permissionSettings não é retornado no objeto "Space" para solicitações de lista.
next_page_token

string

É possível enviar um token como pageToken para recuperar a próxima página de resultados. Se estiver vazio, não haverá páginas subsequentes.

MatchedUrl

Uma URL correspondente em uma mensagem do Chat. Os apps de chat podem visualizar URLs correspondentes. Para mais informações, consulte Visualizar links.

Campos
url

string

Apenas saída. O URL que foi correspondido.

MeetSpaceLinkData

Dados para links de espaços do Meet.

Campos
meeting_code

string

Código da reunião do espaço vinculado do Meet.
type

Type

Indica o tipo de espaço do Meet.
huddle_status

HuddleStatus

Opcional. Apenas saída. Se o Meet for um Huddle, indica o status dele. Caso contrário, ele não será definido.

HuddleStatus

O status da conversa em grupo

Tipos enumerados
HUDDLE_STATUS_UNSPECIFIED Valor padrão para a enumeração. Não use.
STARTED A reunião rápida começou.
ENDED A reunião rápida foi encerrada. Nesse caso, o URI e os identificadores do espaço do Meet não serão mais válidos.
MISSED A reunião rápida foi perdida. Nesse caso, o URI e os identificadores do espaço do Meet não serão mais válidos.

Tipo

O tipo de espaço do Meet.

Tipos enumerados
TYPE_UNSPECIFIED Valor padrão para a enumeração. Não use.
MEETING O espaço do Meet é uma reunião.
HUDDLE O espaço do Meet é uma reunião rápida.

Associação

Representa uma relação de associação no Google Chat, como se um usuário ou app do Chat foi convidado para um espaço, faz parte dele ou não está presente.

Campos
name

string

Identificador. Nome do recurso da assinatura, atribuído pelo servidor.

Formato: spaces/{space}/members/{member}
state