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 :
    • 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 compte Google spécial 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 la section 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 la page Activer des services.

    Si ces services ou autorisations n'ont pas encore été activés pour votre projet, vous êtes invité à les activer lors de la configuration du connecteur.

Configurer le connecteur

Pour configurer le connecteur, vous devez créer une connexion à votre source de données (système backend). Une connexion est spécifique à 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 Integration Connectors > Connections (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 la page Emplacements.

    2. Cliquez sur SUIVANT.
  4. Dans la section Détails de la connexion, procédez comme suit :
    1. Connector (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, saisissez un nom pour l'instance de connexion.

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

      • Les noms de connexion peuvent contenir des lettres, des chiffres ou des traits d'union.
      • Les lettres doivent être en minuscules.
      • Les noms de connexion doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
      • Les noms de connexion ne doivent pas dépasser 49 caractères.
    4. Saisissez éventuellement une Description pour l'instance de connexion.
    5. Compte de service : sélectionnez un compte de service disposant des rôles requis.
    6. Vous pouvez également configurer les paramètres du nœud 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 plus de transactions pour une connexion, plus de nœuds sont nécessaires. À l'inverse, moins de nœuds sont nécessaires pour traiter moins de transactions. Pour comprendre comment les nœuds affectent la tarification de votre connecteur, consultez la section 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 une meilleure disponibilité) et le nombre maximal sur 50.

    7. Emprunter l'ID de l'utilisateur:pour spécifier (facultatif) l'ID de l'utilisateur à emprunter.
    8. Mode d'emprunt d'identité : spécifiez le type d'emprunt d'identité. Il doit s'agir du mode utilisateur ou du mode administrateur.
    9. Inclure les sous-répertoires : optionnellement, si vous souhaitez inclure des sous-répertoires lors de la liste des fichiers et des dossiers.
    10. Inclure les ressources de l'équipe : (facultatif) si vous souhaitez inclure les fichiers et les dossiers de l'équipe.
    11. Vous pouvez également cliquer sur + Ajouter un libellé pour ajouter un libellé à 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.

      Les types d'authentification suivants sont compatibles avec la connexion à un compte "Envoi sécurisé" :

      • Octroi de code d'autorisation OAuth 2.0

      2. Pour comprendre comment configurer ces types d'authentification, consultez la section Configurer l'authentification.

    2. Cliquez sur Next (Suivant).
  6. Vérifiez vos informations de connexion et d'authentification.
  7. Cliquez sur Créer.

Configurer l'authentification

Saisissez les détails en fonction de l'authentification que vous souhaitez utiliser.

  • Octroi du code d'autorisation OAuth 2.0
    • ID client : ID client utilisé pour demander des jetons d'accès.
    • Scopes (Champs d'application) : liste des champs d'application souhaités, séparés par une virgule, du portail des autorisations de boîte de dépôt.
    • 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 via 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é. 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, dans un connecteur de serveur de fichiers, les dossiers sont les entités et, dans un connecteur de système de messagerie, les files d'attente sont les entités.

    Toutefois, il est possible qu'un connecteur ne soit pas compatible 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é. Vous pouvez effectuer l'une des opérations suivantes sur une entité :

    La sélection d'une entité dans la liste disponible 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 de connecteur. Toutefois, si un connecteur n'accepte aucune des opérations d'entité, opérations ne sont pas répertoriées dans la liste Operations.

  • Action : une action est une fonction de première classe mise à la disposition de l'intégration via 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 ne prenne en charge aucune action, auquel cas la liste Actions est vide.

Limites du système

Le connecteur Dropbox peut traiter 18 transactions par seconde, par nœud, et throttles toutes les transactions au-delà de cette limite. Par défaut, les connecteurs d'intégration allouent deux nœuds (pour une meilleure disponibilité) à une connexion.

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

Actions

Cette section liste les actions compatibles avec le connecteur. Pour savoir comment configurer les actions, consultez Exemples d'actions.

Action CopyResource

Cette action vous permet de copier un fichier ou un dossier à un autre emplacement du compte "Envoi sécurisé" de l'utilisateur.

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

Nom du paramètre Type de données Requis Description
From_Path Chaîne Oui Chemin d'accès dans le compte "Envoi sécurisé" de l'utilisateur à copier ou déplacer.
To_Path Chaîne Oui Chemin de destination dans le compte "Envoi sécurisé" de l'utilisateur pour la ressource copiée.
Renommer automatiquement Chaîne Non En cas de conflit, demandez au serveur Dropbox d'essayer de renommer automatiquement le fichier pour éviter le conflit. La valeur par défaut de ce champ est "False".
Allow_Ownership_Transfer Chaîne Non Autoriser les transferts 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 Chaîne Non Agrégation représentant le chemin de l'objet. Il peut également s'agir du nom d'une table #TEMP.

Par exemple, pour configurer l'action CopyResource, consultez les exemples d'actions.

Action CreateFolder

Cette action vous permet de créer un dossier à un chemin d'accès donné.

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

Nom du paramètre Type de données Requis Description
Chemin d'accès Chaîne Oui Chemin d'accès à créer dans le compte "Envoi sécurisé" de l'utilisateur.
Renommer automatiquement Booléen Non En cas de conflit, demandez au serveur Dropbox d'essayer de renommer automatiquement le dossier pour éviter le conflit. La valeur par défaut est false.
ForceAsync Booléen Non Indique si la création doit être forcée de manière asynchrone. Disponible uniquement lorsque vous utilisez ObjectPathsAggregate. La valeur par défaut est false.
ObjectPathsAggregate Chaîne Non Agrégation JSON représentant les chemins. Il peut également s'agir du nom d'une table #TEMP.

Par exemple, pour configurer l'action CreateFolder, consultez les exemples d'actions.

Action DeleteResource

Cette action vous permet de supprimer le fichier ou le dossier à un chemin d'accès 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 Requis Description
Chemin d'accès Chaîne Oui Identifiant unique du fichier ou du dossier.
ObjectPathsAggregate Chaîne Non Agrégat représentant le chemin d'accès à l'objet. Il peut également s'agir du nom d'une table #TEMP.

Par exemple, pour configurer l'action DeleteResource, consultez les exemples d'actions.

Action MoveResource

Déplacez un fichier ou un dossier vers un autre emplacement dans la boîte de dépôt de l'utilisateur. Si le chemin d'accès source est un dossier, tout son contenu sera déplacé. Notez que nous ne prenons pas en charge le changement de casse uniquement pour le moment.

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

Nom du paramètre Type de données Requis Description
From_Path Chaîne Oui Chemin d'accès dans le compte "Envoi sécurisé" de l'utilisateur à copier ou déplacer.
To_Path Chaîne Oui Chemin d'accès dans le compte "Envoi sécurisé" de l'utilisateur qui est la destination.
Renommer automatiquement Chaîne Non En cas de conflit, demandez au serveur Dropbox d'essayer de renommer automatiquement le fichier pour éviter le conflit. La valeur par défaut de ce champ est "False".
Allow_Ownership_Transfer Chaîne Non Autoriser les transferts 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 Chaîne Non Agrégation représentant le chemin de l'objet. Il peut également s'agir du nom d'une table #TEMP.

Par exemple, pour configurer l'action MoveResource, consultez les exemples d'actions.

Action RenameResource

Cette action vous 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 Requis Description
Chemin d'accès Chaîne Oui Chemin d'accès à la ressource à renommer. Exemple : /myFolder/sample.txt
NewName Chaîne Oui Nouveau nom de la ressource. Exemple : sampleDocument.txt

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

Action "UnshareFolder"

Cette action vous permet de rendre un dossier non partagé. Nécessite le champ d'application sharing.write.

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

Nom du paramètre Type de données Requis Description
FolderId Chaîne Oui ID du dossier partagé à annuler.
LeaveCopy Chaîne Non Si la valeur est "true", les membres de ce dossier partagé obtiendront une copie de ce dossier une fois le partage annulé. La valeur par défaut est false.

Par exemple, pour configurer l'action UnshareFolder, consultez les exemples d'actions.

Action DownloadFile

Cette action vous permet de télécharger un fichier. Nécessite le champ d'application files.content.read.

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

Nom du paramètre Type de données Requis Description
ID Chaîne Oui ID du document à télécharger.
Révision Chaîne Non Révision du document à télécharger (par exemple, "rev:a1c10ce0dd78").
Chemin d'accès Chaîne Non Chemin d'accès au fichier ou au dossier à télécharger.
AsZip Booléen Non Téléchargez un dossier au format ZIP. Doit être défini sur "true" pour télécharger un dossier.
FileStream Chaîne Non Instance d'un flux de sortie dans lequel des données de fichiers sont écrites. Utilisé uniquement si DownloadTo n'est pas défini.
DownloadTo Chaîne Non Chemin d'accès du dossier dans lequel télécharger le fichier.
FileType Chaîne Oui Type de fichier (fichier ou papier)

Pour savoir comment configurer l'action DownloadFile, consultez la section 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 avec 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 Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur connectorInputPayload, puis saisissez une valeur semblable à celle-ci dans la section Champ Default Value: 
    {
  "From_Path": "/DropboxFolder/pptxFile.pptx",
  "To_Path": "/DropBoxFolder2/Folder/pptFile.pptx"
}

    4. Si l'action aboutit, la Réponse connectorOutputPayload de la tâche CopyResource aura une valeur semblable à celle-ci:

    [ { "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 chemin d'accès 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 réussit, le paramètre de réponse connectorOutputPayload de la tâche CreateFolder aura une valeur semblable à celle-ci :

    [ { "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 réussit, le paramètre de réponse connectorOutputPayload de la tâche DeleteResource aura une valeur semblable à celle-ci :

    [{
"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 Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur connectorInputPayload, puis saisissez une valeur semblable à celle-ci dans la section Champ Default Value: 
    {
  "From_Path": "/TestDropBoxFolder/Folder1/dummypdf2.pdf",
  "To_Path": "/EmptyFolder/Folder1/dummypdf2.pdf"
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche MoveResource aura une valeur semblable à celle-ci :

    [{
  "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 Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur connectorInputPayload, puis saisissez une valeur semblable à celle-ci dans la section Champ Default Value: 
    {
  "Path": "/TestDropBox/abcd",
  "NewName": "abcded"
}

    4. Si l'action aboutit, la Réponse connectorOutputPayload de la tâche RenameResource aura une valeur semblable à celle-ci:

    [{
"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 Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur connectorInputPayload, puis saisissez une valeur semblable à celle-ci dans la section Champ Default Value: 
    {
  "FolderId": "3336772979"
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche UnshareFolder aura une valeur semblable à celle-ci :

    [{
"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 Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur connectorInputPayload, puis saisissez une valeur semblable à celle-ci dans la section Champ Default Value: 
    {
  "Id": "id:8-07A6kHAoIAAAAAAAABcg",
  "FileType": "file"
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche DownloadFile aura une valeur semblable à celle-ci :

    [ { "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 à la fois dans Apigee Integration et Application Integration. Vous pouvez utiliser la connexion lors d'une intégration via la tâche "Connecteurs".

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

Obtenir de l'aide auprès de la communauté Google Cloud

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

Étape suivante