Esta página explica como usar a API Google Chat para compartilhar um espaço do Google Chat com usuários específicos em uma organização do Google Workspace, para que eles possam descobrir e participar do espaço.
Para especificar os usuários na sua organização que podem descobrir e participar de um espaço, crie públicos-alvo. Um público-alvo é um grupo de pessoas, como departamentos específicos ou toda a organização, com quem você pode compartilhar um espaço do Chat para melhorar a visibilidade e a capacidade de compartilhamento do espaço. Os públicos-alvo também permitem gerenciar e personalizar as associações de espaços, em vez de precisar convidar usuários individuais para um espaço. Para mais informações, consulte Sobre públicos-alvo.
Só é possível tornar espaços nomeados detectáveis para públicos-alvo. Não é possível compartilhar outros tipos de espaço, como mensagens diretas ou conversas em grupo, com públicos-alvo.
Pré-requisitos
- Uma conta do Google Workspace Business ou Enterprise com acesso ao . Sua conta precisa ter o papel de superadministrador da organização do Google Workspace.
- Um público-alvo disponível para acesso no Chat. Para criar um público-alvo, consulte Criar um público alvo. Para disponibilizar um público-alvo para espaços do Chat, consulte Configurar o acesso ao espaço para o Chat.
- Você precisa chamar a API Google Chat com autenticação do usuário.
Receber o ID do público-alvo
Para receber o ID de um público-alvo, faça o seguinte:
No Admin Console do Google, acesse Menu > Diretório > Públicos-alvo.
Na tabela Públicos-alvo, clique no campo Nome do público-alvo.
Encontre o ID do público-alvo no URL da página. O formato do URL é
https://admin.google.com/ac/targetaudiences/TARGET_AUDIENCE_ID, em queTARGET_AUDIENCE_IDé o ID alfanumérico do público-alvo.
Na próxima seção, você vai usar o ID do público-alvo para criar um espaço detectável ou atualizar um espaço atual para torná-lo detectável para o público-alvo.
Especificar públicos-alvo e permissões detalhadas
Para criar um espaço com permissões de acesso específicas, use o
create ou
setup método no
Space recurso. Para atualizar as permissões de um espaço atual, use o
update método. Como apenas espaços nomeados podem ser compartilhados com públicos-alvo, o tipo de espaço (representado no campo spaceType) precisa ser SPACE.
Para especificar quem pode descobrir ou participar de um espaço, inclua o
AccessSettings
objeto no recurso Space. No objeto, use o campo accessPermissionSettings para especificar uma ou mais das seguintes permissões:
- Detectável: use
discoverSpaceSettingpara definir quem pode encontrar o nome e a descrição de um espaço e pesquisar por ele no Google Chat. É possível especificar vários públicos-alvo para descoberta. - Participável: use
joinSpaceSettingpara definir quem pode participar de um espaço sem um convite explícito e visualizar a mensagem do espaço. Os usuários que podem participar de um espaço também precisam poder descobri-lo. O Google Chat oferece suporte a um único público-alvo para essa permissão.
O exemplo a seguir mostra como tornar um espaço detectável para dois públicos-alvo e permitir que um deles participe:
"accessSettings": {
"accessPermissionSettings": {
"discoverSpaceSetting": {
"principals": [
{ "audience": { "name": "audiences/TARGET_AUDIENCE_ID_1" } },
{ "audience": { "name": "audiences/TARGET_AUDIENCE_ID_2" } }
]
},
"joinSpaceSetting": {
"principals": [
{ "audience": { "name": "audiences/TARGET_AUDIENCE_ID_1" } }
]
}
}
}
Substitua TARGET_AUDIENCE_ID_1 e
TARGET_AUDIENCE_ID_2 pelo ID do público-alvo que você recebeu em
Receber o ID do público-alvo.
Para usar as configurações de compartilhamento de espaço do Chat padrão da sua organização do Google Workspace, substitua por default.
Para compatibilidade com versões anteriores, use o campo audience
Para compatibilidade com versões anteriores, você pode continuar usando o campo audience para
especificar um único público-alvo que pode participar de um espaço, mas recomendamos
Especificar públicos-alvo e permissões detalhadas em vez disso.
Definir o campo audience é equivalente a especificar o público-alvo em joinSpaceSetting e discoverSpaceSetting:
"accessSettings": {
"audience": "audiences/TARGET_AUDIENCE_ID"
}
Substitua TARGET_AUDIENCE_ID pelo ID do público-alvo que você recebeu em Receber o ID do público-alvo.
Para usar as configurações de compartilhamento de espaço do Chat padrão da sua organização do Google Workspace, substitua por default.
Entender as configurações de acesso nas respostas da API
Quando você recebe espaços, o
AccessSettings
objeto na resposta reflete as permissões detalhadas definidas para o espaço.
Os campos a seguir em AccessSettings indicam a capacidade de pesquisa e as permissões de participação de um espaço:
accessState: derivado de permissões de descoberta (discoverSpaceSetting). Se a descoberta for concedida a um ou mais públicos-alvo, esse campo seráDISCOVERABLE. Caso contrário, seráPRIVATE.audience: mapeado especificamente para permissões de participação (joinSpaceSetting). Se uma única permissão de participação for concedida a um público-alvo, esse campo vai conter o nome do recurso desse público-alvo.
Espaço detectável sem público-alvo de participação
Um espaço pode ser detectável por um público-alvo, mas não pode ser acessado diretamente (por exemplo, se os usuários precisarem ser convidados explicitamente para participar).
Nesse caso, o objeto AccessSettings tem os seguintes valores:
accessState:DISCOVERABLEaudience: omitido ounull
Se você vir accessState definido como DISCOVERABLE, mas audience não estiver presente, isso significa que o espaço pode ser descoberto pelos públicos-alvo especificados em discoverSpaceSetting, mas só pode ser acessado por convite. Para saber quais
públicos-alvo podem descobrir o espaço, confira o
accessPermissionSettings.discoverSpaceSetting
campo.
Temas relacionados
Para mais detalhes sobre públicos-alvo, consulte os guias a seguir:
- Criar um público-alvo
- Configurar o compartilhamento no Chat
- Criar espaços com diferentes níveis de acesso
Para mais detalhes sobre como criar ou atualizar espaços usando a API Chat, consulte os guias a seguir: