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, participar e ver os membros do espaço.
Para especificar os usuários na sua organização que podem descobrir, participar e ver os membros 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 ter um controle mais granular sobre quem pode acessar o espaço e as informações dele. Com os públicos-alvo, você também pode gerenciar e personalizar as associações a espaços sem precisar convidar usuários individuais. Para mais informações, consulte Sobre públicos-alvo.
Só é possível tornar os espaços nomeados detectáveis para públicos-alvo. Não é possível compartilhar outros tipos de espaços, como mensagens diretas ou conversas em grupo, com públicos-alvo.
Pré-requisitos
- Uma conta do Google Workspace Business ou Enterprise com acesso ao Google Chat. Sua conta precisa ter a função de superadministrador na 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 os espaços do Chat, consulte Configurar o acesso ao espaço para o Chat.
- É necessário chamar a API Google Chat com autenticação do usuário.
Receber o ID do público-alvo
Para conseguir o ID de um público-alvo, faça o seguinte:
No Google Admin Console, 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 existente para que ele possa ser encontrado pelo público-alvo.
Especifique públicos-alvo e permissões granulares
Para criar um espaço com permissões de acesso específicas, use o método
create ou
setup no recurso
Space. Para atualizar as permissões de um espaço, use o método
update. 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, participar ou ver os participantes de um espaço, inclua o objeto
AccessSettings
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 conseguir encontrá-lo. O Google Chat oferece suporte a um único público-alvo para essa permissão. - Ver associação: use
viewSpaceMembershipSettingpara definir quem pode ver a lista de participantes em um espaço. Ao atualizar quem pode ver a participação no espaço,accessSettings.accessPermissionSettings.viewSpaceMembershipSettingprecisa ser especificado compermissionSettings.viewSpaceMembershipnoupdateMaske no corpo da solicitação. Quando um público-alvo é configurado emviewSpaceMembershipSetting,viewSpaceMembershipprecisa ser concedido a todos os membros (managersAllowed,assistantManagersAllowedemembersAlloweddefinidos comotrue).
O exemplo a seguir mostra como tornar um espaço detectável para dois públicos-alvo, permitir que um deles participe e garantir que todos os participantes e públicos-alvo especificados possam ver quem está no espaço:
{
"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" } }
]
},
"viewSpaceMembershipSetting": {
"principals": [
{ "audience": { "name": "audiences/TARGET_AUDIENCE_ID_1" } },
{ "audience": { "name": "audiences/TARGET_AUDIENCE_ID_2" } }
]
}
}
},
"permissionSettings": {
"viewSpaceMembership": {
"managersAllowed": true,
"assistantManagersAllowed": true,
"membersAllowed": true
}
}
}
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 padrão de compartilhamento de espaço do Chat na 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 granulares.
Definir o campo audience
é equivalente a especificar o público-alvo em joinSpaceSetting:
"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 padrão de compartilhamento de espaço do Chat na sua organização do Google Workspace, substitua por default.
Entender as configurações de acesso nas respostas da API
Quando você recebe ou lista espaços, o objeto
AccessSettings
na resposta reflete as permissões granulares definidas para o espaço.
Os campos a seguir em AccessSettings indicam a capacidade de pesquisa e
permissões de participação de um espaço:
accessState: derivado das 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 junção (joinSpaceSetting). Se um único público-alvo receber permissão de junção, este campo vai conter o nome do recurso desse público-alvo.
Espaço detectável sem público-alvo para 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ó é possível participar dele por convite. Para saber quais
públicos-alvo podem descobrir o espaço, confira o campo
accessPermissionSettings.discoverSpaceSetting.
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 detalhes sobre como criar ou atualizar espaços usando a API Chat, consulte os seguintes guias: