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,

  // 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

Nome do recurso do espaço.

Formato: spaces/{space}
type
(deprecated)

enum (Type)

Apenas saída. Obsoleto: use spaceType. O tipo de 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 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. 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 a displayName, tente usar outra displayName. Talvez um espaço na organização do Google Workspace já esteja usando esse nome de exibição.

Este campo pode estar vazio nas mensagens diretas.

Aceita até 128 caracteres.
externalUserAllowed

boolean

Imutável. Se qualquer usuário do Google Chat pode participar deste espaço. 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 pessoal (conta de usuário não gerenciada). Por padrão, um espaço criado por uma conta pessoal permite 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 que qualquer usuário do Google Chat use esse campo.

Nos espaços atuais, este 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 e conversas neste espaço.
importMode

boolean

Opcional. Indica se esse espaço foi criado no 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 em que o espaço foi criado nos 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 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. Nos espaços de mensagens diretas (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 do administrador, seu app do Chat precisa ter mensagens diretas.
membershipCount

object (MembershipCount)

Apenas saída. A contagem de associações participantes 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 do espaço.

Campo de união space_permission_settings. Representa as configurações de permissão de um espaço. Preenchido apenas quando space_type é SPACE. space_permission_settings só pode ser de um dos tipos a seguir:
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

Opcional. Apenas entrada. Configurações de permissão do espaço. Entrada para criar um espaço. Um espaço de colaboração será criado se este campo não for definido. 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 exatas que podem ser definidas para atualizar o espaço. Entrada para atualizar um espaço. Caso contrário, somente saída. Para criar espaços, use predefinedPermissionSettings.

Tipo

Obsoleto: use SpaceType.

Tipos enumerados
TYPE_UNSPECIFIED Reservado.
ROOM Conversas entre duas ou mais pessoas.
DM Mensagem direta individual entre uma pessoa e um app do Chat, com todas as mensagens sem formatação. 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.

Tipos enumerados
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 com 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 linha de execução no espaço do Chat.

Tipos enumerados
SPACE_THREADING_STATE_UNSPECIFIED Reservado.
THREADED_MESSAGES Espaços nomeados compatíveis com agrupamentos de mensagens. Ao responder a uma mensagem, os usuários podem responder em uma conversa, o que mantém a resposta no contexto da mensagem original.
GROUPED_MESSAGES Espaços nomeados com organização por tema. Os tópicos e suas respostas são agrupados.
UNTHREADED_MESSAGES Mensagens diretas 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.

Aceita até 150 caracteres.
guidelines

string

Opcional. 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 conversas são mantidas após a criação.

Tipos enumerados
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

Contagem de usuários humanos que participaram diretamente do espaço, sem contar os usuários que participaram de um grupo.
joinedGroupCount

integer

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 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. Desmarque este campo para restringir o espaço. Só é preenchido quando o espaço é detectável. Formato: audiences/{audience} e audiences/default podem ser usados como alias da configuração de compartilhamento padrão do Chat.

AccessState

Representa o estado de acesso do espaço.

Tipos enumerados
ACCESS_STATE_UNSPECIFIED O estado de acesso é desconhecido ou incompatível com esta API.
PRIVATE O espaço pode ser encontrado pelos 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.

PredefinedPermissionSettings

As configurações de permissão que você pode especificar ao criar um espaço nomeado. É possível que mais configurações sejam adicionadas no futuro. Saiba mais sobre as configurações de permissão para espaços nomeados em Saiba mais sobre os espaços.

Tipos enumerados
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED Não especificado. Não use.
COLLABORATION_SPACE Configuração para transformar o espaço em um espaço de colaboração onde 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 para 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)

Configuração para gerenciar participantes e grupos em um espaço.
modifySpaceDetails

object (PermissionSetting)

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

object (PermissionSetting)

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

object (PermissionSetting)

Configuração para usar @todos em um espaço.
manageApps

object (PermissionSetting)

Configuração para gerenciar apps em um espaço.
manageWebhooks

object (PermissionSetting)

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)

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

PermissionSetting

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

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

boolean

Indica se os administradores dos espaços têm essa permissão.
membersAllowed

boolean

Indica se membros 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 nomeado.

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 de que o autor da chamada é participante.

patch

 Atualiza um espaço.

setup

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