Recurso: 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.
Representação JSON |
---|
{ "name": string, "type": enum ( |
Campos | |
---|---|
name |
Nome do recurso do espaço. Formato: |
type |
Apenas saída. Obsoleto: use |
spaceType |
O tipo de espaço. Obrigatório ao criar ou atualizar o tipo de um espaço. Saída apenas para outros usos. |
singleUserBotDm |
Opcional. Se o espaço é uma mensagem direta entre um app do Chat e uma única pessoa. |
threaded |
Apenas saída. Obsoleto: use |
displayName |
O nome de exibição do espaço. Obrigatório ao criar um espaço. Se você receber a mensagem de erro Para mensagens diretas, esse campo pode estar vazio. Pode ter até 128 caracteres. |
externalUserAllowed |
Imutável. Se o espaço permite que qualquer usuário do Google Chat participe. Entrada ao criar um espaço em uma organização do Google Workspace. Omita esse campo ao criar espaços nas seguintes condições:
Nos espaços atuais, esse 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 |
spaceHistoryState |
O estado do histórico de mensagens das mensagens e conversas neste espaço. |
importMode |
Opcional. Indica se este espaço foi criado no app |
createTime |
Opcional. Imutável. O horário de criação dos 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 do 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 a hora de criação original. Só é preenchido na saída quando |
adminInstalled |
Apenas saída. Nos 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 permitir a instalação do administrador, o app do Chat precisa ter mensagens diretas. |
accessSettings |
Opcional. Especifica a configuração de acesso do espaço. Só é preenchido quando |
spaceUri |
Apenas saída. O URI do espaço. |
Tipo
Obsoleto: use SpaceType
.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Reservado. |
ROOM |
Conversas entre duas ou mais pessoas. |
DM |
Mensagem direta individual entre uma pessoa e um app do Chat, em que todas as mensagens são simples. Isso não inclui mensagens diretas entre duas pessoas. |
SpaceType
O tipo de espaço. Obrigatório ao criar ou atualizar um espaço. Saída apenas para outros usos.
Enums | |
---|---|
SPACE_TYPE_UNSPECIFIED |
Reservado. |
SPACE |
Um lugar onde as pessoas enviam mensagens, compartilham arquivos e colaboram. Uma SPACE pode incluir apps do Chat. |
GROUP_CHAT |
Conversas em grupo entre três ou mais pessoas Uma GROUP_CHAT pode incluir apps do Chat. |
DIRECT_MESSAGE |
Mensagens individuais entre duas pessoas ou uma pessoa e um app do Chat. |
SpaceThreadingState
Especifica o tipo de estado da conversa no espaço do Chat.
Enums | |
---|---|
SPACE_THREADING_STATE_UNSPECIFIED |
Reservado. |
THREADED_MESSAGES |
Espaços nomeados que aceitam agrupamentos de mensagens. Quando os usuários respondem a uma mensagem, eles podem responder em uma conversa, que mantém a resposta no contexto da mensagem original. |
GROUPED_MESSAGES |
Espaços nomeados em que a conversa é organizada por tema. Os tópicos e as respostas deles são agrupados. |
UNTHREADED_MESSAGES |
Mensagens diretas entre duas pessoas e conversas em grupo feitas por três ou mais pessoas. |
SpaceDetails
Detalhes sobre o espaço, incluindo descrição e regras
Representação JSON |
---|
{ "description": string, "guidelines": string } |
Campos | |
---|---|
description |
Opcional. Uma descrição do espaço. Por exemplo, descreva o tópico de discussão, a finalidade funcional ou os participantes do espaço. Pode ter até 150 caracteres. |
guidelines |
Opcional. As regras, expectativas e etiqueta do espaço. Pode ter até 5.000 caracteres. |
HistoryState
O estado do histórico de mensagens e espaços. Especifica por quanto tempo as mensagens e as conversas são mantidas após a criação.
Enums | |
---|---|
HISTORY_STATE_UNSPECIFIED |
Valor padrão. Não use. |
HISTORY_OFF |
Histórico desativado. As mensagens e conversas são mantidas por 24 horas. |
HISTORY_ON |
Histórico ativado. As regras de retenção do Vault da organização especificam por quanto tempo as mensagens e conversas são mantidas. |
AccessSettings
Representa a configuração de acesso do espaço.
Representação JSON |
---|
{
"accessState": enum ( |
Campos | |
---|---|
accessState |
Apenas saída. Indica o estado de acesso do espaço. |
audience |
Opcional. É o nome do recurso do público-alvo que pode acessar o espaço. Defina esse campo como um ID de público-alvo válido para tornar o espaço detectável ou use o alias |
AccessState
Representa o estado de acesso do espaço.
Enums | |
---|---|
ACCESS_STATE_UNSPECIFIED |
O estado de acesso é desconhecido ou não é compatível com esta API. |
PRIVATE |
O espaço pode ser encontrado por participantes ou grupos adicionados ou convidados. |
DISCOVERABLE |
O espaço pode ser encontrado pelo público-alvo selecionado e pelos participantes ou grupos adicionados ou convidados. |
Métodos |
|
---|---|
|
Conclui o processo de importação do espaço especificado e o torna visível para os usuários. |
|
Cria um espaço nomeado. |
|
Exclui um espaço nomeado. |
|
Retorna a mensagem direta existente com o usuário especificado. |
|
Retorna detalhes sobre um espaço. |
|
Lista os espaços de que o autor da chamada participa. |
|
Atualiza um espaço. |
|
Cria um espaço e adiciona usuários especificados a ele. |