Índice
ChatService
(interface)AccessoryWidget
(mensagem)ActionResponse
(mensagem)ActionResponse.ResponseType
(enum)ActionResponse.SelectionItems
(mensagem)ActionResponse.UpdatedWidget
(mensagem)ActionStatus
(mensagem)Annotation
(mensagem)AnnotationType
(enum)AttachedGif
(mensagem)Attachment
(mensagem)Attachment.Source
(enum)AttachmentDataRef
(mensagem)CardWithId
(mensagem)ChatSpaceLinkData
(mensagem)CompleteImportSpaceRequest
(mensagem)CompleteImportSpaceResponse
(mensagem)ContextualAddOnMarkup
(mensagem)ContextualAddOnMarkup.Card
(mensagem)ContextualAddOnMarkup.Card.CardAction
(mensagem)ContextualAddOnMarkup.Card.CardHeader
(mensagem)ContextualAddOnMarkup.Card.CardHeader.ImageStyle
(enum)ContextualAddOnMarkup.Card.Section
(mensagem)CreateMembershipRequest
(mensagem)CreateMessageRequest
(mensagem)CreateMessageRequest.MessageReplyOption
(enum)CreateReactionRequest
(mensagem)CreateSpaceRequest
(mensagem)CustomEmoji
(mensagem)DeleteMembershipRequest
(mensagem)DeleteMessageRequest
(mensagem)DeleteReactionRequest
(mensagem)DeleteSpaceRequest
(mensagem)DeletionMetadata
(mensagem)DeletionMetadata.DeletionType
(enum)Dialog
(mensagem)DialogAction
(mensagem)DriveDataRef
(mensagem)DriveLinkData
(mensagem)Emoji
(mensagem)EmojiReactionSummary
(mensagem)FindDirectMessageRequest
(mensagem)GetAttachmentRequest
(mensagem)GetMembershipRequest
(mensagem)GetMessageRequest
(mensagem)GetSpaceEventRequest
(mensagem)GetSpaceReadStateRequest
(mensagem)GetSpaceRequest
(mensagem)GetThreadReadStateRequest
(mensagem)Group
(mensagem)HistoryState
(enum)ListMembershipsRequest
(mensagem)ListMembershipsResponse
(mensagem)ListMessagesRequest
(mensagem)ListMessagesResponse
(mensagem)ListReactionsRequest
(mensagem)ListReactionsResponse
(mensagem)ListSpaceEventsRequest
(mensagem)ListSpaceEventsResponse
(mensagem)ListSpacesRequest
(mensagem)ListSpacesResponse
(mensagem)MatchedUrl
(mensagem)Membership
(mensagem)Membership.MembershipRole
(enum)Membership.MembershipState
(enum)MembershipBatchCreatedEventData
(mensagem)MembershipBatchDeletedEventData
(mensagem)MembershipBatchUpdatedEventData
(mensagem)MembershipCreatedEventData
(mensagem)MembershipDeletedEventData
(mensagem)MembershipUpdatedEventData
(mensagem)Message
(mensagem)MessageBatchCreatedEventData
(mensagem)MessageBatchDeletedEventData
(mensagem)MessageBatchUpdatedEventData
(mensagem)MessageCreatedEventData
(mensagem)MessageDeletedEventData
(mensagem)MessageUpdatedEventData
(mensagem)QuotedMessageMetadata
(mensagem)Reaction
(mensagem)ReactionBatchCreatedEventData
(mensagem)ReactionBatchDeletedEventData
(mensagem)ReactionCreatedEventData
(mensagem)ReactionDeletedEventData
(mensagem)RichLinkMetadata
(mensagem)RichLinkMetadata.RichLinkType
(enum)SearchSpacesRequest
(mensagem)SearchSpacesResponse
(mensagem)SetUpSpaceRequest
(mensagem)SlashCommand
(mensagem)SlashCommandMetadata
(mensagem)SlashCommandMetadata.Type
(enum)Space
(mensagem)Space.AccessSettings
(mensagem)Space.AccessSettings.AccessState
(enum)Space.MembershipCount
(mensagem)Space.PermissionSetting
(mensagem)Space.PermissionSettings
(mensagem)Space.PredefinedPermissionSettings
(enum)Space.SpaceDetails
(mensagem)Space.SpaceThreadingState
(enum)Space.SpaceType
(enum)Space.Type
(enum)SpaceBatchUpdatedEventData
(mensagem)SpaceEvent
(mensagem)SpaceReadState
(mensagem)SpaceUpdatedEventData
(mensagem)Thread
(mensagem)ThreadReadState
(mensagem)UpdateMembershipRequest
(mensagem)UpdateMessageRequest
(mensagem)UpdateSpaceReadStateRequest
(mensagem)UpdateSpaceRequest
(mensagem)User
(mensagem)User.Type
(enum)UserMentionMetadata
(mensagem)UserMentionMetadata.Type
(enum)WidgetMarkup
(mensagem)WidgetMarkup.Button
(mensagem)WidgetMarkup.FormAction
(mensagem)WidgetMarkup.FormAction.ActionParameter
(mensagem)WidgetMarkup.Icon
(enum)WidgetMarkup.Image
(mensagem)WidgetMarkup.ImageButton
(mensagem)WidgetMarkup.KeyValue
(mensagem)WidgetMarkup.OnClick
(mensagem)WidgetMarkup.OpenLink
(mensagem)WidgetMarkup.TextButton
(mensagem)WidgetMarkup.TextParagraph
(mensagem)
ChatService
Permite que os desenvolvedores criem apps e integrações do Chat na plataforma do Google Chat.
CompleteImportSpace |
---|
Conclui o processo de importação do espaço especificado e o torna visível para os usuários. Exige autenticação de apps e delegação em todo o domínio. Para mais informações, consulte Autorizar apps do Google Chat a importar dados.
|
CreateMembership |
---|
Cria uma assinatura para o app de chamada do Chat, um usuário ou um Grupo do Google. Não é possível criar assinaturas em outros apps do Chat. Ao criar uma participação, se a política de aceitação automática estiver desativada para o participante especificado, ele vai receber um convite e precisará aceitar o convite do espaço antes de entrar. Caso contrário, a criação de uma associação adicionará o participante diretamente ao espaço especificado. Exige a autenticação do usuário. Para conferir exemplos de uso, consulte:
|
CreateMessage |
---|
Cria uma mensagem em um espaço do Google Chat. Confira um exemplo em Enviar uma mensagem. O método A imagem abaixo mostra como o Chat atribui uma mensagem quando você usa a autenticação do app. O Chat mostra o app do Chat como o remetente da mensagem. O conteúdo da mensagem pode ter texto ( 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 remetente e atribui o app do Chat à mensagem mostrando o nome dela. O conteúdo da mensagem só pode conter texto ( O tamanho máximo da mensagem, incluindo o conteúdo dela, é de 32.000 bytes.
|
CreateReaction |
---|
Cria uma reação e a adiciona a uma mensagem. Apenas emojis Unicode são aceitos. Confira um exemplo em Adicionar uma reação a uma mensagem. Exige a autenticação do usuário.
|
CreateSpace |
---|
Cria um espaço sem participantes. Pode ser usado para criar um espaço nomeado. Não é possível usar espaços agrupados por temas. Veja um exemplo em Criar um espaço. Se você receber a mensagem de erro Se você for membro do programa de prévia para desenvolvedores, poderá criar um chat em grupo no modo de importação usando Exige a autenticação do usuário.
|
DeleteMembership |
---|
Exclui uma assinatura. Veja um exemplo em Remover um usuário ou um app do Google Chat de um espaço. Exige a autenticação do usuário.
|
DeleteMessage |
---|
Exclui uma mensagem. Veja um exemplo em Excluir uma mensagem. Requer autenticação. Dá suporte à autenticação de apps e à autenticação de usuários. Ao usar a autenticação de apps, as solicitações só podem excluir mensagens criadas pelo app de chamada do Chat.
|
DeleteReaction |
---|
Exclui uma reação a uma mensagem. Apenas emojis Unicode são aceitos. Confira um exemplo em Excluir uma reação. Exige a autenticação do usuário.
|
DeleteSpace |
---|
Exclui um espaço nomeado. Sempre executa uma exclusão em cascata. Isso significa que os recursos filhos do espaço, como as mensagens postadas e as associações nele, também são excluídos. Veja um exemplo em Excluir um espaço. Exige a autenticação de um usuário que tenha permissão para excluir o espaço.
|
FindDirectMessage |
---|
Retorna a mensagem direta com o usuário especificado. Se nenhum espaço de mensagem direta for encontrado, retornará um erro Com a autenticação do usuário, retorna o espaço de mensagem direta entre o usuário especificado e o usuário autenticado. Com a autenticação de apps, retorna o espaço de mensagens diretas entre o usuário especificado e o app de chamada do Chat. Requer autenticação do usuário ou autenticação de apps.
|
GetAttachment |
---|
Recebe os metadados de um anexo de mensagem. Os dados dos anexos são buscados com a API Media. Veja um exemplo em Receber metadados sobre um anexo de mensagem. Requer autenticação de apps.
|
GetMembership |
---|
Retorna detalhes sobre uma assinatura. Por exemplo, consulte Ver detalhes sobre a assinatura de um usuário ou de um app do Google Chat. Requer autenticação. Dá suporte à autenticação de apps e à autenticação de usuários.
|
GetMessage |
---|
Retorna detalhes sobre uma mensagem. Veja um exemplo em Receber detalhes sobre uma mensagem. Requer autenticação. Dá suporte à autenticação de apps e à autenticação de usuários. Observação: pode retornar a mensagem de um participante ou espaço bloqueado.
|
GetSpace |
---|
Retorna detalhes sobre um espaço. Veja um exemplo em Ver detalhes sobre um espaço. Requer autenticação. Dá suporte à autenticação de apps e à autenticação de usuários.
|
GetSpaceEvent |
---|
Retorna um evento de um espaço do Google Chat. O payload do evento contém a versão mais recente do recurso que foi alterado. Por exemplo, se você solicitar um evento sobre uma nova mensagem, mas ela for atualizada posteriormente, o servidor retornará o recurso Exige a autenticação do usuário. Para receber um evento, o usuário autenticado precisa participar do espaço. Veja um exemplo em Ver detalhes sobre um evento de um espaço do Google Chat.
|
GetSpaceReadState |
---|
Retorna detalhes sobre o estado de leitura de um usuário em um espaço, usado para identificar mensagens lidas e não lidas. Veja um exemplo em Ver detalhes sobre o estado de leitura do espaço de um usuário. Exige a autenticação do usuário.
|
GetThreadReadState |
---|
Retorna detalhes sobre o estado de leitura de um usuário em uma sequência, usada para identificar mensagens lidas e não lidas. Por exemplo, consulte Ver detalhes sobre o estado de leitura da linha de execução de um usuário. Exige a autenticação do usuário.
|
ListMemberships |
---|
Lista as associações em um espaço. Por exemplo, consulte Listar usuários e apps do Google Chat em um espaço. As associações da página de detalhes com autenticação de app listam as associações em espaços a que o app do Chat tem acesso, mas exclui as associações a apps do Chat, inclusive as que pertencem a ele. A listagem das associações com a autenticação de usuário lista as associações em espaços a que o usuário autenticado tem acesso. Requer autenticação. Dá suporte à autenticação de apps e à autenticação de usuários.
|
ListMessages |
---|
Lista as mensagens de um espaço de que o autor da chamada participa, inclusive as 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,
|
ListReactions |
---|
Lista as reações a uma mensagem. Veja um exemplo em Listar reações para uma mensagem. Exige a autenticação do usuário.
|
ListSpaceEvents |
---|
Lista os 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 participantes do espaço, o servidor retornará recursos Exige a autenticação do usuário. Para listar eventos, o usuário autenticado precisa ser membro do espaço. Por exemplo, consulte Listar eventos de um espaço do Google Chat.
|
ListSpaces |
---|
Lista os espaços de que o autor da chamada é participante. Os chats em grupo e as mensagens diretas só são listados depois que a primeira mensagem é enviada. Para ver um exemplo, consulte Listar espaços. Requer autenticação. Dá suporte à autenticação de apps e à autenticação de usuários. Lista os espaços visíveis para o autor da chamada ou o usuário autenticado. Os chats em grupo e as mensagens diretas só são listados depois que a primeira mensagem é enviada. Para listar todos os espaços nomeados da organização do Google Workspace, use o método
|
SearchSpaces |
---|
use_admin_access como true .
|
SetUpSpace |
---|
Cria um espaço e adiciona usuários especificados a ele. O usuário que fez a chamada é adicionado automaticamente ao espaço e não pode ser especificado como participante na solicitação. Veja um exemplo em Configurar um espaço com os participantes iniciais. Para especificar os membros que serão adicionados, adicione as assinaturas com o Para especificar os grupos do Google que serão adicionados, adicione assinaturas com o Em um espaço nomeado ou um chat em grupo, se o autor da chamada bloquear, ser bloqueado por alguns participantes ou não tiver permissão para adicionar alguns participantes, eles não serão adicionados ao espaço criado. Para criar uma mensagem direta (DM) entre o usuário que fez 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 o DM não será criado. Para criar uma mensagem direta entre o usuário que fez a chamada e o app de chamada, defina Se já houver um tomador de decisão entre dois usuários, mesmo que um deles bloqueie o outro no momento em que uma solicitação for feita, a mensagem direta atual será retornada. Os espaços com respostas agrupadas não podem ser usados. Se você receber a mensagem de erro Exige a autenticação do usuário.
|
UpdateMembership |
---|
Atualiza uma assinatura. Veja um exemplo em Atualizar a associação de um usuário a um espaço. Exige a autenticação do usuário.
|
UpdateMessage |
---|
Atualiza uma mensagem. Há uma diferença entre os métodos Requer autenticação. Dá suporte à autenticação de apps e à autenticação de usuários. Ao usar a autenticação de apps, as solicitações só podem atualizar as mensagens criadas pelo app de chamada do Chat.
|
UpdateSpace |
---|
Atualiza um espaço. Veja um exemplo em Atualizar um espaço. Se você estiver atualizando o campo Exige a autenticação do usuário.
|
UpdateSpaceReadState |
---|
Atualiza 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 Atualizar o estado de leitura do espaço de um usuário. Exige a autenticação do usuário.
|
AccessoryWidget
Um ou mais widgets interativos que aparecem na parte inferior de uma mensagem. Confira mais detalhes em 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 |
Uma lista de botões. |
ActionResponse
Parâmetros que um app do Chat pode usar para configurar como a resposta é postada.
Campos | |
---|---|
type |
Somente entrada. O tipo de resposta do app do Chat. |
url |
Somente entrada. URL para os usuários autenticarem ou configurarem. Apenas para tipos de resposta |
dialog_action |
Somente entrada. Uma resposta a um evento de interação relacionado a uma caixa de diálogo. Precisa estar acompanhado de |
updated_widget |
Somente entrada. A resposta do widget atualizado. |
ResponseType
O tipo de resposta do app do Chat.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Tipo padrão processado como NEW_MESSAGE . |
NEW_MESSAGE |
Postar como uma nova mensagem no tema. |
UPDATE_MESSAGE |
Atualize a mensagem do app do Chat. Isso só é permitido em um evento CARD_CLICKED em que o tipo de remetente da mensagem é BOT . |
UPDATE_USER_MESSAGE_CARDS |
Atualize os cards na mensagem de um usuário. Isso só é permitido como resposta a um evento MESSAGE com um URL correspondente ou um evento CARD_CLICKED em que o tipo de remetente da mensagem é HUMAN . O texto é ignorado. |
REQUEST_CONFIG |
Solicitar ao usuário autenticação ou configuração adicional. |
DIALOG |
Apresenta uma caixa de diálogo. |
UPDATE_WIDGET |
Consulta das opções de preenchimento automático de texto do widget. |
SelectionItems
Lista de resultados de preenchimento automático do widget.
Campos | |
---|---|
items[] |
Uma matriz dos objetos SelectionItem. |
UpdatedWidget
A resposta do widget atualizado. Usado para fornecer opções de preenchimento automático para um widget.
Campos | |
---|---|
widget |
ID do widget atualizado. O ID precisa corresponder ao do widget que acionou a solicitação de atualização. |
Campo de união updated_widget . O widget é atualizado em resposta a uma ação do usuário. updated_widget pode ser apenas de um dos tipos a seguir: |
|
suggestions |
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 |
O código de status. |
user_facing_message |
A mensagem a ser enviada aos usuários sobre o status da solicitação. Se não for definido, uma mensagem genérica com base no |
Nota
Apenas saída. Anotações associadas ao corpo de texto simples da mensagem. Para adicionar uma formatação básica a uma mensagem de texto, consulte Formatar mensagens de texto.
Exemplo de corpo de mensagem de texto simples:
Hello @FooBot how are you!"
Os metadados de anotações correspondentes:
"annotations":[{
"type":"USER_MENTION",
"startIndex":6,
"length":7,
"userMention": {
"user": {
"name":"users/{user}",
"displayName":"FooBot",
"avatarUrl":"https://goo.gl/aeDtrS",
"type":"BOT"
},
"type":"MENTION"
}
}]
Campos | |
---|---|
type |
O tipo da anotação. |
length |
Tamanho da substring no corpo da mensagem de texto simples a que essa anotação corresponde. |
start_index |
Índice inicial (base 0, inclusive) no corpo da mensagem de texto simples a que 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 |
Os metadados da menção do usuário. |
slash_command |
Os metadados para um comando de barra. |
rich_link_metadata |
Os metadados para um link avançado. |
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. |
RICH_LINK |
Uma anotação de link avançada. |
AttachedGif
Uma imagem GIF especificada por um URL.
Campos | |
---|---|
uri |
Apenas saída. O URL que hospeda a imagem GIF. |
Anexo
Um anexo no Google Chat.
Campos | |
---|---|
name |
Nome do recurso do anexo, no formato |
content_name |
Apenas saída. O nome do arquivo original do conteúdo, não o caminho completo. |
content_type |
Apenas saída. O tipo de conteúdo (tipo MIME) do arquivo. |
thumbnail_uri |
Apenas saída. O URL da miniatura que deve ser usada para visualizar o anexo para um usuário humano. Os apps de chat não podem usar esse URL para fazer o download de anexos. |
download_uri |
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 de anexos. |
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 |
Uma referência aos dados do anexo. Esse campo é usado com a API de mídia para fazer o download dos dados de anexo. |
drive_data_ref |
Apenas saída. Uma referência ao anexo do Google Drive. Este 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 será enviado para o Chat. |
AttachmentDataRef
Uma referência aos dados do anexo.
Campos | |
---|---|
resource_name |
O nome do recurso dos dados do anexo. Esse campo é usado com a API de mídia para fazer o download dos dados de anexo. |
attachment_upload_token |
Token opaco contendo uma referência a um anexo enviado. Tratada por clientes como uma string opaca e usada para criar ou atualizar mensagens do Chat com anexos. |
CardWithId
Um card em uma mensagem do Google Chat.
Somente apps do Chat podem criar cards. Se o app do Chat se autenticar como um usuário, a mensagem não poderá conter cartões.
Elabore e visualize cards com o Criador de cartões.
Abrir o Card BuilderCampos | |
---|---|
card_id |
Obrigatório se a mensagem tiver vários cards. Identificador exclusivo de um cartão em uma mensagem. |
card |
Um cartão. O tamanho máximo é de 32 KB. |
ChatSpaceLinkData
Dados de links do espaço do Chat.
Campos | |
---|---|
space |
O espaço do recurso de espaço do Chat vinculado. Formato: |
thread |
A linha de execução do recurso de espaço do Chat vinculado. Formato: |
message |
A mensagem do recurso do espaço do Chat vinculado. Formato: |
CompleteImportSpaceRequest
Mensagem de solicitação para concluir o processo de importação de um espaço.
Campos | |
---|---|
name |
Obrigatório. Nome do recurso do espaço do modo de importação. Formato: |
CompleteImportSpaceResponse
Mensagem de resposta para concluir o processo de importação de um espaço.
Campos | |
---|---|
space |
O espaço do modo de importação. |
ContextualAddOnMarkup
Esse tipo não tem campos.
A marcação para que os desenvolvedores especifiquem o conteúdo de um complemento contextual.
Cartas
Um card é um elemento da interface que pode conter widgets de interface, como texto e imagens.
Campos | |
---|---|
header |
O cabeçalho do card. Geralmente, um cabeçalho contém um título e uma imagem. |
sections[] |
As seções são separadas por uma linha divisória. |
card_actions[] |
As ações deste card. |
name |
Nome do cartão. |
CardAction
Uma ação de card é a ação associada ao card. Para um cartão de fatura, uma ação típica seria: excluir a fatura, enviar a fatura por e-mail ou abrir a fatura no navegador.
Indisponível nos apps do Google Chat.
Campos | |
---|---|
action_label |
O rótulo era exibido no item do menu de ações. |
on_click |
A ação "onclick" deste item de ação. |
CardHeader
Campos | |
---|---|
title |
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 deles ocupará uma linha. Se apenas o título for especificado, ele vai ocupar as duas linhas. |
subtitle |
O subtítulo do cabeçalho do cartão. |
image_style |
O tipo da imagem (por exemplo, borda quadrada ou circular). |
image_url |
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 que são renderizados (verticalmente) na ordem em que são especificados. Em todas as plataformas, os cards têm uma largura fixa estreita. Por isso, no momento não é necessário usar propriedades de layout (por exemplo, flutuante).
Campos | |
---|---|
header |
Cabeçalho da seção. É possível usar texto formatado. Saiba mais sobre a formatação de texto em Formatar texto nos apps do Google Chat e Formatar texto em complementos do Google Workspace. |
widgets[] |
Uma seção precisa conter pelo menos um widget. |
CreateMembershipRequest
Mensagem de solicitação para criar uma assinatura.
Campos | |
---|---|
parent |
Obrigatório. O nome do recurso do espaço para criar a associação. Formato: espaços/{space} |
membership |
Obrigatório. A relação de associação a ser criada. O campo |
use_admin_access |
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 "Gerenciar conversas de chats e espaços". Exige o escopo OAuth 2.0 Não é possível criar assinaturas do app ou criar assinaturas para usuários fora da organização do Google Workspace do administrador usando o acesso de administrador. |
CreateMessageRequest
Cria uma mensagem.
Campos | |
---|---|
parent |
Obrigatório. O nome do recurso do espaço em que uma mensagem será criada. Formato: |
message |
Obrigatório. Corpo da mensagem. |
thread_key |
Opcional. Obsoleto: use |
request_id |
Opcional. Um ID de solicitação exclusivo para esta mensagem. Especificar um ID de solicitação existente retorna a mensagem criada com esse ID, em vez de criar uma nova mensagem. |
message_reply_option |
Opcional. Especifica se uma mensagem inicia uma conversa ou responde a uma. Compatível apenas em espaços nomeados. |
message_id |
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 O valor desse campo precisa atender aos seguintes requisitos:
Veja 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 uma nova conversa. O uso dessa opção ignora qualquer thread ID ou incluído. |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
Cria a mensagem como uma resposta à conversa especificada por thread ID ou . Em caso de falha, a mensagem inicia uma nova conversa. |
REPLY_MESSAGE_OR_FAIL |
Cria a mensagem como uma resposta à conversa especificada por thread ID ou . Se uma nova thread_key for usada, 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 |
Obrigatório. A mensagem em que a reação foi criada. Formato: |
reaction |
Obrigatório. A reação a ser criada. |
CreateSpaceRequest
Uma solicitação para criar um espaço sem participantes.
Campos | |
---|---|
space |
Obrigatório. Os campos Se você receber a mensagem de erro Se você for um membro do programa de prévia para desenvolvedores, poderá usar O espaço |
request_id |
Opcional. Um identificador exclusivo para essa solicitação. Um UUID aleatório é recomendado. 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 para o mesmo app do Chat com um usuário autenticado diferente retorna um erro. |
CustomEmoji
Representa um emoji personalizado.
Campos | |
---|---|
uid |
Apenas saída. Chave exclusiva para o recurso de emoji personalizado. |
DeleteMembershipRequest
Pedir para excluir a participação em um espaço.
Campos | |
---|---|
name |
Obrigatório. Nome do recurso da assinatura a ser excluída. Os apps de chat podem excluir ou as próprias assinaturas. Os apps de chat não podem excluir outros apps assinaturas. Ao excluir uma associação humana, é necessário o escopo Ao excluir uma associação a um app, é necessário o escopo Formato: |
use_admin_access |
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 "Gerenciar conversas de chats e espaços". Exige o escopo OAuth 2.0 Não é possível excluir assinaturas de apps em um espaço usando o acesso de administrador. |
DeleteMessageRequest
Solicitação para excluir uma mensagem.
Campos | |
---|---|
name |
Obrigatório. Nome do recurso da mensagem. Formato: Se você tiver definido um ID personalizado para sua mensagem, poderá usar o valor do campo |
force |
Quando Isso só se aplica durante a autenticação como usuário. Não tem efeito na autenticação como um app do Chat. |
DeleteReactionRequest
Exclui uma reação a uma mensagem.
Campos | |
---|---|
name |
Obrigatório. Nome da reação que será excluída. Formato: |
DeleteSpaceRequest
Solicitação para excluir um espaço.
Campos | |
---|---|
name |
Obrigatório. Nome do recurso do espaço a ser excluído. Formato: |
use_admin_access |
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 "Gerenciar conversas de chats e espaços". Exige o escopo OAuth 2.0 |
DeletionMetadata
Informações sobre uma mensagem excluída. Uma mensagem é excluída quando o delete_time
é definido.
Campos | |
---|---|
deletion_type |
Indica quem excluiu a mensagem. |
DeletionType
Quem excluiu a mensagem e como ela foi excluída.
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 do Chat excluiu a própria mensagem quando ela expirou. |
CREATOR_VIA_APP |
Um app do Chat excluiu a mensagem em nome do usuário. |
SPACE_OWNER_VIA_APP |
Um app do Chat excluiu a mensagem em nome do proprietário do espaço. |
Dialog
Wrapper em torno do corpo do cartão da caixa de diálogo.
Campos | |
---|---|
body |
Somente entrada. Corpo da caixa de diálogo, renderizado em um modal. Os apps do Google Chat não são compatíveis com as seguintes entidades de card: |
DialogAction
Contém uma caixa de diálogo e um código de status da solicitação.
Campos | |
---|---|
action_status |
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 |
Somente entrada. Caixa de diálogo para a solicitação. |
DriveDataRef
Uma referência aos dados de um anexo do Drive.
Campos | |
---|---|
drive_file_id |
O ID do arquivo do Drive. Use com a API Drive. |
DriveLinkData
Dados de links do Google Drive.
Campos | |
---|---|
drive_data_ref |
Um DriveDataRef que faz referência a um arquivo do Google Drive. |
mime_type |
O tipo MIME do recurso vinculado do Google Drive. |
Emoji
Um emoji usado como reação a uma mensagem.
Campos | |
---|---|
Campo de união content . O conteúdo do emoji. content pode ser apenas de um dos tipos a seguir: |
|
unicode |
Um emoji básico representado por uma string Unicode. |
custom_emoji |
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 associado às reações. |
reaction_count |
O número total de reações com o emoji associado. |
FindDirectMessageRequest
Uma solicitação para receber o espaço de mensagem direta com base no recurso do usuário.
Campos | |
---|---|
name |
Obrigatório. Nome do recurso do usuário que vai receber a mensagem direta. Formato: |
GetAttachmentRequest
Solicitação para receber um anexo.
Campos | |
---|---|
name |
Obrigatório. Nome do recurso do anexo, no formato |
GetMembershipRequest
Solicitação para participar de um espaço.
Campos | |
---|---|
name |
Obrigatório. Nome do recurso da associação a ser recuperada. Para conseguir a associação do app usando a autenticação do usuário, você tem a opção de usar Formato: Quando autenticado como um usuário, é possível usar o e-mail do usuário como um alias para |
use_admin_access |
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 "Gerenciar conversas de chats e espaços". Requer os escopos do OAuth 2.0 Não é possível receber assinaturas de apps em um espaço quando você usa o acesso de administrador. |
GetMessageRequest
Solicitação para receber uma mensagem.
Campos | |
---|---|
name |
Obrigatório. Nome do recurso da mensagem. Formato: Se você tiver definido um ID personalizado para sua mensagem, poderá usar o valor do campo |
GetSpaceEventRequest
Mensagem de solicitação para receber um evento do espaço.
Campos | |
---|---|
name |
Obrigatório. O nome do recurso do evento do espaço. Formato: |
GetSpaceReadStateRequest
Mensagem de solicitação para a API GetSpaceReadState.
Campos | |
---|---|
name |
Obrigatório. Nome do recurso do estado de leitura do espaço a ser recuperado. Oferece suporte apenas à busca do 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:
Formato: users/{user}/spaces/{space}/spaceReadState |
GetSpaceRequest
Uma solicitação para retornar um único espaço.
Campos | |
---|---|
name |
Obrigatório. Nome de recurso do espaço, no formato Formato: |
use_admin_access |
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 "Gerenciar conversas de chats e espaços". Requer os escopos OAuth 2.0 |
GetThreadReadStateRequest
Mensagem de solicitação para a API GetThreadReadStateRequest.
Campos | |
---|---|
name |
Obrigatório. Nome do recurso do estado de leitura da linha de execução a ser recuperada. Oferece suporte apenas à busca do 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:
Formato: users/{user}/spaces/{space}/threads/{thread}/threadReadState |
Grupo
Um Grupo do Google no Google Chat.
Campos | |
---|---|
name |
Nome de recurso para um Grupo do Google. Representa um grupo na API Cloud Identity Groups. Formato: groups/{group} |
HistoryState
O estado do histórico de mensagens e espaços. Especifica por quanto tempo as mensagens e as conversas são mantidas após a criação.
Enums | |
---|---|
HISTORY_STATE_UNSPECIFIED |
Valor padrão. Não use. |
HISTORY_OFF |
Histórico desativado. As mensagens e conversas são mantidas por 24 horas. |
HISTORY_ON |
Histórico ativado. As regras de retenção do Google Vault da organização especificam por quanto tempo as mensagens e as conversas são mantidas. |
ListMembershipsRequest
Mensagem de solicitação para associações à ficha.
Campos | |
---|---|
parent |
Obrigatório. O nome do recurso do espaço em que uma lista de participantes será buscada. Formato: espaços/{space} |
page_size |
Opcional. O número máximo de assinaturas a serem retornadas. O serviço pode retornar menos do que esse valor. Se não for especificado, serão retornadas no máximo 100 associações. 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 |
page_token |
Opcional. Um token de página, recebido de uma chamada anterior para listar associações. Forneça esse parâmetro para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos devem corresponder à chamada que forneceu o token da página. Transmitir valores diferentes para outros parâmetros pode levar a resultados inesperados. |
filter |
Opcional. Um filtro de consulta. É possível filtrar as associações pela função ( Para filtrar por função, defina Para filtrar por tipo, defina Para filtrar por função e tipo, use o operador É necessário usar Por exemplo, as seguintes consultas são válidas:
As seguintes consultas são inválidas:
As consultas inválidas são rejeitadas pelo servidor com um erro |
show_groups |
Opcional. Quando |
show_invited |
Opcional. Quando Requer a autenticação do usuário no momento. |
use_admin_access |
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 "Gerenciar conversas de chats e espaços". Requer o escopo OAuth 2.0 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 as associações do espaço.
Campos | |
---|---|
memberships[] |
Lista não ordenada. Lista de associações na página solicitada (ou na primeira). |
next_page_token |
Um token que pode ser enviado como |
ListMessagesRequest
Lista as mensagens do espaço especificado do usuário.
Campos | |
---|---|
parent |
Obrigatório. O nome do recurso do espaço para listar mensagens. Formato: |
page_size |
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 sã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 |
page_token |
Opcional, se estiver reiniciando de uma consulta anterior. Um token de página recebido de uma chamada de mensagens de lista anterior. Forneça esse parâmetro para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos devem corresponder à chamada que forneceu o token da página. Transmitir valores diferentes para outros parâmetros pode levar a resultados inesperados. |
filter |
Um filtro de consulta. Você pode filtrar as mensagens por data ( Para filtrar as mensagens pela data de criação, especifique a Para filtrar por linha de execução, especifique o Para filtrar por linha de execução e data, use o operador Por exemplo, as seguintes consultas são válidas:
As consultas inválidas são rejeitadas pelo servidor com um erro |
order_by |
Opcional, se estiver reiniciando de uma consulta anterior. Como a lista de mensagens é ordenada. Especifique um valor para ordenar por uma operação de ordenação. Os valores de operação de ordenação válidos são os seguintes:
A ordem padrão é |
show_deleted |
Define se as mensagens excluídas serão incluídas. As mensagens excluídas incluem o horário da exclusão e os metadados sobre a exclusão, mas o conteúdo da mensagem não está disponível. |
ListMessagesResponse
Mensagem de resposta para listar mensagens.
Campos | |
---|---|
messages[] |
Lista de mensagens. |
next_page_token |
É possível enviar um token como |
ListReactionsRequest
Lista as reações a uma mensagem.
Campos | |
---|---|
parent |
Obrigatório. A mensagem à qual os usuários reagiram. Formato: |
page_size |
Opcional. O número máximo de reações retornadas. O serviço pode retornar menos reações do que esse valor. Se não for especificado, o valor padrão será 25. O valor máximo é 200. valores acima de 200 são alterados para 200. |
page_token |
Opcional. (Se estiver retomando de uma consulta anterior.) Um token de página recebido de uma chamada de reações de lista anterior. Forneça isso para recuperar a página subsequente. Ao paginar, o valor do filtro deve corresponder à chamada que forneceu o token da página. Transmitir um valor diferente pode levar a resultados inesperados. |
filter |
Opcional. Um filtro de consulta. Você pode filtrar as reações por emoji ( Para filtrar as reações de vários emojis ou usuários, mescle campos semelhantes com o operador Para filtrar as reações por emoji e usuário, use o operador Caso a consulta use Por exemplo, as seguintes consultas são válidas:
As seguintes consultas são inválidas:
As consultas inválidas são rejeitadas pelo servidor com um erro |
ListReactionsResponse
Resposta a uma solicitação de reações de lista.
Campos | |
---|---|
reactions[] |
Lista de reações na página solicitada (ou na primeira). |
next_page_token |
Token de continuação para recuperar a próxima página de resultados. Está vazio na última página de resultados. |
ListSpaceEventsRequest
Mensagem de solicitação para listar eventos do espaço.
Campos | |
---|---|
parent |
Obrigatório. Nome do recurso do espaço do Google Chat onde os eventos ocorreram. Formato: |
page_size |
Opcional. O número máximo de eventos do espaço retornados. O serviço pode retornar menos do que esse valor. Valores negativos retornam um erro |
page_token |
Um token de página, recebido de uma chamada anterior de eventos do espaço de lista. Forneça isso para recuperar a página subsequente. Na paginação, todos os outros parâmetros fornecidos para listar eventos do espaço precisam corresponder à chamada que forneceu o token da página. Transmitir valores diferentes para os outros parâmetros pode gerar resultados inesperados. |
filter |
Obrigatório. Um filtro de consulta. É necessário especificar pelo menos um tipo de evento ( Também é possível filtrar por horário de início (
Para especificar um horário de início ou término, use o operador Por exemplo, as seguintes consultas são válidas:
As seguintes consultas são inválidas:
As consultas inválidas são rejeitadas pelo servidor com um erro |
ListSpaceEventsResponse
Mensagem de resposta para listar eventos do espaço.
Campos | |
---|---|
space_events[] |
Os resultados são retornados em ordem cronológica (o evento mais antigo primeiro). |
next_page_token |
Token de continuação usado para buscar mais eventos. Se esse campo for omitido, não haverá páginas subsequentes. |
ListSpacesRequest
Uma solicitação para listar os espaços de que o autor da chamada participa.
Campos | |
---|---|
page_size |
Opcional. O número máximo de espaços a serem retornados. O serviço pode retornar menos do 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 |
page_token |
Opcional. Um token de página, recebido de uma chamada de espaços de lista anterior. Forneça esse parâmetro para recuperar a página subsequente. Ao paginar, o valor do filtro deve corresponder à chamada que forneceu o token da página. Transmitir um valor diferente pode levar a resultados inesperados. |
filter |
Opcional. Um filtro de consulta. É possível filtrar os espaços pelo tipo ( Para filtrar por tipo de espaço, especifique um valor de tipo enumerado válido, como Por exemplo, as seguintes consultas são válidas:
As consultas inválidas são rejeitadas pelo servidor com um erro |
ListSpacesResponse
A resposta para uma solicitação de listagem de espaços.
Campos | |
---|---|
spaces[] |
Lista de espaços na página solicitada (ou na primeira). |
next_page_token |
É possível enviar um token como |
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 |
Apenas saída. O URL correspondente. |
Associação
Representa uma relação de associação no Google Chat, por exemplo, se um usuário ou app do Chat é convidado, faz parte ou está ausente de um espaço.
Campos | |
---|---|
name |
Nome de recurso da associação, atribuído pelo servidor. Formato: |
state |
Apenas saída. Estado da assinatura. |
role |
Opcional. A função 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 no |
create_time |
Opcional. Imutável. O horário de criação da associação, como a data em que um participante entrou ou foi convidado para um espaço. Este campo é apenas para saída, exceto quando usado para importar associações históricas em espaços do modo de importação. |
delete_time |
Opcional. Imutável. O horário de exclusão da participação, como quando um participante saiu ou foi removido de um espaço. Este campo é apenas para saída, exceto quando usado para importar associações históricas em espaços do modo de importação. |
Campo de união memberType . Participante 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 |
O usuário ou app do Google Chat a que a associação corresponde. Se o app do Chat se autenticar como um usuário, a saída preencherá o usuário |
group_member |
O Grupo do Google ao qual a associação corresponde. |
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 : a pessoa não faz parte do espaço, mas pode receber um convite. Para Google Groups : sempre recebe esse papel (outros valores de tipo enumerado podem ser usados no futuro). |
ROLE_MEMBER |
É participante do espaço. O usuário tem permissões básicas, como enviar mensagens para o espaço. Nas conversas em grupo individuais e sem nome, todos têm essa função. |
ROLE_MANAGER |
Administrador do espaço O usuário tem todas as permissões básicas e administrativas para gerenciar o espaço, como adicionar ou remover participantes. Compatível apenas com SpaceType.SPACE . |
MembershipState
Especifica o relacionamento do membro com um espaço. Outros estados de assinatura 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. |
INVITED |
O usuário recebeu um convite, mas não entrou no espaço. |
NOT_A_MEMBER |
O usuário não pertence ao espaço nem tem um convite pendente para participar dele. |
MembershipBatchCreatedEventData
Payload de evento para várias novas associações.
Tipo de evento: google.workspace.chat.membership.v1.batchCreated
Campos | |
---|---|
memberships[] |
Uma lista de novas associações. |
MembershipBatchDeletedEventData
Payload de evento para várias associações excluídas.
Tipo de evento: google.workspace.chat.membership.v1.batchDeleted
Campos | |
---|---|
memberships[] |
Uma lista de assinaturas excluídas. |
MembershipBatchUpdatedEventData
Payload de evento para várias associações atualizadas.
Tipo de evento: google.workspace.chat.membership.v1.batchUpdated
Campos | |
---|---|
memberships[] |
Uma lista de assinaturas atualizadas. |
MembershipCreatedEventData
Payload de evento para uma nova assinatura.
Tipo de evento: google.workspace.chat.membership.v1.created
.
Campos | |
---|---|
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 |
A assinatura foi excluída. Apenas os campos |
MembershipUpdatedEventData
Payload de evento para uma assinatura atualizada.
Tipo de evento: google.workspace.chat.membership.v1.updated
Campos | |
---|---|
membership |
A assinatura atualizada. |
Mensagem
Uma mensagem em um espaço do Google Chat.
Campos | |
---|---|
name |
Nome do recurso da mensagem. Formato: Em que Se você definir um ID personalizado ao criar uma mensagem, poderá usá-lo para especificar a mensagem em uma solicitação. Basta substituir |
sender |
Apenas saída. O usuário que criou a mensagem. Se o app do Chat se autenticar como um usuário, a saída preencherá o usuário |
create_time |
Opcional. Imutável. Nos espaços criados no Chat, o horário em que a mensagem foi criada. Este campo é apenas para 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 |
Apenas saída. A hora em que a mensagem foi editada pela última vez por um usuário. Se a mensagem nunca tiver sido editada, este campo estará vazio. |
delete_time |
Apenas saída. O horário em que a mensagem foi excluída no Google Chat. Se a mensagem nunca for excluída, esse campo ficará vazio. |
text |
Corpo da mensagem em texto simples. 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 |
Apenas saída. Contém a mensagem
Para mais informações, consulte Conferir a formatação de texto enviada em uma mensagem. |
cards[] |
Obsoleto: use Cards avançados, formatados e interativos que você pode usar para exibir elementos da interface, como textos formatados, botões e imagens clicáveis. Os cards normalmente aparecem abaixo do corpo de texto simples da mensagem. |
cards_v2[] |
Uma matriz de cards. Somente apps do Chat podem criar cards. Se o app do Chat se autenticar como um usuário, as mensagens não poderão conter cartões. Para saber como criar uma mensagem com cards, consulte Enviar uma mensagem. Elabore e visualize cards com o Criador de cartões. Abrir o Card Builder |
annotations[] |
Apenas saída. Anotações associadas ao |
thread |
A conversa a que a mensagem pertence. Para exemplos de uso, consulte Iniciar ou responder a uma conversa. |
space |
Se o app do Chat se autenticar como um usuário, a saída vai preencher o espaço |
fallback_text |
Uma descrição em texto simples dos cards da mensagem, usada quando os cards reais não podem ser exibidos, por exemplo, notificações em dispositivos móveis. |
action_response |
Somente entrada. Parâmetros que um app do Chat pode usar para configurar como a resposta é postada. |
argument_text |
Apenas saída. Corpo de texto simples da mensagem com todas as menções a apps do Chat removidas. |
slash_command |
Apenas saída. Informações do comando de barra, se aplicável. |
attachment[] |
Anexo enviado pelo usuário. |
matched_url |
Apenas saída. Um URL em |
thread_reply |
Apenas saída. Quando definido como Se o espaço não permitir a resposta em conversas, este campo será sempre |
client_assigned_message_id |
Opcional. Um ID personalizado para a mensagem. Você pode usar esse campo para identificar ou receber, excluir ou atualizar uma mensagem. Para definir um ID personalizado, especifique o campo |
emoji_reaction_summaries[] |
Apenas saída. A lista de resumos de reações com emojis na mensagem. |
private_message_viewer |
Imutável. Entrada para criar uma mensagem. Caso contrário, apenas saída. O usuário que pode ver a mensagem. Quando definida, a mensagem é particular e só fica visível para o usuário especificado e para o app do Chat. Para incluir esse campo na solicitação, chame a API Chat usando a autenticação de apps e omita o seguinte: Confira mais detalhes em Enviar uma mensagem particular. |
deletion_metadata |
Apenas saída. Informações sobre uma mensagem excluída. Uma mensagem é excluída quando |
quoted_message_metadata |
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. |
attached_gifs[] |
Apenas saída. Imagens GIF anexadas à mensagem. |
accessory_widgets[] |
Um ou mais widgets interativos que aparecem na parte inferior de uma mensagem. Você pode adicionar widgets de acessório a mensagens que contenham texto, cards ou ambos. Indisponível para mensagens que contêm caixas de diálogo. Confira mais detalhes em Adicionar widgets interativos na parte de baixo de uma mensagem. Para criar uma mensagem com widgets de acessório, é preciso autenticar o app. |
MessageBatchCreatedEventData
Payload de evento para várias mensagens novas.
Tipo de evento: google.workspace.chat.message.v1.batchCreated
Campos | |
---|---|
messages[] |
Uma lista de novas mensagens. |
MessageBatchDeletedEventData
Payload de evento para várias mensagens excluídas.
Tipo de evento: google.workspace.chat.message.v1.batchDeleted
Campos | |
---|---|
messages[] |
Uma lista de mensagens excluídas. |
MessageBatchUpdatedEventData
Payload de evento para várias mensagens atualizadas.
Tipo de evento: google.workspace.chat.message.v1.batchUpdated
Campos | |
---|---|
messages[] |
Uma lista de mensagens atualizadas. |
MessageCreatedEventData
Payload de evento de uma nova mensagem.
Tipo de evento: google.workspace.chat.message.v1.created
Campos | |
---|---|
message |
A nova mensagem. |
MessageDeletedEventData
Payload do evento para uma mensagem excluída.
Tipo de evento: google.workspace.chat.message.v1.deleted
Campos | |
---|---|
message |
A mensagem excluída. Somente os campos |
MessageUpdatedEventData
Payload de evento de uma mensagem atualizada.
Tipo de evento: google.workspace.chat.message.v1.updated
Campos | |
---|---|
message |
A mensagem atualizada. |
QuotedMessageMetadata
Informações sobre uma mensagem citada.
Campos | |
---|---|
name |
Apenas saída. Nome do recurso da mensagem citada. Formato: |
last_update_time |
Apenas saída. O carimbo de data/hora em que a mensagem citada foi criada ou atualizada pela última vez. |
Reação
Reação a uma mensagem.
Campos | |
---|---|
name |
O nome do recurso da reação. Formato: |
user |
Apenas saída. O usuário que criou a reação. |
emoji |
O emoji usado na reação. |
ReactionBatchCreatedEventData
Payload de evento para várias reações novas.
Tipo de evento: google.workspace.chat.reaction.v1.batchCreated
Campos | |
---|---|
reactions[] |
Uma lista de novas reações. |
ReactionBatchDeletedEventData
Payload de evento para várias reações excluídas.
Tipo de evento: google.workspace.chat.reaction.v1.batchDeleted
Campos | |
---|---|
reactions[] |
Uma lista de reações excluídas. |
ReactionCreatedEventData
Payload de evento para uma nova reação.
Tipo de evento: google.workspace.chat.reaction.v1.created
Campos | |
---|---|
reaction |
A nova reação. |
ReactionDeletedEventData
Payload de evento para uma reação excluída.
Tipo: google.workspace.chat.reaction.v1.deleted
Campos | |
---|---|
reaction |
A reação excluída. |
RichLinkMetadata
Um link avançado para um recurso.
Campos | |
---|---|
uri |
O URI do link. |
rich_link_type |
O tipo de link avançado. |
Campo de união data . Dados do recurso vinculado. data pode ser apenas de um dos tipos a seguir: |
|
drive_link_data |
Dados de um link do Drive. |
chat_space_link_data |
Dados de um link do espaço do Chat. |
RichLinkType
O tipo de link avançado. Outros tipos podem ser adicionados no futuro.
Enums | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
Valor padrão do tipo enumerado. Não use. |
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 |
Quando O usuário que faz a chamada precisa ser um administrador do Google Workspace com o privilégio "Gerenciar conversas de chats e espaços". Requer o escopo OAuth 2.0 No momento, esse método só oferece suporte ao acesso de administrador. Portanto, apenas |
page_size |
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, serão retornados no máximo 100 espaços. O valor máximo é 1.000. Se você usar um valor maior que 1.000, ele será alterado automaticamente para 1.000. |
page_token |
Um token, recebido da chamada anterior de espaços de pesquisa. Forneça esse parâmetro para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos devem corresponder à chamada que forneceu o token da página. Transmitir valores diferentes para outros parâmetros pode levar a resultados inesperados. |
query |
Obrigatório. Uma consulta de pesquisa. É possível pesquisar usando os seguintes parâmetros:
O
Em campos diferentes, somente os operadores No mesmo campo, As consultas de exemplo a seguir são válidas:
|
order_by |
Opcional. Como a lista de espaços é ordenada. Os atributos que podem ser ordenados são:
Os valores de operação de ordenação válidos são:
A sintaxe compatível é:
|
SearchSpacesResponse
Responda com uma lista de espaços correspondentes à solicitação de espaços de pesquisa.
Campos | |
---|---|
spaces[] |
Uma página dos espaços solicitados. |
next_page_token |
Um token que pode ser usado para recuperar a próxima página. Se esse campo estiver vazio, não haverá páginas subsequentes. |
total_size |
O número total de espaços que correspondem à consulta em todas as páginas. Se o resultado tiver mais de 10.000 espaços, esse valor é uma estimativa. |
SetUpSpaceRequest
Solicitação para criar um espaço e adicionar usuários especificados a ele.
Campos | |
---|---|
space |
Obrigatório. O campo Para criar um espaço, defina Para criar um chat em grupo, defina Para criar uma conversa individual entre pessoas, defina Para criar uma conversa individual entre uma pessoa e o app de chamada do Chat, defina Se um espaço |
request_id |
Opcional. Um identificador exclusivo para essa solicitação. Um UUID aleatório é recomendado. Especificar um ID de solicitação já existente retorna o espaço criado com esse ID em vez de criar um novo. Especificar um ID de solicitação para o mesmo app do Chat com um usuário autenticado diferente retorna um erro. |
memberships[] |
Opcional. Os usuários ou grupos do Google Chat que serão convidados para o espaço. Omita o usuário que faz a chamada, porque ele é adicionado automaticamente. O conjunto atualmente permite até 20 associações (além do autor da chamada). Para associação humana, o campo Para associação a um grupo do Google, o campo Opcional ao definir Obrigatório ao definir Obrigatório ao definir Precisa estar em branco ao criar uma conversa individual entre uma pessoa e o app de chamada do Chat (ao definir |
SlashCommand
Um comando de barra no Google Chat.
Campos | |
---|---|
command_id |
O ID do comando de barra invocado. |
SlashCommandMetadata
Metadados de anotação para comandos de barra (/).
Campos | |
---|---|
bot |
O app do Chat cujo comando foi invocado. |
type |
O tipo de comando de barra. |
command_name |
O nome do comando de barra invocado. |
command_id |
O ID do comando de barra invocado. |
triggers_dialog |
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 |
Adicionar 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 |
Nome do recurso do espaço. Formato: Em que |
type |
Apenas saída. Obsoleto: use |
space_type |
O tipo de espaço. Obrigatório ao criar ou atualizar o tipo de um espaço. Saída apenas para outro uso. |
single_user_bot_dm |
Opcional. Se o espaço é uma mensagem direta entre um app do Chat e uma única pessoa. |
threaded |
Apenas saída. Obsoleto: use |
display_name |
O nome de exibição do espaço. Obrigatório ao criar um espaço com um Este campo pode estar vazio nas mensagens diretas. Aceita até 128 caracteres. |
external_user_allowed |
Imutável. Se qualquer usuário do Google Chat pode participar deste espaço. Entrada ao criar um espaço em uma organização do Google Workspace. Omita este campo ao criar espaços nas seguintes condições:
Nos espaços atuais, este campo é apenas para saída. |
space_threading_state |
Apenas saída. O estado da conversa no espaço do Chat. |
space_details |
Detalhes sobre o espaço, incluindo descrição e regras. |
space_history_state |
O estado do histórico de mensagens e conversas neste espaço. |
import_mode |
Opcional. Indica se esse espaço foi criado no |
create_time |
Opcional. Imutável. O horário em que o espaço foi criado nos espaços criados no Chat. Este campo é apenas para 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. Preenchido na saída apenas quando |
last_active_time |
Apenas saída. Carimbo de data/hora da última mensagem no espaço. |
admin_installed |
Apenas saída. Nos espaços de mensagens diretas (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 |
Apenas saída. A contagem de associações participantes agrupadas por tipo de participante. Preenchido quando |
access_settings |
Opcional. Especifica a configuração de acesso do espaço. Preenchido apenas quando |
space_uri |
Apenas saída. O URI para um usuário acessar o espaço. |
Campo de união space_permission_settings . Representa as configurações de permissão de um espaço. Preenchido apenas quando space_type é SPACE . space_permission_settings só pode ser de um dos tipos a seguir: |
|
predefined_permission_settings |
Opcional. Somente entrada. Configurações de permissão do espaço. Entrada para criar um espaço. Um espaço de colaboração será criado se este campo não for definido. Depois que você cria o espaço, as configurações são preenchidas no campo |
permission_settings |
Opcional. Configurações de permissão exatas que podem ser definidas para atualizar o espaço. Entrada para atualizar um espaço. Caso contrário, somente saída. Para criar espaços, use |
AccessSettings
Representa a configuração de acesso do espaço.
Campos | |
---|---|
access_state |
Apenas saída. Indica o estado de acesso do espaço. |
audience |
Opcional. O nome do recurso do público-alvo que pode descobrir, participar e visualizar as mensagens do espaço. Se ela não for definida, só os usuários ou Grupos do Google convidados ou adicionados ao espaço poderão acessá-lo. Veja mais detalhes em Tornar um espaço detectável para um público-alvo. Formato: Para usar o público-alvo padrão da organização do Google Workspace, defina como |
AccessState
Representa o estado de acesso do espaço.
Enums | |
---|---|
ACCESS_STATE_UNSPECIFIED |
O estado de acesso é desconhecido ou incompatível com esta API. |
PRIVATE |
Só os usuários ou Grupos do Google adicionados ou convidados individualmente por outros usuários ou administradores do Google Workspace podem encontrar e acessar o espaço. |
DISCOVERABLE |
Um administrador concedeu a um público-alvo acesso ao espaço. Os usuários ou grupos do Google que foram adicionados ou convidados individualmente para o espaço também podem encontrar e acessar o espaço. Saiba mais em Tornar um espaço detectável para usuários específicos. |
MembershipCount
Campos | |
---|---|
joined_direct_human_user_count |
Contagem de usuários humanos que participaram diretamente do espaço, sem contar os usuários que participaram de um grupo. |
joined_group_count |
Número de grupos que participaram diretamente do espaço. |
PermissionSetting
Representa uma configuração de permissão do espaço.
Campos | |
---|---|
managers_allowed |
Indica se os administradores dos espaços têm essa permissão. |
members_allowed |
Indica se pessoas que não são administradores têm essa permissão. |
PermissionSettings
Configurações de permissão para um espaço nomeado. Para definir as configurações de permissão ao criar um espaço, especifique o campo PredefinedPermissionSettings
na sua solicitação.
Campos | |
---|---|
manage_members_and_groups |
Configuração para gerenciar participantes e grupos em um espaço. |
modify_space_details |
Configuração para atualizar o nome, o avatar, a descrição e as diretrizes do espaço. |
toggle_history |
Configuração para ativar e desativar o histórico do espaço. |
use_at_mention_all |
Configuração para usar @todos em um espaço. |
manage_apps |
Configuração para gerenciar apps em um espaço. |
manage_webhooks |
Configuração para gerenciar webhooks em um espaço. |
post_messages |
Apenas saída. Configurações para postar mensagens em um espaço. |
reply_messages |
Configurações para responder a mensagens em um espaço. |
PredefinedPermissionSettings
As configurações de permissão de espaço que podem ser especificadas ao criar um espaço nomeado. É possível que mais configurações sejam adicionadas no futuro. Saiba mais sobre as configurações de permissão para espaços nomeados em Saiba mais sobre os espaços.
Enums | |
---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED |
Não especificado. Não use. |
COLLABORATION_SPACE |
Configuração para transformar o espaço em um espaço de colaboração onde 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 |
Opcional. Uma descrição do espaço. Por exemplo, descreva o tema de discussão, o propósito funcional ou os participantes do espaço. Aceita até 150 caracteres. |
guidelines |
Opcional. Regras, expectativas e etiqueta do espaço. Aceita até 5.000 caracteres. |
SpaceThreadingState
Especifica o tipo de estado da linha de execução no espaço do Chat.
Enums | |
---|---|
SPACE_THREADING_STATE_UNSPECIFIED |
Reservado. |
THREADED_MESSAGES |
Espaços nomeados compatíveis com agrupamentos de mensagens. Ao responder a uma mensagem, os usuários podem responder em uma conversa, o que mantém a resposta no contexto da mensagem original. |
GROUPED_MESSAGES |
Espaços nomeados com organização por tema. Os tópicos e as respostas deles são agrupados. |
UNTHREADED_MESSAGES |
Mensagens diretas 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 apenas para outro uso.
Enums | |
---|---|
SPACE_TYPE_UNSPECIFIED |
Reservado. |
SPACE |
Um lugar onde as pessoas enviam mensagens, compartilham arquivos e colaboram. Uma SPACE pode incluir apps do Chat. |
GROUP_CHAT |
Conversas em grupo com três ou mais pessoas. Uma GROUP_CHAT pode incluir apps do Chat. |
DIRECT_MESSAGE |
Mensagens individuais entre duas pessoas ou uma pessoa e um app do Chat. |
Tipo
Obsoleto: use SpaceType
.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Reservado. |
ROOM |
Conversas entre duas ou mais pessoas. |
DM |
Mensagem direta individual entre uma pessoa e um app do Chat, com todas as mensagens sem formatação. Isso não inclui mensagens diretas entre duas pessoas. |
SpaceBatchUpdatedEventData
Payload de evento para várias atualizações em um espaço.
Tipo de evento: google.workspace.chat.space.v1.batchUpdated
Campos | |
---|---|
spaces[] |
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 |
Nome do recurso do evento do espaço. Formato: |
event_time |
A hora em que o evento ocorreu. |
event_type |
Tipo de evento espacial. 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 Tipos de eventos compatíveis com messages:
Tipos de eventos compatíveis com assinaturas:
Tipos de evento compatíveis com as reações:
Tipos de evento compatíveis com o espaço:
|
Campo de união
|
|
message_created_event_data |
Payload de evento de uma nova mensagem. Tipo de evento: |
message_updated_event_data |
Payload de evento de uma mensagem atualizada. Tipo de evento: |
message_deleted_event_data |
Payload de evento de uma mensagem excluída. Tipo de evento: |
message_batch_created_event_data |
Payload de evento para várias mensagens novas. Tipo de evento: |
message_batch_updated_event_data |
Payload de evento para várias mensagens atualizadas. Tipo de evento: |
message_batch_deleted_event_data |
Payload de evento para várias mensagens excluídas. Tipo de evento: |
space_updated_event_data |
Payload de evento para uma atualização de espaço. Tipo de evento: |
space_batch_updated_event_data |
Payload de evento para várias atualizações em um espaço. Tipo de evento: |
membership_created_event_data |
Payload de evento para uma nova assinatura. Tipo de evento: |
membership_updated_event_data |
Payload de evento para uma assinatura atualizada. Tipo de evento: |
membership_deleted_event_data |
Payload do evento para uma associação excluída. Tipo de evento: |
membership_batch_created_event_data |
Payload de evento para várias novas associações. Tipo de evento: |
membership_batch_updated_event_data |
Payload de evento para várias associações atualizadas. Tipo de evento: |
membership_batch_deleted_event_data |
Payload de evento para várias associações excluídas. Tipo de evento: |
reaction_created_event_data |
Payload de evento para uma nova reação. Tipo de evento: |
reaction_deleted_event_data |
Payload de evento para uma reação excluída. Tipo de evento: |
reaction_batch_created_event_data |
Payload de evento para várias reações novas. Tipo de evento: |
reaction_batch_deleted_event_data |
Payload de evento para várias reações excluídas. Tipo de evento: |
SpaceReadState
O estado de leitura de um usuário em um espaço, usado para identificar mensagens lidas e não lidas.
Campos | |
---|---|
name |
Nome do recurso do estado de leitura do espaço. Formato: |
last_read_time |
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 um carimbo de data/hora especificado pelo usuário para marcar a última posição de leitura em um espaço. |
SpaceUpdatedEventData
Payload de evento para um espaço atualizado.
Tipo de evento: google.workspace.chat.space.v1.updated
Campos | |
---|---|
space |
O espaço atualizado. |
Conversa
Uma conversa em um espaço do Google Chat. Para exemplos de uso, consulte Iniciar ou responder a uma conversa.
Se você especificar uma conversa ao criar uma mensagem, poderá definir o campo messageReplyOption
para determinar o que vai acontecer se nenhuma conversa correspondente for encontrada.
Campos | |
---|---|
name |
Nome do recurso da linha de execução. Exemplo: |
thread_key |
Opcional. Entrada para criar ou atualizar uma conversa. Caso contrário, somente saída. ID da linha de execução. Aceita até 4.000 caracteres. Esse ID é exclusivo do app do Chat que o define. Por exemplo, se vários apps de chat criarem uma mensagem usando a mesma chave de conversa, as mensagens serão postadas em conversas diferentes. Para responder a uma conversa criada por uma pessoa ou outro app do Chat, especifique o campo |
ThreadReadState
O estado de leitura de um usuário em uma conversa, usado para identificar mensagens lidas e não lidas.
Campos | |
---|---|
name |
Nome do recurso do estado de leitura da linha de execução. Formato: |
last_read_time |
A hora em que o estado de leitura da linha de execução do usuário foi atualizado. Geralmente, isso corresponde ao carimbo de data/hora da última mensagem lida em uma conversa. |
UpdateMembershipRequest
Mensagem de solicitação para atualizar uma assinatura.
Campos | |
---|---|
membership |
Obrigatório. A assinatura a ser atualizada. Somente os campos especificados por |
update_mask |
Obrigatório. Os caminhos do campo a serem atualizados. Separe valores por vírgulas ou use Caminhos de campo atualmente compatíveis:
|
use_admin_access |
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 "Gerenciar conversas de chats e espaços". Exige o escopo OAuth 2.0 |
UpdateMessageRequest
Solicitação para atualizar uma mensagem.
Campos | |
---|---|
message |
Obrigatório. Mensagem com campos atualizados. |
update_mask |
Obrigatório. Os caminhos do campo a serem atualizados. Separe valores por vírgulas ou use Caminhos de campo atualmente compatíveis:
|
allow_missing |
Opcional. Se |
UpdateSpaceReadStateRequest
Mensagem de solicitação para a API UpdateSpaceReadState.
Campos | |
---|---|
space_read_state |
Obrigatório. O estado de leitura do espaço e os campos a serem atualizados. Oferece suporte apenas à atualização do 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:
Formato: users/{user}/spaces/{space}/spaceReadState |
update_mask |
Obrigatório. Os caminhos de campo a serem atualizados. Caminhos de campo compatíveis:
Quando o Para marcar o espaço como lido, defina |
UpdateSpaceRequest
Uma solicitação para atualizar um único espaço.
Campos | |
---|---|
space |
Obrigatório. Espaço com campos a serem atualizados. |
update_mask |
Obrigatório. Os caminhos de campo atualizados, separados por vírgulas se houver vários. Você pode atualizar os seguintes campos de um espaço:
|
use_admin_access |
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 "Gerenciar conversas de chats e espaços". Exige o escopo OAuth 2.0 Alguns valores |
Usuário
Um usuário no Google Chat. Quando retornado como saída de uma solicitação, se o app do Chat se autenticar como um usuário, a saída de um recurso User
vai preencher apenas os name
e type
do usuário.
Campos | |
---|---|
name |
Nome do recurso para um Formato: Para
|
display_name |
Apenas saída. O nome de exibição do usuário. |
domain_id |
Identificador exclusivo do domínio do Google Workspace do usuário. |
type |
Tipo de usuário. |
is_anonymous |
Apenas saída. Quando |
Tipo
Enums | |
---|---|
TYPE_UNSPECIFIED |
Valor padrão do tipo enumerado. NÃO USE. |
HUMAN |
Usuário humano. |
BOT |
Usuário do app do Chat. |
UserMentionMetadata
Metadados de anotação para menções a usuários (@).
Campos | |
---|---|
user |
O usuário mencionou. |
type |
O tipo de menção ao usuário. |
Tipo
Enums | |
---|---|
TYPE_UNSPECIFIED |
Valor padrão do tipo enumerado. Não use. |
ADD |
Adicionar 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[] |
Uma lista de botões. Os botões também são |
Campo de união data . Uma WidgetMarkup só pode ter um dos seguintes itens. É possível usar vários campos WidgetMarkup para mostrar mais itens. data só pode ser de um dos tipos a seguir: |
|
text_paragraph |
Exibir um parágrafo de texto neste widget. |
image |
Mostre uma imagem neste widget. |
key_value |
Exiba 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
|
|
text_button |
Um botão com texto e ação |
image_button |
Um botão com imagem e ação |
FormAction
Uma ação de formulário descreve o comportamento quando o formulário é enviado. Por exemplo, você pode invocar o Apps Script para processar o formulário.
Campos | |
---|---|
action_method_name |
O nome do método é usado para identificar qual parte do formulário acionou o envio do formulário. Essas informações são enviadas de volta ao app do 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[] |
Lista de parâmetros de ação. |
ActionParameter
Lista de parâmetros de string a serem fornecidos quando o método de ação é invocado. Por exemplo, considere três botões de soneca: soneca agora, soneca um dia e soneca próxima semana. Você pode usar action method = snooze()
, transmitindo o tipo e o tempo de adiamento na lista de parâmetros de string.
Campos | |
---|---|
key |
O nome do parâmetro para o script de ação. |
value |
O valor do parâmetro. |
Ícone
O conjunto de ícones compatíveis.
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 |
É o URL da imagem. |
on_click |
A ação |
aspect_ratio |
É a proporção da imagem (largura e altura). Esse campo permite reservar a altura correta para a imagem enquanto você aguarda o carregamento dela. Ela não substitui a proporção integrada da imagem. Se ela não for definida, o servidor vai preenchê-la fazendo uma pré-busca da imagem. |
ImageButton
Um botão de imagem com uma ação onclick
.
Campos | |
---|---|
on_click |
A ação |
name |
O nome do |
Campo de união icons . O ícone pode ser especificado por uma Icon enum ou um URL. icons só pode ser de um dos tipos a seguir: |
|
icon |
O ícone especificado por uma |
icon_url |
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 |
O texto do marcador superior. Suporte a texto formatado. Saiba mais sobre a formatação de texto em Formatar texto nos apps do Google Chat e Formatar texto em complementos do Google Workspace. |
content |
O texto do conteúdo. Texto formatado é permitido e sempre obrigatório. Saiba mais sobre a formatação de texto em Formatar texto nos apps do Google Chat e Formatar texto em complementos do Google Workspace. |
content_multiline |
Se o conteúdo precisar ser multilinha. |
bottom_label |
O texto do marcador inferior. Suporte a texto formatado. Saiba mais sobre a formatação de texto em Formatar texto nos apps do Google Chat e Formatar texto em complementos do Google Workspace. |
on_click |
A ação |
Campo de união icons . Pelo menos um dos ícones, top_label e bottom_label , precisa ser definido. icons só pode ser de um dos tipos a seguir: |
|
icon |
Um valor de enumeração que é substituído pela API Chat pela imagem de ícone correspondente. |
icon_url |
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 só pode ser de um dos tipos a seguir: |
|
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
|
|
action |
Uma ação de formulário será acionada por esta ação |
open_link |
Se especificada, esta ação |
OpenLink
Um link que abre uma nova janela.
Campos | |
---|---|
url |
O URL a ser aberto. |
TextButton
Um botão com texto e ação onclick
.
Campos | |
---|---|
text |
O texto do botão. |
on_click |
A ação |
TextParagraph
Um parágrafo de texto. Suporte a texto formatado. Saiba mais sobre a formatação de texto em Formatar texto nos apps do Google Chat e Formatar texto em complementos do Google Workspace.
Campos | |
---|---|
text |
|