Package google.chat.v1

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

ContextualAddOnMarkup

Esse tipo não tem campos.

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

Cartas

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

Campos
`header`	`CardHeader` O cabeçalho do card. Um cabeçalho geralmente contém um título e uma imagem.
`sections[]`	`Section` As seções são separadas por uma linha divisória.
`card_actions[]`	`CardAction` As ações deste card.
`name`	`string` Nome do card.

CardAction

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

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

Campos

action_label

string

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

on_click

OnClick

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

CardHeader

Campos
`title`	`string` O título precisa ser especificado. O cabeçalho tem uma altura fixa: se um título e um subtítulo forem especificados, cada um vai ocupar uma linha. Se apenas o título for especificado, ele vai ocupar as duas linhas.
`subtitle`	`string` O subtítulo do cabeçalho do card.
`image_style`	`ImageStyle` O tipo da imagem (por exemplo, borda quadrada ou circular).
`image_url`	`string` O URL da imagem no cabeçalho do card.

ImageStyle

Tipos enumerados
`IMAGE_STYLE_UNSPECIFIED`
`IMAGE`	Borda quadrada.
`AVATAR`	Borda circular.

Seção

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

Campos

header

string

O cabeçalho da seção. O texto formatado é aceito. Para mais informações sobre formatação de texto, consulte Formatar texto em apps do Google Chat e Formatar texto em complementos do Google Workspace.

widgets[]

WidgetMarkup

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

CreateCustomEmojiRequest

Uma solicitação para criar um emoji personalizado.

Campos

custom_emoji

Obrigatório. O emoji personalizado a ser criado.

CreateMembershipRequest

Mensagem de solicitação para criar uma assinatura.

Campos

parent

string

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

Formato: spaces/{space}

membership

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

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

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

Ao fazer a autenticação como usuário, o escopo de autorização chat.memberships é obrigatório.
Ao fazer a autenticação como um app, o escopo de autorização chat.app.memberships é obrigatório.
Defina user.type como HUMAN e user.name com o formato users/{user}, em que {user} pode ser o endereço de e-mail do usuário. Para usuários na mesma organização do Workspace, {user} também pode ser o id da pessoa na API People ou o id do usuário na API Directory. Por exemplo, se o ID do perfil da pessoa da API People para user@example.com for 123456789, você poderá adicionar o usuário ao espaço definindo membership.member.name como users/user@example.com ou users/123456789.

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

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

use_admin_access

bool

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

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

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

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

CreateMessageNotificationOptions

Opções para o comportamento da notificação quando a mensagem é postada.

Campos

notification_type

NotificationType

O tipo de notificação da mensagem.

NotificationType

As opções de tipos de notificação para a mensagem.

Tipos enumerados

NOTIFICATION_TYPE_NONE Comportamento padrão. O comportamento da notificação é semelhante ao de quando o usuário humano envia a mensagem usando a interface do Chat: nenhuma notificação é enviada ao remetente humano.

NOTIFICATION_TYPE_FORCE_NOTIFY

Forçar a notificação dos destinatários. Isso ignora as configurações de notificação de espaço dos usuários e as configurações do modo Não Perturbe do Chat. Essa opção não ignora as configurações do modo Não Perturbe no dispositivo.

Exige autenticação do app.

NOTIFICATION_TYPE_SILENT

Não notificar os destinatários nem marcar a mensagem como não lida. Isso funciona de forma semelhante a silenciar a conversa ou ativar o modo Não perturbe do Chat.

Exige autenticação do app.

CreateMessagePinRequest

Mensagem de solicitação para criar uma mensagem fixada.

Campos

parent

string

Obrigatório. O espaço pai em que a mensagem será fixada. Formato: spaces/{space}

message_pin

MessagePin

Obrigatório. O MessagePin a ser criado.

CreateMessageRequest

Cria uma mensagem.

Campos
`parent`	`string` Obrigatório. O nome do recurso do espaço em que uma mensagem será criada. Formato: `spaces/{space}`
`message`	`Message` Obrigatório. Corpo da mensagem.
`thread_key (deprecated)`	`string` Este item está obsoleto. Opcional. Descontinuado: use `thread.thread_key`. ID da conversa. Aceita até 4.000 caracteres. Para iniciar ou adicionar a uma conversa, crie uma mensagem e especifique um `threadKey` ou o `thread.name`. Para ver um exemplo de uso, consulte Iniciar ou responder a uma conversa de mensagem.
`request_id`	`string` Opcional. Um ID exclusivo para essa solicitação. Recomendamos um UUID aleatório. Especificar um ID de solicitação torna a solicitação idempotente, o que garante que várias solicitações idênticas com o mesmo ID resultem na criação de apenas uma mensagem. As solicitações seguintes com o mesmo ID retornam a mensagem atual e não a atualizam, mesmo que os detalhes solicitados sejam diferentes do estado atual. Para usar esse campo de forma eficaz: Verifique se as solicitações subsequentes são idênticas e usam as mesmas credenciais de autenticação da solicitação original. Se uma mensagem já tiver sido criada com o ID de solicitação fornecido, a solicitação vai retornar essa mensagem. A mensagem retornada pode não estar totalmente preenchida. A API repete a mensagem na sua solicitação com os nomes de recursos atribuídos pelo sistema preenchidos. Para recuperar os metadados mais recentes da mensagem, chame `GetMessage`. Reutilizar um ID de solicitação com um usuário autenticado diferente resulta em um erro.
`message_reply_option`	`MessageReplyOption` Opcional. Especifica se uma mensagem inicia uma conversa ou responde a uma. Compatível apenas com espaços nomeados. Ao responder às interações do usuário, esse campo é ignorado. Para interações em uma conversa, a resposta é criada na mesma conversa. Caso contrário, a resposta será criada como uma nova conversa.
`message_id`	`string` Opcional. Um código personalizado para uma mensagem. Permite que os apps do Chat recebam, atualizem ou excluam uma mensagem sem precisar armazenar o ID atribuído pelo sistema no nome do recurso da mensagem (representado no campo `name` da mensagem). O valor desse campo precisa atender aos seguintes requisitos: Começa com `client-`. Por exemplo, `client-custom-name` é um código personalizado válido, mas `custom-name` não é. Contém até 63 caracteres e apenas letras minúsculas, números e hifens. É exclusivo em um espaço. Um app do Chat não pode usar o mesmo código personalizado para mensagens diferentes. Veja mais detalhes em Nomear uma mensagem.
`create_message_notification_options`	`CreateMessageNotificationOptions` Opcional. Controla o comportamento da notificação quando a mensagem é postada. Para saber mais, consulte Forçar notificações ou enviar mensagens silenciosas.

MessageReplyOption

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

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

CreateReactionRequest

Cria uma reação a uma mensagem.

Campos

parent

string

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

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

reaction

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

CreateSectionRequest

Mensagem de solicitação para criar uma seção.

Campos

parent

string

Obrigatório. O nome do recurso pai em que a seção é criada.

Formato: users/{user}

section

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

CreateSpaceRequest

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

Campos

space

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

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

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

request_id

string

Opcional. Um ID exclusivo para essa solicitação. Recomendamos um UUID aleatório. Especificar um ID de solicitação torna a solicitação idempotente, o que garante que várias solicitações idênticas com o mesmo ID resultem na criação de apenas um espaço. As solicitações subsequentes com o mesmo ID retornam o espaço atual e não o atualizam, mesmo que os detalhes solicitados sejam diferentes do estado atual.

Para usar esse campo de forma eficaz:

Verifique se as solicitações subsequentes são idênticas e usam as mesmas credenciais de autenticação da solicitação original.
Se um espaço já tiver sido criado com o ID de solicitação fornecido, a solicitação vai retornar esse espaço. O espaço retornado pode não estar totalmente preenchido. A API repete o espaço na sua solicitação com o nome do recurso atribuído pelo sistema preenchido. Para recuperar os metadados mais recentes do espaço, chame GetSpace.
Reutilizar um ID de solicitação com um usuário autenticado diferente resulta em um erro.

CustomEmoji

Representa um emoji personalizado.

Campos
`name`	`string` Identificador. O nome do recurso do emoji personalizado, atribuído pelo servidor. Formato: `customEmojis/{customEmoji}`
`uid`	`string` Apenas saída. Chave exclusiva do recurso de emoji personalizado.
`emoji_name`	`string` Opcional. Imutável. Nome fornecido pelo usuário para o emoji personalizado, que é exclusivo na organização. Obrigatório quando o emoji personalizado é criado, somente saída em outros casos. Os nomes dos emojis precisam começar e terminar com dois-pontos, estar em letras minúsculas e conter apenas caracteres alfanuméricos, hífens e sublinhados. Use hífens e sublinhados para separar palavras e nunca consecutivamente. Exemplo: `:valid-emoji-name:`
`temporary_image_uri`	`string` Apenas saída. Um URL de imagem temporário para o emoji personalizado, válido por pelo menos 10 minutos. Esse campo não é preenchido na resposta quando o emoji personalizado é criado.
`payload`	`CustomEmojiPayload` Opcional. Somente entrada. Dados de payload. Obrigatório quando o emoji personalizado é criado.

CustomEmojiPayload

Dados de payload do emoji personalizado.

Campos

file_content

bytes

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

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

filename

string

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

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

CustomEmojiMetadata

Metadados de anotação para emojis personalizados.

Campos

custom_emoji

O emoji personalizado.

CustomStatus

Representa o status personalizado de um usuário no Google Chat. Isso inclui uma mensagem de texto curta com um emoji opcional que o usuário define para dar mais contexto sobre a disponibilidade dele.

Campos
`text`	`string` Obrigatório. O texto do status personalizado. Essa será uma string com comprimento máximo de 64.
`emoji`	`Emoji` Obrigatório. O emoji do status personalizado. Apenas emojis Unicode são aceitos. Emojis personalizados não são aceitos.
Campo de união `expiration`. O prazo de validade do status personalizado. Ele pode ser especificado como um carimbo de data/hora absoluto ou uma duração de vida útil. `expiration` pode ser apenas de um dos tipos a seguir:
`expire_time`	`Timestamp` O carimbo de data/hora de quando o status personalizado expira.
`ttl`	`Duration` Somente entrada. A duração do tempo de vida após o qual o status personalizado expira.

DeleteCustomEmojiRequest

Solicitação para excluir um emoji personalizado.

Campos

name

string

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

Formato: customEmojis/{customEmoji}

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

DeleteMembershipRequest

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

Campos

name

string

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

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

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

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

use_admin_access

bool

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

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

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

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

DeleteMessagePinRequest

Mensagem de solicitação para excluir uma mensagem fixada.

Campos

name

string

Obrigatório. O nome do recurso da mensagem fixada a ser removida. Formato: spaces/{space}/messagePins/{message_pin}

DeleteMessageRequest

Solicitação para excluir uma mensagem.

Campos

name

string

Obrigatório. Nome do recurso da mensagem.

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

Se você definiu um código personalizado para sua mensagem, use o valor do campo clientAssignedMessageId para {message}. Para mais detalhes, consulte Nomear uma mensagem.

force

bool

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

Só se aplica ao autenticar como usuário. Não tem efeito ao autenticar como um app do Chat.

DeleteReactionRequest

Exclui uma reação a uma mensagem.

Campos

name

string

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

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

DeleteSectionRequest

Mensagem de solicitação para excluir uma seção.

Campos

name

string

Obrigatório. O nome da seção a ser excluída.

Formato: users/{user}/sections/{section}

DeleteSpaceRequest

Solicitação para excluir um espaço.

Campos

name

string

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

Formato: spaces/{space}

use_admin_access

bool

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

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

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

DeletionMetadata

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

Campos

deletion_type

DeletionType

Indica quem excluiu a mensagem.

DeletionType

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

Tipos enumerados
`DELETION_TYPE_UNSPECIFIED`	Esse valor não é usado.
`CREATOR`	O usuário excluiu a própria mensagem.
`SPACE_OWNER`	Um proprietário ou administrador excluiu a mensagem.
`ADMIN`	Um administrador do Google Workspace excluiu a mensagem. Os administradores podem excluir qualquer mensagem no espaço, incluindo as enviadas por qualquer participante ou app do Chat.
`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 criador (usando a autenticação do usuário).
`SPACE_OWNER_VIA_APP`	Um app do Chat excluiu a mensagem em nome de um administrador do espaço (usando a autenticação do usuário).
`SPACE_MEMBER`	Um participante do espaço excluiu a mensagem. Os usuários podem excluir mensagens enviadas por apps.

Dialog

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

Campos

body

Card

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

DialogAction

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

Campos

action_status

ActionStatus

Somente entrada. Status de uma solicitação para invocar ou enviar uma caixa de diálogo. Mostra um status e uma mensagem aos usuários, se necessário. Por exemplo, em caso de erro ou sucesso.

Campo de união action. Ação a ser realizada. action pode ser apenas de um dos tipos a seguir:

dialog

Dialog

Somente entrada. Caixa de diálogo da solicitação.

DoNotDisturbMetadata

Metadados associados ao estado de disponibilidade DO_NOT_DISTURB, especificando quando o estado está definido para expirar.

Campos

expiration_time

Timestamp

Apenas saída. Carimbo de data/hora até o qual o usuário deve ser marcado como DO_NOT_DISTURB. Essa data pode ser até um ano após a data atual.

DriveDataRef

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

Campos

drive_file_id

string

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

DriveLinkData

Dados para links do Google Drive.

Campos

drive_data_ref

DriveDataRef

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

mime_type

string

O tipo MIME do recurso vinculado do Google Drive.

Elementos

Os elementos são componentes adicionais que podem ou não estar associados ao texto da mensagem fornecido durante a criação dela.

Campos

cited_sources[]

CitedSource

Uma lista de fontes que serão mostradas abaixo da mensagem como links de rodapé. Eles não são referenciados inline. Para referências inline, use citations.

citations[]

Citation

Uma lista de citações inline referenciadas no texto da mensagem (com tags <chat-citation>) que são renderizadas como cards de informações interativos.

ElementsImage

Um objeto que encapsula diferentes maneiras de representar uma imagem. Representações atualmente aceitas: - Uma imagem buscada em um URI. Outras representações podem ser aceitas no futuro.

Campos

Campo de união image. Obrigatório. Uma das representações de imagem compatíveis. image pode ser apenas de um dos tipos a seguir:

image_uri

string

Obrigatório. Um URI acessível publicamente para uma imagem.

Emoji

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

Campos

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

unicode

string

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

custom_emoji

Um emoji personalizado.

EmojiReactionSummary

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

Campos

emoji

Emoji

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

reaction_count

int32

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

FindDirectMessageRequest

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

Campos

name

string

Obrigatório. Nome do recurso do usuário com quem você quer encontrar mensagens diretas.

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

FindGroupChatsRequest

Uma solicitação para receber espaços de chat em grupo com base nos recursos do usuário.

Campos
`users[]`	`string` Opcional. Nomes de recursos de todos os usuários humanos no grupo de chat com o usuário que está ligando. Não é possível incluir apps do Chat na solicitação. O número máximo de usuários que podem ser especificados em uma única solicitação é `49`. Formato: `users/{user}`, em que `{user}` é o `id` da pessoa na API People ou o `id` do usuário na API Directory. Por exemplo, para encontrar todos os grupos de chat com o usuário que está fazendo a chamada e outros dois usuários, com os IDs de perfil da API People `123456789` e `987654321`, use `users/123456789` e `users/987654321`. Também é possível usar o e-mail como um alias para `{user}`. Por exemplo, `users/example@gmail.com`, em que `example@gmail.com` é o e-mail do usuário do Google Chat.
`page_size`	`int32` Opcional. O número máximo de espaços a serem retornados. O serviço pode retornar um valor inferior a este. Se não for especificado, no máximo 10 espaços serão retornados. O valor máximo é 30. Se você usar um valor maior que 30, ele será alterado automaticamente para 30. Valores negativos retornam um erro `INVALID_ARGUMENT`.
`page_token`	`string` Opcional. Um token de página recebido de uma chamada anterior para encontrar grupos de chat. Informe esse parâmetro para recuperar a página seguinte. Na paginação, todos os outros parâmetros enviados precisam corresponder à chamada que proporcionou o token. Transmitir valores diferentes pode levar a resultados inesperados.
`space_view`	`SpaceView` Tipo de visualização de espaço solicitado. Se não for definido, o padrão será `SPACE_VIEW_RESOURCE_NAME_ONLY`. As solicitações que especificam `SPACE_VIEW_EXPANDED` precisam incluir escopos que permitam ler dados do espaço, por exemplo, https://www.googleapis.com/auth/chat.spaces ou https://www.googleapis.com/auth/chat.spaces.readonly.

FindGroupChatsResponse

Uma resposta que contém espaços de chat em grupo com exatamente o usuário que fez a chamada e os usuários solicitados.

Campos

spaces[]

Lista de espaços na página solicitada (ou na primeira).

next_page_token

string

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

ForwardedMetadata

Metadados sobre o espaço de origem de onde uma mensagem foi encaminhada.

Campos

space

string

Apenas saída. O nome do recurso do espaço de origem. Formato: spaces/{space}

space_display_name

string

Apenas saída. O nome de exibição do espaço ou da mensagem direta de origem no momento do encaminhamento. Para SPACE, esse é o nome do espaço. Para DIRECT_MESSAGE, esse é o nome do outro participante (por exemplo, "Usuário A"). Para GROUP_CHAT, esse é um nome gerado com base nos nomes dos membros, limitado a 5, incluindo o criador (por exemplo, "Usuário A, Usuário B").

GetAttachmentRequest

Solicitação para receber um anexo.

Campos

name

string

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

GetAvailabilityRequest

Solicite mensagem para o método GetAvailability.

Campos

name

string

Obrigatório. O nome do recurso da disponibilidade a ser recuperada.

Formato: users/{user}/availability

{user} é o ID da pessoa na API People ou na API Directory do SDK Admin. Por exemplo, users/123456789.

O endereço de e-mail do usuário ou me também pode ser usado como um alias para se referir ao autor da chamada. Por exemplo, users/user@example.com ou users/me.

GetCustomEmojiRequest

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

Campos

name

string

Obrigatório. Nome do recurso do emoji personalizado.

Formato: customEmojis/{customEmoji}

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

GetMembershipRequest

Solicitação para receber uma assinatura de um espaço.

Campos

name

string

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

Para receber a associação do app usando a autenticação do usuário, use spaces/{space}/members/app.

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

Você pode usar o e-mail do usuário como um alias para {member}. Por exemplo, spaces/{space}/members/example@gmail.com, em que example@gmail.com é o e-mail do usuário do Google Chat.

use_admin_access

bool

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

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

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

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

GetMessageRequest

Solicitação para receber uma mensagem.

Campos

name

string

Obrigatório. Nome do recurso da mensagem.

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

Se você definiu um código personalizado para sua mensagem, use o valor do campo clientAssignedMessageId para {message}. Para mais detalhes, consulte Nomear uma mensagem.

markup_syntax

MarkupSyntax

Opcional. Especifica a sintaxe de saída desejada para o campo formatted_text da mensagem de chat.

GetSpaceEventRequest

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

Campos

name

string

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

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

GetSpaceNotificationSettingRequest

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

Campos

name

string

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

users/me/spaces/{space}/spaceNotificationSetting, OU
users/user@example.com/spaces/{space}/spaceNotificationSetting, OU
users/123456789/spaces/{space}/spaceNotificationSetting. Observação: somente o ID do usuário ou o e-mail do autor da chamada é permitido no caminho.

GetSpaceReadStateRequest

Mensagem de solicitação para a API GetSpaceReadState.

Campos

name

string

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

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

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

O alias me. Por exemplo, users/me/spaces/{space}/spaceReadState.
O endereço de e-mail do Workspace. Por exemplo, users/user@example.com/spaces/{space}/spaceReadState.
O ID do usuário. Por exemplo, users/123456789/spaces/{space}/spaceReadState.

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

GetSpaceRequest

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

Campos

name

string

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

Formato: spaces/{space}

use_admin_access

bool

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

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

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

GetThreadReadStateRequest

Mensagem de solicitação para a API GetThreadReadStateRequest.

Campos

name

string

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

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

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

O alias me. Por exemplo, users/me/spaces/{space}/threads/{thread}/threadReadState.
O endereço de e-mail do Workspace. Por exemplo, users/user@example.com/spaces/{space}/threads/{thread}/threadReadState.
O ID do usuário. Por exemplo, users/123456789/spaces/{space}/threads/{thread}/threadReadState.

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

Grupo

Um Grupo do Google no Google Chat.

Campos

name

string

Nome do recurso de um Grupo do Google.

Representa um grupo na API Cloud Identity Groups.

Formato: groups/{group}

HistoryState

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

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

ListCustomEmojisRequest

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

Campos

page_size

int32

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

page_token

string

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

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

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

filter

string

Opcional. Um filtro de consulta.

Permite filtrar por criador.

Para filtrar por criador, especifique um valor válido. No momento, apenas creator("users/me") e NOT creator("users/me") são aceitos para filtrar emojis personalizados de acordo com o usuário que os criou.

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

creator("users/me")

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

ListCustomEmojisResponse

Uma resposta para listar emojis personalizados.

Campos

custom_emojis[]

Lista não ordenada. Lista de emojis personalizados.

next_page_token

string

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

ListMembershipsRequest

Mensagem de solicitação para listar assinaturas.

Campos
`parent`	`string` Obrigatório. O nome do recurso do espaço para o qual uma lista de participantes será buscada. Formato: spaces/{space}
`page_size`	`int32` Opcional. O número máximo de assinaturas a serem retornadas. O serviço pode retornar um valor inferior a este. Se não for especificado, no máximo 100 assinaturas serão retornadas. O valor máximo é 1.000. Se você usar um valor maior que 1.000, ele será alterado automaticamente para 1.000. Valores negativos retornam um erro `INVALID_ARGUMENT`.
`page_token`	`string` Opcional. Um token de página recebido de uma chamada anterior para listar assinaturas. Informe esse parâmetro para recuperar a página seguinte. Na paginação, todos os outros parâmetros enviados precisam corresponder à chamada que proporcionou o token da página. Transmitir valores diferentes para os outros parâmetros pode levar a resultados inesperados.
`filter`	`string` Opcional. Um filtro de consulta. É possível filtrar as assinaturas por papel (`role`) e tipo (`member.type`) de membro. Para filtrar por função, defina `role` como `ROLE_MEMBER` ou `ROLE_MANAGER`. Para filtrar por tipo, defina `member.type` como `HUMAN` ou `BOT`. Também é possível filtrar por `member.type` usando o operador `!=`. Para filtrar por papel e tipo, use o operador `AND`. Para filtrar por função ou tipo, use o operador `OR`. É necessário usar `member.type = "HUMAN"` ou `member.type != "BOT"` quando `use_admin_access` está definido como verdadeiro. Outros filtros de tipo de assinatura serão rejeitados. Por exemplo, as seguintes consultas são válidas: `role = "ROLE_MANAGER" OR role = "ROLE_MEMBER" member.type = "HUMAN" AND role = "ROLE_MANAGER" member.type != "BOT"` As seguintes consultas são inválidas: `member.type = "HUMAN" AND member.type = "BOT" role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"` Consultas inválidas são rejeitadas pelo servidor com um erro `INVALID_ARGUMENT`.
`show_groups`	`bool` Opcional. Quando `true`, também retorna as assinaturas associadas a um `Google Group`, além de outros tipos de assinaturas. Se um `filter` for definido, as assinaturas de `Google Group` que não corresponderem aos critérios de filtro não serão retornadas.
`show_invited`	`bool` Opcional. Quando `true`, também retorna as assinaturas associadas aos membros `invited`, além de outros tipos de assinaturas. Se um filtro for definido, as assinaturas de `invited` que não corresponderem aos critérios do filtro não serão retornadas. Atualmente, exige autenticação do usuário.
`use_admin_access`	`bool` Opcional. Quando `true`, o método é executado usando os privilégios de administrador do Google Workspace do usuário. O usuário que faz a chamada precisa ser um administrador do Google Workspace com o privilégio de gerenciar conversas de chats e espaços. Requer o escopo do OAuth 2.0 `chat.admin.memberships.readonly` ou `chat.admin.memberships`. Não é possível listar as assinaturas de apps em um espaço usando o acesso de administrador.

ListMembershipsResponse

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

Campos

memberships[]

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

next_page_token

string

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

ListMessagePinsRequest

Mensagem de solicitação para listar as mensagens fixadas.

Campos

parent

string

Obrigatório. O espaço pai que possui a coleção de itens fixados. Formato: spaces/{space}

page_size

int32

Opcional. O número máximo de mensagens fixadas retornadas. O serviço pode retornar menos mensagens do que esse valor. O valor máximo é 100. Se você usar um valor maior que 100, ele será alterado automaticamente para 100. Se não for especificado, no máximo 100 mensagens fixadas serão retornadas. Valores negativos retornam um erro INVALID_ARGUMENT.

page_token

string

Opcional. Um token de página recebido de uma chamada anterior para listar as mensagens fixadas. Informe esse parâmetro para recuperar a página seguinte.

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

ListMessagePinsResponse

Mensagem de resposta para listar as mensagens fixadas.

Campos

message_pins[]

MessagePin

As mensagens fixadas do espaço especificado.

next_page_token

string

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

ListMessagesRequest

Lista as mensagens no espaço especificado em que o usuário é participante.

Campos
`parent`	`string` Obrigatório. O nome do recurso do espaço de onde as mensagens serão listadas. Formato: `spaces/{space}`
`page_size`	`int32` Opcional. O número máximo de mensagens retornadas. O serviço pode retornar menos mensagens do que esse valor. Se não for especificado, no máximo 25 serão retornados. O valor máximo é 1.000. Se você usar um valor maior que 1.000, ele será alterado automaticamente para 1.000. Valores negativos retornam um erro `INVALID_ARGUMENT`.
`page_token`	`string` Opcional. Um token de página recebido de uma chamada de listagem de mensagens anterior. Informe esse parâmetro para recuperar a página seguinte. Na paginação, todos os outros parâmetros enviados precisam corresponder à chamada que proporcionou o token da página. Transmitir valores diferentes para os outros parâmetros pode levar a resultados inesperados.
`filter`	`string` Opcional. Um filtro de consulta. É possível filtrar mensagens por data (`create_time`) e conversa (`thread.name`). Para filtrar as mensagens pela data de criação, especifique `create_time` com um carimbo de data/hora no formato RFC-3339 e aspas duplas. Por exemplo, `"2023-04-21T11:30:00-04:00"`. Use o operador maior que `>` para listar as mensagens criadas após um carimbo de data/hora ou o operador menor que `<` para listar as mensagens criadas antes de um carimbo de data/hora. Para filtrar mensagens em um intervalo de tempo, use o operador `AND` entre dois carimbos de data/hora. Para filtrar por conversa, especifique o `thread.name`, formatado como `spaces/{space}/threads/{thread}`. Só é possível especificar um `thread.name` por consulta. Para filtrar por conversa e data, use o operador `AND` na consulta. Por exemplo, as seguintes consultas são válidas: `create_time > "2012-04-21T11:30:00-04:00" create_time > "2012-04-21T11:30:00-04:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123 create_time > "2012-04-21T11:30:00+00:00" AND create_time < "2013-01-01T00:00:00+00:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123 thread.name = spaces/AAAAAAAAAAA/threads/123` Consultas inválidas são rejeitadas pelo servidor com um erro `INVALID_ARGUMENT`.
`order_by`	`string` Opcional. Como a lista de mensagens é ordenada. Especifique um valor para ordenar por uma operação de ordenação. Os valores válidos para a operação de ordenação são os seguintes: `ASC` para ordem crescente. `DESC` para decrescente. A ordem padrão é `create_time ASC`.
`show_deleted`	`bool` Opcional. Se as mensagens excluídas devem ser incluídas. As mensagens excluídas incluem o horário e os metadados da exclusão, mas o conteúdo da mensagem não está disponível.
`markup_syntax`	`MarkupSyntax` Opcional. Especifica a sintaxe de saída desejada para o campo `formatted_text` da mensagem de chat.

ListMessagesResponse

Mensagem de resposta para listar mensagens.

Campos

messages[]

Lista de mensagens.

next_page_token

string

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

ListReactionsRequest

Lista as reações a uma mensagem.

Campos
`parent`	`string` Obrigatório. A mensagem que recebeu a reação dos usuários. Formato: `spaces/{space}/messages/{message}`
`page_size`	`int32` Opcional. O número máximo de reações retornadas. O serviço pode retornar menos reações do que esse valor. Se não for especificado, o valor padrão será 25. O valor máximo é 200. Valores maiores serão convertidos para 200.
`page_token`	`string` Opcional. (Se estiver retomando de uma consulta anterior.) Um token de página recebido de uma chamada anterior para listar reações. Forneça isso para recuperar a página subsequente. Ao paginar, o valor do filtro precisa corresponder à chamada que forneceu o token da página. Transmitir um valor diferente pode levar a resultados inesperados.
`filter`	`string` Opcional. Um filtro de consulta. É possível filtrar as reações por emoji (`emoji.unicode` ou `emoji.custom_emoji.uid`) e usuário (`user.name`). Para filtrar reações de vários emojis ou usuários, junte campos semelhantes com o operador `OR`, como `emoji.unicode = "🙂" OR emoji.unicode = "👍"` e `user.name = "users/AAAAAA" OR user.name = "users/BBBBBB"`. Para filtrar as reações por emoji e usuário, use o operador `AND`, como `emoji.unicode = "🙂" AND user.name = "users/AAAAAA"`. Se a consulta usar `AND` e `OR`, agrupe-os com parênteses. Por exemplo, as seguintes consultas são válidas: `user.name = "users/{user}" emoji.unicode = "🙂" emoji.custom_emoji.uid = "{uid}" emoji.unicode = "🙂" OR emoji.unicode = "👍" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" emoji.unicode = "🙂" AND user.name = "users/{user}" (emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}") AND user.name = "users/{user}"` As seguintes consultas são inválidas: `emoji.unicode = "🙂" AND emoji.unicode = "👍" emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}" emoji.unicode = "🙂" OR user.name = "users/{user}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR user.name = "users/{user}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" AND user.name = "users/{user}"` Consultas inválidas são rejeitadas com um erro `INVALID_ARGUMENT`.

ListReactionsResponse

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

Campos

reactions[]

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

next_page_token

string

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

ListSectionItemsRequest

Mensagem de solicitação para listar itens de seção.

Campos
`parent`	`string` Obrigatório. O pai, que é o nome do recurso da seção que possui essa coleção de itens de seção. Só é possível listar itens de seção para o usuário que está fazendo a chamada. Ao filtrar por espaço, use o caractere curinga `-` para pesquisar em todas as seções. Por exemplo, `users/{user}/sections/-`. Formato: `users/{user}/sections/{section}`
`page_size`	`int32` Opcional. O número máximo de itens de seção a serem retornados. O serviço pode retornar um valor inferior a este. Se não for especificado, no máximo 10 itens de seção serão retornados. O valor máximo é 100. Se você usar um valor maior que 100, ele será alterado automaticamente para 100. Valores negativos retornam um erro `INVALID_ARGUMENT`.
`page_token`	`string` Opcional. Um token de página recebido de uma chamada anterior para listar itens de seção. Forneça isso para recuperar a página subsequente. Na paginação, todos os outros parâmetros enviados precisam corresponder à chamada que proporcionou o token da página. Transmitir valores diferentes para os outros parâmetros pode levar a resultados inesperados.
`filter`	`string` Opcional. Um filtro de consulta. No momento, só é possível filtrar por espaço. Por exemplo, `space = spaces/{space}`. Consultas inválidas são rejeitadas com um erro `INVALID_ARGUMENT`.

ListSectionItemsResponse

Mensagem de resposta para listar itens de seção.

Campos

section_items[]

SectionItem

Os itens da seção especificada.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListSectionsRequest

Mensagem de solicitação para listar seções.

Campos

parent

string

Obrigatório. O pai, que é o nome do recurso do usuário que tem essa coleção de seções. Só é possível listar as seções do usuário que faz a chamada. Para se referir ao usuário que está fazendo a chamada, defina uma das seguintes opções:

O alias me. Por exemplo, users/me.
O endereço de e-mail do Workspace. Por exemplo, users/user@example.com.
O ID do usuário. Por exemplo, users/123456789.

Formato: users/{user}

page_size

int32

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

Se não for especificado, no máximo 10 seções serão retornadas.

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

Valores negativos retornam um erro INVALID_ARGUMENT.

page_token

string

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

ListSectionsResponse

Mensagem de resposta para listar seções.

Campos

sections[]

As seções do usuário especificado.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListSpaceEventsRequest

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

Campos
`parent`	`string` Obrigatório. Nome do recurso do espaço do Google Chat em que os eventos ocorreram. Formato: `spaces/{space}`.
`page_size`	`int32` Opcional. O número máximo de eventos de espaço retornados. O serviço pode retornar um valor inferior a este. Valores negativos retornam um erro `INVALID_ARGUMENT`.
`page_token`	`string` Opcional. Um token de página recebido de uma chamada anterior para listar eventos de espaço. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para listar eventos de espaço precisam corresponder à chamada que forneceu o token da página. Transmitir valores diferentes para os outros parâmetros pode levar a resultados inesperados.
`filter`	`string` Obrigatório. Um filtro de consulta. É preciso especificar pelo menos um tipo de evento (`event_type`) usando o operador `:`. Para filtrar por vários tipos de evento, use o operador `OR`. Omita os tipos de evento em lote no filtro. A solicitação retorna automaticamente todos os eventos de lote relacionados. Por exemplo, se você filtrar por novas reações (`google.workspace.chat.reaction.v1.created`), o servidor também vai retornar eventos de novas reações em lote (`google.workspace.chat.reaction.v1.batchCreated`). Para uma lista de tipos de eventos compatíveis, consulte a documentação de referência de `SpaceEvents`. Também é possível filtrar por horário de início (`start_time`) e de término (`end_time`): `start_time`: carimbo de data/hora exclusivo para começar a listar os eventos do espaço. É possível listar eventos que ocorreram há até 28 dias. Se não for especificado, lista os eventos de espaço dos últimos 28 dias. `end_time`: carimbo de data/hora inclusivo até o qual os eventos do espaço são listados. Se não for especificado, lista os eventos até o momento da solicitação. Para especificar um horário de início ou término, use o operador de igualdade `=` e o formato RFC-3339. Para filtrar por `start_time` e `end_time`, use o operador `AND`. Por exemplo, as seguintes consultas são válidas: `start_time="2023-08-23T19:20:33+00:00" AND end_time="2023-08-23T19:21:54+00:00"` `start_time="2023-08-23T19:20:33+00:00" AND (event_types:"google.workspace.chat.space.v1.updated" OR event_types:"google.workspace.chat.message.v1.created")` As seguintes consultas são inválidas: `start_time="2023-08-23T19:20:33+00:00" OR end_time="2023-08-23T19:21:54+00:00"` `event_types:"google.workspace.chat.space.v1.updated" AND event_types:"google.workspace.chat.message.v1.created"` Consultas inválidas são rejeitadas pelo servidor com um erro `INVALID_ARGUMENT`.

ListSpaceEventsResponse

Mensagem de resposta para listar eventos de espaço.

Campos

space_events[]

SpaceEvent

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

next_page_token

string

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

ListSpacesRequest

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

Campos

page_size

int32

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

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

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

Valores negativos retornam um erro INVALID_ARGUMENT.

page_token

string

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

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

filter

string

Opcional. Um filtro de consulta.

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

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

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

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

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

ListSpacesResponse

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

Campos

spaces[]

MembershipCreatedEventData

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

next_page_token

string

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

MarkAsActiveRequest

Solicite mensagem para o método MarkAsActive.

Campos
`name`	`string` Obrigatório. O nome do recurso da disponibilidade que será marcada como ativa. Formato: users/{user}/availability `{user}` é o ID da pessoa na API People ou na API Directory do SDK Admin. Por exemplo, `users/123456789`. O endereço de e-mail do usuário ou `me` também pode ser usado como um alias para se referir ao autor da chamada. Por exemplo, `users/user@example.com` ou `users/me`.
Campo de união `expiration`. A validade do estado de disponibilidade ACTIVE. O usuário será marcado como "Ausente" após o término do período. Se nenhuma validade for informada, o estado ACTIVE vai expirar 30 minutos após o horário atual. `expiration` pode ser apenas de um dos tipos a seguir:
`expire_time`	`Timestamp` O carimbo de data/hora absoluto em que o estado ACTIVE expira.
`ttl`	`Duration` A duração do horário atual até que o estado ACTIVE expire. O uso de um TTL curto pode redefinir o estado do usuário para que ele seja baseado na atividade após essa breve duração.

MarkAsAwayRequest

Solicite mensagem para o método MarkAsAway.

Campos

name

string

Obrigatório. O nome do recurso da disponibilidade a ser marcada como ausente. Formato: users/{user}/availability

{user} é o ID da pessoa na API People ou na API Directory do SDK Admin. Por exemplo, users/123456789.

O endereço de e-mail do usuário ou me também pode ser usado como um alias para se referir ao autor da chamada. Por exemplo, users/user@example.com ou users/me.

MarkAsDoNotDisturbRequest

Solicite mensagem para o método MarkAsDoNotDisturb.

Campos
`name`	`string` Obrigatório. O nome do recurso da disponibilidade a ser marcada como "Não perturbe". Formato: users/{user}/availability `{user}` é o ID da pessoa na API People ou na API Directory do SDK Admin. Por exemplo, `users/123456789`. O endereço de e-mail do usuário ou `me` também pode ser usado como um alias para se referir ao autor da chamada. Por exemplo, `users/user@example.com` ou `users/me`.
Campo de união `expiration`. Obrigatório. A validade do estado de disponibilidade "Não perturbe". O usuário será marcado como "Ausente" após o término. Esse valor pode ser de no máximo um ano a partir do momento atual. `expiration` pode ser apenas de um dos tipos a seguir:
`expire_time`	`Timestamp` O carimbo de data/hora absoluto de quando o estado de Não Perturbe expira.
`ttl`	`Duration` A duração do horário atual até que o estado de Não Perturbe expire.

MarkupSyntax

Especifica a sintaxe de marcação usada para formatar o texto da mensagem de chat. Aplica-se ao campo text do recurso Message.

Tipos enumerados
`MARKUP_SYNTAX_UNSPECIFIED`	Representa o valor não especificado.
`MARKUP_SYNTAX_CHAT`	Usa a sintaxe de marcação do Google Chat. Consulte https://developers.google.com/workspace/chat/format-messages#format-texts para mais informações.
`MARKUP_SYNTAX_MARKDOWN`	Usa a sintaxe de Markdown. Essa sintaxe é baseada na especificação CommonMark, com extensões adicionais. Consulte https://developers.google.com/workspace/chat/format-messages#format-texts para mais informações.

MatchedUrl

Um URL correspondente em uma mensagem de chat. Os apps do Chat podem mostrar uma prévia dos URLs correspondentes. Para mais informações, consulte Visualizar links.

Campos

url

string

Apenas saída. O URL que foi correspondido.

MeetSpaceLinkData

Dados dos links de espaços para reuniões.

Campos

meeting_code

string

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

type

Type

Indica o tipo de espaço para reuniões.

huddle_status

HuddleStatus

Opcional. Apenas saída. Se o Meet for uma reunião rápida, indica o status dela. Caso contrário, ele não será definido.

HuddleStatus

O status da reunião

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

Tipo

O tipo de espaço para reuniões.

Tipos enumerados
`TYPE_UNSPECIFIED`	Valor padrão do tipo enumerado. Não use.
`MEETING`	O espaço para reuniões do Meet é uma reunião.
`HUDDLE`	O espaço para reuniões do Meet é uma reunião rápida.

Assinatura

Representa uma relação de participação no Google Chat, como se um usuário ou app do Chat foi convidado, faz parte ou está ausente de um espaço.

Campos
`name`	`string` Identificador. Nome do recurso da assinatura, atribuído pelo servidor. Formato: `spaces/{space}/members/{member}`
`state`	`MembershipState` Apenas saída. Estado da assinatura.
`role`	`MembershipRole` Opcional. Função do usuário em um espaço do Chat, que determina as ações permitidas no espaço. Este campo só pode ser usado como entrada em `UpdateMembership`.
`create_time`	`Timestamp` Opcional. Imutável. O horário de criação da assinatura, como quando um participante entrou ou foi convidado para entrar em um espaço. Este campo é somente saída, exceto quando usado para importar associações históricas em espaços do modo de importação.
`delete_time`	`Timestamp` Opcional. Imutável. O horário de exclusão da assinatura, como quando um participante saiu ou foi removido de um espaço. Este campo é somente saída, exceto quando usado para importar associações históricas em espaços do modo de importação.
`affiliation`	`Affiliation` Apenas saída. A relação de um usuário com a organização do Workspace proprietária do espaço. Nos espaços de contas pessoais, a afiliação de todos os participantes é `EXTERNAL`.
Campo de união `memberType`. Membro associado a esta assinatura. Outros tipos de membros podem ser aceitos no futuro. `memberType` pode ser apenas de um dos tipos a seguir:
`member`	`User` Opcional. O usuário ou app do Google Chat a que a assinatura corresponde. Se o app do Chat for autenticado como um usuário, a saída vai preencher apenas os campos `name` e `type` do usuário para usuários internos e externos, a menos que eles sejam participantes do espaço ou tenham uma afinidade anterior, como uma conversa por mensagem direta (DM), com o usuário que está chamando.
`group_member`	`Group` Opcional. O Grupo do Google ao qual a associação corresponde. A leitura ou mutação de associações para Grupos do Google requer autenticação do usuário.

Afiliação

Representa a afiliação de um usuário à organização do Google Workspace proprietária do espaço. Esse tipo enumerado pode ter mais valores adicionados no futuro.

Tipos enumerados
`AFFILIATION_UNSPECIFIED`	Valor padrão. Esse valor não é usado.
`INTERNAL`	Uma conta gerenciada pela mesma organização do Google Workspace que é proprietária do espaço.
`EXTERNAL`	Uma conta externa à organização do Google Workspace que é proprietária do espaço (por exemplo, uma conta pessoal ou gerenciada por outra organização do Workspace).
`MANAGED_EXTERNAL`	Uma conta gerenciada pela organização do Workspace que é proprietária do espaço, mas provisionada para um usuário externo à organização (por exemplo, um usuário visitante). Para saber mais sobre os convidados, acesse https://support.google.com/chat/answer/16997417.

MembershipRole

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

Tipos enumerados
`MEMBERSHIP_ROLE_UNSPECIFIED`	Valor padrão. Para `users`: a pessoa não é participante do espaço, mas pode ser convidada. Para `Google Groups`: esse papel é sempre atribuído a eles (outros valores de tipo enumerado podem ser usados no futuro).
`ROLE_MEMBER`	Um participante do espaço. Na interface do Chat, essa função é chamada de Participante. O usuário tem permissões básicas, como enviar mensagens para o espaço. Os administradores e proprietários podem conceder permissões adicionais aos participantes em um espaço, incluindo: Adicionar ou remover membros. Modificar detalhes do espaço. Ativar ou desativar o histórico. Mencione todos no espaço com `@all`. Gerenciar apps do Chat e webhooks instalados no espaço. Nas mensagens diretas e nas conversas em grupo sem nome, todos têm essa função.
`ROLE_MANAGER`	Um proprietário do espaço. Na interface do Chat, essa função é chamada de "Proprietário". O usuário tem todas as permissões para gerenciar o espaço, incluindo: Mudar a função de outros participantes no espaço para participante, administrador ou proprietário. Exclua o espaço. Compatível apenas com `SpaceType.SPACE` (espaços nomeados). Para saber mais, consulte Saiba mais sobre sua função como proprietário ou administrador do espaço.
`ROLE_ASSISTANT_MANAGER`	Um administrador do espaço. Na interface do Chat, essa função é chamada de "Administrador". O usuário tem todas as permissões básicas de `ROLE_MEMBER` e pode receber um subconjunto de permissões administrativas de um proprietário. Por padrão, os administradores têm todas as permissões de um proprietário, exceto a capacidade de: Exclua o espaço. Tornar outro participante proprietário. Mudar a função de um proprietário. Por padrão, as permissões dos administradores incluem, entre outras: Tornar outro participante administrador. Excluir mensagens no espaço. Gerenciar permissões do espaço. Receber notificações de pedidos para participar do espaço se o administrador tiver a permissão "Gerenciar participantes" nas configurações do espaço. Tornar um espaço detectável. Compatível apenas com `SpaceType.SPACE` (espaços nomeados). Para saber mais, consulte Gerenciar as configurações do espaço.

MembershipState

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

Tipos enumerados
`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 foi convidado para participar do espaço, mas ainda não entrou.
`NOT_A_MEMBER`	O usuário não pertence ao espaço e não tem um convite pendente para participar dele.

MembershipBatchCreatedEventData

Payload de evento para várias novas assinaturas.

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

Campos

memberships[]

Uma lista de novas assinaturas.

MembershipBatchDeletedEventData

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

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

Campos

memberships[]

MembershipDeletedEventData

Uma lista de assinaturas excluídas.

MembershipBatchUpdatedEventData

Payload de evento para várias assinaturas atualizadas.

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

Campos

memberships[]

MembershipUpdatedEventData

Uma lista de assinaturas atualizadas.

MembershipCreatedEventData

Payload de evento para um novo membro.

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

Campos

membership

O novo membro.

MembershipDeletedEventData

Payload de 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 name e state são preenchidos.

MembershipUpdatedEventData

Payload de evento para uma assinatura atualizada.

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

Campos

membership

MessageCreatedEventData

A assinatura atualizada.

Mensagem

Uma mensagem em um espaço do Google Chat.

Campos
`name`	`string` Identificador. Nome do recurso da mensagem. Formato: `spaces/{space}/messages/{message}` Em que `{space}` é o ID do espaço em que a mensagem foi postada e `{message}` é um ID atribuído pelo sistema para a mensagem. Por exemplo, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. Se você definir um código personalizado ao criar uma mensagem, poderá usá-lo para especificar a mensagem em uma solicitação, substituindo `{message}` pelo valor do campo `clientAssignedMessageId`. Por exemplo, `spaces/AAAAAAAAAAA/messages/client-custom-name`. Veja mais detalhes em Nomear uma mensagem.
`sender`	`User` Apenas saída. O usuário que criou a mensagem. Se o app do Chat for autenticado como um usuário, a saída vai preencher apenas os campos `name` e `type` do usuário para usuários internos e externos, a menos que eles sejam participantes do espaço ou tenham uma afinidade anterior, como uma conversa por mensagem direta (DM), com o usuário que está chamando.
`create_time`	`Timestamp` Opcional. Imutável. Para espaços criados no Chat, o horário em que a mensagem foi criada. Este campo é somente saída, exceto quando usado em espaços do modo de importação. Para espaços no modo de importação, defina esse campo como o carimbo de data/hora histórico em que a mensagem foi criada na origem para preservar o horário de criação original.
`last_update_time`	`Timestamp` Apenas saída. A hora em que a mensagem foi editada pela última vez por um usuário. Se a mensagem nunca tiver sido editada, esse campo vai ficar vazio.
`delete_time`	`Timestamp` 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`	`string` Opcional. Corpo de texto simples da mensagem. O primeiro link para uma imagem, vídeo ou página da Web gera um ícone de visualização. Você também pode @mencionar um usuário do Google Chat ou todos no espaço. Para saber como criar mensagens de texto, consulte Enviar uma mensagem.
`formatted_text`	`string` Apenas saída. Contém a mensagem `text` com marcações adicionadas para comunicar a formatação. Esse campo pode não capturar toda a formatação visível na interface, mas inclui o seguinte: Sintaxe de marcação para negrito, itálico, tachado, fonte monoespaçada, bloco monoespaçado, lista com marcadores e citação em bloco. Menções de usuários usando o formato `<users/{user}>`. Hiperlinks personalizados usando o formato `<{url}\|{rendered_text}>`, em que a primeira string é o URL e a segunda é o texto renderizado, por exemplo, `<http://example.com\|custom text>`. Emojis personalizados usando o formato `:{emoji_name}:`, por exemplo, `:smile:`. Isso não se aplica a emojis Unicode, como `U+1F600` para um emoji de rosto sorridente. Itens de lista com marcadores usando asteriscos (``), por exemplo, ` item`. Para mais informações, consulte Ver a formatação de texto enviada em uma mensagem.
`cards[] (deprecated)`	`Card` Este item está obsoleto. Descontinuado: use `cards_v2`. Cards avançados, formatados e interativos que podem ser usados para mostrar 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` e `cards_v2` podem ter um tamanho máximo de 32 KB.
`cards_v2[]`	`CardWithId` Opcional. Uma matriz de cards. Os apps do Chat podem criar cards com a autenticação de apps. Como parte do Programa de prévia para desenvolvedores, se o app do Chat se autenticar como usuário, ele poderá criar mensagens de card. Se o app do Chat não fizer parte do Programa de Prévia para Desenvolvedores, ele não poderá criar cards com autenticação de usuário. Para saber como criar uma mensagem que contém cards, consulte Enviar uma mensagem. Crie e visualize cards com o Criador de cards. Abra o Criador de Cards
`annotations[]`	`Annotation` Apenas saída. As anotações podem ser associadas ao corpo de texto simples da mensagem ou a ícones que levam a recursos do Google Workspace, como o Google Docs ou as Planilhas, com `start_index` e `length` de 0.
`thread`	`Thread` A conversa a que a mensagem pertence. Para ver um exemplo de uso, consulte Iniciar ou responder a uma conversa de mensagem.
`space`	`Space` Apenas saída. Se o app do Chat for autenticado como um usuário, a saída vai preencher apenas o `name` do espaço.
`fallback_text`	`string` Opcional. Uma descrição em texto simples dos cards da mensagem, usada quando os cards reais não podem ser exibidos, por exemplo, em notificações no dispositivo móvel.
`action_response`	`ActionResponse` Somente entrada. Parâmetros que um app do Chat pode usar para configurar como a resposta é postada.
`argument_text`	`string` Apenas saída. Corpo de texto simples da mensagem sem as menções ao app do Chat.
`slash_command`	`SlashCommand` Apenas saída. Informações sobre o comando de barra, se aplicável.
`attachment[]`	`Attachment` Opcional. Anexo enviado pelo usuário.
`matched_url`	`MatchedUrl` Apenas saída. Um URL no campo `text` da mensagem de chat que corresponde a um padrão de visualização de link. Para mais informações, consulte Visualizar links.
`thread_reply`	`bool` Apenas saída. Quando `true`, a mensagem é uma resposta em uma conversa. Quando `false`, a mensagem fica visível na conversa de nível superior do espaço como a primeira mensagem de uma conversa agrupada ou uma mensagem sem respostas agrupadas. Se o espaço não for compatível com respostas em conversas, esse campo será sempre `false`.
`silent`	`bool` Apenas saída. Se esta é uma mensagem silenciosa. As mensagens silenciosas são aquelas em que o Chat suprime as notificações push para os destinatários.
`client_assigned_message_id`	`string` Opcional. Um código personalizado para a mensagem. Você pode usar o campo para identificar, receber, excluir ou atualizar uma mensagem. Para definir um código personalizado, especifique o campo `messageId` ao criar a mensagem. Para mais detalhes, consulte Nomear uma mensagem.
`emoji_reaction_summaries[]`	`EmojiReactionSummary` Apenas saída. A lista de resumos de reações com emoji na mensagem.
`private_message_viewer`	`User` Opcional. Imutável. Entrada para criar uma mensagem, caso contrário, somente saída. O usuário que pode ver a mensagem. Quando definido, a mensagem é particular e fica visível apenas para o usuário especificado e o app do Chat. Para incluir esse campo na solicitação, chame a API Chat usando a autenticação do app e omita o seguinte: Anexos Para mais detalhes, consulte Enviar uma mensagem particular.
`deletion_metadata`	`DeletionMetadata` Apenas saída. Informações sobre uma mensagem excluída. Uma mensagem é excluída quando `delete_time` é definido.
`quoted_message_metadata`	`QuotedMessageMetadata` Opcional. Informações sobre uma mensagem que outra mensagem cita. Ao criar uma mensagem, você pode citar mensagens na mesma conversa ou citar uma mensagem raiz para criar outra. No entanto, não é possível citar uma resposta de mensagem de uma conversa diferente. Ao atualizar uma mensagem, não é possível adicionar ou substituir o campo `quotedMessageMetadata`, mas é possível removê-lo. Para ver um exemplo de uso, consulte Citar outra mensagem.
`attached_gifs[]`	`AttachedGif` Apenas saída. Imagens GIF anexadas à mensagem.
`accessory_widgets[]`	`AccessoryWidget` Opcional. Um ou mais widgets interativos que aparecem na parte de baixo de uma mensagem. É possível adicionar widgets de acessório a mensagens que contêm texto, cards ou ambos. Não há suporte para mensagens que contêm caixas de diálogo. Para mais detalhes, consulte Adicionar widgets interativos na parte de baixo de uma mensagem. Para criar uma mensagem com widgets acessórios, é necessário fazer a autenticação do app.
`elements`	`Elements` Opcional. Os elementos são componentes adicionais fornecidos durante a criação da mensagem que podem ou não estar associados a partes específicas do texto da mensagem. Elas são diferentes das anotações, que são somente de saída e oferecem informações complementares vinculadas a fragmentos de mensagens ou ao texto inteiro da mensagem. Prévia para desenvolvedores:disponível no Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos.
`markup_syntax`	`MarkupSyntax` Opcional. Especifica como o servidor interpreta o conteúdo do campo `text` da mensagem.

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[]

MessageDeletedEventData

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[]

MessageUpdatedEventData

Uma lista de mensagens atualizadas.

MessageCreatedEventData

Payload de evento para uma nova mensagem.

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

Campos

message

A nova mensagem.

MessageDeletedEventData

Payload de evento para uma mensagem excluída.

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

Campos

message

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

MessagePin

Um pin em uma mensagem de chat. Para mais informações, consulte Fixar uma mensagem.

Campos

name

string

Identificador. O nome do recurso da mensagem fixada. Formato: spaces/{space}/messagePins/{message_pin} O componente do ID do recurso corresponde ao componente do ID do recurso da mensagem. Por exemplo, uma mensagem com spaces/AAA/messages/bbb.ccc corresponde ao pin de mensagem com o nome de recurso spaces/AAA/messagePins/bbb.ccc.

message

string

Obrigatório. Imutável. O nome do recurso da mensagem fixada. Formato: spaces/{space}/messages/{message}

MessageUpdatedEventData

Payload de evento para uma mensagem atualizada.

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

Campos

message

A mensagem atualizada.

MoveSectionItemRequest

Mensagem de solicitação para mover um item de uma seção para outra.

Campos

name

string

Obrigatório. O nome do recurso do item da seção a ser movido.

Formato: users/{user}/sections/{section}/items/{item}

target_section

string

Obrigatório. O nome do recurso da seção para onde o item será movido.

Formato: users/{user}/sections/{section}

MoveSectionItemResponse

Mensagem de resposta para mover um item de seção.

Campos

section_item

SectionItem

O item de seção atualizado.

PositionSectionRequest

Mensagem de solicitação para posicionar uma seção.

Campos
`name`	`string` Obrigatório. O nome do recurso da seção a ser posicionada. Formato: `users/{user}/sections/{section}`
Campo de união `position`. Obrigatório. A nova posição da seção. `position` pode ser apenas de um dos tipos a seguir:
`sort_order`	`int32` Opcional. A posição absoluta da seção na lista de seções. A posição precisa ser maior que 0. Se a posição for maior que o número de seções, a seção será anexada ao final da lista. Essa operação insere a seção na posição indicada e desloca a seção original nessa posição, e as que estão abaixo dela, para a próxima posição.
`relative_position`	`Position` Opcional. A posição relativa da seção na lista de seções.

Posição

É a posição da seção.

Tipos enumerados
`POSITION_UNSPECIFIED`	Posição não especificada.
`START`	Início da lista de seções.
`END`	Fim da lista de seções.

PositionSectionResponse

Mensagem de resposta para posicionar uma seção.

Campos

section

ReactionCreatedEventData

A seção atualizada.

QuotedMessageMetadata

Informações sobre uma mensagem que outra mensagem cita.

Ao atualizar uma mensagem, não é possível adicionar ou substituir o campo quotedMessageMetadata, mas é possível removê-lo.

Para ver um exemplo de uso, consulte Citar outra mensagem.

Campos
`name`	`string` Obrigatório. Nome do recurso da mensagem citada. Formato: `spaces/{space}/messages/{message}`
`last_update_time`	`Timestamp` Obrigatório. O carimbo de data/hora de quando a mensagem citada foi criada ou atualizada pela última vez. Se a mensagem foi editada, use este campo, `last_update_time`. Se a mensagem nunca foi editada, use `create_time`. Se `last_update_time` não corresponder à versão mais recente da mensagem citada, a solicitação vai falhar.
`quote_type`	`QuoteType` Opcional. Especifica o tipo de citação. Se não for definido, o padrão será REPLY no caminho de leitura/gravação da mensagem para compatibilidade com versões anteriores.
`quoted_message_snapshot`	`QuotedMessageSnapshot` Apenas saída. Um resumo do conteúdo da mensagem citada.
`forwarded_metadata`	`ForwardedMetadata` Apenas saída. Metadados sobre o espaço de origem da mensagem citada. Preenchido apenas para o tipo de cotação FORWARD.

QuoteType

O tipo de citação da mensagem citada.

Tipos enumerados

QUOTE_TYPE_UNSPECIFIED Reservado. Esse valor não é usado.

REPLY

Quando quote_type é REPLY, é possível fazer o seguinte:

Se você estiver respondendo em uma conversa, poderá citar outra mensagem nela.
Se você estiver criando uma mensagem raiz, poderá citar outra mensagem raiz nesse espaço.

FORWARD

Quando quote_type é FORWARD, você pode citar:

Mensagem de um espaço diferente.
Resposta de uma mensagem de uma conversa diferente no mesmo espaço.

QuotedMessageSnapshot

Mostra uma captura de tela do conteúdo da mensagem citada no momento da citação ou do encaminhamento.

Campos
`sender`	`string` Apenas saída. O nome do autor da mensagem citada. Preenchido para os tipos de citação REPLY e FORWARD.
`text`	`string` Apenas saída. Captura de tela do conteúdo de texto da mensagem citada.
`formatted_text`	`string` Apenas saída. Contém a mensagem citada `text` com marcações adicionadas para oferecer suporte à formatação avançada,como hiperlinks, emojis personalizados, marcação etc. Preenchido apenas para o tipo de citação FORWARD.
`annotations[]`	`Annotation` Apenas saída. Anotações analisadas do corpo de texto da mensagem citada. Preenchido apenas para o tipo de cotação FORWARD.
`attachments[]`	`Attachment` Apenas saída. Anexos que faziam parte da mensagem citada. São cópias dos metadados do anexo da mensagem citada. Preenchido apenas para o tipo de cotação FORWARD.

Reação

Uma reação a uma mensagem.

Campos

name

string

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

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

user

User

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

emoji

Emoji

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

ReactionBatchCreatedEventData

Payload 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[]

ReactionDeletedEventData

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.

ReplaceMessageCardsRequest

Mensagem de solicitação para o método de API ReplaceMessageCards.

Campos

name

string

Obrigatório. O nome do recurso da mensagem.

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

cards_v2[]

CardWithId

Opcional. Uma matriz de cards a serem incluídos na mensagem. Esses cards vão substituir os cards atuais da mensagem. Se estiver vazio, os cards originais incluídos na mensagem serão apagados.

ReplaceMessageCardsResponse

Esse tipo não tem campos.

Mensagem de resposta para a API ReplaceMessageCards.

RichLinkMetadata

Um link avançado para um recurso. Os links avançados podem ser associados ao corpo de texto simples da mensagem ou representar ícones que levam a recursos do Google Workspace, como o Google Docs ou as Planilhas, com start_index e length de 0.

Campos
`uri`	`string` O URI desse link.
`rich_link_type`	`RichLinkType` 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`	`DriveLinkData` Dados de um link do Drive.
`chat_space_link_data`	`ChatSpaceLinkData` Dados de um link de espaço do Chat.
`meet_space_link_data`	`MeetSpaceLinkData` Dados de um link de espaço para reuniões.
`calendar_event_link_data`	`CalendarEventLinkData` Dados de um link de evento da agenda.

RichLinkType

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

Tipos enumerados
`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 de espaço do Chat. Por exemplo, um ícone inteligente de espaço.
`GMAIL_MESSAGE`	Um tipo de link avançado de mensagem do Gmail. Especificamente, um ícone do Gmail de Compartilhar no Chat. A API só é compatível com a leitura de mensagens com links diretos GMAIL_MESSAGE.
`MEET_SPACE`	Um tipo de link avançado de mensagem do Meet. Por exemplo, um ícone do Meet.
`CALENDAR_EVENT`	Um tipo de link de mensagem da Agenda. Por exemplo, um ícone da Agenda.

SearchMessageResult

Um único item de resultado de uma pesquisa de mensagens.

Campos

message

A mensagem correspondente.

space_mute_setting

MuteSetting

A configuração de silenciamento do usuário que faz a chamada para o espaço em que a mensagem é postada. O app de ligação pode usar essas informações para decidir como processar a mensagem, dependendo se o espaço está silenciado para o usuário ou não.

Retornado apenas se a visualização da solicitação for SEARCH_MESSAGES_VIEW_FULL e as credenciais de chamada incluírem o seguinte escopo de autorização:

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

read

bool

Indica se a mensagem correspondente foi lida pelo usuário que fez a chamada.

Retornado apenas se a visualização da solicitação for SEARCH_MESSAGES_VIEW_FULL e as credenciais de chamada incluírem um dos seguintes escopos de autorização:

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

SearchMessagesRequest

Mensagem de solicitação para pesquisar mensagens.

Campos
`parent`	`string` Obrigatório. O nome do recurso do espaço em que a pesquisa será feita. Para pesquisar em todos os espaços que o usuário pode acessar, defina esse campo como `spaces/-`. O uso de qualquer outro valor para `parent` resulta em um erro `INVALID_ARGUMENT`. Para limitar a pesquisa a um ou mais espaços, use `space.name` ou `space.display_name` em `filter`.
`filter`	`string` Obrigatório. Uma consulta de pesquisa. A consulta pode especificar uma ou mais palavras-chave da rede de pesquisa, que são usadas para filtrar os resultados, Também é possível filtrar os resultados usando os seguintes campos de mensagem: `create_time`: aceita um carimbo de data/hora no formato RFC-3339, e os operadores de comparação compatíveis são: `<` e `>=`. `sender.name`: o nome do recurso do remetente (`users/{user}`). Só aceita `=`. Você pode usar o e-mail como um alias para `{user}`. Por exemplo, `users/example@gmail.com`, em que `example@gmail.com` é o e-mail do usuário do Google Chat. `space.name`: o nome do recurso do espaço em que a mensagem foi postada. (`spaces/{space}`). Compatível apenas com `=`. Se esse filtro não for definido, a pesquisa será realizada em todas as mensagens diretas e espaços que o usuário pode acessar como participante. `space.display_name`: aceita o operador `:` (tem) e filtra os espaços com base em uma correspondência parcial do nome de exibição. Os resultados são limitados às cinco melhores correspondências de espaço. Por exemplo, `space.display_name:Project` pesquisa mensagens nos cinco primeiros espaços que contêm a palavra "Projeto" nos nomes de exibição. `space.space_type`: o tipo do espaço. Compatível apenas com `=`. Por exemplo, `space.space_type="DIRECT_MESSAGE"` retorna apenas mensagens diretas. Os valores possíveis são `DIRECT_MESSAGE`, `GROUP_CHAT` e `SPACE`. `attachment`: aceita o operador `:` (tem qualquer) para verificar a presença de anexos. Se `attachment:` for especificado, somente as mensagens com pelo menos um anexo serão retornadas. `annotations.user_mentions.user.name`: o nome do recurso do usuário mencionado (`users/{user}`). Só aceita `:` (tem). Por exemplo: `annotations.user_mentions.user.name:"users/1234567890"` retorna apenas mensagens que contêm uma menção ao usuário especificado. Como alternativa, o alias `me` pode ser usado para filtrar mensagens que mencionam o usuário autor da chamada, por exemplo: `annotations.user_mentions.user.name:users/me`. Você também pode usar o e-mail como um alias para `{user}`, por exemplo, `users/example@gmail.com`. Para filtragem avançada, as seguintes funções também estão disponíveis: `has_link()`: retorna apenas as mensagens que têm pelo menos um hiperlink no texto. `is_unread()`: filtra as mensagens que foram lidas pelo usuário que fez a chamada. Para usar os filtros `space.display_name` ou `space.space_type`, as credenciais de chamada precisam incluir um dos seguintes escopos de autorização: `https://www.googleapis.com/auth/chat.spaces.readonly` `https://www.googleapis.com/auth/chat.spaces` Para usar o filtro `is_unread()`, as credenciais de chamada precisam incluir um dos seguintes escopos de autorização: `https://www.googleapis.com/auth/chat.users.readstate.readonly` `https://www.googleapis.com/auth/chat.users.readstate` Em campos diferentes, apenas os operadores `AND` são aceitos. Um exemplo válido é `sender.name = "users/1234567890" AND is_unread()`. A palavra `AND` é opcional e está implícita se for omitida. Por exemplo, `sender.name = "users/1234567890" is_unread()` é válido e equivale ao exemplo anterior. Um exemplo inválido é `sender.name = "users/1234567890" OR is_unread()`, porque `OR` não é compatível entre campos diferentes. No mesmo campo: `create_time` é compatível apenas com `AND` e só pode ser usado para representar um intervalo, como `create_time >= "2022-01-01T00:00:00+00:00" AND create_time < "2023-01-01T00:00:00+00:00"`. `sender.name` aceita apenas o operador `OR`, por exemplo: `sender.name = "users/1234567890" OR sender.name = "users/0987654321"`. `space.name` aceita apenas o operador `OR`, por exemplo: `space.name = "spaces/ABCDEFGH" OR space.name = "spaces/QWERTYUI"`. `space.display_name` é compatível com os operadores `AND` e `OR`, mas não com uma combinação dos dois. Por exemplo: `space.display_name:Project AND space.display_name:Tasks` retorna mensagens que estão em espaços com nomes de exibição que contêm `Project` e `Tasks`, enquanto `space.display_name:Project OR space.display_name:Tasks` retorna mensagens que estão em espaços com nomes de exibição que contêm `Project` ou `Tasks` ou ambos. `space.space_type` aceita apenas o operador `OR`, por exemplo: `space.space_type = "DIRECT_MESSAGE" OR space.space_type = "GROUP_CHAT"`. `annotations.user_mentions.user.name` é compatível com os operadores `AND` e `OR`, mas não com uma combinação dos dois. Por exemplo: `annotations.user_mentions.user.name:"users/1234567890" AND annotations.user_mentions.user.name:"users/0987654321"` retorna apenas mensagens que mencionam os dois usuários, enquanto `annotations.user_mentions.user.name:"users/1234567890" OR annotations.user_mentions.user.name:"users/0987654321"` retorna mensagens que mencionam um ou ambos os usuários. Os parênteses são necessários para eliminar a ambiguidade da precedência do operador ao combinar os operadores `AND` e `OR` na mesma consulta. Por exemplo: `(sender.name="users/me" OR sender.name="users/123456") AND is_unread()`. Caso contrário, os parênteses são opcionais. Os exemplos de consulta a seguir são válidos: `"Pending reports" AND create_time >= "2023-01-01T00:00:00Z" sender.name = "users/example@gmail.com" annotations.user_mentions.user.name:"users/0987654321" attachment:* AND space.name = "spaces/ABCDEFGH" tasks AND is_unread() AND sender.name = "users/1234567890" "things to do" "urgent" (sender.name = "users/1234567890") AND (create_time < "2023-05-01T00:00:00Z") tasks AND space.name = "spaces/ABCDEFGH" AND has_link() "project one" is_unread() space.display_name:Project tasks` O tamanho máximo da consulta é de 1.000 caracteres. Consultas inválidas são rejeitadas pelo servidor com um erro `INVALID_ARGUMENT`.
`page_size`	`int32` Opcional. O número máximo de resultados a serem retornados. O serviço pode retornar um valor inferior a este. Se não for especificado, no máximo 25 serão retornados. O valor máximo é 100. Se você usar um valor maior que 100, ele será alterado automaticamente para 100.
`page_token`	`string` Opcional. Um token recebido da chamada de mensagens de pesquisa anterior. Informe esse parâmetro para recuperar a página seguinte. Na paginação, todos os outros parâmetros enviados precisam corresponder à chamada que proporcionou o token da página. Transmitir valores diferentes para os outros parâmetros pode levar a resultados inesperados.
`order_by`	`string` Opcional. Como a lista de resultados é ordenada. Os atributos aceitos para ordenação são: `create_time`: classifica os resultados pelo horário de criação da mensagem. Valor padrão. `relevance`: classifica os resultados por relevância. (Prévia para desenvolvedores do ) A ordem padrão é `create_time desc`. Só é possível usar uma única ordem por consulta (`create_time` ou `relevance`). Somente a ordem decrescente (`desc`) é aceita, e ela precisa ser especificada após o atributo de ordem.
`markup_syntax`	`MarkupSyntax` Opcional. Especifica a sintaxe de saída desejada para o campo `formatted_text` da mensagem de chat.
`view`	`SearchMessagesView` Opcional. Especifica o tipo de visualização de resultados da pesquisa que será retornado. O padrão é `SEARCH_MESSAGES_VIEW_BASIC`.

SearchMessagesView

Os tipos de visualização compatíveis com resultados de pesquisa parciais.

Tipos enumerados
`SEARCH_MESSAGES_VIEW_UNSPECIFIED`	O valor padrão / não definido. O padrão da API será a visualização BASIC.
`SEARCH_MESSAGES_VIEW_BASIC`	Inclui apenas as mensagens correspondentes nos resultados, sem metadados adicionais. Esse é o valor padrão.
`SEARCH_MESSAGES_VIEW_FULL`	Inclui tudo nos resultados: as mensagens correspondentes e outros metadados.

SearchMessagesResponse

Mensagem de resposta para pesquisar mensagens.

Campos

results[]

SearchMessageResult

A lista de resultados da pesquisa que correspondem à consulta.

next_page_token

string

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

SearchSpacesRequest

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

Campos
`use_admin_access`	`bool` Quando `true`, o método é executado usando os privilégios de administrador do Google Workspace do usuário. O usuário que faz a chamada precisa ser um administrador do Google Workspace com o privilégio de gerenciar conversas de chats e espaços. Requer o escopo do OAuth 2.0 `chat.admin.spaces.readonly` ou `chat.admin.spaces`.
`page_size`	`int32` O número máximo de espaços a serem retornados. O serviço pode retornar um valor inferior a este. Se não for especificado, no máximo 100 espaços serão retornados. O valor máximo é 1.000 quando `useAdminAccess` é definido como `true`. Caso contrário, o valor máximo é 100. Se você usar um valor maior que o máximo, ele será alterado automaticamente para o valor máximo.
`page_token`	`string` Um token recebido da chamada de espaços de pesquisa anterior. Informe esse parâmetro para recuperar a página seguinte. Na paginação, todos os outros parâmetros enviados precisam corresponder à chamada que proporcionou o token da página. Transmitir valores diferentes para os outros parâmetros pode levar a resultados inesperados.
`query`	`string` Obrigatório. Uma consulta de pesquisa. É possível pesquisar usando os seguintes parâmetros quando `useAdminAccess` está definido como `true`: `create_time` `customer` `display_name` `external_user_allowed` `last_active_time` `space_history_state` `space_type` Quando `useAdminAccess` é definido como `false`: `display_name` `external_user_allowed` `space_type` `create_time` e `last_active_time` aceitam um carimbo de data/hora no formato RFC-3339, e os operadores de comparação compatíveis são: `=`, `<`, `>`, `<=`, `>=`. `customer` é obrigatório quando `useAdminAccess` está definido como `true` e é usado para indicar de qual cliente os espaços serão buscados. `customers/my_customer` é o único valor compatível. `display_name` aceita apenas o operador `HAS` (`:`). O texto a ser correspondido é primeiro tokenizado em tokens, e cada token é correspondido por prefixo sem diferenciação de maiúsculas e minúsculas e de forma independente como uma substring em qualquer lugar no `display_name` do espaço. Por exemplo, `Fun Eve` corresponde a `Fun event` ou `The evening was fun`, mas não a `notFun event` ou `even`. Quando `useAdminAccess` é definido como `false`, `display_name` é necessário para recuperar resultados significativos. Caso contrário, o comportamento padrão é retornar uma resposta vazia. `external_user_allowed` aceita `true` ou `false`. `space_history_state` aceita apenas valores do campo `historyState` de um recurso `space`. `space_type` é obrigatório, e o único valor válido é `SPACE`. Em campos diferentes, apenas os operadores `AND` são aceitos. Um exemplo válido é `space_type = "SPACE" AND display_name:"Hello"`, e um exemplo inválido é `space_type = "SPACE" OR display_name:"Hello"`. No mesmo campo, `space_type` não é compatível com os operadores `AND` ou `OR`. `display_name`, "space_history_state" e "external_user_allowed" só aceitam operadores `OR`. `last_active_time` e `create_time` são compatíveis com os operadores `AND` e `OR`. `AND` só pode ser usado para representar um intervalo, como `last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00"`. Os exemplos de consulta a seguir são válidos quando `useAdminAccess` está definido como `true`: customer = "customers/my_customer" AND space_type = "SPACE" customer = "customers/my_customer" AND space_type = "SPACE" AND display_name:"Hello World" customer = "customers/my_customer" AND space_type = "SPACE" AND (last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time > "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (display_name:"Hello World" OR display_name:"Fun event") AND (last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time < "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (create_time > "2019-01-01T00:00:00+00:00" AND create_time < "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF") Os exemplos de consulta a seguir são válidos quando `useAdminAccess` está definido como `false`: `display_name:"Hello World" AND space_type = "SPACE" (display_name:"Hello" OR display_name:"Fun") AND space_type = "SPACE" (external_user_allowed = "true" AND space_type = "SPACE") // Returns an empty response. (external_user_allowed = "true" AND display_name:"Hello" AND space_type = "SPACE")` O tamanho máximo da consulta é de 1.000 caracteres. Consultas inválidas são rejeitadas pelo servidor com um erro `INVALID_ARGUMENT`.
`order_by`	`string` Opcional. Como a lista de espaços é ordenada. Os atributos aceitos para ordenação são: `membership_count.joined_direct_human_user_count`: indica o número de usuários humanos que entraram diretamente em um espaço. `last_active_time`: indica o horário em que o último item qualificado foi adicionado a qualquer tópico desse espaço. `create_time`: indica o horário de criação do espaço. Quando `useAdminAccess` é `false`, apenas `create_time` e `relevance` são compatíveis com a ordenação. Somente `DESC` é aceito para esses campos em pesquisas que não são de administrador. Os valores válidos para a operação de ordenação são: `ASC` para ordem crescente. Valor padrão. `DESC` para decrescente. A sintaxe aceita quando `useAdminAccess` é definido como `true`: `membership_count.joined_direct_human_user_count DESC` `membership_count.joined_direct_human_user_count ASC` `last_active_time DESC` `last_active_time ASC` `create_time DESC` `create_time ASC` Quando `useAdminAccess` é definido como `false`: `create_time DESC` `relevance DESC` ( prévia para desenvolvedores)

SearchSpacesResponse

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

Campos
`spaces[] (deprecated)`	`Space` Este item está obsoleto. Descontinuado: use o novo campo `results`. Uma página dos espaços solicitados. Este campo será preenchido somente quando `useAdminAccess` estiver definido como `true` e será descontinuado em favor do novo campo `results`.
`next_page_token`	`string` Um token que pode ser usado para recuperar a próxima página. Se esse campo estiver vazio, não haverá páginas subsequentes. Preenchido apenas quando `useAdminAccess` está definido como `true`.
`total_size`	`int32` O número total de espaços que correspondem à consulta em todas as páginas. Se o resultado for maior que 10.000 espaços, esse valor será uma estimativa. Preenchido apenas quando `useAdminAccess` está definido como `true`.
`results[]`	`SearchSpaceResult` Apenas saída. A lista de resultados da pesquisa que correspondem à consulta.

SearchSpaceResult

Um único item de resultado de uma pesquisa de espaço.

Campos

space

Apenas saída. O espaço correspondente.

Seção

Representa uma seção no Google Chat. As seções ajudam os usuários a organizar os espaços. Há dois tipos de seções:

Seções do sistema:são seções predefinidas gerenciadas pelo Google Chat. Os nomes de recursos são fixos, e não é possível criar, excluir ou modificar o display_name deles. Por exemplo:
- users/{user}/sections/default-direct-messages
- users/{user}/sections/default-spaces
- users/{user}/sections/default-apps
Seções personalizadas:são seções criadas e gerenciadas pelo usuário. Para criar uma seção personalizada usando CreateSection, é necessário um display_name. As seções personalizadas podem ser atualizadas usando UpdateSection e excluídas usando DeleteSection.

Campos
`name`	`string` Identificador. Nome do recurso da seção. Para seções do sistema, o ID é uma string constante: DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` DEFAULT_SPACES: `users/{user}/sections/default-spaces` DEFAULT_APPS: `users/{user}/sections/default-apps` Formato: `users/{user}/sections/{section}`
`display_name`	`string` Opcional. O nome de exibição da seção. Preenchido apenas para seções do tipo `CUSTOM_SECTION`. Aceita até 80 caracteres. Obrigatório ao criar um `CUSTOM_SECTION`.
`sort_order`	`int32` Apenas saída. A ordem da seção em relação a outras seções. As seções com um valor de `sort_order` menor aparecem antes das seções com um valor maior.
`type`	`SectionType` Obrigatório. O tipo da seção.

SectionType

Tipos de seção.

Tipos enumerados
`SECTION_TYPE_UNSPECIFIED`	Tipo de seção não especificado.
`CUSTOM_SECTION`	Seção personalizada.
`DEFAULT_DIRECT_MESSAGES`	Seção padrão que contém DIRECT_MESSAGE entre dois usuários humanos ou espaços GROUP_CHAT que não pertencem a nenhuma seção personalizada.
`DEFAULT_SPACES`	Espaços padrão que não pertencem a nenhuma seção personalizada.
`DEFAULT_APPS`	Seção padrão que contém os apps instalados de um usuário.

SectionItem

Um item de seção definido pelo usuário. Isso é usado para representar itens de seção, como espaços, agrupados em uma seção.

Campos

name

string

Identificador. O nome do recurso do item da seção.

Formato: users/{user}/sections/{section}/items/{item}

Campo de união item. Obrigatório. O item da seção. item pode ser apenas de um dos tipos a seguir:

space

string

Opcional. O nome do recurso do espaço.

Formato: spaces/{space}

SetUpSpaceRequest

Solicita a criação de um espaço e adiciona usuários especificados a ele.

Campos

space

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

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

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

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

Para criar uma conversa individual entre um humano e o app do Chat que está fazendo a chamada, defina Space.spaceType como DIRECT_MESSAGE e Space.singleUserBotDm como true. Não defina Space.displayName ou Space.spaceDetails.

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

request_id

string

Para usar esse campo de forma eficaz:

Verifique se as solicitações subsequentes são idênticas e usam as mesmas credenciais de autenticação da solicitação original.
Se um espaço já tiver sido criado com o ID de solicitação fornecido, a solicitação vai retornar esse espaço. O espaço retornado pode não estar totalmente preenchido. A API repete o espaço na sua solicitação com o nome do recurso atribuído pelo sistema preenchido. Para recuperar os metadados mais recentes do espaço, chame GetSpace.
Reutilizar um ID de solicitação com um usuário autenticado diferente resulta em um erro.

memberships[]

AccessPermissionSetting

Opcional. Os usuários ou grupos do Google Chat que serão convidados para participar do espaço. Omita o usuário que está fazendo a chamada, porque ele é adicionado automaticamente.

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

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

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

Opcional ao definir Space.spaceType como SPACE.

Obrigatório ao definir Space.spaceType como GROUP_CHAT, além de pelo menos duas assinaturas.

Obrigatório ao definir Space.spaceType como DIRECT_MESSAGE com um usuário humano, além de exatamente uma assinatura.

Precisa estar vazio ao criar uma conversa individual entre um humano e o app do Chat que está fazendo a chamada (ao definir Space.spaceType como DIRECT_MESSAGE e Space.singleUserBotDm como true).

SlashCommand

Metadados sobre um comando de barra no Google Chat.

Campos

command_id

int64

O ID do comando de barra.

SlashCommandMetadata

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

Campos
`bot`	`User` O app do Chat que teve o comando invocado.
`type`	`Type` O tipo de comando de barra.
`command_name`	`string` O nome do comando de barra invocado.
`command_id`	`int64` O ID do comando de barra invocado.
`triggers_dialog`	`bool` Indica se o comando de barra é para uma caixa de diálogo.

Tipo

Tipos enumerados
`TYPE_UNSPECIFIED`	Valor padrão do tipo enumerado. Não use.
`ADD`	Adicionar o app do Chat ao espaço.
`INVOKE`	Invoque o comando de barra no espaço.

Espaço

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

Campos
`name`	`string` Identificador. Nome do recurso do espaço. Formato: `spaces/{space}` Em que `{space}` representa o ID atribuído pelo sistema ao espaço. Para conseguir o ID do espaço, chame o método `spaces.list()` ou use o URL do espaço. Por exemplo, se o URL do espaço for `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, o ID será `AAAAAAAAA`.
`type (deprecated)`	`Type` Este item está obsoleto. Apenas saída. Descontinuado: use `space_type`. O tipo de um espaço.
`space_type`	`SpaceType` Opcional. O tipo de espaço. Obrigatório ao criar um espaço ou atualizar o tipo de um espaço. Somente saída para outro uso.
`single_user_bot_dm`	`bool` Opcional. Se o espaço é uma mensagem direta entre um app do Chat e uma única pessoa.
`threaded (deprecated)`	`bool` Este item está obsoleto. Apenas saída. Descontinuado: use `spaceThreadingState`. Se as mensagens são agrupadas neste espaço.
`display_name`	`string` Opcional. O nome de exibição do espaço. Obrigatório ao criar um espaço com um `spaceType` de `SPACE`. Se você receber a mensagem de erro `ALREADY_EXISTS` ao criar um espaço ou atualizar o `displayName`, tente usar outro `displayName`. Um espaço na organização do Google Workspace pode já estar usando esse nome de exibição. Para mensagens diretas, esse campo pode estar vazio. Aceita até 128 caracteres.
`external_user_allowed`	`bool` Opcional. Imutável. Se esse espaço permite que qualquer usuário do Google Chat seja um participante. Entrada ao criar um espaço em uma organização do Google Workspace. Omita esse campo ao criar espaços nas seguintes condições: O usuário autenticado usa uma conta pessoal (conta de usuário não gerenciada). Por padrão, um espaço criado por uma conta pessoal permite qualquer usuário do Google Chat. Para espaços atuais, esse campo é somente saída.
`space_threading_state`	`SpaceThreadingState` Apenas saída. O estado das conversas no espaço do Chat.
`space_details`	`SpaceDetails` Opcional. Detalhes sobre o espaço, incluindo descrição e regras.
`space_history_state`	`HistoryState` Opcional. O estado do histórico de mensagens e conversas neste espaço.
`import_mode`	`bool` Opcional. Se este espaço foi criado no `Import Mode` como parte de uma migração de dados para o Google Workspace. Durante a importação, os espaços não ficam visíveis para os usuários até que o processo seja concluído. A criação de um espaço no `Import Mode` requer autenticação do usuário.
`create_time`	`Timestamp` Opcional. Imutável. Para espaços criados no Chat, o horário em que o espaço foi criado. Este 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. Preenchido na saída apenas quando `spaceType` é `GROUP_CHAT` ou `SPACE`.
`last_active_time`	`Timestamp` Apenas saída. Carimbo de data/hora da última mensagem no espaço.
`admin_installed`	`bool` Apenas saída. Para espaços de mensagem direta (DM) com um app do Chat, se o espaço foi criado por um administrador do Google Workspace. Os administradores podem instalar e configurar uma mensagem direta com um app do Chat em nome dos usuários da organização. Para que o administrador possa instalar o app do Chat, ele precisa ter o recurso de mensagens diretas.
`membership_count`	`MembershipCount` Apenas saída. A contagem de assinaturas agrupadas por tipo de membro. Preenchido quando o `space_type` é `SPACE`, `DIRECT_MESSAGE` ou `GROUP_CHAT`.
`access_settings`	`AccessSettings` Opcional. Especifica a configuração de acesso do espaço. Preenchido apenas quando `space_type` é `SPACE`.
`space_uri`	`string` Apenas saída. O URI para um usuário acessar o espaço.
`import_mode_expire_time`	`Timestamp` Apenas saída. O horário 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 prazo de validade usando `spaces.completeImport`. Este campo só é preenchido para espaços criados com o modo de importação.
`customer`	`string` Opcional. Imutável. O ID de cliente do domínio do espaço. Obrigatório apenas ao criar um espaço com autenticação de app e `SpaceType` é `SPACE`. Caso contrário, não deve ser definido. No formato `customers/{customer}`, em que `customer` é o `id` do recurso do cliente do SDK Admin. Os apps particulares também podem usar o alias `customers/my_customer` para criar o espaço na mesma organização do Google Workspace que o app. Esse campo não é preenchido para mensagens diretas (DMs) ou quando o espaço é criado por usuários que não são do Google Workspace.
Campo de união `space_permission_settings`. Representa o conjunto de permissões de um espaço. Preenchido apenas quando `space_type` é `SPACE`. `space_permission_settings` pode ser apenas de um dos tipos a seguir:
`predefined_permission_settings`	`PredefinedPermissionSettings` Opcional. Somente entrada. Configurações predefinidas de conjunto de permissões de espaço, inseridas apenas ao criar um espaço. Se o campo não for definido, um espaço de colaboração será criado. Depois que você cria o espaço, as configurações são preenchidas no campo `PermissionSettings`. A definição de configurações de conjunto de permissões predefinidas é compatível com: Autenticação de apps com aprovação do administrador com os escopos `chat.app.spaces` ou `chat.app.spaces.create`. Autenticação de usuários
`permission_settings`	`PermissionSettings` Opcional. Configurações de permissão para espaços atuais. Entrada para atualizar as configurações exatas de conjunto de permissões do espaço, em que as configurações de conjunto de permissões atuais são substituídas. A saída lista as configurações de permissão atuais. A leitura e a atualização das configurações de permissão são compatíveis com: Autenticação de app com aprovação do administrador com o escopo `chat.app.spaces`. Preenchido e configurável apenas quando o app do Chat criou o espaço. Autenticação de usuários

AccessPermissionSetting

Uma configuração de permissão de acesso.

Campos

principals[]

Principal

Opcional. Lista não ordenada. Principais permitidos para essa permissão.

AccessPermissionSettings

Acessar as configurações de permissão de um espaço.

Campos

discover_space_setting

Opcional. Configuração de permissão de acesso para descobrir o espaço.

join_space_setting

AccessPermissionSetting

Opcional. Configuração de permissão de acesso para participar do espaço.

view_space_membership_setting

AccessPermissionSetting

Opcional. Configuração de permissão de acesso para ver os participantes do espaço. Precisa ser especificado com PermissionSettings.view_space_membership na máscara de atualização e no corpo da solicitação ao atualizar quem pode ver as inscrições no espaço. Ao conceder acesso de visualização a um público-alvo, você também precisa conceder PermissionSettings.view_space_membership a todos os membros na mesma solicitação. Para remover um público-alvo (por exemplo, para restringir o acesso de visualização apenas aos administradores ou administradores assistentes do espaço), especifique um AccessPermissionSetting vazio (sem principals).

AccessSettings

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

Campos

access_state

AccessState

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

audience

string

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

Formato: audiences/{audience}

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

A leitura do público-alvo é compatível com:

Autenticação de usuários
Autenticação de app com aprovação do administrador com o escopo chat.app.spaces.

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

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

access_permission_settings

AccessPermissionSettings

Opcional. Acesse as configurações de permissão do espaço.

Para definir o público-alvo ao criar um espaço, especifique o campo accessSettings.audience na solicitação.

AccessState

Representa o estado de acesso do espaço.

Tipos enumerados

ACCESS_STATE_UNSPECIFIED O estado de acesso é desconhecido ou não é compatível com esta API.

PRIVATE Apenas usuários ou Grupos do Google que foram adicionados ou convidados individualmente por outros usuários ou administradores do Google Workspace podem encontrar e acessar o espaço.

DISCOVERABLE

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

Para criar espaços visíveis, é necessário fazer a autenticação do usuário.

MembershipCount

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

Campos

joined_direct_human_user_count

int32

Apenas saída. Contagem de usuários humanos que entraram diretamente no espaço, sem contar os usuários que entraram por serem membros de um grupo que entrou.

joined_group_count

int32

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

PermissionSetting

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

Campos

managers_allowed

bool

Opcional. Se os proprietários do espaço (ROLE_MANAGER) têm essa permissão.

members_allowed

bool

Opcional. Se os participantes básicos do espaço (ROLE_MEMBER) têm essa permissão.

assistant_managers_allowed

bool

Opcional. Se os administradores do espaço (ROLE_ASSISTANT_MANAGER) têm essa permissão.

PermissionSettings

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

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

Campos
`manage_members_and_groups`	`PermissionSetting` Opcional. Configuração para gerenciar participantes e grupos em um espaço.
`modify_space_details`	`PermissionSetting` Opcional. Configuração para atualizar o nome, o avatar, a descrição e as diretrizes do espaço.
`toggle_history`	`PermissionSetting` Opcional. Configuração para ativar e desativar o histórico do espaço.
`use_at_mention_all`	`PermissionSetting` Opcional. Configuração para usar @todos em um espaço.
`manage_apps`	`PermissionSetting` Opcional. Configuração para gerenciar apps em um espaço.
`manage_webhooks`	`PermissionSetting` Opcional. Configuração para gerenciar webhooks em um espaço.
`post_messages`	`PermissionSetting` Apenas saída. Configuração para postar mensagens em um espaço.
`reply_messages`	`PermissionSetting` Opcional. Configuração para responder a mensagens em um espaço.
`view_space_membership`	`PermissionSetting` Opcional. Configuração para ver os participantes do espaço. Precisa ser especificado com `AccessPermissionSettings.view_space_membership_setting` na máscara de atualização e no corpo da solicitação ao atualizar quem pode ver as inscrições no espaço. Ao restringir o acesso de visualização a funções específicas (por exemplo, apenas administradores de espaço ou assistentes), especifique as permissões de função desejadas aqui e forneça um `AccessPermissionSettings.view_space_membership_setting` vazio na mesma solicitação. Se um público-alvo estiver configurado em `AccessPermissionSettings.view_space_membership_setting`, essa configuração precisará ser concedida a todos os membros.

PredefinedPermissionSettings

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

Tipos enumerados
`PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED`	Não especificado. Não use.
`COLLABORATION_SPACE`	Configuração para tornar o espaço um local de colaboração em que todos os participantes podem postar mensagens.
`ANNOUNCEMENT_SPACE`	Configuração para transformar o espaço em um espaço de avisos onde apenas os administradores podem postar mensagens.

Principal

Um principal que representa uma entidade com acesso concedido.

Campos

Campo de união principal_type. O tipo de principal. principal_type pode ser apenas de um dos tipos a seguir:

audience

Audience

Um público-alvo.

SpaceDetails

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

Campos

description

string

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

Aceita até 4.096 caracteres.

guidelines

string

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

Aceita até 5.000 caracteres.

SpaceThreadingState

Especifica o tipo de estado de conversas em uma conversa no espaço do Chat.

Tipos enumerados
`SPACE_THREADING_STATE_UNSPECIFIED`	Reservado.
`THREADED_MESSAGES`	Espaços que aceitam conversas agrupadas. Quando os usuários respondem a uma mensagem, eles podem fazer isso na conversa, o que mantém a resposta no contexto da mensagem original.
`GROUPED_MESSAGES`	Espaços com nome em que a conversa é organizada por tema. Os tópicos e as respostas são agrupados.
`UNTHREADED_MESSAGES`	Espaços que não aceitam conversas em sequência. Esse estado de conversas em espaços é usado apenas em casos especiais, incluindo: Chat contínuo da reunião em que as conversas estão desativadas intencionalmente. Conversas em grupo legadas criadas antes de 2022.

SpaceType

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

Tipos enumerados
`SPACE_TYPE_UNSPECIFIED`	Reservado.
`SPACE`	Um lugar onde as pessoas enviam mensagens, compartilham arquivos e colaboram. Um `SPACE` pode incluir apps do Chat.
`GROUP_CHAT`	Conversas em grupo entre 3 ou mais pessoas. Um `GROUP_CHAT` pode incluir apps do Chat.
`DIRECT_MESSAGE`	Mensagens individuais entre duas pessoas ou entre uma pessoa e um app do Chat.

Tipo

Descontinuado: use SpaceType.

Tipos enumerados
`TYPE_UNSPECIFIED`	Reservado.
`ROOM`	Conversas entre dois ou mais humanos.
`DM`	Mensagem direta individual entre uma pessoa e um app do Chat, em que todas as mensagens são simples. 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[]

SpaceUpdatedEventData

Uma lista de espaços atualizados.

SpaceEvent

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

Campos
`name`	`string` Nome do recurso do evento de espaço. Formato: `spaces/{space}/spaceEvents/{spaceEvent}`
`event_time`	`Timestamp` Horário em que o evento ocorreu.
`event_type`	`string` Tipo de evento de espaço. Cada tipo de evento tem uma versão em lote, que representa várias instâncias do tipo de evento que ocorrem em um curto período. Para solicitações `spaceEvents.list()`, omita os tipos de evento em lote no filtro de consulta. Por padrão, o servidor retorna o tipo de evento e a versão em lote dele. Tipos de evento compatíveis com mensagens: Nova mensagem: `google.workspace.chat.message.v1.created` Mensagem atualizada: `google.workspace.chat.message.v1.updated` Mensagem excluída: `google.workspace.chat.message.v1.deleted` Várias mensagens novas: `google.workspace.chat.message.v1.batchCreated` Várias mensagens atualizadas: `google.workspace.chat.message.v1.batchUpdated` Várias mensagens excluídas: `google.workspace.chat.message.v1.batchDeleted` Tipos de evento compatíveis com assinaturas: Novo membro: `google.workspace.chat.membership.v1.created` Assinatura atualizada: `google.workspace.chat.membership.v1.updated` Assinatura excluída: `google.workspace.chat.membership.v1.deleted` Várias assinaturas novas: `google.workspace.chat.membership.v1.batchCreated` Várias assinaturas atualizadas: `google.workspace.chat.membership.v1.batchUpdated` Várias assinaturas excluídas: `google.workspace.chat.membership.v1.batchDeleted` Tipos de evento compatíveis com reações: Nova reação: `google.workspace.chat.reaction.v1.created` Reação excluída: `google.workspace.chat.reaction.v1.deleted` Várias reações novas: `google.workspace.chat.reaction.v1.batchCreated` Várias reações excluídas: `google.workspace.chat.reaction.v1.batchDeleted` Tipos de evento compatíveis sobre o espaço: Espaço atualizado: `google.workspace.chat.space.v1.updated` Várias atualizações de espaço: `google.workspace.chat.space.v1.batchUpdated`
Campo de união `payload`. `payload` pode ser apenas de um dos tipos a seguir:
`message_created_event_data`	`MessageCreatedEventData` Payload de evento para uma nova mensagem. Tipo de evento: `google.workspace.chat.message.v1.created`
`message_updated_event_data`	`MessageUpdatedEventData` Payload de evento para uma mensagem atualizada. Tipo de evento: `google.workspace.chat.message.v1.updated`
`message_deleted_event_data`	`MessageDeletedEventData` Payload de evento para uma mensagem excluída. Tipo de evento: `google.workspace.chat.message.v1.deleted`
`message_batch_created_event_data`	`MessageBatchCreatedEventData` Payload de evento para várias mensagens novas. Tipo de evento: `google.workspace.chat.message.v1.batchCreated`
`message_batch_updated_event_data`	`MessageBatchUpdatedEventData` Payload de evento para várias mensagens atualizadas. Tipo de evento: `google.workspace.chat.message.v1.batchUpdated`
`message_batch_deleted_event_data`	`MessageBatchDeletedEventData` Payload de evento para várias mensagens excluídas. Tipo de evento: `google.workspace.chat.message.v1.batchDeleted`
`space_updated_event_data`	`SpaceUpdatedEventData` Payload de evento para uma atualização de espaço. Tipo de evento: `google.workspace.chat.space.v1.updated`
`space_batch_updated_event_data`	`SpaceBatchUpdatedEventData` Payload de evento para várias atualizações em um espaço. Tipo de evento: `google.workspace.chat.space.v1.batchUpdated`
`membership_created_event_data`	`MembershipCreatedEventData` Payload de evento para um novo membro. Tipo de evento: `google.workspace.chat.membership.v1.created`
`membership_updated_event_data`	`MembershipUpdatedEventData` Payload de evento para uma assinatura atualizada. Tipo de evento: `google.workspace.chat.membership.v1.updated`
`membership_deleted_event_data`	`MembershipDeletedEventData` Payload de evento para uma associação excluída. Tipo de evento: `google.workspace.chat.membership.v1.deleted`
`membership_batch_created_event_data`	`MembershipBatchCreatedEventData` Payload de evento para várias novas assinaturas. Tipo de evento: `google.workspace.chat.membership.v1.batchCreated`
`membership_batch_updated_event_data`	`MembershipBatchUpdatedEventData` Payload de evento para várias assinaturas atualizadas. Tipo de evento: `google.workspace.chat.membership.v1.batchUpdated`
`membership_batch_deleted_event_data`	`MembershipBatchDeletedEventData` Payload de evento para várias assinaturas excluídas. Tipo de evento: `google.workspace.chat.membership.v1.batchDeleted`
`reaction_created_event_data`	`ReactionCreatedEventData` Payload de evento para uma nova reação. Tipo de evento: `google.workspace.chat.reaction.v1.created`
`reaction_deleted_event_data`	`ReactionDeletedEventData` Payload de evento para uma reação excluída. Tipo de evento: `google.workspace.chat.reaction.v1.deleted`
`reaction_batch_created_event_data`	`ReactionBatchCreatedEventData` Payload de evento para várias reações novas. Tipo de evento: `google.workspace.chat.reaction.v1.batchCreated`
`reaction_batch_deleted_event_data`	`ReactionBatchDeletedEventData` Payload de evento para várias reações excluídas. Tipo de evento: `google.workspace.chat.reaction.v1.batchDeleted`

SpaceNotificationSetting

A configuração de notificação de um usuário em um espaço.

Campos

name

string

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

notification_setting

NotificationSetting

A configuração de notificação.

mute_setting

MuteSetting

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

MuteSetting

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

Tipos enumerados
`MUTE_SETTING_UNSPECIFIED`	Reservado.
`UNMUTED`	O usuário vai receber notificações do espaço com base na configuração de notificação.
`MUTED`	O usuário não vai receber nenhuma notificação do espaço, seja qual for a configuração de notificação.

NotificationSetting

Os tipos de configuração de notificação. Outros tipos podem ser aceitos no futuro.

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

SpaceReadState

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

Campos

name

string

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

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

last_read_time

Timestamp

Opcional. O horário em que o estado de leitura do espaço do usuário foi atualizado. Normalmente, 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 de evento para um espaço atualizado.

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

Campos

space

O espaço atualizado.

SpaceView

Uma visualização que especifica quais campos devem ser preenchidos no recurso Space. Para garantir a compatibilidade com versões futuras, recomendamos que seu código considere valores adicionais.

Tipos enumerados
`SPACE_VIEW_UNSPECIFIED`	O valor padrão / não definido.
`SPACE_VIEW_RESOURCE_NAME_ONLY`	Preenche apenas o nome do recurso do Space.
`SPACE_VIEW_EXPANDED`	Preenche os campos de recursos do Space. Observação: o campo `permissionSettings` não será preenchido. As solicitações que especificam SPACE_VIEW_EXPANDED precisam incluir escopos que permitam ler dados de espaço, por exemplo, https://www.googleapis.com/auth/chat.spaces ou https://www.googleapis.com/auth/chat.spaces.readonly.

Conversa

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

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

Campos

name

string

Identificador. Nome do recurso da conversa.

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

thread_key

string

Opcional. Entrada para criar ou atualizar uma conversa. Caso contrário, somente saída. ID da conversa. Aceita até 4.000 caracteres.

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

ThreadReadState

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

Campos

name

string

Nome do recurso do estado de leitura da conversa.

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

last_read_time

Timestamp

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

UpdateAvailabilityRequest

Solicite mensagem para o método UpdateAvailability.

Campos

availability

Availability

Obrigatório. A disponibilidade a ser atualizada.

update_mask

Obrigatório. Lista de campos a serem atualizados. O único campo que pode ser atualizado é custom_status.

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 são atualizados.

update_mask

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

Caminhos de campo compatíveis no momento:

role

use_admin_access

bool

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

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

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

UpdateMessageRequest

Solicitação para atualizar uma mensagem.

Campos

message

Obrigatório. Mensagem com campos atualizados.

update_mask

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

Caminhos de campo compatíveis no momento:

text
attachment
cards (requer autenticação do app).
cards_v2 (requer autenticação do app).
accessory_widgets (requer autenticação do app).
quoted_message_metadata (permite apenas a remoção da mensagem citada).

allow_missing

bool

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

UpdateSectionRequest

Mensagem de solicitação para atualizar uma seção.

Campos

section

Obrigatório. A seção a ser atualizada.

update_mask

SpaceNotificationSetting

Obrigatório. A máscara para especificar quais campos atualizar.

Caminhos de campo compatíveis no momento:

display_name

UpdateSpaceNotificationSettingRequest

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

Campos

space_notification_setting

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

update_mask

Obrigatório. Caminhos de campo compatíveis:

notification_setting
mute_setting

UpdateSpaceReadStateRequest

Mensagem de solicitação para a API UpdateSpaceReadState.

Campos

space_read_state

SpaceReadState

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

Só é possível atualizar o estado de leitura do usuário que está fazendo a chamada.

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

O alias me. Por exemplo, users/me/spaces/{space}/spaceReadState.
O endereço de e-mail do Workspace. Por exemplo, users/user@example.com/spaces/{space}/spaceReadState.
O ID do usuário. Por exemplo, users/123456789/spaces/{space}/spaceReadState.

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

update_mask

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

last_read_time

Quando o last_read_time é anterior ao horário de criação da mensagem mais recente, o espaço aparece como não lido na interface.

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

UpdateSpaceRequest

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

Campos

space

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

update_mask