Í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)CreateCustomEmojiRequest
(mensagem)CreateMembershipRequest
(mensagem)CreateMessageRequest
(mensagem)CreateMessageRequest.MessageReplyOption
(enum)CreateReactionRequest
(mensagem)CreateSpaceRequest
(mensagem)CustomEmoji
(mensagem)CustomEmoji.CustomEmojiPayload
(mensagem)DeleteCustomEmojiRequest
(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)GetCustomEmojiRequest
(mensagem)GetMembershipRequest
(mensagem)GetMessageRequest
(mensagem)GetSpaceEventRequest
(mensagem)GetSpaceNotificationSettingRequest
(mensagem)GetSpaceReadStateRequest
(mensagem)GetSpaceRequest
(mensagem)GetThreadReadStateRequest
(mensagem)Group
(mensagem)HistoryState
(enum)ListCustomEmojisRequest
(mensagem)ListCustomEmojisResponse
(mensagem)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)SpaceNotificationSetting
(mensagem)SpaceNotificationSetting.MuteSetting
(enum)SpaceNotificationSetting.NotificationSetting
(enum)SpaceReadState
(mensagem)SpaceUpdatedEventData
(mensagem)Thread
(mensagem)ThreadReadState
(mensagem)UpdateMembershipRequest
(mensagem)UpdateMessageRequest
(mensagem)UpdateSpaceNotificationSettingRequest
(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. 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.
|
CreateCustomEmoji |
---|
Requer autenticação do usuário.
|
CreateMembership |
---|
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:
|
CreateMessage |
---|
Cria uma mensagem em um espaço do Google Chat. Confira um exemplo em Enviar uma mensagem. O método 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 ( 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 ( O tamanho máximo da mensagem, incluindo o conteúdo, é de 32.000 bytes.
|
CreateReaction |
---|
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.
|
CreateSpace |
---|
Cria um espaço. Pode ser usado para criar um espaço nomeado ou um chat em grupo no Oferece suporte aos seguintes tipos de autenticação: Ao autenticar como um app, o campo A associação ao espaço na criação depende se ele foi criado em
Se você receber a mensagem de erro
|
DeleteCustomEmoji |
---|
Requer autenticação do usuário.
|
DeleteMembership |
---|
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:
|
DeleteMessage |
---|
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.
|
DeleteReaction |
---|
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.
|
DeleteSpace |
---|
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:
|
FindDirectMessage |
---|
Retorna a mensagem direta com o usuário especificado. Se nenhum espaço de mensagem direta for encontrado, um erro 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:
|
GetAttachment |
---|
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.
|
GetCustomEmoji |
---|
Requer autenticação do usuário.
|
GetMembership |
---|
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:
|
GetMessage |
---|
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.
|
GetSpace |
---|
Retorna detalhes sobre um espaço. Confira um exemplo em Conferir detalhes sobre um espaço. Oferece suporte aos seguintes tipos de autenticação:
|
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 mudou. Por exemplo, se você solicitar um evento sobre uma nova mensagem, mas ela for atualizada mais tarde, o servidor vai retornar o recurso Observação: o campo 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.
|
GetSpaceNotificationSetting |
---|
Requer autenticação do usuário.
|
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. Confira um exemplo em Receber detalhes sobre o estado de leitura do espaço de um usuário. Requer autenticação do usuário.
|
GetThreadReadState |
---|
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.
|
ListCustomEmojis |
---|
Requer autenticação do usuário.
|
ListMemberships |
---|
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:
|
ListMessages |
---|
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, Requer autenticação do usuário.
|
ListReactions |
---|
Lista as reações a uma mensagem. Para conferir um exemplo, consulte Listar reações a uma mensagem. Requer autenticação do usuário.
|
ListSpaceEvents |
---|
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 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.
|
ListSpaces |
---|
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
|
SearchSpaces |
---|
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
|
SetUpSpace |
---|
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 Para especificar os Grupos do Google a serem adicionados, adicione associações com o 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 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 Requer autenticação do usuário.
|
UpdateMembership |
---|
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:
|
UpdateMessage |
---|
Atualiza uma mensagem. Há uma diferença entre os métodos 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.
|
UpdateSpace |
---|
Atualiza um espaço. Confira um exemplo em Atualizar um espaço. Se você estiver atualizando o campo Oferece suporte aos seguintes tipos de autenticação:
|
UpdateSpaceNotificationSetting |
---|
Requer 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. Para conferir um exemplo, consulte Atualizar o estado de leitura do espaço de um usuário. Requer autenticação do usuário.
|
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_ |
Uma lista de botões. |
ActionResponse
Parâmetros que um app de chat pode usar para configurar como a resposta é postada.
Campos | |
---|---|
type |
Somente entrada. O tipo de resposta do app Chat. |
url |
Somente entrada. URL para autenticação ou configuração dos usuários. (Somente para tipos de resposta |
dialog_ |
Somente entrada. Uma resposta a um evento de interação relacionado a uma caixa de diálogo. Precisa ser acompanhado por |
updated_ |
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[] |
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 |
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 |
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_ |
O código de status. |
user_ |
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 |
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 |
O tipo da anotação. |
length |
Comprimento da substring no corpo da mensagem de texto simples a que esta anotação corresponde. |
start_ |
Í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_ |
Os metadados da menção do usuário. |
slash_ |
Os metadados de um comando de barra. |
rich_ |
Os metadados de 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çado. |
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 |
Opcional. Nome do recurso do anexo, no formato |
content_ |
Apenas saída. O nome do arquivo original do conteúdo, não o caminho completo. |
content_ |
Apenas saída. O tipo de conteúdo (tipo MIME) do arquivo. |
thumbnail_ |
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_ |
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 |
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_ |
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_ |
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_ |
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_ |
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 cardsCampos | |
---|---|
card_ |
Obrigatório se a mensagem tiver vários cards. Um identificador exclusivo de um cartão em uma mensagem. |
card |
Um cartão. O tamanho máximo é de 32 KB. |
ChatSpaceLinkData
Dados para links do espaço do Chat.
Campos | |
---|---|
space |
O espaço do recurso do espaço do Chat vinculado. Formato: |
thread |
A linha do recurso do 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 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 |
O cabeçalho do card. Um cabeçalho geralmente contém um título e uma imagem. |
sections[] |
As seções são separadas por um divisor de linha. |
card_ |
As ações deste card. |
name |
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_ |
O rótulo usado para mostrar o item do menu de ações. |
on_ |
A ação onclick para este 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 ocupará uma linha. Se apenas o título for especificado, ele ocupará as duas linhas. |
subtitle |
O subtítulo do cabeçalho do card. |
image_ |
O tipo de imagem (por exemplo, borda quadrada ou circular). |
image_ |
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 |
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[] |
Uma seção precisa conter pelo menos um widget. |
CreateCustomEmojiRequest
Uma solicitação para criar um emoji personalizado.
Campos | |
---|---|
custom_ |
Obrigatório. O emoji personalizado a ser criado. |
CreateMembershipRequest
Mensagem de solicitação para criar uma associação.
Campos | |
---|---|
parent |
Obrigatório. O nome do recurso do espaço em que a associação será criada. Formato: spaces/{space} |
membership |
Obrigatório. A relação de associação a ser criada. O campo 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:
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 |
use_ |
Opcional. Quando 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 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 |
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. Descontinuado: use |
request_ |
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_ |
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_ |
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:
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 incluído. |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
Cria a mensagem como uma resposta à conversa especificada por thread ID ou . 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 . 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 |
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 nomeado sem participantes.
Campos | |
---|---|
space |
Obrigatório. Os campos Se você receber a mensagem de erro O espaço |
request_ |
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 |
Identificador. O nome do recurso do emoji personalizado, atribuído pelo servidor. Formato: |
uid |
Apenas saída. Chave exclusiva para o recurso de emoji personalizado. |
emoji_ |
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: |
temporary_ |
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 |
Opcional. Somente entrada. Dados de payload. Obrigatório quando o emoji personalizado é criado. |
CustomEmojiPayload
Dados de payload do emoji personalizado.
Campos | |
---|---|
file_ |
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 |
Obrigatório. Somente entrada. O nome do arquivo de imagem. Extensões de arquivo aceitas: |
DeleteCustomEmojiRequest
Solicitação para excluir um emoji personalizado.
Campos | |
---|---|
name |
Obrigatório. Nome do recurso do emoji personalizado a ser excluído. Formato: Você pode usar o nome do emoji como um alias para |
DeleteMembershipRequest
Solicitação para excluir uma assinatura em um espaço.
Campos | |
---|---|
name |
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 Ao excluir uma associação a um app, é necessário o escopo Formato: |
use_ |
Opcional. Quando 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 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 |
Obrigatório. Nome do recurso da mensagem. Formato: Se você definiu um ID personalizado para a mensagem, use o valor do campo |
force |
Opcional. Quando 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 |
Obrigatório. Nome da reação a 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_ |
Opcional. Quando 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 |
DeletionMetadata
Informações sobre uma mensagem excluída. Uma mensagem é excluída quando delete_time
é definida.
Campos | |
---|---|
deletion_ |
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 |
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: |
DialogAction
Contém uma caixa de diálogo e o código de status da solicitação.
Campos | |
---|---|
action_ |
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. Dialog para a solicitação. |
DriveDataRef
Uma referência aos dados de um anexo do Drive.
Campos | |
---|---|
drive_ |
O ID do arquivo do Drive. Use com a API Drive. |
DriveLinkData
Dados para links do Google Drive.
Campos | |
---|---|
drive_ |
Uma DriveDataRef que faz referência a um arquivo do Google Drive. |
mime_ |
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 |
Opcional. Um emoji básico representado por uma string Unicode. |
custom_ |
Apenas saída. Um emoji personalizado. |
EmojiReactionSummary
O número de pessoas que reagiram a uma mensagem com um emoji específico.
Campos | |
---|---|
emoji |
Apenas saída. Emoji associado às reações. |
reaction_ |
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 |
Obrigatório. Nome do recurso do usuário com quem você quer encontrar uma mensagem direta. Formato: |
GetAttachmentRequest
Solicitação para receber um anexo.
Campos | |
---|---|
name |
Obrigatório. Nome do recurso do anexo, no formato |
GetCustomEmojiRequest
Uma solicitação para retornar um único emoji personalizado.
Campos | |
---|---|
name |
Obrigatório. Nome do recurso do emoji personalizado. Formato: Você pode usar o nome do emoji como um alias para |
GetMembershipRequest
Solicitação para adquirir uma assinatura de um espaço.
Campos | |
---|---|
name |
Obrigatório. Nome do recurso da assinatura a ser recuperada. Para receber a assinatura do app usando a autenticação do usuário, use Formato: É possível usar o e-mail do usuário como um alias para |
use_ |
Opcional. Quando 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 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 |
Obrigatório. Nome do recurso da mensagem. Formato: Se você definiu um ID personalizado para a mensagem, use o valor do campo |
GetSpaceEventRequest
Mensagem de solicitação para receber um evento de espaço.
Campos | |
---|---|
name |
Obrigatório. O nome do recurso do evento do espaço. Formato: |
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 |
Obrigatório. Formato: users/{user}/spaces/{space}/spaceNotificationSetting
|
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. 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:
Formato: users/{user}/spaces/{space}/spaceReadState |
GetSpaceRequest
Uma solicitação para retornar um único espaço.
Campos | |
---|---|
name |
Obrigatório. Nome do recurso do espaço, no formato Formato: |
use_ |
Opcional. Quando 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 |
GetThreadReadStateRequest
Solicita uma mensagem para a API GetThreadReadStateRequest.
Campos | |
---|---|
name |
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:
Formato: users/{user}/spaces/{space}/threads/{thread}/threadReadState |
Grupo
Um Grupo do Google no Google Chat.
Campos | |
---|---|
name |
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_ |
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_ |
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 |
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 Por exemplo, a consulta a seguir retorna o emoji personalizado criado pelo autor da chamada:
Consultas inválidas são rejeitadas pelo servidor com um erro |
ListCustomEmojisResponse
Uma resposta a uma lista de emojis personalizados.
Campos | |
---|---|
custom_ |
Lista não ordenada. Lista de emojis personalizados na página solicitada (ou primeira). |
next_ |
Um token que pode ser enviado como |
ListMembershipsRequest
Mensagem de solicitação para listar assinaturas.
Campos | |
---|---|
parent |
Obrigatório. O nome do recurso do espaço para o qual uma lista de membros será buscada. Formato: spaces/{space} |
page_ |
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 |
page_ |
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 |
Opcional. Um filtro de consulta. É possível filtrar as assinaturas por função ( Para filtrar por função, defina Para filtrar por tipo, defina Para filtrar por função e tipo, use o operador
Por exemplo, as consultas a seguir são válidas:
As consultas a seguir são inválidas:
Consultas inválidas são rejeitadas pelo servidor com um erro |
show_ |
Opcional. Quando |
show_ |
Opcional. Quando Atualmente, exige autenticação do usuário. |
use_ |
Opcional. Quando 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 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[] |
Lista não ordenada. Lista de assinaturas na página solicitada (ou primeira). |
next_ |
Um token que pode ser enviado como |
ListMessagesRequest
Lista as mensagens no espaço especificado em que o usuário é membro.
Campos | |
---|---|
parent |
Obrigatório. O nome do recurso do espaço de onde as mensagens serão listadas. Formato: |
page_ |
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 |
page_ |
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 |
Opcional. Um filtro de consulta. É possível filtrar mensagens por data ( Para filtrar mensagens pela data de criação, especifique o Para filtrar por linha de execução, especifique Para filtrar por linha de execução e data, use o operador Por exemplo, as consultas a seguir são válidas:
Consultas inválidas são rejeitadas pelo servidor com um erro |
order_ |
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:
A ordenação padrão é |
show_ |
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[] |
Lista de mensagens. |
next_ |
Você pode enviar um token como |
ListReactionsRequest
Lista as reações a uma mensagem.
Campos | |
---|---|
parent |
Obrigatório. A mensagem que os usuários reagiram. Formato: |
page_ |
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_ |
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 |
Opcional. Um filtro de consulta. É possível filtrar as reações por emoji ( Para filtrar reações de vários emojis ou usuários, combine campos semelhantes com o operador Para filtrar reações por emoji e usuário, use o operador Se a consulta usar Por exemplo, as consultas a seguir são válidas:
As consultas a seguir são inválidas:
Consultas inválidas são rejeitadas pelo servidor com um erro |
ListReactionsResponse
Resposta a uma solicitação de lista de reações.
Campos | |
---|---|
reactions[] |
Lista de reações na página solicitada (ou primeira). |
next_ |
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 |
Obrigatório. Nome do recurso do espaço do Google Chat em que os eventos ocorreram. Formato: |
page_ |
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 |
page_ |
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 |
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 consultas a seguir são válidas:
As consultas a seguir são inválidas:
Consultas inválidas são rejeitadas pelo servidor com um erro |
ListSpaceEventsResponse
Mensagem de resposta para listar eventos do espaço.
Campos | |
---|---|
space_ |
Os resultados são retornados em ordem cronológica (o evento mais antigo primeiro). Observação: o campo |
next_ |
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_ |
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 |
page_ |
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 |
Opcional. Um filtro de consulta. Você pode 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 consultas a seguir são válidas:
Consultas inválidas são rejeitadas pelo servidor com um erro |
ListSpacesResponse
A resposta para uma solicitação de lista de espaços.
Campos | |
---|---|
spaces[] |
Lista de espaços na página solicitada (ou primeira). Observação: o campo |
next_ |
Você pode 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 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 |
Identificador. Nome do recurso da assinatura, atribuído pelo servidor. Formato: |
state |
Apenas saída. Estado da assinatura. |
role |
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 |
create_ |
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_ |
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 |
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 |
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[] |
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[] |
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[] |
Uma lista de assinaturas atualizadas. |
MembershipCreatedEventData
Payload do 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 excluída. Somente os campos |
MembershipUpdatedEventData
Payload do 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 |
Identificador. Nome do recurso da mensagem. Formato: Em que Se você definir um ID personalizado ao criar uma mensagem, poderá usar esse ID para especificar a mensagem em uma solicitação substituindo |
sender |
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 |
create_ |
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_ |
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_ |
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 |
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_ |
Apenas saída. Contém a mensagem
Para mais informações, consulte Conferir a formatação de texto enviada em uma mensagem. |
cards[] |
Descontinuado: use 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_ |
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[] |
Apenas saída. Anotações associadas ao |
thread |
A linha de execução à qual a mensagem pertence. Para conferir um exemplo de uso, consulte Iniciar ou responder a uma conversa. |
space |
Apenas saída. Se o app de chat se autenticar como um usuário, a saída só vai preencher o espaço |
fallback_ |
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_ |
Somente entrada. Parâmetros que um app de chat pode usar para configurar como a resposta é postada. |
argument_ |
Apenas saída. Corpo de texto simples da mensagem sem nenhuma menção do app Chat. |
slash_ |
Apenas saída. Informações sobre o comando de barra, se aplicável. |
attachment[] |
Opcional. Anexo enviado pelo usuário. |
matched_ |
Apenas saída. Um URL em |
thread_ |
Apenas saída. Quando Se o espaço não oferecer suporte a respostas em conversas, esse campo será sempre |
client_ |
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 |
emoji_ |
Apenas saída. A lista de resumos das reações com emojis na mensagem. |
private_ |
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_ |
Apenas saída. Informações sobre uma mensagem excluída. Uma mensagem é excluída quando |
quoted_ |
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_ |
Apenas saída. Imagens GIF anexadas à mensagem. |
accessory_ |
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[] |
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[] |
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[] |
Uma lista de mensagens atualizadas. |
MessageCreatedEventData
Payload do evento para 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 do evento para 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_ |
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 |
Identificador. O nome do recurso da reação. Formato: |
user |
Apenas saída. O usuário que criou a reação. |
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[] |
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[] |
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 |
A nova reação. |
ReactionDeletedEventData
Payload do 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 desse link. |
rich_ |
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_ |
Dados de um link do Drive. |
chat_ |
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_ |
Quando 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 No momento, esse método só oferece suporte ao acesso de administrador. Portanto, apenas |
page_ |
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_ |
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 |
Obrigatório. Uma consulta de pesquisa. É possível pesquisar usando os seguintes parâmetros:
Em campos diferentes, apenas operadores No mesmo campo, Os exemplos de consultas a seguir são válidos:
|
order_ |
Opcional. Como a lista de espaços é organizada. Os atributos de ordenação aceitos são:
Os valores válidos para a operação de ordenação são:
As sintaxes compatíveis são:
|
SearchSpacesResponse
Resposta com uma lista de espaços correspondentes à solicitação de pesquisa de espaços.
Campos | |
---|---|
spaces[] |
Uma página com os espaços solicitados. |
next_ |
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_ |
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 |
Obrigatório. O campo Para criar um espaço, defina Para criar um chat em grupo, defina Para criar uma conversa individual entre humanos, defina Para criar uma conversa individual entre uma pessoa e o app de chat que está ligando, defina Se um espaço |
request_ |
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[] |
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 Para a associação a grupos do Google, o campo Opcional ao definir Obrigatório ao definir Obrigatório ao definir Precisa estar vazio ao criar uma conversa individual entre uma pessoa e o app de chat que está ligando (ao definir |
SlashCommand
Um comando de barra no Google Chat.
Campos | |
---|---|
command_ |
O ID do comando de barra invocado. |
SlashCommandMetadata
Metadados de anotação para comandos de barra (/).
Campos | |
---|---|
bot |
O app Chat cujo comando foi invocado. |
type |
O tipo de comando de barra. |
command_ |
O nome do comando de barra invocado. |
command_ |
O ID do comando de barra invocado. |
triggers_ |
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 |
Identificador. Nome do recurso do espaço. Formato: em que |
type |
Apenas saída. Descontinuado: use |
space_ |
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_ |
Opcional. Se o espaço é uma DM entre um app de chat e uma pessoa. |
threaded |
Apenas saída. Descontinuado: use |
display_ |
Opcional. O nome de exibição do espaço. Obrigatório ao criar um espaço com um Para mensagens diretas, esse campo pode estar vazio. Suporta até 128 caracteres. |
external_ |
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:
Para espaços existentes, esse campo é somente saída. |
space_ |
Apenas saída. O estado da conversa em grupo no espaço do Chat. |
space_ |
Opcional. Detalhes sobre o espaço, incluindo descrição e regras. |
space_ |
Opcional. O estado do histórico de mensagens e conversas neste espaço. |
import_ |
Opcional. Se o espaço foi criado em A criação de um espaço em |
create_ |
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 |
last_ |
Apenas saída. Carimbo de data/hora da última mensagem no espaço. |
admin_ |
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_ |
Apenas saída. Contagem de associações agrupadas por tipo de participante. Preenchido quando |
access_ |
Opcional. Especifica a configuração de acesso do espaço. Preenchido apenas quando |
space_ |
Apenas saída. O URI para um usuário acessar o espaço. |
import_ |
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 Esse campo só é preenchido para espaços criados com o modo de importação. |
customer |
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 No formato Para DMs, esse campo não é preenchido. |
Campo de união Requer autenticação do usuário. |
|
predefined_ |
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 |
permission_ |
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_ |
Apenas saída. Indica o estado de acesso do espaço. |
audience |
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: Para usar o público-alvo padrão da organização do Google Workspace, defina como A leitura do público-alvo de destino oferece suporte a:
Esse campo não é preenchido ao usar o escopo 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_ |
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_ |
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_ |
Opcional. Se os administradores dos espaços têm essa permissão. |
members_ |
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_ |
Opcional. Configurações para gerenciar participantes e grupos em um espaço. |
modify_ |
Opcional. Configurações para atualizar o nome, o avatar, a descrição e as diretrizes do espaço. |
toggle_ |
Opcional. Configurações para ativar e desativar o histórico do espaço. |
use_ |
Opcional. Configurações para usar @todos em um espaço. |
manage_ |
Opcional. Configurações para gerenciar apps em um espaço. |
manage_ |
Opcional. Configurações para gerenciar webhooks em um espaço. |
post_ |
Apenas saída. Configurações para postar mensagens em um espaço. |
reply_ |
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 |
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 |
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[] |
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_ |
Horário em que o evento ocorreu. |
event_ |
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 Tipos de eventos compatíveis com mensagens:
Tipos de evento compatíveis com filiação:
Tipos de evento compatíveis com reações:
Tipos de evento compatíveis sobre o espaço:
|
Campo de união
|
|
message_ |
Payload do evento para uma nova mensagem. Tipo de evento: |
message_ |
Payload do evento para uma mensagem atualizada. Tipo de evento: |
message_ |
Payload do evento para uma mensagem excluída. Tipo de evento: |
message_ |
Payload do evento para várias mensagens novas. Tipo de evento: |
message_ |
Payload do evento para várias mensagens atualizadas. Tipo de evento: |
message_ |
Payload do evento para várias mensagens excluídas. Tipo de evento: |
space_ |
Payload do evento para uma atualização de espaço. Tipo de evento: |
space_ |
Payload do evento para várias atualizações em um espaço. Tipo de evento: |
membership_ |
Payload do evento para uma nova assinatura. Tipo de evento: |
membership_ |
Payload do evento para uma assinatura atualizada. Tipo de evento: |
membership_ |
Payload do evento para uma associação excluída. Tipo de evento: |
membership_ |
Payload do evento para várias assinaturas novas. Tipo de evento: |
membership_ |
Payload do evento para várias assinaturas atualizadas. Tipo de evento: |
membership_ |
Payload do evento para várias assinaturas excluídas. Tipo de evento: |
reaction_ |
Payload do evento para uma nova reação. Tipo de evento: |
reaction_ |
Payload do evento para uma reação excluída. Tipo de evento: |
reaction_ |
Payload do evento para várias novas reações. Tipo de evento: |
reaction_ |
Payload do evento para várias reações excluídas. Tipo de evento: |
SpaceNotificationSetting
As configurações de notificação de um usuário em um espaço.
Campos | |
---|---|
name |
Identificador. O nome do recurso da configuração de notificação do espaço. Formato: |
notification_ |
A configuração de notificação. |
mute_ |
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 |
Nome do recurso do estado de leitura do espaço. Formato: |
last_ |
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 |
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 |
Identificador. Nome do recurso da linha de execução. Exemplo: |
thread_ |
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 |
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_ |
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 |
Obrigatório. A assinatura a ser atualizada. Somente os campos especificados por |
update_ |
Obrigatório. Os caminhos de campo a serem atualizados. Separe vários valores com vírgulas ou use Caminhos de campo compatíveis:
|
use_ |
Opcional. Quando 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 |
UpdateMessageRequest
Solicitação para atualizar uma mensagem.
Campos | |
---|---|
message |
Obrigatório. Mensagem com campos atualizados. |
update_ |
Obrigatório. Os caminhos de campo a serem atualizados. Separe vários valores com vírgulas ou use Caminhos de campo compatíveis:
|
allow_ |
Opcional. Se |
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_ |
Obrigatório. O nome do recurso das configurações de notificação do espaço precisa ser preenchido no formato |
update_ |
Obrigatório. Caminhos de campo aceitos: - |
UpdateSpaceReadStateRequest
Mensagem de solicitação para a API UpdateSpaceReadState.
Campos | |
---|---|
space_ |
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:
Formato: users/{user}/spaces/{space}/spaceReadState |
update_ |
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. O |
update_ |
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:
|
use_ |
Opcional. Quando 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 Alguns valores de |
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 |
Nome do recurso de um Formato: Para
|
display_ |
Apenas saída. O nome de exibição do usuário. |
domain_ |
Identificador exclusivo do domínio do Google Workspace do usuário. |
type |
Tipo de usuário. |
is_ |
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 de chat. |
UserMentionMetadata
Metadados de anotação para menções de usuários (@).
Campos | |
---|---|
user |
O usuário mencionado. |
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[] |
Uma lista de botões. Buttons também é |
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_ |
Mostrar um parágrafo de texto neste widget. |
image |
Mostrar uma imagem neste widget. |
key_ |
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
|
|
text_ |
Um botão com texto e ação |
image_ |
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, é possível invocar o Apps Script para processar o formulário.
Campos | |
---|---|
action_ |
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[] |
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 |
O nome do parâmetro do script de ação. |
value |
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_ |
É o URL da imagem. |
on_ |
A ação |
aspect_ |
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_ |
A ação |
name |
O nome dessa |
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 |
O ícone especificado por um |
icon_ |
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_ |
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 |
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_ |
Se o conteúdo precisa ser multilinha. |
bottom_ |
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_ |
A ação |
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 |
Um valor de tipo enumerado que é substituído pela API Chat pela imagem de ícone correspondente. |
icon_ |
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 |
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 é acionada por essa ação |
open_ |
Essa 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_ |
A açã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 |
|