REST Resource: spaces

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 (Type),
  "spaceType": enum (SpaceType),
  "singleUserBotDm": boolean,
  "threaded": boolean,
  "displayName": string,
  "externalUserAllowed": boolean,
  "spaceThreadingState": enum (SpaceThreadingState),
  "spaceDetails": {
    object (SpaceDetails)
  },
  "spaceHistoryState": enum (HistoryState),
  "importMode": boolean,
  "createTime": string,
  "adminInstalled": boolean,
  "accessSettings": {
    object (AccessSettings)
  },
  "spaceUri": string
}
Campos
name

string

Nome do recurso do espaço.

Formato: spaces/{space}

type
(deprecated)

enum (Type)

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

spaceType

enum (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

boolean

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

threaded
(deprecated)

boolean

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

displayName

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 o displayName, tente usar outro displayName. Talvez um espaço da organização do Google Workspace já use esse nome de exibição.

Para mensagens diretas, esse campo pode estar vazio.

Pode ter até 128 caracteres.

externalUserAllowed

boolean

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:

  • 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 o acesso de qualquer usuário do Google Chat.

  • O espaço é usado para importar dados para o Google Chat porque os espaços do modo de importação só podem permitir participantes da mesma organização do Google Workspace. No entanto, como parte do Programa de prévia para desenvolvedores do Google Workspace, os espaços do modo de importação podem permitir qualquer usuário do Google Chat. Assim, esse campo pode ser definido para os espaços do modo de importação.

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

spaceThreadingState

enum (SpaceThreadingState)

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

spaceDetails

object (SpaceDetails)

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

spaceHistoryState

enum (HistoryState)

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

importMode

boolean

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

createTime

string (Timestamp format)

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 spaceType é GROUP_CHAT ou SPACE.

adminInstalled

boolean

Apenas saída. Se o app do Chat foi instalado por um administrador do Google Workspace. Os administradores podem instalar um app do Chat para um domínio, uma unidade organizacional ou um grupo de usuários.

Os administradores só podem instalar os apps do Chat para a troca de mensagens diretas entre os usuários e o app. Para oferecer suporte à instalação por administradores, seu app precisa ter mensagens diretas.

accessSettings

object (AccessSettings)

Opcional. Especifica a configuração de acesso do espaço. Só é preenchido quando spaceType é SPACE.

spaceUri

string

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

string

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

string

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 (AccessState),
  "audience": string
}
Campos
accessState

enum (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 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 audiences/default para definir o espaço com a configuração de acesso padrão no Admin Console. Saiba mais em Tornar um espaço detectável para um público-alvo. Cancele a definição deste campo para restringir o espaço. Preenchido apenas quando o espaço é detectável. Formato: audiences/{audience}, audiences/default pode ser usado como alias da configuração de compartilhamento padrão do Chat.

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

completeImport

Conclui o processo de importação do espaço especificado e o torna visível para os usuários.

create

Cria um espaço nomeado.

delete

Exclui um espaço nomeado.

findDirectMessage

Retorna a mensagem direta existente com o usuário especificado.

get

Retorna detalhes sobre um espaço.

list

Lista os espaços de que o autor da chamada participa.

patch

Atualiza um espaço.

setup

Cria um espaço e adiciona usuários especificados a ele.