Dropbox

Com o conector do Dropbox, você pode se conectar a uma instância do Dropbox e realizar as operações aceitas.

Antes de começar

Antes de usar o conector do Dropbox, execute as seguintes tarefas:

• No seu projeto do Google Cloud, faça o seguinte:
  • Conceder o papel do IAM roles/connectors.admin ao usuário e configurar 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.

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.
4. Na seção Detalhes da conexão, faça o seguinte:
   1. Conector: selecione Caixa de depósito 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. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
   6. 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.

   Observação: você só poderá personalizar os valores do nó de conexão se for um cliente de pagamento por utilização.
   7. Impersonate User Id: especifica o ID do usuário a ser personificado.
   8. Personificar o modo de usuário: especifique o tipo de personificação de usuário. Precisa ser o modo "Usuário" ou "Administrador".
   9. Incluir subdiretórios:opcionalmente, se você quiser incluir subdiretórios ao listar arquivos e pastas.
   10. Incluir recursos da equipe:como opção, se você quiser incluir arquivos e pastas de equipes.
   11. Também é possível clicar em + Adicionar rótulo para adicionar um rótulo à conexão na forma de um par de chave-valor.
   12. Clique em Próxima.
5. Na seção Autenticação, insira os detalhes da autenticação.
   1. Selecione um Tipo de autenticação e insira os detalhes relevantes.

      Os seguintes tipos de autenticação oferecem suporte à conexão do Dropbox:

      • Concessão de código de autenticação OAuth 2.0

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

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

Configurar a autenticação

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

• Concessão de código de autenticação OAuth 2.0
  • ID do cliente: o ID usado para solicitar tokens de acesso.
  • Escopos: é uma lista separada por vírgulas dos escopos desejados do portal de permissões da caixa de depósito.
  • Chave secreta do cliente: usada para solicitar tokens de acesso.

Entidades, operações e ações

Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.

Observação:você pode ver as entidades, as operações e as ações de um conector na tarefa de conectores.

• Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.

  No entanto, é possível que um conector não aceite ou não tenha entidades. Nesse caso, a lista Entities estará vazia.

• Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar qualquer uma das seguintes operações em uma entidade:
  • Lista
  • Receber
  • Criar
  • Atualizar
  • Excluir

  Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não oferecer suporte a nenhuma das operações da entidade, como as operações não estão listadas na lista Operations.

• Ação: uma ação é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. Normalmente, uma ação tem alguns parâmetros de entrada, . No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

.

Observação : todas as entidades e ações têm um esquema associado a elas. Por exemplo, um esquema de ação terá os detalhes do parâmetro como: o parâmetro e o tipo de dados correspondente. O esquema (metadados) de entidades e ações é buscado pela conexão em do seu back-end. Se houver atualizações no esquema, elas não serão refletidas automaticamente nas conexões atuais. atualize manualmente o esquema. Atualizar o esquema de uma conexão, abra a página Detalhes da conexão e clique em Atualizar o esquema de conexão.

Limitações do sistema

O conector do Dropbox pode processar 18 transações por segundo, por nó, e throttles as transações além desse limite. Por padrão, o Integration Connectors aloca dois nós para melhor disponibilidade para uma conexão.

Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.

Observação:o número de nós do Integration Connectors será escalonado automaticamente de maneira dinâmica com base no seu uso. No entanto, se você quiser reservar capacidade para grandes volumes aguardando o escalonamento automático, ajuste o valor mínimo do nó para uma conexão. Mais nós são necessários para processar mais transações para uma conexão. Por outro lado, menos nós são necessários se uma conexão processa menos transações. Para configurar o nó , faça o seguinte:

• Se você é um cliente de pagamento por uso, configure os valores mínimo e máximo do nó na página "Editar conexão".
• Se você tiver uma assinatura entre em contato com o suporte.

O número máximo de transações que um nó pode processar depende de vários fatores. Portanto, antes de ajustar os nós mínimos para melhorar a capacidade de processamento, verifique se os sistemas de back-end estão configurados de maneira ideal para lidar com o tráfego necessário.

Ações

Nesta seção, listamos as ações compatíveis com o conector. Para entender como configurar as ações, consulte Exemplos de ação.

Observação:os resultados de todas as ações estarão disponíveis como um Resposta JSON no connectorOutputPayload da tarefa Connectors depois de executar a integração.

Ação CopyResource

Essa ação permite copiar um arquivo ou uma pasta para um local diferente no Dropbox do usuário.

Parâmetros de entrada da ação CopyResource

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
From_Path	String	Sim	Caminho no Dropbox do usuário para ser copiado ou movido.
To_Path	String	Sim	Caminho de destino no Dropbox do usuário para o recurso copiado.
Renomear automaticamente	String	Não	Se houver um conflito, faça com que o servidor Dropbox tente renomear o arquivo automaticamente para evitar o conflito. O padrão para este campo é Falso.
Allow_Ownership_Transfer	String	Não	Permitir movimentos por proprietário mesmo que isso resulte na transferência de propriedade do conteúdo que está sendo movido. Isso não se aplica a cópias. O padrão para esse campo é "False".
ObjectPathsAggregate	String	Não	Um agregado que representa o caminho do objeto. Também pode ser o nome de uma tabela #TEMP.

Para saber como configurar a ação CopyResource, consulte Exemplos de ação.

Ação CreateFolder

Essa ação permite criar uma pasta em um determinado caminho.

Parâmetros de entrada da ação CreateFolder

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
Caminho	String	Sim	Caminho no Dropbox do usuário a ser criado.
AutoRename	Booleano	Não	Se houver um conflito, peça para o servidor do Dropbox tentar renomear a pasta automaticamente para evitar o conflito. O valor padrão é falso.
ForceAsync	Booleano	Não	Define se a criação deve ocorrer de forma assíncrona. Disponível apenas ao usar ObjectPathsAggregate. O valor padrão é falso.
ObjectPathsAggregate	String	Não	Um agregado JSON que representa os caminhos. Também pode ser o nome de uma tabela #TEMP.

Por exemplo, sobre como configurar a ação CreateFolder, consulte Exemplos de ação.

Ação DeleteResource

Essa ação permite excluir o arquivo ou a pasta em um determinado caminho. Se o caminho for uma pasta, todo o conteúdo dela também será excluído.

Parâmetros de entrada da ação DeleteResource

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
Caminho	String	Sim	Identificador exclusivo do arquivo ou da pasta.
ObjectPathsAggregate	String	Não	Um agregado que representa o caminho do objeto. Também pode ser o nome de uma tabela #TEMP.

Por exemplo, sobre como configurar a ação DeleteResource, consulte Exemplos de ação.

Ação MoveResource

Mova um arquivo ou uma pasta para outro local no Dropbox do usuário. Se o caminho de origem for uma pasta, todo o conteúdo dela será movido. No momento, não oferecemos suporte à renomeação somente de maiúsculas e minúsculas.

Parâmetros de entrada da ação MoveResource

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
From_Path	String	Sim	Caminho no Dropbox do usuário para ser copiado ou movido.
To_Path	String	Sim	Caminho no Dropbox do usuário que é o destino.
Renomear automaticamente	String	Não	Se houver um conflito, faça com que o servidor Dropbox tente renomear o arquivo automaticamente para evitar o conflito. O padrão para este campo é Falso.
Allow_Ownership_Transfer	String	Não	Permitir movimentos por proprietário mesmo que isso resulte na transferência de propriedade do conteúdo que está sendo movido. Isso não se aplica a cópias. O padrão para esse campo é "False".
ObjectPathsAggregate	String	Não	Um agregado que representa o caminho do objeto. Também pode ser o nome de uma tabela #TEMP.

Por exemplo, sobre como configurar a ação MoveResource, consulte Exemplos de ação.

Ação RenomearResource

Essa ação permite renomear um recurso fornecendo um caminho e um novo nome.

Parâmetros de entrada da ação RenomearResource

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
Caminho	String	Sim	O caminho para o recurso a ser renomeado. Por exemplo: /myFolder/sample.txt
NewName	String	Sim	O novo nome do recurso. Por exemplo: sampleDocument.txt

Por exemplo, sobre como configurar a ação RenameResource, consulte Exemplos de ação.

Ação Cancelar compartilhamento de pasta

Esta ação permite cancelar o compartilhamento de uma pasta. Requer o escopo sharing.write.

Parâmetros de entrada da ação UnshareFolder

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
FolderId	String	Sim	O ID da pasta compartilhada para cancelar o compartilhamento.
LeaveCopy	String	Não	Se verdadeiro, os participantes desta pasta compartilhada receberão uma cópia dela após o compartilhamento ser cancelado. O valor padrão é falso.

Por exemplo, sobre como configurar a ação UnshareFolder, consulte Exemplos de ação.

Ação DownloadFile

Esta ação permite fazer o download de um arquivo. Requer o escopo files.content.read.

Parâmetros de entrada da ação DownloadFile

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
ID	String	Sim	O ID do documento que será transferido por download.
Revisão	String	Não	A revisão do documento a ser transferida por download, por exemplo, "rev:a1c10ce0dd78".
Caminho	String	Não	O caminho do arquivo ou da pasta para download.
AsZip	Booleano	Não	Fazer o download de uma pasta em um formato ZIP. Precisa ser definido como verdadeiro para fazer o download de uma pasta.
FileStream	String	Não	Uma instância de um stream de saída em que os dados do arquivo são gravados. Usado apenas se DownloadTo não estiver definido.
DownloadTo	String	Não	O caminho da pasta para fazer o download do arquivo.
FileType	String	Sim	O tipo de arquivo(arquivo ou papel)

Por exemplo, sobre como configurar o DownloadFile, consulte os Exemplos de ação.

Exemplos de ação

Esta seção descreve como executar algumas das ações neste conector.

Exemplo: copiar um recurso

O exemplo a seguir mostra como copiar um recurso com o caminho especificado para um caminho diferente:

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação CopyResource e clique em Concluído.
3. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

   {
     "From_Path": "/DropboxFolder/pptxFile.pptx",
     "To_Path": "/DropBoxFolder2/Folder/pptFile.pptx"
   }

Se a ação for bem-sucedida, o CopyResource resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

[ { "Success": "true", "metadata_.tag": "file", 
  "metadata_name": "pptxFile.pptx", 
  "metadata_path_lower": "/testingdropboxupdated/abcde/pptxfile.pptx", 
  "metadata_path_display": "/TestingDropBoxUpdated/abcde/pptxFile.pptx", 
  "metadata_parent_shared_folder_id": "3204685267", "metadata_id": "id:8-07A6kHAoIAAAAAAAAC1w",
  "metadata_client_modified": "2024-06-13T11:06:37Z", "metadata_server_modified": "2024-07-12T10:19:02Z",
  "metadata_rev": "61d0a3560ecb5bf039dd3", "metadata_size": "17052", 
  "metadata_sharing_info_read_only": "false", "metadata_sharing_info_parent_shared_folder_id": "3204685267",
  "metadata_sharing_info_modified_by": "dbid:AACVLctlrEo-ouTSxUVSTi0loZCSZKc933A", 
  "metadata_is_downloadable": "true", 
  "metadata_content_hash": "0234f7d4eaf914cb276716c8b2a24e24655d1f6f39ee549207e33a4255e2fba2" } ]

Exemplo: criar uma pasta

O exemplo abaixo mostra como criar uma pasta em um determinado caminho:

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação CreateFolder e clique em Concluído.
3. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

   {
     "Path": "/TestDrobBoxFolder/newFolder"
   }

Se a ação for bem-sucedida, a resposta connectorOutputPayload da tarefa CreateFolder terá um valor semelhante ao seguinte:

[ { "Id": "id:8-07A6kHAoIAAAAAAAAC2Q" } ]

Exemplo: excluir um recurso

O exemplo a seguir mostra como excluir um recurso:

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação DeleteResource e clique em Concluído.
3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
     "Path": "/TestingDropBox/FolderToBeDeletedName"
   }

Se a ação for bem-sucedida, o DeleteResource resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

[{
"Status": "Success"
}]

Exemplo: mover um recurso

O exemplo abaixo mostra como mover um recurso:

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação MoveResource e clique em Concluído.
3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
     "From_Path": "/TestDropBoxFolder/Folder1/dummypdf2.pdf",
     "To_Path": "/EmptyFolder/Folder1/dummypdf2.pdf"
   }

Se a ação for bem-sucedida, o MoveResource resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

[{
  "Status": "Success"
  }]

Exemplo: renomear um recurso

O exemplo abaixo mostra como renomear um recurso:

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação RenameResource e clique em Concluído.
3. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

   {
     "Path": "/TestDropBox/abcd",
     "NewName": "abcded"
   }

Se a ação for bem-sucedida, o RenameResource resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

[{
"Status": "Success"
}]

Exemplo: cancelar o compartilhamento de uma pasta

O exemplo a seguir mostra como cancelar o compartilhamento de uma pasta:

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação UnshareFolder e clique em Concluído.
3. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

   {
     "FolderId": "3336772979"
   }

Se a ação for bem-sucedida, o UnshareFolder resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

[{
"Status": "Success"
}]

Exemplo: fazer o download de um arquivo

O exemplo abaixo mostra como fazer o download de um arquivo:

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação DownloadFile e clique em Concluído.
3. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

   {
     "Id": "id:8-07A6kHAoIAAAAAAAABcg",
     "FileType": "file"
   }

Se a ação for bem-sucedida, o DownloadFile resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

[ { "Success": "true", "Name": "license.txt", 
  "Id": "id:8-07A6kHAoIAAAAAAAABcg", "ClientModified": "2024-07-09T09:52:41Z", 
  "ServerModified": "2024-07-09T09:52:41Z", "Revision": "61ccd7da2b987c0f52053", "Size": "11", 
  "LowerCasePath": "/sahil kapoor/testingdropboxupdated/uploadfolderwithnestedfolder/nestedfolder2/license.txt",
   "DisplayPath": "/Sahil Kapoor/TestingDropBoxUpdated/uploadFolderWithNestedFolder/NestedFolder2/license.txt",
    "PreviewURL": null, "IsDownloadable": "true", "HasExplicitSharedMembers": null, 
  "ContentHash": "f6dc724d119649460e47ce719139e521e082be8a9755c5bece181de046ee65fe", "Owner": null,
  "Title": null, "MimeType": null, "FileData": "SGVsbG8gd29ybGQ=", "parent_shared_folder_id": "3237290067",
  "sharing_info_read_only": "false", "sharing_info_parent_shared_folder_id": "3237290067", 
  "sharing_info_modified_by": "dbid:AACVLctlrEo-ouTSxUVSTi0loZCSZKc933A" } ]

Usar a conexão do Dropbox em uma integração

Depois que você cria a conexão, ela fica disponível nos Apigee Integration e Application Integration. Você pode usar a conexão em uma integração pela tarefa Conectores.

• Para entender como criar e usar a tarefa "Connectors" na integração da Apigee, consulte Tarefa Connectors.
• Para entender como criar e usar a tarefa Conectores no Application Integration, consulte Tarefa 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

• Entenda como suspender e retomar uma conexão.
• Entenda como monitorar o uso do conector.
• Saiba como acessar os registros do conector.