Package google.chat.v1

ButtonList

Uma lista de botões.

ResponseType

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

string

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

DialogAction

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

UpdatedWidget

Somente entrada. A resposta do widget atualizado.

SelectionItem

Uma matriz dos objetos SelectionItem.

string

ID do widget atualizado. O ID precisa corresponder ao do widget que acionou a solicitação de atualização.

SelectionItems

Lista de resultados de preenchimento automático do widget

Code

O código de status.

string

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

AnnotationType

O tipo da anotação.

int32

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

int32

Índice inicial (base 0, inclusive) no corpo da mensagem de texto simples a que essa anotação corresponde.

UserMentionMetadata

Os metadados da menção do usuário.

SlashCommandMetadata

Os metadados para um comando de barra.

RichLinkMetadata

Os metadados para um link avançado.

string

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

string

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

string

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

string

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

string

Apenas saída. O URL da miniatura que deve ser usada para visualizar o anexo para um usuário humano. Os apps de chat não podem usar esse URL para fazer o download de anexos.

string

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

Source

Apenas saída. A origem do anexo.

AttachmentDataRef

Uma referência aos dados do anexo. Esse campo é usado com a API de mídia para fazer o download dos dados de anexo.

DriveDataRef

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

string

O nome do recurso dos dados do anexo. Esse campo é usado com a API de mídia para fazer o download dos dados de anexo.

string

Token opaco contendo uma referência a um anexo enviado. Tratada por clientes como uma string opaca e usada para criar ou atualizar mensagens do Chat com anexos.

string

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

Card

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

string

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

Formato: spaces/{space}

string

A linha de execução do recurso de espaço do Chat vinculado.

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

string

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

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

string

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

Formato: spaces/{space}

Space

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

CardHeader

O cabeçalho do cartão. Geralmente, um cabeçalho contém um título e uma imagem.

Section

As seções são separadas por uma linha divisória.

CardAction

As ações deste card.

string

Nome do cartão.

string

O rótulo era exibido no item do menu de ações.

OnClick

A ação "onclick" deste item de ação.

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 deles ocupará uma linha. Se apenas o título for especificado, ele vai ocupar as duas linhas.

string

O subtítulo do cabeçalho do cartão.

ImageStyle

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

string

O URL da imagem no cabeçalho do card.

string

Cabeçalho da seção. É possível usar texto formatado. Saiba mais sobre a formatação de texto em Formatar texto nos apps do Google Chat e Formatar texto em complementos do Google Workspace.

WidgetMarkup

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

string

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

Formato: espaços/{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 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 o escopo chat.memberships, definir user.type como HUMAN e definir 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 de pessoa da API People para user@example.com for 123456789, defina membership.member.name como users/user@example.com ou users/123456789 para adicionar o usuário ao espaço. Quando um app do Chat cria uma relação de assinatura por conta própria, ele precisa usar o escopo chat.memberships.app, definir user.type como BOT e definir user.name como users/app.

bool

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

Exige o escopo OAuth 2.0 chat.admin.memberships.

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

string

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

Formato: spaces/{space}

Message

Obrigatório. Corpo da mensagem.

string

Opcional. Obsoleto: use thread.thread_key. ID da linha de execução. Aceita até 4.000 caracteres. Para iniciar ou adicionar itens a uma conversa, crie uma mensagem e especifique o threadKey ou o thread.name. Para exemplos de uso, consulte Iniciar ou responder a uma conversa.

string

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

MessageReplyOption

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

string

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

O valor desse campo precisa atender aos seguintes requisitos:

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

Veja mais detalhes em Nomear uma mensagem.

string

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

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

Reaction

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

Space

Obrigatório. Os campos displayName e spaceType precisam ser preenchidos. Somente SpaceType.SPACE é aceito.

Se você receber a mensagem de erro ALREADY_EXISTS, tente outra displayName. Talvez um espaço na organização do Google Workspace já esteja usando esse nome de exibição.

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

string

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

string

Apenas saída. Chave exclusiva para o recurso de emojis personalizados.

string

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

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

Ao excluir uma assinatura do app, é necessário o escopo chat.memberships.app e o formato spaces/{space}/members/app.

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

bool

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

Exige o escopo OAuth 2.0 chat.admin.memberships.

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

string

Obrigatório. Nome do recurso da mensagem.

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

Se você tiver definido um ID personalizado para sua mensagem, poderá usar o valor do campo clientAssignedMessageId para o {message}. Veja mais detalhes em Nomear uma mensagem.

bool

Quando true, a exclusão de uma mensagem também exclui as respostas agrupadas. Quando false, se uma mensagem tiver respostas agrupadas, a exclusão falha.

Isso só se aplica durante a autenticação como usuário. Não tem efeito na autenticação como um app do Chat.

string

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

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

string

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

Formato: spaces/{space}

bool

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

Exige o escopo OAuth 2.0 chat.admin.delete.

DeletionType

Indica quem excluiu a mensagem.

Card

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

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.

Dialog

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

string

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

DriveDataRef

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

string

O tipo MIME do recurso vinculado do Google Drive.

string

Um emoji básico representado por uma string Unicode.

CustomEmoji

Apenas saída. Um emoji personalizado.

Emoji

Emoji associado às reações.

int32

O número total de reações com o emoji associado.

string

Obrigatório. Nome do recurso do usuário que vai receber a mensagem direta.

Formato: users/{user}, em que {user} é o id para a pessoa da API People ou o id para o usuário na API Directory. Por exemplo, se o ID do perfil da API People é 123456789, é possível 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.

string

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

string

Obrigatório. Nome do recurso da associação a ser recuperada.

Para conseguir a associação do app usando a autenticação do usuário, você tem a opção de usar spaces/{space}/members/app.

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

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

bool

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

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

Não é possível receber assinaturas de apps em um espaço quando você usa o acesso de administrador.

string

Obrigatório. Nome do recurso da mensagem.

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

Se você tiver definido um ID personalizado para sua mensagem, poderá usar o valor do campo clientAssignedMessageId para o {message}. Veja mais detalhes em Nomear uma mensagem.

string

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

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

string

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

Oferece suporte apenas à busca do estado de leitura do usuário que fez a chamada.

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

• 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 de usuário dele. Por exemplo, users/123456789/spaces/{space}/spaceReadState.

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

string

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

Formato: spaces/{space}

bool

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

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

string

Obrigatório. Nome do recurso do estado de leitura da linha de execução a ser recuperada.

Oferece suporte apenas à busca do estado de leitura do usuário que fez a chamada.

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

• 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 de usuário dele. Por exemplo, users/123456789/spaces/{space}/threads/{thread}/threadReadState.

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

string

Nome de recurso para um Grupo do Google.

Representa um grupo na API Cloud Identity Groups.

Formato: groups/{group}

string

Obrigatório. O nome do recurso do espaço em que uma lista de participantes será buscada.

Formato: espaços/{space}

int32

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

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

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

Valores negativos retornam um erro INVALID_ARGUMENT.

string

Opcional. Um token de página, recebido de uma chamada anterior para listar associações. Forneça esse parâmetro para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos devem corresponder à chamada que forneceu o token da página. Passar valores diferentes para outros parâmetros pode levar a resultados inesperados.

string

Opcional. Um filtro de consulta.

É possível filtrar as associações pela função (role) e tipo (member.type) de um membro.

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

Para filtrar por tipo, defina member.type como HUMAN ou BOT. Prévia para desenvolvedores: também é possível filtrar por member.type usando o operador !=.

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

É necessário usar member.type = "HUMAN" ou member.type != "BOT" quando use_admin_access é definido como verdadeiro. Outros filtros de tipo de membro 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"

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

bool

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

bool

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

Requer a autenticação do usuário no momento.

bool

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

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

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

Membership

Lista não ordenada. Lista de associações na página solicitada (ou na primeira).

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.

string

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

Formato: spaces/{space}

int32

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

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

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

Valores negativos retornam um erro INVALID_ARGUMENT.

string

Opcional, se estiver reiniciando de uma consulta anterior.

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

Ao paginar, todos os outros parâmetros fornecidos devem corresponder à chamada que forneceu o token da página. Passar valores diferentes para outros parâmetros pode levar a resultados inesperados.

string

Um filtro de consulta.

Você pode filtrar as mensagens por data (create_time) e conversa (thread.name).

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

Para filtrar por linha de execução, especifique o thread.name, formatado como spaces/{space}/threads/{thread}. Só é possível especificar um thread.name por consulta.

Para filtrar por linha de execução e data, use o operador AND na consulta.

Por exemplo, as 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

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

string

Opcional, se estiver reiniciando de uma consulta anterior.

Como a lista de mensagens é ordenada. Especifique um valor a ser ordenado por uma operação de ordenação. Os valores de operação de ordenação válidos são os seguintes:

• ASC para crescente.

• DESC para decrescente.

A ordem padrão é create_time ASC.

bool

Define se as mensagens excluídas serão incluídas. As mensagens excluídas incluem o horário da exclusão e os metadados sobre a exclusão, mas o conteúdo da mensagem não está disponível.

Message

Lista de mensagens.

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.

string

Obrigatório. A mensagem à qual os usuários reagiram.

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

int32

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

string

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

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

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

string

Opcional. Um filtro de consulta.

Você pode filtrar as reações por emoji (emoji.unicode ou emoji.custom_emoji.uid) e usuário (user.name).

Para filtrar as reações de vários emojis ou usuários, mescle 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".

Caso a consulta use AND e OR, agrupe-os entre 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}"

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

Reaction

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

string

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

string

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

Formato: spaces/{space}.

int32

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

Valores negativos retornam um erro INVALID_ARGUMENT.

string

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

Na paginação, todos os outros parâmetros fornecidos para listar eventos do espaço precisam corresponder à chamada que forneceu o token da página. Passar valores diferentes para outros parâmetros pode levar a resultados inesperados.

string

Obrigatório. Um filtro de consulta.

É necessário especificar pelo menos um tipo de evento (event_type) usando o operador "tem :". Para filtrar por vários tipos de evento, use o operador OR. Omita tipos de eventos em lote no filtro. A solicitação retorna automaticamente todos os eventos em lote relacionados. Por exemplo, se você filtrar por novas reações (google.workspace.chat.reaction.v1.created), o servidor também vai retornar eventos de novas reações em lote (google.workspace.chat.reaction.v1.batchCreated). Para ver uma lista de tipos de evento 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 eventos do espaço. Você pode listar eventos que ocorreram há até 28 dias. Se não for especificado, lista os eventos do espaço dos últimos 28 dias.
• end_time: carimbo de data/hora inclusivo até os eventos do espaço listados. Se não for especificado, lista os eventos até o momento da solicitação.

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

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

SpaceEvent

Os resultados são retornados em ordem cronológica (o evento mais antigo primeiro).

string

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

int32

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

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

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

Valores negativos retornam um erro INVALID_ARGUMENT.

string

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

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

string

Opcional. Um filtro de consulta.

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

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

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

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

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

Space

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

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.

string

Apenas saída. O URL correspondente.

string

Nome de recurso da associação, atribuído pelo servidor.

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

MembershipState

Apenas saída. Estado da assinatura.

MembershipRole

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

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

Timestamp

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

Timestamp

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

User

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

Group

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

MembershipCreatedEventData

Uma lista de novas associações.

MembershipDeletedEventData

Uma lista de assinaturas excluídas.

MembershipUpdatedEventData

Uma lista de assinaturas atualizadas.

Membership

A nova assinatura.

Membership

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

Membership

A assinatura atualizada.

string

Nome do recurso da mensagem.

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

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

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

User

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

Timestamp

Opcional. Imutável. Nos espaços criados no Chat, o horário em que a mensagem foi criada. Este campo é apenas para saída, exceto quando usado em espaços do modo de importação.

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

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, este campo estará vazio.

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.

string

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

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

string

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

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

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

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

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

Saiba mais em Visualizar a formatação do texto enviada em uma mensagem.

Card

Obsoleto: use cards_v2.

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

CardWithId

Uma matriz de cards.

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

Para saber mais sobre cards e como criá-los, consulte Enviar mensagens de cards.

Elabore e visualize cards com o Criador de cartões.

Annotation

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

Thread

A conversa a que a mensagem pertence. Para exemplos de uso, consulte Iniciar ou responder a uma conversa.

Space

Se o app do Chat se autenticar como um usuário, a saída vai preencher o espaço name.

string

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

ActionResponse

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

string

Apenas saída. Corpo de texto simples da mensagem com todas as menções a apps do Chat removidas.

SlashCommand

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

Attachment

Anexo enviado pelo usuário.

MatchedUrl

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

bool

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

Se o espaço não permitir a resposta em conversas, este campo será sempre false.

string

Opcional. Um ID personalizado para a mensagem. Você pode usar esse campo para identificar ou receber, excluir ou atualizar uma mensagem. Para definir um ID personalizado, especifique o campo messageId ao criar a mensagem. Veja mais detalhes em Nomear uma mensagem.

EmojiReactionSummary

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

User

Imutável. Entrada para criar uma mensagem. Caso contrário, apenas saída. O usuário que pode ver a mensagem. Quando definida, a mensagem é particular e só fica visível para o usuário especificado e para o app do Chat. As visualizações de link e os anexos não são compatíveis com mensagens particulares.

Apenas apps do Chat podem enviar mensagens privadas. Se o app do Chat se autenticar como um usuário para enviar uma mensagem, ela não pode ser particular e precisa omitir esse campo.

Veja mais detalhes em Enviar mensagens privadas para usuários do Google Chat.

DeletionMetadata

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

QuotedMessageMetadata

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

AttachedGif

Apenas saída. Imagens GIF anexadas à mensagem.

AccessoryWidget

Um ou mais widgets interativos que aparecem na parte inferior de uma mensagem. Você pode adicionar widgets de acessório a mensagens que contenham texto, cards ou ambos. Indisponível para mensagens que contêm caixas de diálogo. Confira mais detalhes em Adicionar widgets interativos na parte de baixo de uma mensagem.

Para criar uma mensagem com widgets de acessório, é preciso autenticar o app.

MessageCreatedEventData

Uma lista de novas mensagens.

MessageDeletedEventData

Uma lista de mensagens excluídas.

MessageUpdatedEventData

Uma lista de mensagens atualizadas.

Message

A nova mensagem.

Message

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

Message

A mensagem atualizada.

string

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

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

Timestamp

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

string

O nome do recurso da reação.

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

User

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

Emoji

O emoji usado na reação.

ReactionCreatedEventData

Uma lista de novas reações.

ReactionDeletedEventData

Uma lista de reações excluídas.

Reaction

A nova reação.

Reaction

A reação excluída.

string

O URI do link.

RichLinkType

O tipo de link avançado.

DriveLinkData

Dados de um link do Drive.

ChatSpaceLinkData

Dados de um link do espaço do Chat.

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 "Gerenciar conversas de chats e espaços".

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

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

int32

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

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

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

string

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

Ao paginar, todos os outros parâmetros fornecidos devem corresponder à chamada que forneceu o token da página. Passar valores diferentes para outros parâmetros pode levar a resultados inesperados.

string

Obrigatório. Uma consulta de pesquisa.

Você pode pesquisar usando os seguintes parâmetros:

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

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

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

display_name só aceita o operador HAS (:). O texto correspondente é primeiro tokenizado em tokens. Cada token é comparado com o prefixo de forma indiferente a maiúsculas e minúsculas e como uma substring em qualquer lugar no display_name do espaço. Por exemplo, Fun Eve corresponde a Fun event ou The evening was fun, mas não a notFun event ou even.

external_user_allowed aceita true ou false.

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

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

Em campos diferentes, somente 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 oferece suporte aos operadores AND ou OR. display_name, 'space_history_state' e 'external_user_allowed' oferecem suporte apenas a operadores OR. last_active_time e create_time oferecem suporte aos 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".

As consultas de exemplo a seguir são válidas:

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")

string

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

Os atributos que podem ser ordenados são:

• membership_count.joined_direct_human_user_count: indica a contagem de usuários humanos que entraram diretamente em um espaço.
• last_active_time: indica o momento em que o último item qualificado é adicionado a qualquer tema desse espaço.
• create_time: indica o momento da criação do espaço.

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

• ASC para crescente. Valor padrão.

• DESC para decrescente.

A sintaxe compatível é:

• 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

Space

Uma página dos espaços solicitados.

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.

int32

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

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 outra displayName. Talvez um espaço na organização do Google Workspace já esteja usando esse nome de exibição.

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

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

Para criar uma conversa individual entre uma pessoa e o app de chamada do Chat, defina Space.spaceType como DIRECT_MESSAGE e Space.singleUserBotDm como true. Não defina Space.displayName ou Space.spaceDetails.

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

string

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

Membership

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

O conjunto atualmente permite até 20 associações (além do autor da chamada).

Para associação humana, o campo 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. Só é possível adicionar apps do Chat para a configuração de mensagens diretas com o app de chamada. Também é possível adicionar membros usando o e-mail do usuário como um alias para {user}. Por exemplo, o 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 associação a um grupo do Google, o campo Membership.group_member precisa conter um group com name preenchido (formato groups/{group}). Você só pode adicionar Grupos do Google quando definir Space.spaceType como SPACE.

Opcional ao definir Space.spaceType como SPACE.

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

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

Precisa estar em branco ao criar uma conversa individual entre uma pessoa e o app de chamada do Chat (ao definir Space.spaceType como DIRECT_MESSAGE e Space.singleUserBotDm como true).

int64

O ID do comando de barra invocado.

User

O app do Chat cujo comando foi invocado.

Type

O tipo de comando de barra.

string

O nome do comando de barra invocado.

int64

O ID do comando de barra invocado.

bool

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

string

Nome do recurso do espaço.

Formato: spaces/{space}

Type

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

SpaceType

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

bool

Opcional. Se o espaço é uma mensagem direta entre um app do Chat e uma única pessoa.

bool

Apenas saída. Obsoleto: use spaceThreadingState. Indica se as mensagens estão agrupadas neste espaço.

string

O nome de exibição do espaço. Obrigatório ao criar um espaço. Se você receber a mensagem de erro ALREADY_EXISTS ao criar um espaço ou atualizar a displayName, tente usar outra displayName. Talvez um espaço na organização do Google Workspace já esteja usando esse nome de exibição.

Este campo pode estar vazio nas mensagens diretas.

Aceita até 128 caracteres.

bool

Imutável. Se qualquer usuário do Google Chat pode participar deste espaço. Entrada ao criar um espaço em uma organização do Google Workspace. Omita este campo ao criar espaços nas seguintes condições:

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

Nos espaços atuais, este campo é apenas para saída.

SpaceThreadingState

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

SpaceDetails

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

HistoryState

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

bool

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

Timestamp

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

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

Preenchido na saída apenas quando spaceType é GROUP_CHAT ou SPACE.

Timestamp

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

bool

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

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

MembershipCount

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

AccessSettings

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

string

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

PredefinedPermissionSettings

Opcional. Somente entrada. Configurações de permissão do espaço. Entrada para criar um espaço. Um espaço de colaboração será criado se este campo não for definido. Depois que você cria o espaço, as configurações são preenchidas no campo PermissionSettings.

PermissionSettings

Opcional. Configurações de permissão exatas que podem ser definidas para atualizar o espaço. Entrada para atualizar um espaço. Caso contrário, somente saída. Para criar espaços, use predefined_permission_settings.

AccessState

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

string

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

Formato: audiences/{audience}

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

int32

Contagem de usuários humanos que participaram diretamente do espaço, sem contar os usuários que participaram de um grupo.

int32

Número de grupos que participaram diretamente do espaço.

bool

Indica se os administradores dos espaços têm essa permissão.

bool

Indica se membros que não são administradores têm essa permissão.

PermissionSetting

Configuração para gerenciar participantes e grupos em um espaço.

PermissionSetting

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

PermissionSetting

Configuração para ativar e desativar o histórico do espaço.

PermissionSetting

Configuração para usar @todos em um espaço.

PermissionSetting

Configuração para gerenciar apps em um espaço.

PermissionSetting

Configuração para gerenciar webhooks em um espaço.

PermissionSetting

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

PermissionSetting

Configuração para responder a mensagens em um espaço.

string

Opcional. Uma descrição do espaço. Por exemplo, descreva o tema de discussão, o propósito funcional ou os participantes do espaço.

Aceita até 150 caracteres.

string

Opcional. Regras, expectativas e etiqueta do espaço.

Aceita até 5.000 caracteres.

SpaceUpdatedEventData

Uma lista de espaços atualizados.

string

Nome do recurso do evento do espaço.

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

Timestamp

A hora em que o evento ocorreu.

string

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

Tipos de eventos compatíveis com messages:

• 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 novas mensagens: 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 eventos compatíveis com assinaturas:

• Nova assinatura: 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 novas assinaturas: 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 as 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 com o espaço:

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

MessageCreatedEventData

Payload de evento para uma nova mensagem.

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

MessageUpdatedEventData

Payload de evento de uma mensagem atualizada.

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

MessageDeletedEventData

Payload de evento de uma mensagem excluída.

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

MessageBatchCreatedEventData

Payload de evento para várias mensagens novas.

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

MessageBatchUpdatedEventData

Payload de evento para várias mensagens atualizadas.

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

MessageBatchDeletedEventData

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

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

SpaceUpdatedEventData

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

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

SpaceBatchUpdatedEventData

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

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

MembershipCreatedEventData

Payload de evento para uma nova assinatura.

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

MembershipUpdatedEventData

Payload de evento para uma assinatura atualizada.

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

MembershipDeletedEventData

Payload de evento de uma assinatura excluída.

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

MembershipBatchCreatedEventData

Payload de evento para várias novas associações.

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

MembershipBatchUpdatedEventData

Payload de evento para várias associações atualizadas.

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

MembershipBatchDeletedEventData

Payload de evento para várias associações excluídas.

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

ReactionCreatedEventData

Payload de evento para uma nova reação.

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

ReactionDeletedEventData

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

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

ReactionBatchCreatedEventData

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

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

ReactionBatchDeletedEventData

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

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

string

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

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

Timestamp

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

Space

O espaço atualizado.

string

Nome do recurso da linha de execução.

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

string

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

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

string

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

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

Timestamp

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

Membership

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

FieldMask

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

Caminhos de campo atualmente compatíveis:

• role

bool

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

Exige o escopo OAuth 2.0 chat.admin.memberships.

Message

Obrigatório. Mensagem com campos atualizados.

FieldMask

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

Caminhos de campo atualmente compatíveis:

• text

• attachment

• cards (exige autenticação de apps.)

• cards_v2 (exige autenticação de apps.)

• accessory_widgets (exige autenticação de apps.)

bool

Opcional. Se true e a mensagem não for encontrada, uma nova mensagem será criada e updateMask será ignorada. O ID da mensagem especificado precisa ser atribuído pelo cliente. Caso contrário, a solicitação falhará.

SpaceReadState

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

Oferece suporte apenas à atualização do estado de leitura do usuário que fez a chamada.

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

• 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 de usuário dele. Por exemplo, users/123456789/spaces/{space}/spaceReadState.

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

FieldMask

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

• last_read_time

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

Para marcar o espaço como lido, defina last_read_time como qualquer valor depois (maior) que o 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 que aparecem na conversa de nível superior do espaço. As respostas nas conversas não são afetadas por esse carimbo de data/hora. Elas dependem do estado de leitura da linha de execução.

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.

FieldMask

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

Você pode atualizar os seguintes campos de um espaço:

• space_details

• display_name: só é possível atualizar o nome de exibição de espaços em que o campo spaceType é SPACE. Se você receber a mensagem de erro ALREADY_EXISTS, tente um valor diferente. Talvez um espaço na organização do Google Workspace já esteja usando esse nome de exibição.

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

• space_history_state: atualiza as configurações do histórico do espaço ativando ou desativando o histórico. Disponível apenas se as configurações de histórico estiverem ativadas na organização do Google Workspace. Para atualizar o estado do histórico do espaço, omita todas as outras máscaras de campo da solicitação. space_history_state não é compatível com o acesso de administrador.

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

• Prévia para desenvolvedores: oferece suporte à mudança das configurações de permissão de um espaço. Os caminhos de campo compatíveis incluem permission_settings.manage_members_and_groups, permission_settings.modify_space_details, permission_settings.toggle_history, permission_settings.use_at_mention_all, permission_settings.manage_apps, permission_settings.manage_webhooks e permission_settings.reply_messages. Aviso: mutuamente exclusivo com todos os outros caminhos de campo de configurações que não são de permissão. permission_settings não é compatível com o acesso de administrador.

bool

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

Exige o escopo OAuth 2.0 chat.admin.spaces.

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

string

Nome do recurso para um user do Google Chat.

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

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

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

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

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

string

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

string

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

Type

Tipo de usuário.

bool

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

User

O usuário mencionou.

Type

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

Button

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

TextParagraph

Exibir um parágrafo de texto neste widget.

Image

Mostre uma imagem neste widget.

KeyValue

Exiba um item de chave-valor neste widget.

TextButton

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

ImageButton

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

string

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

ActionParameter

Lista de parâmetros de ação.

string

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

string

O valor do parâmetro.

string

É o URL da imagem.

OnClick

A ação onclick.

double

É a proporção da imagem (largura e altura). Esse campo permite reservar a altura correta para a imagem enquanto ela é carregada. Ela não substitui a proporção integrada da imagem. Se ela não for definida, o servidor vai preenchê-la fazendo uma pré-busca da imagem.

OnClick

A ação onclick.

string

O nome do image_button usado para acessibilidade. O valor padrão será fornecido se esse nome não for especificado.

Icon

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

string

O ícone especificado por um URL.

string

O texto do marcador superior. Suporte a texto formatado. Saiba mais sobre a formatação de texto em Formatar texto nos apps do Google Chat e Formatar texto em complementos do Google Workspace.

string

O texto do conteúdo. Texto formatado é permitido e sempre obrigatório. Saiba mais sobre a formatação de texto em Formatar texto nos apps do Google Chat e Formatar texto em complementos do Google Workspace.

bool

Se o conteúdo precisar ser multilinha.

string

O texto do marcador inferior. Suporte a texto formatado. Saiba mais sobre a formatação de texto em Formatar texto nos apps do Google Chat e Formatar texto em complementos do Google Workspace.

OnClick

A ação onclick. Somente o marcador superior, o marcador inferior e a região do conteúdo são clicáveis.

Icon

Um valor de enumeração que é substituído pela API Chat pela imagem de ícone correspondente.

string

O ícone especificado por um URL.

Button

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

FormAction

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

OpenLink

Se especificada, esta ação onclick acionará uma ação de link aberto.

string

O URL a ser aberto.

string

O texto do botão.

OnClick

A ação onclick do botão.

string