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
}
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 pessoa.
threaded
(deprecated)

boolean

Apenas saída. Obsoleto: use spaceThreadingState. Indica 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.

Em mensagens diretas, esse campo pode estar vazio.

Ela pode ter até 128 caracteres.
externalUserAllowed

boolean

Imutável. Indica se o espaço permite qualquer usuário do Google Chat como 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 do Google. Por padrão, o espaço permite qualquer usuário do Google Chat.

  • O espaço é usado para importar dados para o Google Chat. Os espaços do modo de importação só podem permitir participantes da mesma organização do Google Workspace.

Para os espaços atuais, esse campo é apenas 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 e conversas neste espaço.
importMode

boolean

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

createTime

string (Timestamp format)

Opcional. Horário de criação dos espaços criados no Chat Este campo é apenas para a saída, exceto quando usado em espaços importados.

Para espaços importados, defina este campo como o carimbo de data/hora histórico em que o espaço foi criado na origem, a fim de preservar o horário de criação original.

Preenchido apenas na saída quando spaceType for 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 no domínio, em uma unidade organizacional ou em um grupo de usuários.

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

Tipo

Obsoleto: use SpaceType.

Enums
TYPE_UNSPECIFIED
ROOM Conversas entre duas ou mais pessoas.
DM Mensagem direta individual entre uma pessoa e um app de chat, com mensagens simples. Isso não inclui mensagens diretas entre duas pessoas.

Tipo de espaço

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. Um SPACE pode incluir apps de chat.
GROUP_CHAT Conversas em grupo entre três ou mais pessoas Um GROUP_CHAT pode incluir apps de 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 compatíveis com agrupamentos de mensagens. Quando os usuários respondem a uma mensagem, eles podem responder em uma conversa, mantendo a resposta no contexto da mensagem original.
GROUPED_MESSAGES Espaços nomeados em que a conversa é organizada por tema. Os temas e as respostas deles são agrupados.
UNTHREADED_MESSAGES Mensagens diretas entre duas pessoas e conversas em grupo entre três ou mais pessoas.

Detalhes do espaço

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

Representação JSON 
{
  "description": string,
  "guidelines": string
}
Campos
description

string

Opcional. Descrição do espaço. Por exemplo, descreva o tema de discussão, o objetivo funcional ou os participantes do espaço.

Ela pode ter até 150 caracteres.
guidelines

string

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

Suporta até 5.000 caracteres.

Estado do histórico

O estado do histórico de mensagens e espaços. Especifica por quanto tempo as mensagens e 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.

Métodos

completeImport

 Termina o processo de importação para o 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.