REST Resource: spaces

{
  "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.
}

string

Identificador. Nome do recurso do espaço.

Formato: spaces/{space}

em que {space} representa o ID atribuído pelo sistema ao espaço. Para conferir o ID do espaço, chame o método spaces.list() ou use o 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.

enum (Type)

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

enum (SpaceType)

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

boolean

Opcional. Se o espaço é uma DM entre um app de chat e uma pessoa.

boolean

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

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 o displayName, tente usar outro 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.

Suporta até 128 caracteres.

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

enum (SpaceThreadingState)

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

object (SpaceDetails)

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

enum (HistoryState)

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

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 em Import Mode requer a autenticação do usuário.

string (Timestamp format)

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

Só é preenchido na saída quando spaceType é GROUP_CHAT ou SPACE.

string (Timestamp format)

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

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.

object (MembershipCount)

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

object (AccessSettings)

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

string

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

string

Opcional. Imutável. O ID do cliente do domínio do espaço. Obrigatório apenas ao criar um espaço com autenticação de app e SpaceType SPACE. Caso contrário, não será necessário definir.

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.

Para DMs, esse campo não é preenchido.

enum (PredefinedPermissionSettings)

Opcional. Somente entrada. Configurações predefinidas de permissão de espaço, insira apenas ao criar um espaço. Se o campo não for definido, um espaço de colaboração será criado. Depois de criar o espaço, as configurações são preenchidas no campo PermissionSettings.

object (PermissionSettings)

Opcional. Configurações de permissão de espaço para espaços existentes. Entrada para atualizar as configurações de permissões exatas do espaço, em que as configurações atuais são substituídas. A saída lista as configurações de permissão atuais.