Criar e configurar uma conexão do Google Drive

A página descreve como criar e configurar uma conexão do Google Drive no Integration Connectors. Para mais informações sobre o conector do Google Drive, consulte Visão geral do conector do Google Drive.

Antes de começar

No projeto Google Cloud, faça o seguinte:

  • Verifique se a conectividade de rede está configurada. Para informações sobre padrões de rede, consulte Conectividade de rede.
  • Conceda o papel do IAM roles/connectors.admin ao usuário que está configurando o conector.
  • Conceda os papéis do IAM roles/secretmanager.viewer e roles/secretmanager.secretAccessor à conta de serviço que você quer usar para o conector.
  • 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.

Criar uma conexão do Google Drive

Para criar uma conexão com o Google Drive, faça o seguinte:

  1. No console do Google Cloud , acesse a página Integration Connectors > Conexões.

    Acessar "Conexões"

  2. Clique em Criar conexão.

    A página Criar conexão é exibida.

  3. Na seção Local:
    1. Clique em Região e selecione um local para a conexão.

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

    2. Clique em Próxima.
  4. Na seção Detalhes da conexão, forneça as seguintes informações:
    1. Conector: selecione Google Drive.
    2. Versão do conector: selecione a versão do conector que você quer usar.

      A versão do conector que você seleciona depende da versão da API Google Drive que você quer usar. Para mais informações, consulte Versões de conexão do Google Drive.

    3. Nome da conexão: insira um nome para a conexão.
    4. Descrição: (opcional) insira uma descrição para a conexão.
    5. Se quiser, ative o Cloud Logging e selecione um nível de registro. Por padrão, o nível de registro é definido como Error.
    6. Conta de serviço: selecione a conta de serviço que você quer usar para a conexão. Verifique se a conta de serviço tem os papéis e permissões do IAM relevantes necessários.
    7. Suporta todos os drives: marque essa caixa de seleção para ativar o acesso aos drives compartilhados. Essa opção está disponível apenas para o Google Drive v2.
    8. Configurações do nó de conexão: (opcional) 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.

    9. Clique em Próxima.
  5. Na seção Autenticação, selecione e configure o tipo de autenticação para a conexão:

    Conta de serviço

    Selecione essa opção se o aplicativo for executado em uma máquina virtual do Google Cloud e precisar usar a conta de serviço anexada da VM para autenticação.

    Para usar esse tipo de autenticação, você precisa ter uma conta de serviço com os papéis e permissões do IAM relevantes necessários para a autenticação.

    Para informações sobre como criar uma conta de serviço, consulte Como criar e gerenciar contas de serviço. Para informações sobre como conceder papéis a uma conta de serviço, consulte Como conceder, alterar e revogar o acesso a recursos.

    Exemplo de detalhes de conexão para o tipo de autenticação de conta de serviço

    Nome do campo Detalhes
    Local us-central1
    Conector Google Drive
    Versão do conector 2
    Nome da conexão googledrive-ws-gcpaccount
    Ativar Cloud Logging Sim
    Conta de serviço 123456789012-compute@developer.gserviceaccount.com
    Número mínimo de nós 2
    Número máximo de nós 50
    Autenticação Autenticação da conta de serviço

    OAuth 2.0: portador JWT

    Para configurar o tipo de autenticação de portador JWT do OAuth 2.0, faça o seguinte:

    1. Crie uma chave JSON da conta de serviço e faça o download do arquivo dela. Esse arquivo de chave é usado como o certificado JWT para a conexão.
    2. Crie um secret para armazenar o arquivo de chave JSON ou o certificado JWT.
    3. Forneça os detalhes do secret ao criar a conexão no Integration Connectors:
      • Certificado JWT: escolha o secret que contém o certificado JWT.
      • Versão do secret: selecione a versão do secret escolhido.
      • Assunto do JWT: (opcional) insira o assunto do JWT a ser usado na conexão. Ele é usado como o campo sub no token JWT.

    Exemplo de detalhes de conexão para o tipo de autenticação de portador JWT do OAuth 2.0

    Nome do campo Detalhes
    Local us-central1
    Conector Google Drive
    Versão do conector 2
    Nome da conexão googledrivejwt
    Ativar Cloud Logging Sim
    Conta de serviço 123456789012-compute@developer.gserviceaccount.com
    Número mínimo de nós 2
    Número máximo de nós 50
    Autenticação OAuth 2.0: portador JWT
    Certificado JWT 
    {
  "type": "service_account",
  "project_id": "sm****-****-******",
  "private_key_id": "0b***************************",
  "private_key": "-----BEGIN PRIVATE KEY-----\nO********************************************=\n-----END PRIVATE KEY-----\n",
  "client_email": "go**********************************8",
  "client_id": "10**********************",
  "auth_uri": "https:***********************",
  "token_uri": "https:************************",
  "auth_provider_x509_cert_url": "https:*********************",
  "client_x509_cert_url": "https:****************************************************",
  "universe_domain": "go********"
}
    Versão do secret 2

    Código de autorização do OAuth 2.0

    Use esse método se o aplicativo exigir interação do usuário final por um login baseado em navegador.

    Para configurar o tipo de autenticação de código de autorização do OAuth 2.0, faça o seguinte:

    1. Crie credenciais do OAuth 2.0 para seu aplicativo da Web. Esse processo cria um ID do cliente e o arquivo JSON da chave secreta do cliente.
    2. Identifique os escopos de acesso que você quer conceder ao aplicativo.
    3. Crie uma chave secreta para armazenar as credenciais do OAuth 2.0 (client_secret.json).
    4. Forneça o ID do cliente, os escopos e os detalhes do Secret ao criar a conexão no Integration Connectors:
      • ID do cliente: insira o ID do cliente criado para seu aplicativo da Web.
      • Escopos: insira uma lista separada por vírgulas dos escopos desejados.
      • Chave secreta do cliente: escolha o Secret que contém as credenciais do OAuth 2.0.
      • Versão do secret: selecione a versão do secret escolhido.

    Exemplo de detalhes de conexão para o tipo de autenticação de código de autorização do OAuth 2.0

    Nome do campo Detalhes
    Local europe-west1
    Conector Google Drive
    Versão do conector 2
    Nome da conexão googledrive-wsconn-code
    Ativar Cloud Logging Sim
    Conta de serviço 123456789012-compute@developer.gserviceaccount.com
    Número mínimo de nós 2
    Número máximo de nós 50
    Autenticação Código de autorização OAuth 2.0
    ID do cliente CLIENT_ID
    Escopos https://www.googleapis.com/auth/drive, https://www.googleapis.com/auth/drive.readonly, https://www.googleapis.com/auth/drive.file, https://www.googleapis.com/auth/drive.appdata, https://www.googleapis.com/auth/drive.appfolder, https://www.googleapis.com/auth/drive.install, https://www.googleapis.com/auth/drive.metadata, https://www.googleapis.com/auth/drive.metadata.readonly, https://www.googleapis.com/auth/drive.activity, https://www.googleapis.com/auth/drive.activity.readonly, https://www.googleapis.com/auth/drive.apps.readonly, https://www.googleapis.com/auth/drive.scripts e https://www.googleapis.com/auth/drive.meet.readonly
    Chave secreta do cliente CLIENT_SECRET
    Versão do secret 2
  6. Ativar substituição de autenticação: (opcional) marque essa caixa de seleção para permitir que a conexão aceite uma autenticação diferente de forma dinâmica durante a execução.
  7. Clique em Próxima.
  8. Na seção Revisão, revise os detalhes de conexão e autenticação. Você pode clicar em qualquer uma das seções anteriores para fazer mudanças, se necessário.
  9. Clique em Criar.

    O Integration Connectors começa a criar a conexão para a configuração fornecida. Esse processo leva alguns minutos para ser concluído. Depois que a conexão for criada, você será redirecionado para a página Conexões.

Usar a conexão do Google Drive em uma integração

Depois de criar a conexão, ela fica disponível na integração da Apigee e no Application Integration. É possível usar a conexão em uma integração pela tarefa de conectores.

  • Para entender como criar e usar a tarefa "Conectores" na integração da Apigee, consulte Tarefa "Conectores".
  • Para entender como criar e usar a tarefa "Conectores" na Application Integration, consulte Tarefa "Conectores".

Para conferir a lista de entidades e operações compatíveis, consulte Entidades e operações compatíveis. Para informações sobre as ações específicas do conector compatíveis, consulte Ações compatíveis.

Exemplos de casos de uso na Application Integration

Os exemplos a seguir mostram como usar a tarefa de conectores na Application Integration para realizar operações usando sua conexão configurada do Google Drive.

Exemplo: listar todos os arquivos

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Files na lista Entity.
  3. Selecione a operação List e clique em Concluído.
  4. Na seção Entrada de tarefa da tarefa Conectores, é possível definir a filterClause de acordo com a exigência do cliente.

    5. O valor de filterClause sempre precisa ser transmitido entre aspas simples (') neste formato.

    É possível usar o filterClause para filtrar um determinado conjunto de registros com base em qualquer coluna.

Exemplo: receber os detalhes de um arquivo

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Files na lista Entity.
  3. Selecione a operação Get e clique em Concluído.
  4. Defina o entityId como "1wsHFAusizqFe5O2", que é a chave a ser transmitida. Para definir o entityId, na seção Data Mapper do Data Mapping, clique em Open Data Mapping Editor e insira "1wsHFAusizqFe5O2" no campo Input Value. Escolha entityId como variável local.

    5. O valor de entityId precisa ser transmitido diretamente, como "1wsHFAusizqFe5O2". Aqui, "1wsHFAusizqFe5O2" é o valor exclusivo da chave primária, que é transmitido.

Exemplo: excluir um arquivo

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Files na lista Entity.
  3. Selecione a operação Delete e clique em Concluído.
  4. Defina o entityId como "1nLrFkDM8nOehXwW8XEpc2UZDBrq_ku-L", que é a chave a ser transmitida. Para definir o entityId, na seção Data Mapper do Data Mapping, clique em Open Data Mapping Editor e insira "1nLrFkDM8nOehXwW8XEpc2UZDBrq_ku-L" no campo Input Value. Escolha entityId como variável local.

    5. Se a entidade tiver duas chaves primárias ou de negócios compostas, em vez de especificar o entityId, você também poderá definir o filterClause como id='1nLrFkDM8nOehXwW8XEpc2UZDBrq_ku-L'.

Exemplo: criar um arquivo

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Files na lista Entity.
  3. Selecione a operação Create e clique em Concluído.
  4. Na seção Data Mapper da tarefa Data Mapping, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value. Escolha entityId/connectorInputPayload como variável local.
    5.   { "FileData": " ",
  "Name": "creategcpshareddrivedocxfile.docx", 
  "MIMEType": "application/vnd.google-apps.document",
  "Encoding": "BASE64"}

    Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

    { "Id": "1C48uLda6lyeakx2hOUdwnib-qtFOAhlpR_Ja2AmPvTU"}

Exemplo: criar um drive compartilhado

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Drives na lista Entity.
  3. Selecione a operação Create e clique em Concluído.
  4. Na seção Data Mapper da tarefa Data Mapping, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value. Escolha entityId/connectorInputPayload como variável local.
    5.   {"Name": "SharedDrive7"}

    Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

      {"Id": "0AN6y5wEvVrmPUk9PVA"}

Exemplo: criar uma permissão para um arquivo, uma pasta ou um drive compartilhado

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Permissions na lista Entity.
  3. Selecione a operação Create e clique em Concluído.
  4. Na seção Data Mapper da tarefa Data Mapping, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value. Escolha entityId/connectorInputPayload como variável local.
    5.   {"ResourceId": "1PErCmc9MmnYzcslo49DeIIN1-ACs3W4L",
  "Role": "COMMENTER",
  "Type": "USER",
  "EmailAddress": "charlie@altostrat.com"}

    Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

      { "PermissionId": "10596783046483894074",
  "ResourceId": "1PErCmc9MmnYzcslo49DeIIN1-ACs3W4L"}

Exemplo: atualizar os detalhes de um arquivo

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Files na lista Entity.
  3. Selecione a operação Update e clique em Concluído.
  4. Na seção Data Mapper da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value. Escolha entityId/connectorInputPayload/filterClause como variável local. 
      {"Name": "New Updated file"}
  5. Defina o entityId do arquivo. Para definir o entityId, clique em Open Data Mapping Editor, insira um valor semelhante ao seguinte no campo Input Value e escolha entityId/connectorInputPayload/filterClause como variável local.

    Em vez de especificar o entityId, você também pode definir a filterClause como 1IY5YhQN-LRgR3IxKlheqXM83sJP3DMFm.

    6. A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

    {"Id": "1IY5YhQN-LRgR3IxKlheqXM83sJP3DMFm">}

Exemplo: atualizar uma permissão para um arquivo, uma pasta ou um drive compartilhado

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Permissions na lista Entity.
  3. Selecione a operação Update e clique em Concluído.
  4. Na seção Data Mapper da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value. Escolha entityId/connectorInputPayload/filterClause como variável local.
    5. (PermissionId='10596783046483894074' and ResourceId='0AKfRSSy6kZbfUk9PVA')
{ "Role": "READER"}
  5. Defina o entityId da permissão. Para definir o entityId, clique em Open Data Mapping Editor, insira um valor semelhante ao seguinte no campo Input Value e escolha entityId/connectorInputPayload/filterClause como variável local.

    Em vez de especificar o entityId, você também pode definir a filterClause como PermissionId='10596783046483894074' and ResourceId='0AKfRSSy6kZbfUk9PVA'.

    A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

      {"PermissionId": "10596783046483894074",
  "ResourceId": "0AKfRSSy6kZbfUk9PVA"}