Esta página oferece uma visão geral de como os administradores do Google Workspace podem usar a API Google Chat para gerenciar espaços do Google Chat na organização.
Para gerenciar espaços do Chat, os administradores do Google Workspace podem usar a ferramenta de gerenciamento de espaços no Google Admin Console ou chamar a API Google Chat. Ao usar a API Chat, os administradores podem criar apps do Google Chat que gerenciam espaços em grande escala e automatizam tarefas comuns ou repetíveis.
O que os administradores podem fazer com a API Chat
Um administrador pode realizar tarefas de gerenciamento com base nas suas funções de administrador atribuídas.
Como administrador do Google Workspace, você pode realizar várias tarefas de gerenciamento com a API Chat, como as seguintes:
- Pesquisar espaços com base em critérios especificados
- Listar os membros de um espaço
- Adicionar membros e remover membros de um espaço
- Receber detalhes sobre um membro e um espaço
- Atualizar ou excluir um espaço
- Atualizar a participação de um usuário
Como autenticar e autorizar como administrador do Google Workspace
Ao usar a API Chat para tarefas de gerenciamento, os administradores podem autenticar e autorizar solicitações invocando privilégios de administrador ou configurando a delegação de autoridade em todo o domínio para a conta de serviço de um aplicativo.
A tabela a seguir descreve as maneiras como os administradores podem autenticar ao usar a API Chat.
| Autenticação de usuários | Quem chama o método de API | O que os usuários veem no Chat |
|---|---|---|
| Privilégios de administrador | Administrador com useAdminAccess=true
|
"O administrador da organização realizou [uma ação]." Por exemplo, "O administrador da organização mudou Kiran B para administrador do espaço". Ele não identifica o nome ou o ID do usuário administrador nem o nome do app Chat. |
| Delegação em todo o domínio | Conta de serviço em nome de um usuário |
"[Usuário] realizou [uma ação] usando [nome do app]." Por exemplo, "Sasha T renomeou o espaço para Discussão do projeto de lançamento". O usuário que está sendo representado pelo serviço é identificado como tendo realizado a ação. |
Usar a API Chat na sua organização
Os exemplos nesta seção demonstram como os administradores usam a API Chat ao gerenciar os espaços e membros da organização com privilégios de administrador.
Os métodos da API Chat a seguir ativam privilégios de administrador com useAdminAccess=true.
spaces.deletespaces.getspaces.patchspaces.searchspaces.members.createspaces.members.deletespaces.members.getspaces.members.listspaces.members.patch
Gerenciar a participação de usuários no espaço
Os cenários a seguir são maneiras de você, como administrador do Google Workspace, gerenciar a participação de usuários no espaço da sua organização com a API Chat.
Adicionar usuários a espaços
Usando spaces.members.create,
os administradores podem adicionar um usuário a qualquer espaço em uma organização.
Usado em conjunto com spaces.search,
os administradores podem adicionar um usuário a um conjunto de espaços determinados pela consulta de pesquisa. Isso pode ser útil ao integrar novos funcionários a uma organização, permitindo que os administradores automatizem um processo de rotina.
Encontrar usuários e removê-los de espaços
Usando spaces.members.get,
os administradores podem determinar se um usuário (interno ou externo à organização) é
membro de algum espaço na organização.
Usado em conjunto com spaces.search,
os administradores podem encontrar todos os espaços de que o usuário é membro e removê-los
dos espaços com
spaces.members.delete.
Isso pode ser útil quando os funcionários mudam de equipe dentro de uma organização ou quando os funcionários que não estão mais na organização são desativados. Ele permite que os administradores automatizem um processo de rotina.
Promover usuários a administradores de espaço
Usando spaces.members.patch,
os administradores podem mudar o papel de um membro atualizando o
MembershipRole
entre as seguintes opções:
ROLE_MEMBER: um membro do espaço. Na interface do Chat, esse papel é chamado de Membro.ROLE_ASSISTANT_MANAGER: um administrador de espaço. Na interface do Chat, esse papel é chamado de Administrador.ROLE_MANAGER: um proprietário do espaço. Na interface do Chat, esse papel é chamado de Proprietário.
Usado em conjunto com spaces.search,
os administradores podem encontrar espaços que não têm um administrador ou proprietário e promover um
membro atual a administrador ou proprietário com spaces.members.patch.
Encontrar membros externos de um espaço
Usando spaces.members.list,
os administradores podem recuperar uma lista de membros em um espaço, recuperar os perfis de usuário
da API People ou da API Directory da organização e filtrar
os resultados para aqueles que são membros de um domínio ou organização externa.
Para mais informações, consulte
Como o Chat identifica usuários.
Auditar e gerenciar espaços
Os cenários a seguir são maneiras de você, como administrador do Google Workspace, auditar e gerenciar os espaços da sua organização com a API Chat.
Encontrar e excluir espaços inativos
Os espaços do Chat não utilizados podem ocupar um espaço de armazenamento valioso e criar confusão na interface do usuário. Os administradores podem usar
spaces.search
para encontrar os espaços inativos e
spaces.delete
para excluí-los. Para mais orientações e um exemplo de código, consulte
Encontrar e excluir espaços inativos do Chat.
Auditar espaços na organização
Usando spaces.search,
os administradores podem recuperar uma lista de todos os espaços em uma organização com informações detalhadas
sobre as configurações e metadados de cada espaço, como data de criação, data da última atividade, número de membros, status da configuração do histórico e capacidade
de convidar pessoas externas.
Exportar uma lista de espaços com base em critérios de pesquisa
Usando spaces.search,
os administradores podem recuperar uma lista de espaços que atendem aos critérios especificados na
query
e exportar os resultados para um arquivo CSV para análise.
Encontrar membros de um espaço com base em critérios de pesquisa
Usando spaces.members.list,
os administradores podem recuperar uma lista de membros de qualquer espaço na organização e
analisar os resultados de critérios específicos.
Encontrar administradores de um espaço
Usando spaces.members.list,
os administradores podem recuperar uma lista de membros de um espaço filtrado para
MembershipState=ROLE_MANAGER.
Para encontrar todos os administradores de espaço na sua organização, em todos os espaços, você pode
usar spaces.search para
listar todos eles. Em seguida, para cada espaço na lista, use spaces.members.list para recuperar os administradores.
Temas relacionados
- Autenticar e autorizar usando privilégios de administrador
- Pesquisar e gerenciar espaços do Google Chat com a API Google Chat como administrador do Google Workspace
spaces.searchmétodo