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: |
type |
Apenas saída. Obsoleto: use |
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 |
Opcional. Se o espaço é uma mensagem direta entre um app do Chat e uma única pessoa. |
threaded |
Apenas saída. Obsoleto: use |
displayName |
O nome de exibição do espaço. Obrigatório ao criar um espaço. Se você receber a mensagem de erro Este campo pode estar vazio nas mensagens diretas. Aceita até 128 caracteres. |
externalUserAllowed |
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:
Nos espaços atuais, este campo é apenas para saída. |
spaceThreadingState |
Apenas saída. O estado da conversa no espaço do Chat. |
spaceDetails |
Detalhes sobre o espaço, incluindo descrição e regras |
spaceHistoryState |
O estado do histórico de mensagens e conversas neste espaço. |
importMode |
Opcional. Indica se esse espaço foi criado no |
createTime |
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 |
lastActiveTime |
Apenas saída. Carimbo de data/hora da última mensagem no espaço. |
adminInstalled |
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 |
Apenas saída. A contagem de associações participantes agrupadas por tipo de participante. Preenchido quando |
accessSettings |
Opcional. Especifica a configuração de acesso do espaço. Preenchido apenas quando |
spaceUri |
Apenas saída. O URI para um usuário acessar o 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 |
Opcional. Somente 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 |
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 |
Tipo
Obsoleto: use SpaceType
.
Enums | |
---|---|
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.
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 da 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. 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 |
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 |
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 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 JSON |
---|
{ "joinedDirectHumanUserCount": integer, "joinedGroupCount": integer } |
Campos | |
---|---|
joinedDirectHumanUserCount |
Contagem de usuários humanos que participaram diretamente do espaço, sem contar os usuários que participaram de um grupo. |
joinedGroupCount |
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 | |
---|---|
accessState |
Apenas saída. Indica o estado de acesso do espaço. |
audience |
Opcional. O nome do recurso do público-alvo que pode descobrir, participar e visualizar as mensagens do espaço. 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 |
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 para o espaço também podem encontrar e acessar o espaço. Saiba mais em Tornar um espaço detectável para usuários específicos. |
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.
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 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 ( |
Campos | |
---|---|
manageMembersAndGroups |
Configuração para gerenciar participantes e grupos em um espaço. |
modifySpaceDetails |
Configuração para atualizar o nome, o avatar, a descrição e as diretrizes do espaço. |
toggleHistory |
Configuração para ativar e desativar o histórico do espaço. |
useAtMentionAll |
Configuração para usar @todos em um espaço. |
manageApps |
Configuração para gerenciar apps em um espaço. |
manageWebhooks |
Configuração para gerenciar webhooks em um espaço. |
postMessages |
Apenas saída. Configuração para postar mensagens em um espaço. |
replyMessages |
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 |
Indica se os administradores dos espaços têm essa permissão. |
membersAllowed |
Indica se 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 nomeado. |
|
Exclui um espaço nomeado. |
|
Retorna a mensagem direta com o usuário especificado. |
|
Retorna detalhes sobre um espaço. |
|
Lista os espaços de que o autor da chamada é participante. |
|
Atualiza um espaço. |
|
|
|
Cria um espaço e adiciona usuários especificados a ele. |