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.

Requer autenticação de app e delegação em todo o domínio. 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.

Requer autenticação do usuário.

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 está fazendo 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 vai adicionar o participante diretamente ao espaço especificado.

Oferece suporte aos seguintes tipos de autenticação:

Para conferir 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. Confira um exemplo em Enviar uma mensagem.

O método create() requer autenticação do usuário ou autenticação do app. 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 de app. O Chat mostra o app do Chat como o remetente da mensagem. O conteúdo da mensagem pode incluir 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 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.

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. Somente emojis Unicode são aceitos. Para conferir um exemplo, consulte Adicionar uma reação a uma mensagem.

Requer autenticação do usuário.

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 conferir um exemplo, consulte Criar um espaço.

Oferece suporte aos seguintes tipos de autenticação:

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

A associação ao espaço na criação depende se ele foi criado em Import mode:

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

Se você receber a mensagem de erro ALREADY_EXISTS ao criar um espaço, tente usar um displayName diferente. Um espaço existente 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.

Requer autenticação do usuário.

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. Confira um exemplo em Remover um usuário ou um app do Google Chat de um espaço.

Oferece suporte aos seguintes tipos de autenticaçã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)

Excluir uma mensagem. Para conferir um exemplo, consulte Excluir uma mensagem.

Oferece suporte aos seguintes tipos de autenticação:

Ao usar a autenticação de app, as solicitações só podem excluir mensagens criadas pelo app de chat que faz 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. Somente emojis Unicode são aceitos. Confira um exemplo em Excluir uma reação.

Requer autenticação do usuário.

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.

Oferece suporte aos seguintes tipos de autenticação:

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, um erro 404 NOT_FOUND será retornado. Para conferir 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 mensagens diretas entre o usuário especificado e o usuário autenticado.

// Oferece suporte aos seguintes tipos de autenticação:

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 conferir um exemplo, consulte Receber metadados sobre um anexo de mensagem. Requer autenticação do app.

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.

Requer autenticação do usuário.

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. Confira um exemplo em Receber detalhes sobre a assinatura de um usuário ou do app do Google Chat.

Oferece suporte aos seguintes tipos de autenticação:

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.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 conferir um exemplo, consulte Receber detalhes sobre uma mensagem.

Oferece suporte aos seguintes tipos de autenticação:

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

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

GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

Retorna detalhes sobre um espaço. Confira um exemplo em Conferir detalhes sobre um espaço.

Oferece suporte aos seguintes tipos de autenticação:

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 mais tarde, 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 do evento "Space" para essa solicitação.

Requer autenticação do usuário. Para receber um evento, o usuário autenticado precisa ser membro do espaço.

Confira um exemplo em Receber detalhes sobre um evento em um espaço do Google Chat.

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.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 as configurações de estado da notificação do espaço.

Requer autenticação do usuário.

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. Confira um exemplo em Receber detalhes sobre o estado de leitura do espaço de um usuário.

Requer autenticação do usuário.

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. Para conferir um exemplo, consulte Receber detalhes sobre o estado de leitura de linha de um usuário.

Requer autenticação do usuário.

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.

Requer autenticação do usuário.

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. Confira um exemplo em Listar usuários e apps do Google Chat em um espaço. A listagem de adesões com autenticação de app lista as adesões em espaços a que o app Chat tem acesso, mas exclui as adesões do app Chat, incluindo as próprias. A listagem de associações com Autenticação do usuário lista as associações em espaços a que o usuário autenticado tem acesso.

Oferece suporte aos seguintes tipos de autenticação:

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.import
  • 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.

ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

Lista as mensagens em um espaço em que o autor da chamada é participante, incluindo mensagens de participantes e espaços bloqueados. 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 conferir um exemplo, consulte Listar mensagens.

Requer autenticação do usuário.

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

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

ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

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

Requer autenticação do usuário.

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 do 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 forem removidos durante o período solicitado, o payload do evento vai conter um recurso Membership vazio.

Requer autenticação do usuário. Para listar eventos, o usuário autenticado precisa ser membro do espaço.

Para conferir um 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.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 em que o autor da chamada é membro. Os chats em grupo e as DMs não são listados até que a primeira mensagem seja enviada. Confira um exemplo em Listar espaços.

Oferece suporte aos seguintes tipos de autenticação:

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.

Requer autenticação do usuário com privilégios de administrador. Na solicitação, defina use_admin_access como true.

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 usuários especificados a ele. O usuário que faz a chamada é adicionado automaticamente ao espaço e não precisa ser especificado como participante na solicitação. Para conferir um exemplo, consulte Configurar um espaço com os primeiros participantes.

Para especificar os membros humanos a serem adicionados, adicione as assinaturas com o membership.member.name apropriado. 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 da API People ou o id do usuário na API Directory. Por exemplo, se o ID do perfil da API People para user@example.com for 123456789, você poderá adicionar o usuário ao espaço definindo membership.member.name como users/user@example.com ou users/123456789.

Para especificar os Grupos do Google a serem adicionados, adicione associações com o membership.group_member.name apropriado. Para adicionar ou convidar um grupo do Google, use groups/{group}, em que {group} é o id do grupo da API Cloud Identity Groups. Por exemplo, é possível usar a API de pesquisa de grupos da Cloud Identity para extrair o ID 123456789 do e-mail do grupo group@example.com e, em seguida, adicionar o grupo ao espaço definindo membership.group_member.name como groups/123456789. Não é possível usar e-mails de grupo, e os grupos do Google só podem ser adicionados como membros em espaços nomeados.

Em um espaço com nome 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, esses participantes não serão adicionados 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 falhará e a DM não será criada.

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

Se uma DM já existir entre dois usuários, mesmo que um deles bloqueie o outro no momento em que uma solicitação é feita, a DM atual 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 um displayName diferente. Um espaço existente na organização do Google Workspace já pode usar esse nome de exibição.

Requer autenticação do usuário.

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 conferir um exemplo, consulte Atualizar a associação de um usuário a um espaço.

Oferece suporte aos seguintes tipos de autenticaçã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

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 o uso do método patch. Para conferir um exemplo, consulte Atualizar uma mensagem.

Oferece suporte aos seguintes tipos de autenticação:

Ao usar a autenticação de app, as solicitações só podem atualizar mensagens criadas pelo app de chat que faz 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. Confira um exemplo em 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 existente na organização do Google Workspace já pode usar esse nome de exibição.

Oferece suporte aos seguintes tipos de autenticação:

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 as configurações de estado da notificação do espaço.

Requer autenticação do usuário.

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 conferir um exemplo, consulte Atualizar o estado de leitura do espaço de um usuário.

Requer autenticação do usuário.

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 autenticação ou configuração dos usuários. (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 por ResponseType.Dialog.

updated_widget

UpdatedWidget

Somente entrada. A resposta do widget atualizado.

ResponseType

O tipo de resposta do app Chat.

Enums
TYPE_UNSPECIFIED Tipo padrão que é processado como NEW_MESSAGE.
NEW_MESSAGE Publique 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 Atualizar os cards na 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 Peça ao usuário para fazer uma 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

A resposta do widget atualizado. Usado para fornecer opções de preenchimento automático para um widget.

Campos
widget

string

O ID do widget atualizado. O ID precisa ser igual 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 que 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. Anotações associadas ao corpo de texto simples da mensagem. Para adicionar formatação básica a uma mensagem de texto, consulte Formatar mensagens de texto.

Exemplo de corpo de mensagem em 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 da anotação.

length

int32

Comprimento da substring no corpo da mensagem de texto simples a que esta anotação corresponde.

start_index

int32

Índice inicial (com base em 0, inclusive) no corpo da mensagem de texto simples ao qual essa 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 do usuário.

slash_command

SlashCommandMetadata

Os metadados de um comando de barra.

AnnotationType

Tipo da anotação.

Enums
ANNOTATION_TYPE_UNSPECIFIED Valor padrão do tipo enumerado. Não use.
USER_MENTION Um usuário é mencionado.
SLASH_COMMAND Um comando de barra é invocado.

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 do arquivo original 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 mostrar o anexo a um usuário humano. Os apps de chat não podem usar esse URL para fazer o download do conteúdo do anexo.

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 fazer o download do conteúdo do anexo.

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 fazer o download dos 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.

Enums
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 de chat com anexos.

CardWithId

Um card em uma mensagem do Google Chat.

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

Crie e visualize cards com o Criador de cards.

Abrir o criador de cards

Campos
card_id

string

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

card

Card

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

ChatSpaceLinkData

Dados para links do espaço do Chat.

Campos
space

string

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

Formato: spaces/{space}

thread

string

A linha do recurso do espaço do Chat vinculado.

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

message

string

A mensagem do recurso do 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 especificar 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

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

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

Campos
action_label

string

O rótulo usado para mostrar o item do menu de ações.

on_click

OnClick

A ação onclick para este item de ação.

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 ocupará as duas linhas.

subtitle

string

O subtítulo do cabeçalho do card.

image_style

ImageStyle

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

image_url

string

O URL da imagem no cabeçalho do card.

ImageStyle

Enums
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. Por isso, atualmente não é necessário usar propriedades de layout (por exemplo, float).

Campos
header

string

O cabeçalho da seção. Texto formatado é aceito. Para mais informações sobre a formatação de texto, consulte Formatar texto em apps do Google Chat e Formatar texto em 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 associação.

Campos
parent

string

Obrigatório. O nome do recurso do espaço em que 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 determinados campos:

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

  • Ao autenticação como um app, o escopo de autorização chat.app.memberships é necessário. A autenticação como app está disponível em

  • Defina user.type como HUMAN e user.name como 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 da API People ou o id do usuário na API Directory. Por exemplo, se o ID do perfil da API People para user@example.com for 123456789, você poderá adicionar o usuário ao espaço definindo membership.member.name como users/user@example.com ou users/123456789.

Convite usuários externos à organização do Workspace que é proprietária do espaço para autenticação do usuário.

Quando um app de chat cria uma relação de associação para si mesmo, ele precisa se autenticar como um usuário e usar o escopo chat.memberships.app, definir user.type como BOT e 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 chats e conversas em espaços.

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

O acesso de administrador não permite criar assinaturas de apps ou assinaturas para usuários fora da organização do Google Workspace do 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 linha de execução. Aceita até 4.000 caracteres. Para iniciar ou adicionar uma conversa, crie uma mensagem e especifique um threadKey ou o thread.name. Para conferir um exemplo de uso, consulte Iniciar ou responder a uma conversa.

request_id

string

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

message_reply_option

MessageReplyOption

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

Esse campo é ignorado quando responde a interações do usuário. Para interações em uma conversa, a resposta é criada na mesma conversa. Caso contrário, a resposta será criada como uma nova linha de execução.

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 hifens.
  • É exclusivo em um espaço. Um app de chat não pode usar o mesmo ID personalizado para mensagens diferentes.

Confira mais detalhes em Nomear uma mensagem.

MessageReplyOption

Especifica como responder a uma mensagem. Mais estados poderão ser adicionados no futuro.

Enums
MESSAGE_REPLY_OPTION_UNSPECIFIED Padrão. Inicia um novo thread. O uso dessa 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 ela falhar, a mensagem vai iniciar uma nova linha de execução.
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 foi 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ó poderá ser usado se importMode estiver definido como verdadeiro.

Se você receber a mensagem de erro ALREADY_EXISTS, tente usar um displayName diferente. Um espaço existente 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 o que for especificado nesse campo será ignorado.

request_id

string

Opcional. Um identificador exclusivo para essa solicitação. Recomendamos um UUID aleatório. Especificar um ID de solicitação atual retorna o espaço criado com esse ID em vez de criar um novo espaço. Especificar um ID de solicitação do mesmo app de 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 para o 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, apenas saída.

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

Exemplo: :valid-emoji-name:

temporary_image_uri

string

Apenas saída. O URL da imagem do emoji personalizado, válido por pelo menos 10 minutos. Ele não é preenchido 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 estar entre 64 e 500 pixels. As restrições estão sujeitas a alterações.

filename

string

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

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

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 assinatura 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 assinaturas. Os apps de chat não podem excluir as assinaturas de outros apps.

Ao excluir uma associação humana, é necessário o escopo chat.memberships e o formato spaces/{space}/members/{member}. Você pode usar o e-mail como um alias para {member}. Por exemplo, spaces/{space}/members/example@gmail.com, em que example@gmail.com é o e-mail do usuário do Google Chat.

Ao excluir uma associação a um app, é necessário 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 chats e conversas em espaços.

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

Não é possível excluir as adesões a 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ê definiu um ID personalizado para a mensagem, use o valor do campo clientAssignedMessageId para {message}. Confira mais detalhes em Nomear uma mensagem.

force

bool

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

Aplicável apenas quando a autenticação como usuário é realizada. Não tem efeito ao autenticação como um app de 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 chats e conversas em 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 é definida.

Campos
deletion_type

DeletionType

Indica quem excluiu a mensagem.

DeletionType

Quem excluiu a mensagem e como ela foi excluída. Outros valores podem ser adicionados no futuro.

Enums
DELETION_TYPE_UNSPECIFIED Esse valor não é usado.
CREATOR O usuário excluiu a própria mensagem.
SPACE_OWNER O proprietário do espaço excluiu a mensagem.
ADMIN Um administrador do Google Workspace excluiu a mensagem.
APP_MESSAGE_EXPIRY Um app de chat excluiu a própria mensagem quando ela expirou.
CREATOR_VIA_APP Um app de chat excluiu a mensagem em nome do usuário.
SPACE_OWNER_VIA_APP Um app de chat excluiu a mensagem em nome do proprietário do espaço.

Dialog

Wrapper em torno 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 oferecem suporte às seguintes entidades de card: DateTimePicker, OnChangeAction.

DialogAction

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

Campos
action_status

ActionStatus

Somente entrada. Status de uma solicitação para invocar ou enviar uma caixa de 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

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

mime_type

string

O tipo MIME do recurso do Google Drive vinculado.

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

Apenas saída. 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 espaço de mensagem direta com base no recurso do usuário.

Campos
name

string

Obrigatório. Nome do recurso do usuário com quem você quer encontrar uma mensagem direta.

Formato: users/{user}, em que {user} é o id da pessoa da 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 autenticados como um usuário, é possível usar o e-mail como um alias para {user}. Por exemplo, users/example@gmail.com, em que example@gmail.com é 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 adquirir uma assinatura de 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, use spaces/{space}/members/app.

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

É possível usar o e-mail do usuário como um alias para {member}. Por exemplo, spaces/{space}/members/example@gmail.com, em que example@gmail.com é 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 chats e conversas em espaços.

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

Não é possível receber assinaturas de apps em um espaço ao usar 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ê definiu um ID personalizado para a mensagem, use o valor do campo clientAssignedMessageId para {message}. Confira mais detalhes em 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ó oferece suporte para a configuração de notificação do usuário que faz a chamada.

Campos
name

string

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

  • users/me/spaces/{space}/spaceNotificationSetting, OU
  • users/user@example.com/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 é permitido 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ó oferece suporte para receber o estado de leitura do usuário que fez a chamada.

Para se referir ao usuário que fez 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/user@example.com/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 chats e conversas em espaços.

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

GetThreadReadStateRequest

Solicita uma mensagem para a API GetThreadReadStateRequest.

Campos
name

string

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

Só oferece suporte para receber o estado de leitura do usuário que fez a chamada.

Para se referir ao usuário que fez 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/user@example.com/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 linhas de conversa são mantidas após a criação.

Enums
HISTORY_STATE_UNSPECIFIED Valor padrão. Não use.
HISTORY_OFF Histórico desativado. As mensagens e as conversas são mantidas por 24 horas.
HISTORY_ON Histórico ativado. As regras de retenção do Vault da organização especificam por quanto tempo as mensagens e as linhas de conversa 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 disso são alterados para 200.

page_token

string

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

Um token de página recebido de uma chamada de emoji personalizado de lista anterior. Forneça isso para recuperar a página subsequente.

Ao fazer a paginação, o valor do filtro precisa corresponder à chamada que forneceu o token da página. Transmitir um valor diferente pode levar a resultados inesperados.

filter

string

Opcional. Um filtro de consulta.

Suporte para filtragem por criador de conteúdo.

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

Por exemplo, a consulta a seguir retorna o emoji personalizado criado pelo autor da chamada:

creator("users/me")

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

ListCustomEmojisResponse

Uma resposta a uma lista de emojis personalizados.

Campos
custom_emojis[]

CustomEmoji

Lista não ordenada. Lista de emojis personalizados na página solicitada (ou 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.

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 membros será buscada.

Formato: spaces/{space}

page_size

int32

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

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á alterado 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 as assinaturas. Forneça esse parâmetro para recuperar a página seguinte.

Na paginação, todos os outros parâmetros enviados 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 por função (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.

member.type = "HUMAN" ou member.type != "BOT" são necessários quando use_admin_access é 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 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 assinaturas associadas a membros invited, além de outros tipos de assinaturas. Se um filtro for definido, as assinaturas de invited que não corresponderem aos critérios do filtro não serão retornadas.

Atualmente, 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 chats e conversas em 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 quando você usa o acesso de administrador.

ListMembershipsResponse

Resposta para listar os participantes do espaço.

Campos
memberships[]

Membership

Lista não ordenada. Lista de assinaturas na página solicitada (ou 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 em que o usuário é membro.

Campos
parent

string

Obrigatório. O nome do recurso do espaço de onde as mensagens serão listadas.

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á alterado automaticamente para 1.000.

Valores negativos retornam um erro INVALID_ARGUMENT.

page_token

string

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

Na paginação, todos os outros parâmetros enviados 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 mensagens por data (create_time) e linha de 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 as mensagens criadas após um carimbo de data/hora ou o operador menor que < para listar as 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 linha de execução, especifique thread.name formatado como spaces/{space}/threads/{thread}. Só é possível especificar um thread.name por consulta.

Para filtrar por linha de execução 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 é organizada. Especifique um valor para classificar por uma operação de ordenação. Os valores válidos da operação de ordenação são os seguintes:

  • ASC para ordem crescente.

  • DESC para ordem decrescente.

A ordenação padrão é create_time ASC.

show_deleted

bool

Opcional. Incluir mensagens excluídas. As mensagens excluídas incluem a hora da exclusão e os metadados sobre ela, 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

Você pode 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 os usuários reagiram.

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 disso são alterados para 200.

page_token

string

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

Um token de página recebido de uma chamada de lista de reações anterior. Forneça isso para recuperar a página subsequente.

Ao fazer a paginação, o valor do filtro precisa corresponder à chamada que forneceu o token da página. Transmitir 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-as 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 pelo servidor 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 primeira).

next_page_token

string

Token de continuação para recuperar a próxima página de resultados. Ele está vazio para a ú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 menos que esse valor.

Valores negativos retornam um erro INVALID_ARGUMENT.

page_token

string

Opcional. Um token de página recebido de uma chamada de eventos de espaço da lista anterior. Forneça isso para recuperar a página subsequente.

Na paginação, todos os outros parâmetros enviados para listar eventos de espaço precisam corresponder à chamada que forneceu o token da página. A transmissão de 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 :. Para filtrar por vários tipos de evento, use o operador OR. Omita os tipos de eventos em lote no filtro. A solicitação retorna automaticamente todos os eventos em 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 de tipos de eventos com suporte, consulte a documentação de referência da SpaceEvents.

Também é possível filtrar por horário de início (start_time) e de término (end_time):

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

Para especificar um horário de início ou término, use o operador = igual e o formato no 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 em 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 menos que esse valor.

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á alterado automaticamente para 1.000.

Valores negativos retornam um erro INVALID_ARGUMENT.

page_token

string

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

Ao fazer a paginação, o valor do filtro precisa corresponder à chamada que forneceu o token da página. Transmitir um valor diferente pode levar a resultados inesperados.

filter

string

Opcional. Um filtro de consulta.

Você pode filtrar os espaços pelo tipo (space_type).

Para filtrar por tipo de espaço, especifique um valor de tipo enumerado 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 primeira). Observação: o campo permissionSettings não é retornado no objeto Space para solicitações de lista.

next_page_token

string

Você pode enviar um token como pageToken para recuperar a próxima página de resultados. Se estiver vazio, não haverá páginas subsequentes.

MatchedUrl

Um 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 encontrado.

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 está ausente.

Campos
name

string

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

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

state

MembershipState

Apenas saída. Estado da assinatura.

role

MembershipRole

Opcional. O papel do usuário em um espaço do Chat, que determina as ações permitidas no espaço.

Esse campo só pode ser usado como entrada em UpdateMembership.

create_time

Timestamp

Opcional. Imutável. O horário de criação da assinatura, como quando um participante entrou ou foi convidado para participar de um espaço. Esse campo é apenas de saída, exceto quando usado para importar associações históricas em espaços do modo de importação.

delete_time

Timestamp

Opcional. Imutável. O horário de exclusão da associação, como quando um participante saiu ou foi removido de um espaço. Esse campo é apenas de saída, exceto quando usado para importar associações históricas em espaços do modo de importação.

Campo de união memberType. Membro associado a esta assinatura. Outros tipos de membros poderão ser aceitos no futuro. memberType pode ser apenas de um dos tipos a seguir:
member

User

Opcional. O usuário ou app do Google Chat ao qual a associação corresponde. Se o app de chat se autenticar como um usuário, a saída vai preencher o usuário name e type.

group_member

Group

Opcional. O grupo do Google ao qual a associação corresponde.

A leitura ou a mutação de associações aos Grupos do Google exige a autenticação do usuário.

MembershipRole

Representa as ações permitidas de um usuário em um espaço do Chat. Mais valores de enumeração podem ser adicionados no futuro.

Enums
MEMBERSHIP_ROLE_UNSPECIFIED Valor padrão. Para users: essa pessoa não é participante do espaço, mas pode ser convidada. Para Google Groups: eles sempre recebem essa função. Outros valores de tipo enumerado podem ser usados no futuro.
ROLE_MEMBER Um participante do espaço. O usuário tem permissões básicas, como enviar mensagens para o espaço. Nas conversas individuais e em grupo sem nome, todos têm essa função.
ROLE_MANAGER Um administrador do espaço. O usuário tem todas as permissões básicas e administrativas que permitem gerenciar o espaço, como adicionar ou remover participantes. Somente compatível com SpaceType.SPACE.

MembershipState

Especifica a relação do participante com um espaço. Outros estados de associação poderão ser aceitos no futuro.

Enums
MEMBERSHIP_STATE_UNSPECIFIED Valor padrão. Não use.
JOINED O usuário é adicionado ao espaço e pode participar dele.
INVITED O usuário recebeu um convite para participar do espaço, mas ainda não entrou nele.
NOT_A_MEMBER O usuário não pertence ao espaço e não tem um convite pendente para participar dele.

MembershipBatchCreatedEventData

Payload do evento para várias assinaturas novas.

Tipo de evento: google.workspace.chat.membership.v1.batchCreated

Campos
memberships[]

MembershipCreatedEventData

Uma lista de novos Clubes dos canais.

MembershipBatchDeletedEventData

Payload do evento para várias assinaturas excluídas.

Tipo de evento: google.workspace.chat.membership.v1.batchDeleted

Campos
memberships[]

MembershipDeletedEventData

Uma lista de assinaturas excluídas.

MembershipBatchUpdatedEventData

Payload do evento para várias assinaturas atualizadas.

Tipo de evento: google.workspace.chat.membership.v1.batchUpdated

Campos
memberships[]

MembershipUpdatedEventData

Uma lista de assinaturas atualizadas.

MembershipCreatedEventData

Payload do evento para uma nova assinatura.

Tipo de evento: google.workspace.chat.membership.v1.created.

Campos
membership

Membership

A nova assinatura.

MembershipDeletedEventData

Payload do evento para uma associação excluída.

Tipo de evento: google.workspace.chat.membership.v1.deleted

Campos
membership

Membership

A assinatura excluída. Somente os campos name e state são preenchidos.

MembershipUpdatedEventData

Payload do evento para uma assinatura atualizada.

Tipo de evento: google.workspace.chat.membership.v1.updated

Campos
membership

Membership

A assinatura atualizada.

Mensagem

Uma mensagem em um espaço do Google Chat.

Campos
name

string

Identificador. Nome do recurso da mensagem.

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

Em que {space} é o ID do espaço em que a mensagem é postada e {message} é um ID atribuído pelo sistema para a mensagem. Por exemplo, spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

Se você definir um ID personalizado ao criar uma mensagem, poderá usar esse ID para especificar a mensagem em uma solicitação substituindo {message} pelo valor do campo clientAssignedMessageId. Por exemplo, spaces/AAAAAAAAAAA/messages/client-custom-name. Confira mais detalhes em Nomear uma mensagem.

sender

User

Apenas saída. O usuário que criou a mensagem. Se o app de chat se autenticar como um usuário, a saída vai preencher o usuário name e type.

create_time

Timestamp

Opcional. Imutável. Para espaços criados no Chat, a hora em que a mensagem foi criada. Esse campo é somente saída, exceto quando usado em espaços do modo de importação.

Para espaços no modo de importação, defina esse campo como o carimbo de data/hora histórico em que a mensagem foi criada na origem para preservar o horário de criação original.

last_update_time

Timestamp

Apenas saída. A hora em que a mensagem foi editada pela última vez por um usuário. Se a mensagem nunca foi editada, esse campo estará vazio.

delete_time

Timestamp

Apenas saída. A hora em que a mensagem foi excluída no Google Chat. Se a mensagem nunca for excluída, esse campo vai estar vazio.

text

string

Opcional. Corpo de texto simples da mensagem. O primeiro link para uma imagem, vídeo ou página da Web gera um ícone de visualização. Você também pode @mencionar um usuário do Google Chat ou todos no espaço.

Para saber como criar mensagens de texto, consulte Enviar uma mensagem.

formatted_text

string

Apenas saída. Contém a mensagem text com marcações adicionadas para comunicar a formatação. Esse campo pode não capturar toda a formatação visível na interface, mas inclui o seguinte:

  • Sintaxe de marcação para negrito, itálico, sublinhado, monoespaçado, bloco monoespaçado e lista com marcadores.

  • Menções de usuários usando o formato <users/{user}>.

  • Hiperlinks personalizados usando o formato <{url}|{rendered_text}>, em que a primeira string é o URL e a segunda é o texto renderizado. Por exemplo, <http://example.com|custom text>.

  • Emoji personalizado usando o formato :{emoji_name}:, por exemplo, :smile:. Isso não se aplica a emojis Unicode, como U+1F600 para um emoji de rosto sorridente.

Para mais informações, consulte Conferir a formatação de texto enviada em uma mensagem.

cards[]
(deprecated)

Card

Descontinuado: use cards_v2.

Cards avançados, formatados e interativos que podem ser usados para mostrar elementos de interface, como textos formatados, botões e imagens clicáveis. Os cards normalmente aparecem abaixo do corpo do texto simples da mensagem. cards e cards_v2 podem ter um tamanho máximo de 32 KB.

cards_v2[]

CardWithId

Opcional. Uma matriz de cards.

Somente os apps de chat podem criar cards. Se o app de chat se autenticar como um usuário, as mensagens não poderão conter cards.

Para saber como criar uma mensagem com cards, consulte Enviar uma mensagem.

Crie e visualize cards com o Criador de cards.

Abrir o criador de cards

annotations[]

Annotation

Apenas saída. Anotações associadas ao text nesta mensagem.

thread

Thread

A linha de execução à qual a mensagem pertence. Para conferir um exemplo de uso, consulte Iniciar ou responder a uma conversa.

space

Space

Apenas saída. Se o app de chat se autenticar como um usuário, a saída só vai preencher o espaço name.

fallback_text

string

Opcional. Uma descrição em texto simples dos cards da mensagem, usada quando os cards reais não podem ser exibidos, por exemplo, notificações para dispositivos móveis.

action_response

ActionResponse

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

argument_text

string

Apenas saída. Corpo de texto simples da mensagem sem nenhuma menção do app Chat.

slash_command

SlashCommand

Apenas saída. Informações sobre o comando de barra, se aplicável.

attachment[]

Attachment

Opcional. Anexo enviado pelo usuário.

matched_url

MatchedUrl

Apenas saída. Um URL em spaces.messages.text que corresponde a um padrão de visualização de link. Para mais informações, consulte Link de visualização.

thread_reply

bool

Apenas saída. Quando true, a mensagem é uma resposta em uma conversa. Quando false, a mensagem fica visível na conversa de nível superior do espaço como a primeira mensagem de uma conversa ou uma mensagem sem respostas agrupadas.

Se o espaço não oferecer suporte a respostas em conversas, esse campo será sempre false.

client_assigned_message_id

string

Opcional. Um ID personalizado para a mensagem. É possível usar o campo para identificar uma mensagem ou para receber, excluir ou atualizar uma mensagem. Para definir um ID personalizado, especifique o campo messageId ao criar a mensagem. Confira mais detalhes em Nomear uma mensagem.

emoji_reaction_summaries[]

EmojiReactionSummary

Apenas saída. A lista de resumos das reações com emojis na mensagem.

private_message_viewer

User

Opcional. Imutável. Entrada para criar uma mensagem, caso contrário, apenas saída. O usuário que pode acessar a mensagem. Quando definido, a mensagem é privada e só fica visível para o usuário especificado e para o app Chat. Para incluir esse campo na solicitação, chame a API Chat usando a autenticação do app e omita o seguinte:

Para mais detalhes, consulte Enviar uma mensagem particular.

deletion_metadata

DeletionMetadata

Apenas saída. Informações sobre uma mensagem excluída. Uma mensagem é excluída quando delete_time é definida.

quoted_message_metadata

QuotedMessageMetadata

Apenas saída. Informações sobre uma mensagem citada por um usuário do Google Chat em um espaço. Os usuários do Google Chat podem citar uma mensagem para responder a ela.

attached_gifs[]

AttachedGif

Apenas saída. Imagens GIF anexadas à mensagem.

accessory_widgets[]

AccessoryWidget

Opcional. Um ou mais widgets interativos que aparecem na parte de baixo de uma mensagem. É possível adicionar widgets a mensagens que contêm texto, cards ou ambos. Não é compatível com mensagens que contêm caixas de diálogo. Para mais detalhes, consulte Adicionar widgets interativos na parte de baixo de uma mensagem.

A criação de uma mensagem com widgets acessórios requer a autenticação do app.

MessageBatchCreatedEventData

Payload do evento para várias mensagens novas.

Tipo de evento: google.workspace.chat.message.v1.batchCreated

Campos
messages[]

MessageCreatedEventData

Uma lista de novas mensagens.

MessageBatchDeletedEventData

Payload do evento para várias mensagens excluídas.

Tipo de evento: google.workspace.chat.message.v1.batchDeleted

Campos
messages[]

MessageDeletedEventData

Uma lista de mensagens excluídas.

MessageBatchUpdatedEventData

Payload do evento para várias mensagens atualizadas.

Tipo de evento: google.workspace.chat.message.v1.batchUpdated

Campos
messages[]

MessageUpdatedEventData

Uma lista de mensagens atualizadas.

MessageCreatedEventData

Payload do evento para uma nova mensagem.

Tipo de evento: google.workspace.chat.message.v1.created

Campos
message

Message

A nova mensagem.

MessageDeletedEventData

Payload do evento para uma mensagem excluída.

Tipo de evento: google.workspace.chat.message.v1.deleted

Campos
message

Message

A mensagem excluída. Somente os campos name, createTime, deleteTime e deletionMetadata são preenchidos.

MessageUpdatedEventData

Payload do evento para uma mensagem atualizada.

Tipo de evento: google.workspace.chat.message.v1.updated

Campos
message

Message

A mensagem atualizada.

QuotedMessageMetadata

Informações sobre uma mensagem citada.

Campos
name

string

Apenas saída. Nome do recurso da mensagem citada.

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

last_update_time

Timestamp

Apenas saída. O carimbo de data/hora em que a mensagem citada foi criada ou atualizada pela última vez.

Reação

Uma reação a uma mensagem.

Campos
name

string

Identificador. O nome do recurso da reação.

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

user

User

Apenas saída. O usuário que criou a reação.

emoji

Emoji

Obrigatório. O emoji usado na reação.

ReactionBatchCreatedEventData

Payload do evento para várias novas reações.

Tipo de evento: google.workspace.chat.reaction.v1.batchCreated

Campos
reactions[]

ReactionCreatedEventData

Uma lista de novas reações.

ReactionBatchDeletedEventData

Payload do evento para várias reações excluídas.

Tipo de evento: google.workspace.chat.reaction.v1.batchDeleted

Campos
reactions[]

ReactionDeletedEventData

Uma lista de reações excluídas.

ReactionCreatedEventData

Payload do evento para uma nova reação.

Tipo de evento: google.workspace.chat.reaction.v1.created

Campos
reaction

Reaction

A nova reação.

ReactionDeletedEventData

Payload do evento para uma reação excluída.

Tipo: google.workspace.chat.reaction.v1.deleted

Campos
reaction

Reaction

A reação excluída.

RichLinkMetadata

Um link avançado para um recurso.

Campos
uri

string

O URI desse link.

Campo de união data. Dados do recurso vinculado. data pode ser apenas de um dos tipos a seguir:

RichLinkType

O tipo de link avançado. Outros tipos podem ser adicionados no futuro.

Enums
DRIVE_FILE Um tipo de link avançado do Google Drive.
CHAT_SPACE Um tipo de link avançado do espaço do Chat. Por exemplo, um ícone inteligente de espaço.

SearchSpacesRequest

Solicitação para pesquisar uma lista de espaços com base em uma consulta.

Campos
use_admin_access

bool

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 chats e conversas em espaços.

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

No momento, esse método só oferece suporte ao acesso de administrador. Portanto, apenas true é aceito para esse campo.

page_size

int32

O número máximo de espaços a serem retornados. O serviço pode retornar menos que esse valor.

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á alterado automaticamente para 1.000.

page_token

string

Um token recebido da chamada de espaços de pesquisa anterior. Forneça esse parâmetro para recuperar a página seguinte.

Na paginação, todos os outros parâmetros enviados precisam corresponder à chamada que forneceu o token da página. Transmitir valores diferentes para os outros parâmetros pode gerar resultados inesperados.

query

string

Obrigatório. Uma consulta de pesquisa.

É possível pesquisar usando os seguintes parâmetros:

  • create_time
  • customer
  • display_name
  • external_user_allowed
  • last_active_time
  • space_history_state
  • space_type

create_time e last_active_time aceitam um carimbo de data/hora no formato RFC-3339, e os operadores de comparação aceitos são: =, <, >, <= e >=.

customer é obrigatório e é usado para indicar de qual cliente buscar os espaços. customers/my_customer é o único valor compatível.

display_name aceita apenas o operador HAS (:). O texto a ser correspondido é tokenizado primeiro, e cada token é correspondido por prefixo, sem distinção entre maiúsculas e minúsculas e de forma independente, como uma substring em qualquer lugar no display_name do espaço. Por exemplo, Fun Eve corresponde a Fun event ou The evening was fun, mas não a notFun event ou even.

external_user_allowed aceita true ou false.

space_history_state aceita apenas valores do campo historyState de um recurso space.

space_type é obrigatório, e o único valor válido é SPACE.

Em campos diferentes, apenas operadores AND são aceitos. Um exemplo válido é space_type = "SPACE" AND display_name:"Hello", e um exemplo inválido é space_type = "SPACE" OR display_name:"Hello".

No mesmo campo, space_type não aceita operadores AND ou OR. display_name, "space_history_state" e "external_user_allowed" só aceitam operadores OR. last_active_time e create_time são compatíveis com os operadores AND e OR. AND só pode ser usado para representar um intervalo, como last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00".

Os exemplos de consultas a seguir são válidos:

customer = "customers/my_customer" AND space_type = "SPACE"

customer = "customers/my_customer" AND space_type = "SPACE" AND
display_name:"Hello World"

customer = "customers/my_customer" AND space_type = "SPACE" AND
(last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(display_name:"Hello World" OR display_name:"Fun event") AND
(last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(create_time > "2019-01-01T00:00:00+00:00" AND create_time <
"2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
(space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
order_by

string

Opcional. Como a lista de espaços é organizada.

Os atributos de ordenação aceitos são:

  • membership_count.joined_direct_human_user_count: indica a contagem de usuários humanos que entraram diretamente em um espaço.
  • last_active_time: indica o momento em que o último item qualificado foi adicionado a qualquer tópico deste espaço.
  • create_time: denota o horário da criação do espaço.

Os valores válidos para a operação de ordenação são:

  • ASC para ordem crescente. Valor padrão.

  • DESC para ordem decrescente.

As sintaxes compatíveis são:

  • membership_count.joined_direct_human_user_count DESC
  • membership_count.joined_direct_human_user_count ASC
  • last_active_time DESC
  • last_active_time ASC
  • create_time DESC
  • create_time ASC

SearchSpacesResponse

Resposta com uma lista de espaços correspondentes à solicitação de pesquisa de espaços.

Campos
spaces[]

Space

Uma página com os espaços solicitados.

next_page_token

string

Um token que pode ser usado para recuperar a próxima página. Se o campo estiver vazio, não haverá páginas subsequentes.

total_size

int32

O número total de espaços que correspondem à consulta em todas as páginas. Se o resultado for mais de 10.000 espaços, esse valor será uma estimativa.

SetUpSpaceRequest

Solicitar a criação de um espaço e adicionar usuários especificados a ele.

Campos
space

Space

Obrigatório. O campo Space.spaceType é obrigatório.

Para criar um espaço, defina Space.spaceType como SPACE e Space.displayName. Se você receber a mensagem de erro ALREADY_EXISTS ao configurar um espaço, tente usar um displayName diferente. Um espaço existente na organização do Google Workspace já pode usar esse nome de exibição.

Para criar um chat em grupo, defina Space.spaceType como GROUP_CHAT. Não defina Space.displayName.

Para criar uma conversa individual entre humanos, defina Space.spaceType como DIRECT_MESSAGE e Space.singleUserBotDm como false. Não defina Space.displayName ou Space.spaceDetails.

Para criar uma conversa individual entre uma pessoa e o app de chat que está ligando, defina Space.spaceType como DIRECT_MESSAGE e Space.singleUserBotDm como true. Não defina Space.displayName ou Space.spaceDetails.

Se um espaço DIRECT_MESSAGE já existir, ele será retornado em vez de criar um novo espaço.

request_id

string

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

memberships[]

Membership

Opcional. Os usuários ou grupos do Google Chat que você quer convidar para participar do espaço. Omita o usuário que fez a chamada, porque ele é adicionado automaticamente.

No momento, o conjunto permite até 20 assinaturas (além do autor da chamada).

Para a associação humana, o campo Membership.member precisa conter um user com name preenchido (formato: users/{user}) e type definido como User.Type.HUMAN. Só é possível adicionar usuários humanos ao configurar um espaço. A adição de apps do Chat só é possível para a configuração de mensagens diretas com o app de chamada. Também é possível adicionar participantes usando o e-mail do usuário como um alias para {user}. Por exemplo, user.name pode ser users/example@gmail.com. Para convidar usuários do Gmail ou de domínios externos do Google Workspace, o e-mail do usuário precisa ser usado para {user}.

Para a associação a grupos do Google, o campo Membership.group_member precisa conter um group com name preenchido (formato groups/{group}). Só é possível adicionar grupos do Google ao definir Space.spaceType como SPACE.

Opcional ao definir Space.spaceType como SPACE.

Obrigatório ao definir Space.spaceType como GROUP_CHAT, junto com pelo menos duas assinaturas.

Obrigatório ao definir Space.spaceType como DIRECT_MESSAGE com um usuário humano e exatamente uma assinatura.

Precisa estar vazio ao criar uma conversa individual entre uma pessoa e o app de chat que está ligando (ao definir Space.spaceType como DIRECT_MESSAGE e Space.singleUserBotDm como true).

SlashCommand

Um comando de barra no Google Chat.

Campos
command_id

int64

O ID do comando de barra invocado.

SlashCommandMetadata

Metadados de anotação para comandos de barra (/).

Campos
bot

User

O app Chat cujo comando foi invocado.

type

Type

O tipo de comando de barra.

command_name

string

O nome do comando de barra invocado.

command_id

int64

O ID do comando de barra invocado.

triggers_dialog

bool

Indica se o comando de barra é para uma caixa de diálogo.

Tipo

Enums
TYPE_UNSPECIFIED Valor padrão do tipo enumerado. Não use.
ADD Adicione o app do Chat ao espaço.
INVOKE Invocar o comando de barra no espaço.

Espaço

Um espaço no Google Chat. Os espaços são conversas entre dois ou mais usuários ou mensagens individuais entre um usuário e um app do Chat.

Campos
name

string

Identificador. Nome do recurso do espaço.

Formato: spaces/{space}

em que {space} representa o ID atribuído pelo sistema ao espaço. Para conferir o ID do espaço, chame o método spaces.list() ou o URL do espaço. Por exemplo, se o URL do espaço for https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA, o ID do espaço será AAAAAAAAA.

type
(deprecated)

Type

Apenas saída. Descontinuado: use space_type. O tipo de espaço.

space_type

SpaceType

Opcional. O tipo de espaço. Obrigatório ao criar um espaço ou atualizar o tipo de espaço. Saída somente para outro uso.

single_user_bot_dm

bool

Opcional. Se o espaço é uma DM entre um app de chat e uma pessoa.

threaded
(deprecated)

bool

Apenas saída. Descontinuado: use spaceThreadingState. Se as mensagens estão agrupadas neste espaço.

display_name

string

Opcional. O nome de exibição do espaço. Obrigatório ao criar um espaço com um spaceType de SPACE. Se você receber a mensagem de erro ALREADY_EXISTS ao criar um espaço ou atualizar o displayName, tente usar outro displayName. Um espaço existente na organização do Google Workspace já pode usar esse nome de exibição.

Para mensagens diretas, esse campo pode estar vazio.

Suporta até 128 caracteres.

external_user_allowed

bool

Opcional. Imutável. Se o espaço permite que qualquer usuário do Google Chat seja um participante. Entrada ao criar um espaço em uma organização do Google Workspace. Omita esse campo ao criar espaços nas seguintes condições:

  • O usuário autenticado usa uma conta de consumidor (conta de usuário não gerenciada). Por padrão, um espaço criado por uma conta de consumidor permite o acesso de qualquer usuário do Google Chat.

Para espaços existentes, esse campo é somente saída.

space_threading_state

SpaceThreadingState

Apenas saída. O estado da conversa em grupo no espaço do Chat.

space_details

SpaceDetails

Opcional. Detalhes sobre o espaço, incluindo descrição e regras.

space_history_state

HistoryState

Opcional. O estado do histórico de mensagens e conversas neste espaço.

import_mode

bool

Opcional. Se o espaço foi criado em Import Mode como parte de uma migração de dados para o Google Workspace. Enquanto os espaços estão sendo importados, eles não ficam visíveis para os usuários até que a importação seja concluída.

A criação de um espaço em Import Mode requer a autenticação do usuário.

create_time

Timestamp

Opcional. Imutável. Para espaços criados no Chat, o horário em que o espaço foi criado. Esse campo é somente saída, exceto quando usado em espaços do modo de importação.

Para espaços no modo de importação, defina esse campo como o carimbo de data/hora histórico em que o espaço foi criado na origem para preservar o horário de criação original.

Só é preenchido na saída quando spaceType é GROUP_CHAT ou SPACE.

last_active_time

Timestamp

Apenas saída. Carimbo de data/hora da última mensagem no espaço.

admin_installed

bool

Apenas saída. Para espaços de mensagem direta (DM) com um app do Chat, se o espaço foi criado por um administrador do Google Workspace. Os administradores podem instalar e configurar uma mensagem direta com um app do Chat em nome dos usuários da organização.

Para oferecer suporte à instalação pelo administrador, o app do Chat precisa ter mensagens diretas.

membership_count

MembershipCount

Apenas saída. Contagem de associações agrupadas por tipo de participante. Preenchido quando space_type é SPACE, DIRECT_MESSAGE ou GROUP_CHAT.

access_settings

AccessSettings

Opcional. Especifica a configuração de acesso do espaço. Preenchido apenas quando space_type é SPACE.

space_uri

string

Apenas saída. O URI para um usuário acessar o espaço.

import_mode_expire_time

Timestamp

Apenas saída. O momento em que o espaço será excluído automaticamente pelo sistema se permanecer no modo de importação.

Cada espaço criado no modo de importação precisa sair desse modo antes do tempo de expiração usando spaces.completeImport.

Esse campo só é preenchido para espaços criados com o modo de importação.

customer

string

Opcional. Imutável. O ID do cliente do domínio do espaço. Obrigatório apenas ao criar um espaço com autenticação de app e SpaceType é SPACE. Caso contrário, não será necessário definir.

No formato customers/{customer}, em que customer é o id do [recurso de cliente do SDK Admin]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Os apps particulares também podem usar o alias customers/my_customer para criar o espaço na mesma organização do Google Workspace que o app.

Para DMs, esse campo não é preenchido.

Campo de união space_permission_settings. Representa as configurações de permissão de um espaço. Preenchido apenas quando space_type é SPACE.

Requer autenticação do usuário. space_permission_settings pode ser apenas de um dos tipos a seguir:

predefined_permission_settings

PredefinedPermissionSettings

Opcional. Somente entrada. Configurações predefinidas de permissão de espaço, insira apenas ao criar um espaço. Se o campo não for definido, um espaço de colaboração será criado. Depois de criar o espaço, as configurações são preenchidas no campo PermissionSettings.

permission_settings

PermissionSettings

Opcional. Configurações de permissão de espaço para espaços existentes. Entrada para atualizar as configurações de permissões exatas do espaço, em que as configurações atuais são substituídas. A saída lista as configurações de permissão atuais.

AccessSettings

Representa a configuração de acesso do espaço.

Campos
access_state

AccessState

Apenas saída. Indica o estado de acesso do espaço.

audience

string

Opcional. O nome do recurso do público-alvo que pode descobrir o espaço, participar dele e visualizar as mensagens. Se não for definido, apenas os usuários ou Grupos do Google que foram convidados ou adicionados individualmente ao espaço poderão acessá-lo. Saiba mais em Tornar um espaço detectável para um público-alvo.

Formato: audiences/{audience}

Para usar o público-alvo padrão da organização do Google Workspace, defina como audiences/default.

A leitura do público-alvo de destino oferece suporte a:

Esse campo não é preenchido ao usar o escopo chat.bot com a autenticação de app.

A definição do público-alvo exige a autenticação do usuário.

AccessState

Representa o estado de acesso do espaço.

Enums
ACCESS_STATE_UNSPECIFIED O estado de acesso é desconhecido ou não é aceito nesta API.
PRIVATE Somente usuários ou Grupos do Google que foram adicionados ou convidados individualmente por outros usuários ou administradores do Google Workspace podem descobrir e acessar o espaço.
DISCOVERABLE

Um administrador do espaço concedeu acesso ao espaço a um público-alvo. Os usuários ou Grupos do Google que foram adicionados ou convidados individualmente também podem descobrir e acessar o espaço. Saiba mais em Tornar um espaço detectável para usuários específicos.

A criação de espaços detectáveis exige a autenticação do usuário.

MembershipCount

Representa a contagem de assinaturas de um espaço, agrupadas em categorias.

Campos
joined_direct_human_user_count

int32

Apenas saída. Contagem de usuários humanos que participaram diretamente do espaço, sem contar os usuários que participaram por terem uma associação em um grupo.

joined_group_count

int32

Apenas saída. Contagem de todos os grupos que entraram diretamente no espaço.

PermissionSetting

Representa uma configuração de permissão de espaço.

Campos
managers_allowed

bool

Opcional. Se os administradores dos espaços têm essa permissão.

members_allowed

bool

Opcional. Se os membros que não são administradores têm essa permissão.

PermissionSettings

Configurações de permissão que podem ser especificadas ao atualizar um espaço nomeado.

Para definir as configurações de permissão ao criar um espaço, especifique o campo PredefinedPermissionSettings na solicitação.

Campos
manage_members_and_groups

PermissionSetting

Opcional. Configurações para gerenciar participantes e grupos em um espaço.

modify_space_details

PermissionSetting

Opcional. Configurações para atualizar o nome, o avatar, a descrição e as diretrizes do espaço.

toggle_history

PermissionSetting

Opcional. Configurações para ativar e desativar o histórico do espaço.

use_at_mention_all

PermissionSetting

Opcional. Configurações para usar @todos em um espaço.

manage_apps

PermissionSetting

Opcional. Configurações para gerenciar apps em um espaço.

manage_webhooks

PermissionSetting

Opcional. Configurações para gerenciar webhooks em um espaço.

post_messages

PermissionSetting

Apenas saída. Configurações para postar mensagens em um espaço.

reply_messages

PermissionSetting

Opcional. Configurações para responder a mensagens em um espaço.

PredefinedPermissionSettings

Configurações de permissão predefinidas que só podem ser especificadas ao criar um espaço nomeado. Mais configurações poderão ser adicionadas no futuro. Para saber mais sobre as configurações de permissão para espaços nomeados, consulte Saiba mais sobre os espaços.

Enums
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED Não especificado. Não use.
COLLABORATION_SPACE Configurações para tornar o espaço um espaço de colaboração em que todos os participantes podem postar mensagens.
ANNOUNCEMENT_SPACE Configurando o espaço para que apenas os administradores possam postar avisos.

SpaceDetails

Detalhes sobre o espaço, incluindo descrição e regras.

Campos
description

string

Opcional. Uma descrição do espaço. Por exemplo, descreva o tema da discussão, a finalidade funcional ou os participantes do espaço.

Suporta até 150 caracteres.

guidelines

string

Opcional. As regras, expectativas e etiqueta do espaço.

Aceita até 5.000 caracteres.

SpaceThreadingState

Especifica o tipo de estado de linha de execução no espaço do Chat.

Enums
SPACE_THREADING_STATE_UNSPECIFIED Reservado.
THREADED_MESSAGES Espaços nomeados compatíveis com linhas de mensagens. Quando os usuários respondem a uma mensagem, eles podem responder na conversa, o que mantém a resposta no contexto da mensagem original.
GROUPED_MESSAGES Espaços nomeados em que a conversa é organizada por tema. Os tópicos e as respostas deles são agrupados.
UNTHREADED_MESSAGES Mensagens diretas (DMs) entre duas pessoas e conversas em grupo com três ou mais pessoas.

SpaceType

O tipo de espaço. Obrigatório ao criar ou atualizar um espaço. Saída somente para outro uso.

Enums
SPACE_TYPE_UNSPECIFIED Reservado.
SPACE Um lugar onde as pessoas enviam mensagens, compartilham arquivos e colaboram. Um SPACE pode incluir apps de chat.
GROUP_CHAT Conversas em grupo com três ou mais pessoas. Um GROUP_CHAT pode incluir apps de chat.
DIRECT_MESSAGE Mensagens individuais entre duas pessoas ou entre uma pessoa e um app do Chat.

Tipo

Descontinuado: use SpaceType.

Enums
TYPE_UNSPECIFIED Reservado.
ROOM Conversas entre duas ou mais pessoas.
DM Mensagem direta entre uma pessoa e um app de chat, em que todas as mensagens são planas. Isso não inclui mensagens diretas entre duas pessoas.

SpaceBatchUpdatedEventData

Payload do evento para várias atualizações em um espaço.

Tipo de evento: google.workspace.chat.space.v1.batchUpdated

Campos
spaces[]

SpaceUpdatedEventData

Uma lista de espaços atualizados.

SpaceEvent

Um evento que representa uma mudança ou atividade em um espaço do Google Chat. Para saber mais, consulte Trabalhar com eventos do Google Chat.

Campos
name

string

Nome do recurso do evento do espaço.

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

event_time

Timestamp

Horário em que o evento ocorreu.

event_type

string

Tipo de evento de espaço. Cada tipo de evento tem uma versão em lote, que representa várias instâncias do tipo de evento que ocorrem em um curto período. Para solicitações spaceEvents.list(), omita os tipos de evento em lote no filtro de consulta. Por padrão, o servidor retorna o tipo de evento e a versão do lote.

Tipos de eventos compatíveis com mensagens:

  • Nova mensagem: google.workspace.chat.message.v1.created
  • Mensagem atualizada: google.workspace.chat.message.v1.updated
  • Mensagem excluída: google.workspace.chat.message.v1.deleted
  • Várias mensagens novas: google.workspace.chat.message.v1.batchCreated
  • Várias mensagens atualizadas: google.workspace.chat.message.v1.batchUpdated
  • Várias mensagens excluídas: google.workspace.chat.message.v1.batchDeleted

Tipos de evento compatíveis com filiação:

  • Nova assinatura: google.workspace.chat.membership.v1.created
  • Assinatura atualizada: google.workspace.chat.membership.v1.updated
  • Associação excluída: google.workspace.chat.membership.v1.deleted
  • Várias assinaturas novas: google.workspace.chat.membership.v1.batchCreated
  • Várias assinaturas atualizadas: google.workspace.chat.membership.v1.batchUpdated
  • Várias assinaturas excluídas: google.workspace.chat.membership.v1.batchDeleted

Tipos de evento compatíveis com reações:

  • Nova reação: google.workspace.chat.reaction.v1.created
  • Reação excluída: google.workspace.chat.reaction.v1.deleted
  • Várias novas reações: google.workspace.chat.reaction.v1.batchCreated
  • Várias reações excluídas: google.workspace.chat.reaction.v1.batchDeleted

Tipos de evento compatíveis sobre o espaço:

  • Espaço atualizado: google.workspace.chat.space.v1.updated
  • Várias atualizações de espaço: google.workspace.chat.space.v1.batchUpdated

Campo de união payload.

payload pode ser apenas de um dos tipos a seguir:

message_created_event_data

MessageCreatedEventData

Payload do evento para uma nova mensagem.

Tipo de evento: google.workspace.chat.message.v1.created

message_updated_event_data

MessageUpdatedEventData

Payload do evento para uma mensagem atualizada.

Tipo de evento: google.workspace.chat.message.v1.updated

message_deleted_event_data

MessageDeletedEventData

Payload do evento para uma mensagem excluída.

Tipo de evento: google.workspace.chat.message.v1.deleted

message_batch_created_event_data

MessageBatchCreatedEventData

Payload do evento para várias mensagens novas.

Tipo de evento: google.workspace.chat.message.v1.batchCreated

message_batch_updated_event_data

MessageBatchUpdatedEventData

Payload do evento para várias mensagens atualizadas.

Tipo de evento: google.workspace.chat.message.v1.batchUpdated

message_batch_deleted_event_data

MessageBatchDeletedEventData

Payload do evento para várias mensagens excluídas.

Tipo de evento: google.workspace.chat.message.v1.batchDeleted

space_updated_event_data

SpaceUpdatedEventData

Payload do evento para uma atualização de espaço.

Tipo de evento: google.workspace.chat.space.v1.updated

space_batch_updated_event_data

SpaceBatchUpdatedEventData

Payload do evento para várias atualizações em um espaço.

Tipo de evento: google.workspace.chat.space.v1.batchUpdated

membership_created_event_data

MembershipCreatedEventData

Payload do evento para uma nova assinatura.

Tipo de evento: google.workspace.chat.membership.v1.created

membership_updated_event_data

MembershipUpdatedEventData

Payload do evento para uma assinatura atualizada.

Tipo de evento: google.workspace.chat.membership.v1.updated

membership_deleted_event_data

MembershipDeletedEventData

Payload do evento para uma associação excluída.

Tipo de evento: google.workspace.chat.membership.v1.deleted

membership_batch_created_event_data

MembershipBatchCreatedEventData

Payload do evento para várias assinaturas novas.

Tipo de evento: google.workspace.chat.membership.v1.batchCreated

membership_batch_updated_event_data

MembershipBatchUpdatedEventData

Payload do evento para várias assinaturas atualizadas.

Tipo de evento: google.workspace.chat.membership.v1.batchUpdated

membership_batch_deleted_event_data

MembershipBatchDeletedEventData

Payload do evento para várias assinaturas excluídas.

Tipo de evento: google.workspace.chat.membership.v1.batchDeleted

reaction_created_event_data

ReactionCreatedEventData

Payload do evento para uma nova reação.

Tipo de evento: google.workspace.chat.reaction.v1.created

reaction_deleted_event_data

ReactionDeletedEventData

Payload do evento para uma reação excluída.

Tipo de evento: google.workspace.chat.reaction.v1.deleted

reaction_batch_created_event_data

ReactionBatchCreatedEventData

Payload do evento para várias novas reações.

Tipo de evento: google.workspace.chat.reaction.v1.batchCreated

reaction_batch_deleted_event_data

ReactionBatchDeletedEventData

Payload do evento para várias reações excluídas.

Tipo de evento: google.workspace.chat.reaction.v1.batchDeleted

SpaceNotificationSetting

As configurações de notificação de um usuário em um espaço.

Campos
name

string

Identificador. O nome do recurso da configuração de notificação do espaço. Formato: users/{user}/spaces/{space}/spaceNotificationSetting.

notification_setting

NotificationSetting

A configuração de notificação.

mute_setting

MuteSetting

A configuração de desativação de som das notificações do espaço.

MuteSetting

Os tipos de configuração de desativação de notificações do espaço.

Enums
MUTE_SETTING_UNSPECIFIED Reservado.
UNMUTED O usuário vai receber notificações sobre o espaço com base na configuração de notificações.
MUTED O usuário não vai receber notificações do espaço, independentemente da configuração.

NotificationSetting

Os tipos de configuração de notificação.

Enums
NOTIFICATION_SETTING_UNSPECIFIED Reservado.
ALL As notificações são acionadas por @menções, conversas seguidas e a primeira mensagem das novas conversas. Todas as novas conversas são seguidas automaticamente, a menos que o usuário desfaça a ação manualmente.
MAIN_CONVERSATIONS A notificação é acionada por @menções, conversas seguidas e a primeira mensagem de novas conversas. Não disponível para mensagens diretas individuais.
FOR_YOU A notificação é acionada por @menções e conversas seguidas. Não disponível para mensagens diretas individuais.
OFF A notificação está desativada.

SpaceReadState

O estado de leitura de um usuário em um espaço, usado para identificar mensagens lidas e não lidas.

Campos
name

string

Nome do recurso do estado de leitura do espaço.

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

last_read_time

Timestamp

Opcional. A hora em que o estado de leitura do espaço do usuário foi atualizado. Geralmente, isso corresponde ao carimbo de data/hora da última mensagem lida ou a um carimbo de data/hora especificado pelo usuário para marcar a última posição de leitura em um espaço.

SpaceUpdatedEventData

Payload do evento para um espaço atualizado.

Tipo de evento: google.workspace.chat.space.v1.updated

Campos
space

Space

O espaço atualizado.

Conversa

Uma conversa em um espaço do Google Chat. Para conferir um exemplo de uso, consulte Iniciar ou responder a uma conversa.

Se você especificar uma linha de execução ao criar uma mensagem, poderá definir o campo messageReplyOption para determinar o que acontece se nenhuma linha de execução correspondente for encontrada.

Campos
name

string

Identificador. Nome do recurso da linha de execução.

Exemplo: spaces/{space}/threads/{thread}

thread_key

string

Opcional. Entrada para criar ou atualizar uma linha de execução. Caso contrário, apenas saída. ID da linha de execução. Aceita até 4.000 caracteres.

Esse ID é exclusivo para o app de chat que o define. Por exemplo, se vários apps de chat criarem uma mensagem usando a mesma chave de linha de execução, as mensagens serão postadas em linhas de execução diferentes. Para responder a uma conversa criada por uma pessoa ou outro app de chat, especifique o campo name da conversa.

ThreadReadState

O estado de leitura de um usuário em uma conversa, usado para identificar mensagens lidas e não lidas.

Campos
name

string

Nome do recurso do estado de leitura da linha de execução.

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

last_read_time

Timestamp

A hora em que o estado de leitura da linha do usuário foi atualizado. Geralmente, isso corresponde ao carimbo de data/hora da última mensagem lida em uma conversa.

UpdateMembershipRequest

Solicita uma mensagem para atualizar uma assinatura.

Campos
membership

Membership

Obrigatório. A assinatura a ser atualizada. Somente os campos especificados por update_mask são atualizados.

update_mask

FieldMask

Obrigatório. Os caminhos de campo a serem atualizados. Separe vários valores com vírgulas ou use * para atualizar todos os caminhos de campo.

Caminhos de campo compatíveis:

  • role
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 chats e conversas em espaços.

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

UpdateMessageRequest

Solicitação para atualizar uma mensagem.

Campos
message

Message

Obrigatório. Mensagem com campos atualizados.

update_mask

FieldMask

Obrigatório. Os caminhos de campo a serem atualizados. Separe vários valores com vírgulas ou use * para atualizar todos os caminhos de campo.

Caminhos de campo compatíveis:

allow_missing

bool

Opcional. Se true e a mensagem não forem encontradas, uma nova mensagem será criada e updateMask será ignorado. O ID da mensagem especificado precisa ser atribuído pelo cliente, ou a solicitação vai falhar.

UpdateSpaceNotificationSettingRequest

Solicitação para atualizar as configurações de notificação do espaço. Só é possível atualizar a configuração de notificação do usuário que faz a chamada.

Campos
space_notification_setting

SpaceNotificationSetting

Obrigatório. O nome do recurso das configurações de notificação do espaço precisa ser preenchido no formato users/{user}/spaces/{space}/spaceNotificationSetting. Somente os campos especificados por update_mask são atualizados.

update_mask

FieldMask

Obrigatório. Caminhos de campo aceitos: - notification_setting - mute_setting

UpdateSpaceReadStateRequest

Mensagem de solicitação para a API UpdateSpaceReadState.

Campos
space_read_state

SpaceReadState

Obrigatório. O estado de leitura do espaço e os campos a serem atualizados.

Só oferece suporte à atualização do estado de leitura para o usuário que faz a chamada.

Para se referir ao usuário que fez 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/user@example.com/spaces/{space}/spaceReadState.

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

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

update_mask

FieldMask

Obrigatório. Os caminhos de campo a serem atualizados. Caminhos de campo compatíveis:

  • last_read_time

Quando o last_read_time é anterior à data de criação da última mensagem, o espaço aparece como não lido na interface.

Para marcar o espaço como lido, defina last_read_time como qualquer valor posterior (maior) do que o horário de criação da última mensagem. O last_read_time é forçado a corresponder ao horário de criação da mensagem mais recente. O estado de leitura do espaço afeta apenas o estado de leitura das mensagens que estão visíveis na conversa de nível superior do espaço. As respostas nas conversas não são afetadas por esse carimbo de data/hora e dependem do estado de leitura da conversa.

UpdateSpaceRequest

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

Campos
space

Space

Obrigatório. Espaço com campos a serem atualizados. O Space.name precisa ser preenchido no formato spaces/{space}. Somente os campos especificados por update_mask são atualizados.

update_mask

FieldMask

Obrigatório. Os caminhos de campo atualizados, separados por vírgulas se houver vários.

É possível atualizar os seguintes campos de um espaço:

space_details: atualiza a descrição do espaço. Suporta até 150 caracteres.

display_name: só oferece suporte à atualização do nome de exibição para espaços em que o campo spaceType é SPACE. Se você receber a mensagem de erro ALREADY_EXISTS, tente usar um valor diferente. Um espaço existente na organização do Google Workspace já pode usar esse nome de exibição.

space_type: oferece suporte apenas para a mudança de um tipo de espaço GROUP_CHAT para SPACE. Inclua display_name e space_type na máscara de atualização e verifique se o espaço especificado tem um nome de exibição não vazio e o tipo de espaço SPACE. A inclusão da máscara space_type e do tipo SPACE no espaço especificado ao atualizar o nome de exibição é opcional se o espaço já tiver o tipo SPACE. Tentar atualizar o tipo de espaço de outras maneiras resulta em um erro de argumento inválido. space_type não é compatível com useAdminAccess.

space_history_state: atualiza as configurações do histórico do espaço ativando ou desativando o histórico do espaço. Só é possível fazer isso se as configurações de histórico estiverem ativadas para a organização do Google Workspace. Para atualizar o estado do histórico do espaço, omita todas as outras máscaras de campo na solicitação. space_history_state não é compatível com useAdminAccess.

access_settings.audience: atualiza a configuração de acesso de quem pode descobrir o espaço, entrar nele e visualizar as mensagens no espaço nomeado em que o campo spaceType é SPACE. Se o espaço tiver um público-alvo, você poderá remover o público-alvo e restringir o acesso ao espaço omitindo um valor para essa máscara de campo. Para atualizar as configurações de acesso de um espaço, o usuário que está fazendo a autenticação precisa ser um administrador do espaço e omitir todas as outras máscaras de campo na solicitação. Não é possível atualizar esse campo se o espaço estiver no modo de importação. Saiba mais em Tornar um espaço detectável para usuários específicos. access_settings.audience não é compatível com useAdminAccess.

permission_settings: oferece suporte à alteração das configurações de permissão de um espaço. Ao atualizar as configurações de permissão, só é possível especificar máscaras de campo permissionSettings. Não é possível atualizar outras máscaras de campo ao mesmo tempo. permissionSettings não é compatível com useAdminAccess. As máscaras de campo compatíveis incluem:

  • permission_settings.manageMembersAndGroups
  • permission_settings.modifySpaceDetails
  • permission_settings.toggleHistory
  • permission_settings.useAtMentionAll
  • permission_settings.manageApps
  • permission_settings.manageWebhooks
  • permission_settings.replyMessages
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 chats e conversas em espaços.

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

Alguns valores de FieldMask não são aceitos com acesso de administrador. Para mais detalhes, consulte a descrição de update_mask.

Usuário

Um usuário no Google Chat. Quando retornado como uma saída de uma solicitação, se o app de chat se autenticar como um usuário, a saída de um recurso User vai preencher apenas o name e o type do usuário.

Campos
name

string

Nome do recurso de um user do Google Chat.

Formato: users/{user}. users/app pode ser usado como um alias para o usuário bot do app de chamada.

Para human users, {user} é o mesmo identificador de usuário que:

  • o id para a Pessoa na API People. Por exemplo, users/123456789 na API Chat representa a mesma pessoa que o ID do perfil de pessoa 123456789 na API People.

  • o id de um usuário na API Directory do SDK Admin.

  • o endereço de e-mail do usuário pode ser usado como um alias para {user} em solicitações de API. Por exemplo, se o ID do perfil da API People para user@example.com for 123456789, use users/user@example.com como um alias para referenciar users/123456789. Somente o nome do recurso canônico (por exemplo, users/123456789) será retornado pela API.

display_name

string

Apenas saída. O nome de exibição do usuário.

domain_id

string

Identificador exclusivo do domínio do Google Workspace do usuário.

type

Type

Tipo de usuário.

is_anonymous

bool

Apenas saída. Quando true, o usuário é excluído ou o perfil dele não fica visível.

Tipo

Enums
TYPE_UNSPECIFIED Valor padrão do tipo enumerado. NÃO USE.
HUMAN Usuário humano.
BOT Usuário do app de chat.

UserMentionMetadata

Metadados de anotação para menções de usuários (@).

Campos
user

User

O usuário mencionado.

type

Type

O tipo de menção de usuário.

Tipo

Enums
TYPE_UNSPECIFIED Valor padrão do tipo enumerado. Não use.
ADD Adicione o usuário ao espaço.
MENTION Mencionar o usuário no espaço.

WidgetMarkup

Um widget é um elemento da interface que apresenta texto e imagens.

Campos
buttons[]

Button

Uma lista de botões. Buttons também é oneof data, e apenas um desses campos precisa ser definido.

Campo de união data. Um WidgetMarkup só pode ter um dos itens a seguir. É possível usar vários campos WidgetMarkup para mostrar mais itens. data pode ser apenas um dos seguintes:
text_paragraph

TextParagraph

Mostrar um parágrafo de texto neste widget.

image

Image

Mostrar uma imagem neste widget.

key_value

KeyValue

Mostre um item de chave-valor neste widget.

Botão

Um botão. Pode ser um botão de texto ou de imagem.

Campos

Campo de união type.

type pode ser apenas de um dos tipos a seguir:

text_button

TextButton

Um botão com texto e ação onclick.

image_button

ImageButton

Um botão com imagem e ação onclick.

FormAction

Uma ação de formulário descreve o comportamento quando o formulário é enviado. Por exemplo, é possível invocar o Apps Script para processar o formulário.

Campos
action_method_name

string

O nome do método é usado para identificar qual parte do formulário acionou o envio. Essas informações são enviadas de volta ao app Chat como parte do evento de clique no card. É possível usar o mesmo nome de método para vários elementos que acionam um comportamento comum.

parameters[]

ActionParameter

Lista de parâmetros de ação.

ActionParameter

Lista de parâmetros de string a serem fornecidos quando o método de ação for invocado. Por exemplo, considere três botões de adiamento: adiar agora, adiar um dia e adiar para a próxima semana. Você pode usar action method = snooze(), transmitindo o tipo e o tempo de suspensão na lista de parâmetros de string.

Campos
key

string

O nome do parâmetro do script de ação.

value

string

O valor do parâmetro.

Ícone

O conjunto de ícones aceitos.

Enums
ICON_UNSPECIFIED
AIRPLANE
BOOKMARK
BUS
CAR
CLOCK
CONFIRMATION_NUMBER_ICON
DOLLAR
DESCRIPTION
EMAIL
EVENT_PERFORMER
EVENT_SEAT
FLIGHT_ARRIVAL
FLIGHT_DEPARTURE
HOTEL
HOTEL_ROOM_TYPE
INVITE
MAP_PIN
MEMBERSHIP
MULTIPLE_PEOPLE
OFFER
PERSON
PHONE
RESTAURANT_ICON
SHOPPING_CART
STAR
STORE
TICKET
TRAIN
VIDEO_CAMERA
VIDEO_PLAY

Imagem

Uma imagem especificada por um URL e que pode ter uma ação onclick.

Campos
image_url

string

É o URL da imagem.

on_click

OnClick

A ação onclick.

aspect_ratio

double

A proporção da imagem (largura e altura). Esse campo permite reservar a altura certa para a imagem enquanto ela é carregada. Ele não tem o objetivo de substituir a proporção integrada da imagem. Se não for definido, o servidor vai preencher o campo com a imagem.

ImageButton

Um botão de imagem com uma ação onclick.

Campos
on_click

OnClick

A ação onclick.

name

string

O nome dessa image_button usada para acessibilidade. O valor padrão é fornecido se esse nome não for especificado.

Campo de união icons. O ícone pode ser especificado por um Icon enum ou um URL. icons pode ser apenas um dos seguintes:
icon

Icon

O ícone especificado por um enum que indexa um ícone fornecido pela API Chat.

icon_url

string

O ícone especificado por um URL.

KeyValue

Um elemento da interface contém uma chave (rótulo) e um valor (conteúdo). Esse elemento também pode conter algumas ações, como o botão onclick.

Campos
top_label

string

O texto do rótulo superior. Suporte a texto formatado. Para mais informações sobre a formatação de texto, consulte Formatar texto em apps do Google Chat e Formatar texto em complementos do Google Workspace.

content

string

O texto do conteúdo. O texto formatado é aceito e sempre obrigatório. Para mais informações sobre a formatação de texto, consulte Formatar texto em apps do Google Chat e Formatar texto em complementos do Google Workspace.

content_multiline

bool

Se o conteúdo precisa ser multilinha.

bottom_label

string

O texto do rótulo de baixo. Suporte a texto formatado. Para mais informações sobre a formatação de texto, consulte Formatar texto em apps do Google Chat e Formatar texto em complementos do Google Workspace.

on_click

OnClick

A ação onclick. Somente o rótulo de cima, o rótulo de baixo e a região de conteúdo são clicáveis.

Campo de união icons. Pelo menos um dos ícones, top_label e bottom_label, precisa ser definido. icons pode ser apenas um dos seguintes:
icon

Icon

Um valor de tipo enumerado que é substituído pela API Chat pela imagem de ícone correspondente.

icon_url

string

O ícone especificado por um URL.

Campo de união control. Um widget de controle. É possível definir button ou switch_widget, mas não ambos. control pode ser apenas um dos seguintes:
button

Button

Um botão que pode ser clicado para acionar uma ação.

OnClick

Uma ação onclick (por exemplo, abrir um link).

Campos

Campo de união data.

data pode ser apenas de um dos tipos a seguir:

action

FormAction

Uma ação de formulário é acionada por essa ação onclick, se especificada.

TextButton

Um botão com texto e ação onclick.

Campos
text

string

O texto do botão.

on_click

OnClick

A ação onclick do botão.

TextParagraph

Um parágrafo de texto. Suporte a texto formatado. Para mais informações sobre a formatação de texto, consulte Formatar texto em apps do Google Chat e Formatar texto em complementos do Google Workspace.

Campos
text

string