SDK Admin do Google Workspace

Com o conector do SDK Admin do Google Workspace, você pode executar as operações compatíveis no SDK Admin do Google Workspace.

Antes de começar

Antes de usar o conector do SDK Admin do Google Workspace, faça o seguinte:

  • No seu projeto do Google Cloud, faça o seguinte:
    • Conceda a função IAM roles/connectors.admin ao usuário que está configurando o conector.
    • Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. Para mais informações, consulte Como criar uma conta de serviço.

    • Ative os seguintes serviços:
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Para entender como ativar os serviços, consulte Como ativar serviços.

    Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.

  • Se você estiver usando a autenticação da conta de serviço em vez da autenticação OAuth 2.0, verifique se as permissões adequadas foram concedidas à conta de serviço. Para mais informações, consulte Papéis e permissões do IAM.

Configurar o conector

Para configurar o conector, crie uma conexão com a fonte de dados (sistema de back-end). Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, siga estas etapas:

  1. No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.

    Acessar a página "Conexões"

  2. Clique em + Criar novo para abrir a página Criar conexão.
  3. Na seção Local, escolha o local da conexão.
    1. Região: selecione um local na lista suspensa.

      Para conferir a lista de todas as regiões com suporte, consulte Locais.

    2. Clique em Próxima.
  • Na seção Detalhes da conexão, defina os seguintes campos:
    1. Conector: selecione SDK para administradores do Google Workspace na lista suspensa de conectores disponíveis.
    2. Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
    3. No campo Nome da conexão, insira um nome para a instância de conexão.

      Os nomes de conexão precisam atender aos seguintes critérios:

      • Os nomes de conexões podem usar letras, números ou hifens.
      • As letras precisam ser minúsculas.
      • Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
      • Os nomes das conexões não podem exceder 63 caracteres.
    4. Como opção, insira uma Descrição para a instância de conexão.
    5. Opcionalmente, selecione Ativar o Cloud Logging se quiser registrar os detalhes da execução do conector.
    6. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
    7. Opcionalmente, defina as Configurações do nó de conexão:

      • Número mínimo de nós: digite o número mínimo de nós de conexão.
      • Número máximo de nós: digite o número máximo de nós de conexão.

      Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir qualquer valor, por padrão, os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.

    8. Outra opção é clicar em + Adicionar rótulo para adicionar um rótulo à conexão na forma de um par de chave-valor.
    9. Clique em Próxima.
    10. Na seção Autenticação, insira os detalhes da autenticação.
      1. Selecione um Tipo de autenticação e insira os detalhes relevantes.

        Você pode escolher um dos seguintes tipos de autenticação:

        • OAuth 2.0
        • Conta de serviço

        2. Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.

      2. Clique em Next.
    11. Revisão: revise os detalhes de conexão e autenticação.
    12. Clique em Criar.

    Configurar a autenticação

    Digite os detalhes com base na autenticação que você quer usar.

    • OAuth 2.0
      • ID do cliente: o ID do cliente necessário para se conectar ao seu serviço de back-end do Google.
      • Escopos: selecione os escopos OAuth 2.0 necessários no menu suspenso. Para acessar todos os escopos do OAuth 2.0 compatíveis para o serviço necessário do Google, consulte a seção relevante na página Escopos do OAuth 2.0 para APIs do Google.
      • Chave secreta do cliente: selecione a chave secreta do Secret Manager que contém a senha associada a ela.
      • Versão do secret: selecione a versão do secret.
    • Conta de serviço

      Selecione essa opção para fazer a autenticação usando a conta de serviço que você forneceu nas etapas anteriores ao configurar essa conexão. Verifique se você tem forneceu à conta de serviço as permissões e os papéis do IAM relevantes necessários para a autenticação.

      • Escopos: selecione os escopos OAuth 2.0 necessários no menu suspenso. Para mais informações, consulte Escopos de acesso.

    Ações

    Esse conector fornece uma camada de abstração para os objetos do o serviço de back-end conectado. É possível acessar os objetos do back-end somente por meio dessa abstração. A abstração é exposta a você como ações. Um Action é a primeira classe. que é disponibilizada para a função de integração pela interface do conector. Uma ação permite que você faça alterações em uma ou mais entidades e varia do ao conector. No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions vai ficar vazia.

    Usar a conexão do SDK Admin do Google Workspace em uma integração

    Depois de criar a conexão, ela fica disponível na integração do aplicativo. É possível usar a conexão em uma integração pela tarefa de conectores.

    Receber ajuda da comunidade do Google Cloud

    Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.

    A seguir

    •