REST Resource: spaces

Recurso: Space

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,
  "lastActiveTime": string,
  "adminInstalled": boolean,
  "membershipCount": {
    object (MembershipCount)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "spaceUri": string,
  "customer": string,

  // Union field space_permission_settings can be only one of the following:
  "predefinedPermissionSettings": enum (PredefinedPermissionSettings),
  "permissionSettings": {
    object (PermissionSettings)
  }
  // End of list of possible types for union field space_permission_settings.
}
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. Você pode conseguir o ID do espaço chamando o método spaces.list() ou pelo 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 do espaço será AAAAAAAAA.
type
(deprecated)

enum (Type)

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

enum (SpaceType)

Opcional. O tipo de espaço. Obrigatório ao criar um espaço ou atualizar o tipo de espaço. Saída apenas para outro uso.
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. Descontinuado: use spaceThreadingState. Se as mensagens estão agrupadas neste espaço.
displayName

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 a displayName, tente usar outra displayName. Um espaço existente na organização do Google Workspace já pode usar esse nome de exibição.

Para mensagens diretas, esse campo pode estar vazio.

Aceita até 128 caracteres.
externalUserAllowed

boolean

Opcional. Imutável. Se o 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 este campo ao criar espaços nas seguintes condições:

  • O usuário autenticado usa uma conta de consumidor (conta de usuário não gerenciada). Por padrão, um espaço criado por uma conta de consumidor permite o acesso de qualquer usuário do Google Chat.

Para espaços existentes, esse campo é somente saída.
spaceThreadingState

enum (SpaceThreadingState)

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

object (SpaceDetails)

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

enum (HistoryState)

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

boolean

Opcional. Se o espaço foi criado em 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.

A criação de um espaço no Import Mode requer autenticação do usuário.
createTime

string (Timestamp format)

Opcional. Imutável. Para espaços criados no Chat, o horário em que o espaço foi criado. 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.
lastActiveTime

string (Timestamp format)

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

boolean

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 oferecer suporte à instalação pelo administrador, o app do Chat precisa ter mensagens diretas.
membershipCount

object (MembershipCount)

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

object (AccessSettings)

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

string

Apenas saída. O URI para um usuário acessar o espaç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 apps e SpaceType for SPACE. Caso contrário, não deve ser definido.

No formato customers/{customer}, em que customer é o id do [recurso de cliente do SDK Admin](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). 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 nas mensagens diretas.

Campo de união space_permission_settings. Representa as configurações de permissão de um espaço. Preenchido apenas quando space_type é SPACE.

Requer autenticação do usuário. space_permission_settings pode ser apenas de um dos tipos a seguir:
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

Opcional. Somente entrada. Configurações predefinidas de permissão do espaço. Só é possível inserir essas informações 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.
permissionSettings

object (PermissionSettings)

Opcional. Configurações de permissão dos espaços atuais. Entrada para atualizar as configurações de permissão do espaço, substituindo as atuais. A saída lista as configurações de permissão atuais.

Tipo

Descontinuado: use SpaceType.

Enums
TYPE_UNSPECIFIED Reservado.
ROOM Conversas entre duas ou mais pessoas.
DM Mensagem direta entre uma pessoa e um app de chat, em que todas as mensagens são planas. 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 outro uso.

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 com três ou mais pessoas. Um GROUP_CHAT pode incluir apps de chat.
DIRECT_MESSAGE Mensagens individuais entre duas pessoas ou entre uma pessoa e um app do Chat.

SpaceThreadingState

Especifica o tipo de estado da linha de execução no espaço do Chat.

Enums
SPACE_THREADING_STATE_UNSPECIFIED Reservado.
THREADED_MESSAGES Espaços nomeados compatíveis com linhas de mensagens. Quando os usuários respondem a uma mensagem, eles podem responder na conversa, o 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 suas respostas são agrupados.
UNTHREADED_MESSAGES Mensagens diretas (DMs) entre duas pessoas e conversas em grupo com 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 tema de discussão, o propósito funcional ou os participantes do espaço.

Suporta até 150 caracteres.
guidelines

string

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

Aceita até 5.000 caracteres.

HistoryState

O estado do histórico de mensagens e espaços. Especifica por quanto tempo as mensagens e as linhas de conversa 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 Google Vault da organização especificam por quanto tempo as mensagens e as conversas são mantidas.

MembershipCount

Representa o número de associações a um espaço agrupadas em categorias.

Representação JSON 
{
  "joinedDirectHumanUserCount": integer,
  "joinedGroupCount": integer
}
Campos
joinedDirectHumanUserCount

integer

Apenas saída. Contagem de usuários humanos que participaram diretamente do espaço, sem contar os usuários que se juntaram por terem uma associação em um grupo.
joinedGroupCount

integer

Apenas saída. Número de grupos que participaram diretamente do espaço.

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 descobrir, participar e visualizar as mensagens do espaço. 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. Saiba mais 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.

Leia o que o público-alvo suporta:

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

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

AccessState

Representa o estado de acesso do espaço.

Enums
ACCESS_STATE_UNSPECIFIED O estado de acesso é desconhecido ou incompatível com esta API.
PRIVATE Só os usuários ou Grupos do Google adicionados ou convidados individualmente por outros usuários ou administradores do Google Workspace podem encontrar e acessar o espaço.
DISCOVERABLE

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

A criação de espaços detectáveis exige a autenticação do usuário.

PredefinedPermissionSettings

Configurações de permissão predefinidas que você só pode especificar ao criar um espaço nomeado. É possível que mais configurações sejam adicionadas no futuro. Para saber mais sobre as configurações de permissão para espaços nomeados, consulte Saiba mais sobre os espaços.

Enums
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED Não especificado. Não use.
COLLABORATION_SPACE Configurações para tornar o espaço um espaço de colaboração em que todos os participantes podem postar mensagens.
ANNOUNCEMENT_SPACE Configuração para tornar o espaço um espaço de avisos onde apenas administradores podem postar mensagens.

PermissionSettings

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

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

Representação JSON 
{
  "manageMembersAndGroups": {
    object (PermissionSetting)
  },
  "modifySpaceDetails": {
    object (PermissionSetting)
  },
  "toggleHistory": {
    object (PermissionSetting)
  },
  "useAtMentionAll": {
    object (PermissionSetting)
  },
  "manageApps": {
    object (PermissionSetting)
  },
  "manageWebhooks": {
    object (PermissionSetting)
  },
  "postMessages": {
    object (PermissionSetting)
  },
  "replyMessages": {
    object (PermissionSetting)
  }
}
Campos
manageMembersAndGroups

object (PermissionSetting)

Opcional. Configurações para gerenciar participantes e grupos em um espaço.
modifySpaceDetails

object (PermissionSetting)

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

object (PermissionSetting)

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

object (PermissionSetting)

Opcional. Configurações para usar @todos em um espaço.
manageApps

object (PermissionSetting)

Opcional. Configurações para gerenciar apps em um espaço.
manageWebhooks

object (PermissionSetting)

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

object (PermissionSetting)

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

object (PermissionSetting)

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

PermissionSetting

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

Representação JSON 
{
  "managersAllowed": boolean,
  "membersAllowed": boolean
}
Campos
managersAllowed

boolean

Opcional. Se os administradores dos espaços têm essa permissão.
membersAllowed

boolean

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

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 sem participantes.

delete

 Exclui um espaço nomeado.

findDirectMessage

 Retorna a mensagem direta com o usuário especificado.

get

 Retorna detalhes sobre um espaço.

list

 Lista os espaços em que o autor da chamada é membro.

patch

 Atualiza um espaço.
Retorna uma lista de espaços em uma organização do Google Workspace com base na pesquisa de um administrador.

setup

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