Dropbox

Le connecteur Dropbox vous permet de vous connecter à une instance Dropbox et d'effectuer les opérations compatibles.

Avant de commencer

Avant d'utiliser le connecteur Dropbox, effectuez les tâches suivantes :

  • Dans votre projet Google Cloud :
    • Assurez-vous que la connectivité réseau est configurée. Pour en savoir plus sur les schémas de réseau, consultez Connectivité réseau.
    • Attribuez le rôle IAM roles/connectors.admin à l'utilisateur qui configure le connecteur.
    • Attribuez les rôles IAM suivants au compte de service que vous souhaitez utiliser pour le connecteur :
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Un compte de service est un type spécial de compte Google destiné à représenter un utilisateur non humain qui doit s'authentifier et obtenir les autorisations permettant d'accéder aux données des API Google. Si vous ne possédez pas de compte de service, vous devez en créer un. Pour plus d'informations, consultez Créer un compte de service.

    • Activez les services suivants :
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Pour savoir comment activer des services, consultez Activer des services.

    Si ces services ou autorisations n'ont pas encore été activés pour votre projet, vous êtes invité à les activer au moment de configurer le connecteur.

Configurer le connecteur

Une connexion est propre à une source de données. Cela signifie que si vous disposez de nombreuses sources de données, vous devez créer une connexion distincte pour chacune d'elles. Pour créer une connexion, procédez comme suit :

  1. Dans la console Cloud, accédez à la page Connecteurs d'intégration > Connexions, puis sélectionnez ou créez un projet Google Cloud.

    Accéder à la page "Connexions"

  2. Cliquez sur + Créer pour ouvrir la page Créer une connexion.
  3. Dans la section Emplacement, choisissez l'emplacement de la connexion.
    1. Région : sélectionnez un emplacement dans la liste déroulante.

      Pour obtenir la liste de toutes les régions disponibles, consultez Emplacements.

    2. Cliquez sur SUIVANT.
  4. Dans la section Détails de connexion, procédez comme suit :
    1. Connecteur : sélectionnez Dropbox dans la liste déroulante des connecteurs disponibles.
    2. Version du connecteur : sélectionnez la version du connecteur dans la liste déroulante des versions disponibles.
    3. Dans le champ Nom de connexion, indiquez le nom de l'instance de connexion.

      Les noms de connexion doivent répondre aux critères suivants :

      • Ils peuvent contenir des lettres, des chiffres ou des traits d'union.
      • Les lettres doivent être en minuscules.
      • Ils doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
      • Ils ne peuvent pas dépasser 49 caractères.
    4. (Facultatif) Saisissez une description de l'instance de connexion.
    5. Compte de service : sélectionnez un compte de service disposant des rôles requis.
    6. (Facultatif) Configurez les paramètres de nœuds de connexion :

      • Nombre minimal de nœuds : saisissez le nombre minimal de nœuds de connexion.
      • Nombre maximal de nœuds : saisissez le nombre maximal de nœuds de connexion.

      Un nœud est une unité (ou instance répliquée) de connexion qui traite des transactions. Pour traiter davantage de transactions pour une connexion, vous devez disposer de plus de nœuds. À l'inverse, moins de nœuds sont nécessaires si une connexion traite moins de transactions. Pour comprendre comment les nœuds affectent la tarification de votre connecteur, consultez Tarifs des nœuds de connexion. Si vous ne saisissez aucune valeur, le nombre minimal de nœuds est défini par défaut sur 2 (pour améliorer la disponibilité) et le nombre maximal de nœuds sur 50.

    7. ID utilisateur à emprunter (facultatif) : permet de spécifier l'ID utilisateur à emprunter.
    8. Mode d'emprunt d'identité (facultatif) : permet de spécifier le type d'emprunt d'identité. Il doit s'agir du mode utilisateur ou du mode administrateur.
    9. Inclure les sous-répertoires (facultatif) : permet d'indiquer si vous souhaitez inclure les sous-répertoires lors de la création de la liste des fichiers et des dossiers.
    10. Inclure les ressources d'équipe (facultatif) : permet d'indiquer si vous souhaitez inclure les fichiers et les dossiers d'équipe.
    11. (Facultatif) Cliquez sur + Ajouter une étiquette pour ajouter une étiquette à la connexion sous la forme d'une paire clé/valeur.
    12. Cliquez sur Suivant.
  5. Dans la section Authentification, saisissez les informations d'authentification.
    1. Sélectionnez un type d'authentification, puis saisissez les informations appropriées.

      Le type d'authentification suivant est compatible avec la connexion Dropbox :

      • Attribution de code d'autorisation OAuth 2.0
    2. Pour savoir comment configurer ce type d'authentification, consultez Configurer l'authentification.

    3. Cliquez sur Suivant.
  6. Vérifier : vérifiez vos informations de connexion et d'authentification.
  7. Cliquez sur Créer.

Configurer l'authentification

Saisissez les informations en fonction de l'authentification que vous souhaitez utiliser.

  • Attribution de code d'autorisation OAuth 2.0
    • ID client : ID client utilisé pour demander des jetons d'accès
    • Niveaux d'accès : liste des niveaux d'accès souhaités, séparés par une virgule, provenant du portail des autorisations Dropbox
    • Code secret du client : code secret du client utilisé pour demander des jetons d'accès

Entités, opérations et actions

Tous les connecteurs Integration Connectors fournissent une couche d'abstraction pour les objets de l'application connectée. Vous ne pouvez accéder aux objets d'une application que par le biais de cette abstraction. L'abstraction vous est présentée en tant qu'entités, opérations et actions.

  • Entité : une entité peut être considérée comme un objet ou un ensemble de propriétés dans l'application ou le service connectés. La définition d'une entité diffère d'un connecteur à l'autre. Par exemple, dans un connecteur de base de données, les tables sont les entités, alors que dans un connecteur de serveur de fichiers, ce sont les dossiers, et dans un connecteur de système de messagerie, ce sont les files d'attente.

    Toutefois, il est possible qu'un connecteur n'accepte ou ne possède aucune entité. Dans ce cas, la liste Entities est vide.

  • Opération : une opération est l'activité que vous pouvez effectuer sur une entité. Voici les opérations possibles :

    Lorsque vous sélectionnez une entité dans la liste proposée, cela génère une liste d'opérations disponibles pour l'entité. Pour obtenir une description détaillée des opérations, consultez les opérations d'entité de la tâche "Connecteurs". Cependant, si un connecteur n'accepte pas l'une des opérations d'entité, cette opération non compatible ne figure pas dans la liste Operations.

  • Action : une action est une fonction de première classe mise à la disposition de l'intégration par le biais de l'interface du connecteur. Une action vous permet de modifier une ou plusieurs entités, et varie d'un connecteur à l'autre. Normalement, une action comporte des paramètres d'entrée et un paramètre de sortie. Toutefois, il est possible qu'un connecteur n'accepte aucune action, auquel cas la liste Actions est vide.

Limites du système

Le connecteur Dropbox peut traiter 18 transactions par seconde et par nœud, et limite les transactions au-delà de ce seuil. Par défaut, Integration Connectors alloue deux nœuds (pour améliorer la disponibilité) à une connexion.

Pour en savoir plus sur les limites applicables à Integration Connectors, consultez Limites.

Actions

Dans cette section, vous trouverez la liste des actions prises en charge par le connecteur. Pour savoir comment configurer les actions, consultez Exemples d'actions.

Action CopyResource

Cette action permet de copier un fichier ou un dossier vers un autre emplacement dans le Dropbox de l'utilisateur.

Paramètres d'entrée de l'action CopyResource

Nom du paramètre Type de données Obligatoire Description
From_Path STRING Oui Chemin d'accès à la ressource à copier ou à déplacer dans le Dropbox de l'utilisateur.
To_Path STRING Oui Chemin de destination de la ressource copiée dans le Dropbox de l'utilisateur.
Autorename STRING Non En cas de conflit, le serveur Dropbox tente de renommer automatiquement le fichier pour résoudre le problème. La valeur par défaut de ce champ est "False".
Allow_Ownership_Transfer STRING Non Autorise les déplacements par le propriétaire, même s'ils entraînent un transfert de propriété du contenu déplacé. Cela ne s'applique pas aux copies. La valeur par défaut de ce champ est "False".
ObjectPathsAggregate STRING Non Agrégat représentant le chemin d'accès à l'objet. Peut également être le nom d'une table #TEMP.

Pour savoir comment configurer l'action CopyResource, consultez Exemples d'actions.

Action CreateFolder

Cette action permet de créer un dossier à un emplacement donné.

Paramètres d'entrée de l'action CreateFolder

Nom du paramètre Type de données Obligatoire Description
Path STRING Oui Chemin d'accès à l'emplacement où créer le dossier dans le Dropbox de l'utilisateur.
AutoRename BOOLEAN Non En cas de conflit, le serveur Dropbox tente de renommer automatiquement le dossier pour résoudre le problème. La valeur par défaut est "false".
ForceAsync BOOLEAN Non Indique si la création asynchrone doit être forcée. Disponible uniquement en cas d'utilisation d'ObjectPathsAggregate. La valeur par défaut est "false".
ObjectPathsAggregate STRING Non Agrégat JSON représentant les chemins d'accès. Peut également être le nom d'une table #TEMP.

Pour savoir comment configurer l'action CreateFolder, consultez Exemples d'actions.

Action DeleteResource

Cette action permet de supprimer le fichier ou le dossier à un emplacement donné. Si le chemin d'accès est un dossier, tout son contenu sera également supprimé.

Paramètres d'entrée de l'action DeleteResource

Nom du paramètre Type de données Obligatoire Description
Path STRING Oui Identifiant unique du fichier ou du dossier.
ObjectPathsAggregate STRING Non Agrégat représentant le chemin d'accès à l'objet. Peut également être le nom d'une table #TEMP.

Pour savoir comment configurer l'action DeleteResource, consultez Exemples d'actions.

Action MoveResource

Cette action permet de déplacer un fichier ou un dossier vers un autre emplacement dans le Dropbox de l'utilisateur. Si le chemin d'accès source est un dossier, tout son contenu sera déplacé. Notez que vous ne pouvez pas modifier un nom en changeant uniquement la casse pour le moment.

Paramètres d'entrée de l'action MoveResource

Nom du paramètre Type de données Obligatoire Description
From_Path STRING Oui Chemin d'accès à la ressource à copier ou à déplacer dans le Dropbox de l'utilisateur.
To_Path STRING Oui Chemin d'accès dans le Dropbox de l'utilisateur qui correspond à la destination.
Autorename STRING Non En cas de conflit, le serveur Dropbox tente de renommer automatiquement le fichier pour résoudre le problème. La valeur par défaut de ce champ est "False".
Allow_Ownership_Transfer STRING Non Autorise les déplacements par le propriétaire, même s'ils entraînent un transfert de propriété du contenu déplacé. Cela ne s'applique pas aux copies. La valeur par défaut de ce champ est "False".
ObjectPathsAggregate STRING Non Agrégat représentant le chemin d'accès à l'objet. Peut également être le nom d'une table #TEMP.

Pour savoir comment configurer l'action MoveResource, consultez Exemples d'actions.

Action RenameResource

Cette action permet de renommer une ressource en fournissant un chemin d'accès et un nouveau nom.

Paramètres d'entrée de l'action RenameResource

Nom du paramètre Type de données Obligatoire Description
Path STRING Oui Chemin d'accès à la ressource à renommer. Exemple : /myFolder/sample.txt.
NewName STRING Oui Nouveau nom de la ressource. Exemple : sampleDocument.txt.

Pour savoir comment configurer l'action RenameResource, consultez Exemples d'actions.

Action UnshareFolder

Cette action permet d'annuler le partage d'un dossier. Nécessite le niveau d'accès "sharing.write".

Paramètres d'entrée de l'action UnshareFolder

Nom du paramètre Type de données Obligatoire Description
FolderId STRING Oui ID du dossier partagé dont vous souhaitez annuler le partage.
LeaveCopy STRING Non Si la valeur est "true", les membres de ce dossier partagé recevront une copie de ce dossier une fois le partage annulé. La valeur par défaut est "false".

Pour savoir comment configurer l'action UnshareFolder, consultez Exemples d'actions.

Action DownloadFile

Cette action permet de télécharger un fichier. Nécessite le niveau d'accès "files.content.read".

Paramètres d'entrée de l'action DownloadFile

Nom du paramètre Type de données Obligatoire Description
Id STRING Oui ID du document à télécharger.
Revision STRING Non Révision du document à télécharger, par exemple "rev:a1c10ce0dd78".
Path STRING Non Chemin d'accès au fichier ou au dossier à télécharger.
AsZip BOOLEAN Non Permet de télécharger un dossier au format ZIP. Doit être défini sur "true" pour télécharger un dossier.
FileStream STRING Non Instance d'un flux de sortie dans lequel les données de fichier sont écrites. Utilisé uniquement si DownloadTo n'est pas défini.
DownloadTo STRING Non Chemin d'accès au dossier dans lequel le fichier doit être téléchargé.
FileType STRING Oui Type de fichier (fichier ou papier).

Pour savoir comment configurer l'action DownloadFile, consultez Exemples d'actions.

Exemples d'actions

Cette section explique comment effectuer certaines actions dans ce connecteur.

Exemple : Copier une ressource

L'exemple suivant montre comment copier une ressource ayant un chemin d'accès spécifié vers un autre chemin d'accès :

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action CopyResource, puis cliquez sur OK.
  3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
      "From_Path": "/DropboxFolder/pptxFile.pptx",
      "To_Path": "/DropBoxFolder2/Folder/pptFile.pptx"
    }
  4. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche CopyResource aura une valeur semblable à la suivante :

    [ { "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" } ]

Exemple : Créer un dossier

L'exemple suivant montre comment créer un dossier à un emplacement donné :

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action CreateFolder, puis cliquez sur OK.
  3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
      "Path": "/TestDrobBoxFolder/newFolder"
    }
  4. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche CreateFolder aura une valeur semblable à la suivante :

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

Exemple : Supprimer une ressource

L'exemple suivant montre comment supprimer une ressource :

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action DeleteResource, puis cliquez sur OK.
  3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
      "Path": "/TestingDropBox/FolderToBeDeletedName"
    }
  4. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche DeleteResource aura une valeur semblable à la suivante :

    [{
    "Status": "Success"
    }]

Exemple : Déplacer une ressource

L'exemple suivant montre comment déplacer une ressource :

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action MoveResource, puis cliquez sur OK.
  3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
      "From_Path": "/TestDropBoxFolder/Folder1/dummypdf2.pdf",
      "To_Path": "/EmptyFolder/Folder1/dummypdf2.pdf"
    }
  4. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche MoveResource aura une valeur semblable à la suivante :

    [{
      "Status": "Success"
      }]

Exemple : Renommer une ressource

L'exemple suivant montre comment renommer une ressource :

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action RenameResource, puis cliquez sur OK.
  3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
      "Path": "/TestDropBox/abcd",
      "NewName": "abcded"
    }
  4. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche RenameResource aura une valeur semblable à la suivante :

    [{
    "Status": "Success"
    }]

Exemple : Annuler le partage d'un dossier

L'exemple suivant montre comment annuler le partage d'un dossier :

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action UnshareFolder, puis cliquez sur OK.
  3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
      "FolderId": "3336772979"
    }
  4. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche UnshareFolder aura une valeur semblable à la suivante :

    [{
    "Status": "Success"
    }]

Exemple : Télécharger un fichier

L'exemple suivant montre comment télécharger un fichier :

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action DownloadFile, puis cliquez sur OK.
  3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
      "Id": "id:8-07A6kHAoIAAAAAAAABcg",
      "FileType": "file"
    }
  4. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche DownloadFile aura une valeur semblable à la suivante :

    [ { "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" } ]

Utiliser la connexion Dropbox dans une intégration

Une fois la connexion créée, elle devient disponible dans Apigee Integration et Application Integration. Vous pouvez utiliser la connexion dans une intégration au moyen de la tâche "Connecteurs".

  • Pour savoir comment créer et utiliser la tâche "Connecteurs" dans Apigee Integration, consultez Tâche "Connecteurs".
  • Pour savoir comment créer et utiliser la tâche "Connecteurs" dans Application Integration, consultez Tâche "Connecteurs".

Demander de l'aide à la communauté Google Cloud

Vous pouvez publier vos questions et discuter de ce connecteur sur les forums Cloud de la communauté Google Cloud.

Étapes suivantes