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 ( |
Campos | |
---|---|
name |
Nome do recurso do espaço. Formato: Em que |
type |
Apenas saída. Obsoleto: use |
space |
O tipo de espaço. Obrigatório ao criar ou atualizar o tipo de um espaço. Saída somente para outro uso. |
single |
Opcional. Se o espaço é uma DM entre um app de chat e uma pessoa. |
threaded |
Apenas saída. Descontinuado: use |
display |
O nome de exibição do espaço. Obrigatório ao criar um espaço com um Para mensagens diretas, esse campo pode estar vazio. Suporta até 128 caracteres. |
external |
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 esse campo ao criar espaços nas seguintes condições:
Para espaços atuais, este campo é apenas para saída. |
space |
Apenas saída. O estado da conversa em grupo no espaço do Chat. |
space |
Detalhes sobre o espaço, incluindo descrição e regras |
space |
O estado do histórico de mensagens e conversas neste espaço. |
import |
Opcional. Indica se esse espaço foi criado no A criação de um espaço em |
create |
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 |
last |
Apenas saída. Carimbo de data/hora da última mensagem no espaço. |
admin |
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. |
membership |
Apenas saída. A contagem de associações agrupadas por tipo de participante. Preenchido quando |
access |
Opcional. Especifica a configuração de acesso do espaço. Preenchido apenas quando |
space |
Apenas saída. O URI para um usuário acessar o espaço. |
customer |
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 apps e No formato Para DMs, esse campo não é preenchido. |
Campo de união Exige a autenticação do usuário. |
|
predefined |
Opcional. Somente entrada. Configurações de permissão predefinidas do 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 que você cria o espaço, as configurações são preenchidas no campo |
permission |
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 somente para outro uso.
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 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 de linha de execução 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 na 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 as respostas deles 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 |
Opcional. Uma descrição do espaço. Por exemplo, descreva o tema da discussão, a finalidade funcional ou os participantes do espaço. Aceita até 150 caracteres. |
guidelines |
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.
Enums | |
---|---|
HISTORY_STATE_UNSPECIFIED |
Valor padrão. Não use. |
HISTORY_OFF |
Histórico desativado. As mensagens e as 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 as linhas de conversa 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 | |
---|---|
joined |
Contagem de usuários humanos que participaram diretamente do espaço, sem contar os usuários que participaram de um grupo. |
joined |
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 ( |
Campos | |
---|---|
access |
Apenas saída. Indica o estado de acesso do espaço. |
audience |
Opcional. O nome do recurso do público-alvo que pode descobrir o espaço, participar dele e visualizar as mensagens. Se ela não for definida, só os usuários ou Grupos do Google convidados ou adicionados ao espaço poderão acessá-lo. Veja mais detalhes em Tornar um espaço detectável para um público-alvo. Formato: Para usar o público-alvo padrão na organização do Google Workspace, defina como A leitura do público-alvo de destino oferece suporte a:
Esse campo não é preenchido ao usar o escopo 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 |
Somente usuários ou Grupos do Google que foram adicionados ou convidados individualmente por outros usuários ou administradores do Google Workspace podem descobrir e acessar o espaço. |
DISCOVERABLE |
Um administrador do espaço concedeu acesso ao espaço a um público-alvo. Os usuários ou grupos do Google que foram adicionados ou convidados individualmente para o espaço também podem encontrar e acessar o espaço. Saiba mais em Tornar um espaço visí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 só podem ser especificadas ao criar um espaço nomeado. Mais configurações poderão ser adicionadas no futuro. Saiba mais sobre as configurações de permissão para espaços nomeados em Saiba mais sobre os espaços.
Enums | |
---|---|
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 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 ( |
Campos | |
---|---|
manage |
Configuração para gerenciar participantes e grupos em um espaço. |
modify |
Configurações para atualizar o nome, o avatar, a descrição e as diretrizes do espaço. |
toggle |
Configuração para ativar e desativar o histórico do espaço. |
use |
Configuração para usar @todos em um espaço. |
manage |
Configuração para gerenciar apps em um espaço. |
manage |
Configurações para gerenciar webhooks em um espaço. |
post |
Apenas saída. Configuração para postar mensagens em um espaço. |
reply |
Configurações 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 | |
---|---|
managers |
Se os administradores dos espaços têm essa permissão. |
members |
Se os membros que não são administradores têm essa permissão. |
Métodos |
|
---|---|
|
Conclui o processo de importação do espaço especificado e o torna visível para os usuários. |
|
Cria um espaço sem participantes. |
|
Exclui um espaço nomeado. |
|
Retorna a mensagem direta com o usuário especificado. |
|
Retorna detalhes sobre um espaço. |
|
Lista os espaços em que o autor da chamada é membro. |
|
Atualiza um espaço. |
|
Retorna uma lista de espaços em uma organização do Google Workspace com base na pesquisa de um administrador. |
|
Cria um espaço e adiciona usuários especificados a ele. |