Box

Le connecteur Box vous permet de vous connecter à un backend Box et d'utiliser SQL pour récupérer et mettre à jour les données Box.

Versions compatibles

Ce connecteur est compatible avec la version 2.0 de l'API Box Content.

Avant de commencer

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

  • Dans votre projet Google Cloud :
    • Vérifiez que la connectivité réseau est configurée. Pour en savoir plus sur les modèles de réseau, consultez la section 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 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 NEXT (Suivant).
  4. Dans la section Détails de connexion, procédez comme suit :
    1. Connecteur : sélectionnez Box 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 peuvent pas dépasser 49 caractères.
    4. Saisissez éventuellement une Description pour l'instance de connexion.
    5. Vous pouvez également activer Cloud Logging, puis sélectionner un niveau de journalisation. Par défaut, le niveau de journalisation est défini sur Error.
    6. Compte de service : sélectionnez un compte de service disposant des rôles requis.
    7. 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.

    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. Utiliser un proxy : cochez cette case pour configurer un serveur proxy pour la connexion, et spécifiez les valeurs suivantes :
      • Schéma d'authentification du proxy : sélectionnez le type d'authentification pour l'authentification auprès du serveur proxy. Les types d'authentification suivants sont compatibles :
        • Basique : authentification HTTP de base.
        • Condensé : authentification HTTP par condensé.
      • Utilisateur du proxy : nom d'utilisateur à utiliser pour l'authentification auprès du serveur proxy.
      • Mot de passe du proxy : secret Secret Manager du mot de passe de l'utilisateur.
      • Type SSL du proxy : type SSL à utiliser lors de la connexion au serveur proxy. Les types d'authentification suivants sont compatibles :
        • Auto : paramètre par défaut. Dans le cas d'une URL HTTPS, l'option "Tunnel" est utilisée. Dans le cas d'une URL HTTP, l'option "JAMAIS" est utilisée.
        • Toujours : la connexion SSL est toujours activée.
        • Jamais : la connexion n'est pas activée pour SSL.
        • Tunnel : la connexion s'effectue via un proxy de tunnelisation. Le serveur proxy ouvre une connexion à l'hôte distant et le trafic transite par le proxy.
      • Dans la section Serveur proxy, saisissez les détails du serveur proxy.
        1. Cliquez sur + Ajouter une destination.
        2. Sélectionnez un type de destination.
          • Adresse de l'hôte : spécifiez le nom d'hôte ou l'adresse IP de la destination.

            Si vous souhaitez établir une connexion privée à votre système backend, procédez comme suit :

    10. Vous pouvez également cliquer sur + AJOUTER UN LIBELLÉ pour ajouter un libellé à la connexion sous la forme d'une paire clé/valeur.
    11. Cliquez sur NEXT (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 Box :

      • Authentification JWT
      • OAuth 2.0 - Code d'autorisation
      • JSON de la boîte
      • OAuth 2.0 - Identifiants client

      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.

  • Authentification JWT
    • ID client: ID client fourni par Box pour l'application que vous avez créée.
    • Code secret du client: secret Secret Manager contenant le code secret client pour l'application que vous avez créée.
    • Version du secret: version du secret client.
    • Clé privée : secret Secret Manager contenant le contenu du fichier de clé privée. La clé privée doit correspondre à la clé publique/au certificat fournis au connecteur.
    • Version du secret: version du secret de la clé privée.
    • Mot de passe de la clé privée: secret Secret Manager contenant le mot de passe (paraphrase) du fichier de clé privée.
    • Version du secret: version du mot de passe de la clé privée.
    • Niveau d'accès de l'application Box: niveau d'accès de l'application Box.
    • ID d'entreprise/ID d'utilisateur : ID d'entreprise si le niveau de l'application est "Enterprise" et ID d'utilisateur si le niveau d'application est "User".
    • ID de clé publique JWT OAuth : ID de la clé publique pour JWT.
    • Schéma d'authentification: schéma d'authentification pour le connecteur Box.
    • Initier OAuth: lancez le paramètre OAuth pour le connecteur Box.
    • Type de certificat JWT OAuth: type de certificat JWT OAuth pour le connecteur Box.
  • OAuth 2.0 - Code d'autorisation
    • ID client:ID client fourni par Box pour l'application que vous avez créée.
    • Champs d'application:champs d'application d'autorisation. Par exemple, root_readonly. Pour comprendre le fonctionnement des portées et afficher toutes les portées disponibles pour Box, consultez Portées.
    • Secret du client : sélectionnez le secret Secret Manager. Avant de configurer cette autorisation, vous devez créer le secret Secret Manager.
    • Version du secret : version du secret Secret Manager pour le code secret du client.
  • JSON Box
    • JSON Box pour l'authentification JWT: secret contenant le contenu du fichier JSON fourni par Box.
    • Version du secret: version du secret du fichier JSON.
  • OAuth 2.0 : identifiants client
    • ID client OAuth: ID client fourni par Box pour l'application que vous avez créée.
    • Code secret du client: secret Secret Manager contenant le code secret client pour l'application que vous avez créée.
    • Version du secret: version du secret client.
    • ID de l'objet: objet utilisateur pour lequel l'application demande un accès délégué.
    • Niveau d'accès de l'application Box: niveau d'accès de l'application Box.

Pour le type d'authentification Authorization code, après avoir créé la connexion, vous devez effectuer quelques étapes supplémentaires pour configurer l'authentification. Pour en savoir plus, consultez la section Étapes supplémentaires après la création de la connexion.

Exemples de configuration de connexion

Cette section présente des exemples de valeurs pour les différents champs que vous configurez lors de la création de la connexion.

Type de connexion de la méthode de jeton OAuth JWT

Nom du champ Détails
Emplacement us-central1
Connecteur Box
Version du connecteur 1
Nom de connexion box-conn
Activer Cloud Logging oui
Compte de service XXXX@serviceaccount
Mode d'emprunt d'identité Utilisateur
Nombre minimal de nœuds 2
Nombre maximal de nœuds 2
Authentification Authentification JWT
ID client XXXX
Code secret du client XXXX
Version de secret 1
Clé privée XXXX
Version de secret 1
Mot de passe de la clé privée XXXX
Version de secret 1
Niveau d'accès de l'application Box Entreprise
ID d'entreprise/ID d'utilisateur XXXX
ID de clé publique JWT OAuth XXXX
Schéma d'authentification OAuthJWT
Lancer OAuth GETANDREFRESH
Type de certificat JWT OAuth PEMKEY_BLOB

Vous pouvez accéder à l'ID client, au code secret du client, au niveau d'accès de l'application Box et à l'ID d'entreprise/d'utilisateur à partir du compte Box.

Vous pouvez accéder à la clé privée et au mot de passe de la clé privée à partir du fichier Private keypair.json que vous avez téléchargé. Pour en savoir plus, consultez la section Informations sur les paires de clés publiques et privées. De plus, avant de transmettre le mot de passe de la clé privée, remplacez \n dans le fichier json par une nouvelle ligne.

Type de connexion avec le code d'autorisation OAuth

Nom du champ Détails
Emplacement us-central1
Connecteur Box
Version du connecteur 1
Nom de connexion box-conn
Activer Cloud Logging oui
Compte de service XXXX@serviceaccount
Mode d'emprunt d'identité Utilisateur
Autorisation OAuth 2.0 - Code d'autorisation
Nombre minimal de nœuds 2
Nombre maximal de nœuds 2
ID client XXXX
Niveaux d'accès root_readwrite
Code secret du client XXXX
Version de secret 1

Pour en savoir plus sur la configuration OAuth de Box, consultez Créer votre application OAuth.

Box JSON pour le type de connexion de la méthode d'authentification JWT

Nom du champ Détails
Emplacement us-central1
Connecteur Box
Version du connecteur 1
Nom de connexion gcp-box-conn-new
Activer Cloud Logging oui
Compte de service XXXX@serviceaccount
Mode d'emprunt d'identité Utilisateur
En tant qu'ID utilisateur XXXX
Nombre minimal de nœuds 2
Nombre maximal de nœuds 2
Authentification JSON de la boîte
Box JSON pour l'authentification JWT XXXX
Version de secret 1

Vous pouvez utiliser le compte Box pour configurer le fichier JSON Box pour l'authentification JWT. Pour savoir comment configurer le JSON Box pour JWT, consultez la section Étapes de création de jetons JWT .

Accédez au fichier JSON Box pour la valeur d'authentification JWT à partir du fichier Private keypair.json que vous avez téléchargé. Pour en savoir plus, consultez la section Informations sur les paires de clés publiques et privées. Vous devez transmettre l'intégralité du contenu du fichier .json dans le champ Box Json for JWT Auth (Cadre JSON pour l'authentification JWT).

Type de connexion des identifiants client OAuth

Nom du champ Détails
Emplacement us-central1
Connecteur Box
Version du connecteur 1
Nom de connexion oauth-clientcred-conn
Activer Cloud Logging oui
Compte de service XXXX@serviceaccount
Mode d'emprunt d'identité Utilisateur
En tant qu'ID utilisateur XXXX
Nombre minimal de nœuds 2
Nombre maximal de nœuds 2
Authentification Identifiants client OAuth
ID client OAuth XXXX
Code secret du client OAuth XXXX
Version de secret 1
ID d'objet XXXX
Niveau d'accès de l'application Box Enterprise

Vous pouvez accéder à l'ID client, au code secret du client, au niveau d'accès de l'application Box et à l'ID d'entreprise/ID utilisateur à partir du compte Box.

Effectuer une nouvelle autorisation au code d'autorisation

Si vous utilisez le type d'authentification Authorization code et que vous avez modifié la configuration de votre application Box, vous devez autoriser à nouveau votre connexion Box. Pour réautoriser une connexion, procédez comme suit:

  1. Cliquez sur la connexion requise sur la page Connexions.

    La page des détails de la connexion s'ouvre.

  2. Cliquez sur Modifier pour modifier les détails de la connexion.
  3. Vérifiez les informations OAuth 2.0 – Code d'autorisation dans la section Authentification.

    Si nécessaire, apportez les modifications nécessaires.

  4. Cliquez sur Enregistrer. Vous êtes redirigé vers la page d'informations sur la connexion.
  5. Cliquez sur Modifier l'autorisation dans la section Authentification. Le volet Authorize (Autoriser) s'affiche.
  6. Cliquez sur Autoriser.

    Si l'autorisation aboutit, l'état de la connexion est défini sur Active sur la page Connexions.

Étapes supplémentaires après la création de la connexion

Si vous avez sélectionné OAuth 2.0 - Authorization code pour l'authentification, vous devez effectuer les étapes supplémentaires suivantes après avoir créé la connexion:

  1. Sur la page Connexions, recherchez la connexion que vous venez de créer.

    Notez que l'état du nouveau connecteur est Autorisation requise.

  2. Cliquez sur Autorisation requise.

    Le volet Modifier l'autorisation s'affiche.

  3. Copiez la valeur de l'URI de redirection dans votre application externe.
  4. Vérifiez les informations d'autorisation.
  5. Cliquez sur Autoriser.

    Si l'autorisation aboutit, l'état de la connexion est défini sur Active sur la page Connexions.

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'est pas compatible avec l'une des opérations d'entité, ces opérations non compatibles ne sont pas listé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.

Actions

Cette section liste toutes les actions compatibles avec la connexion Box.

Action DownloadFile

Cette action vous permet de télécharger un fichier depuis votre instance Box.

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

Nom du paramètre Type de données Obligatoire Description
FileID Chaîne Oui ID du fichier à télécharger.
HasBytes Booléen Oui Indique si le fichier doit être téléchargé sous forme de chaîne ou de chaîne encodée en Base64.

Paramètres de sortie de l'action DownloadFile

Cette action renvoie l'état 200 (OK) avec un corps de réponse indiquant les résultats.

Nom du paramètre Type de données Description
Opération réussie Chaîne Indique si le téléchargement du fichier a réussi.
ContentBytes Chaîne Contenu du fichier sous forme de chaîne encodée en base64.

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

Action UploadFile

Cette action vous permet d'importer un fichier dans votre instance Box.

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

Nom du paramètre Type de données Obligatoire Description
ParentID Chaîne Oui ID du dossier dans lequel vous souhaitez importer le fichier. Si ce paramètre n'est pas spécifié, le fichier est importé dans la racine du compte Box. La valeur par défaut est 0.
Contenu Chaîne Oui Contenu du fichier à importer.

Paramètres de sortie de l'action UploadFile

Cette action renvoie l'état 200 (OK) avec un corps de réponse indiquant les résultats.

Nom du paramètre Type de données Description
Opération réussie Chaîne Indique si l'importation du fichier a réussi.
ID Chaîne ID du fichier nouvellement créé.
VersionID Chaîne ID d'une version spécifique du fichier.
Hachage Chaîne Hachage SHA1 du fichier.
ETag Chaîne Valeur Etag du fichier ou du dossier. La valeur par défaut est 0.

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

Action CopyFile

Cette action vous permet de copier un fichier depuis votre instance Box.

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

Nom du paramètre Type de données Obligatoire Description
FileID Chaîne Oui ID du fichier que vous souhaitez copier.
DestinationFolderId Chaîne Non ID du dossier de destination dans lequel vous souhaitez copier le fichier. Si vous ne spécifiez aucune valeur, la dernière version du fichier est copiée.
NewName Chaîne Oui Nouveau nom du fichier copié.

Paramètres de sortie de l'action CopyFile

Cette action renvoie l'état 200 (OK) avec un corps de réponse indiquant les résultats.

Nom du paramètre Type de données Description
Opération réussie Chaîne Indique si la copie du fichier a réussi.
ID Chaîne ID du fichier copié.

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

Action CopyFolder

Cette action vous permet de copier un dossier entier depuis votre instance Box.

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

Nom du paramètre Type de données Obligatoire Description
FolderID Chaîne Oui ID du dossier que vous souhaitez copier.
DestinationFolderId Chaîne Oui ID du dossier de destination dans lequel vous souhaitez copier le dossier.
NewName Chaîne Non Nouveau nom du fichier pour le dossier copié.

Paramètres de sortie de l'action CopyFolder

Cette action renvoie l'état 200 (OK) avec un corps de réponse indiquant les résultats.

Nom du paramètre Type de données Description
Opération réussie Chaîne Indique si la copie du dossier a réussi.
ID Chaîne ID du dossier copié.

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

Exemples d'actions

Cette section explique comment effectuer certaines actions dans ce connecteur.

Exemple : 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 à la suivante dans le champ Default Value: 
    {
"FileID": "1283194869422", 
"HasBytes": true
}

    4. Cet exemple télécharge un fichier sous forme de chaîne encodée en base64. Si l'action réussit, le paramètre de réponse connectorOutputPayload de votre tâche de connecteur aura une valeur semblable à celle-ci:

    [
{ "Success": "True"},
{"ContentBytes": "JVBERi0xLjQKJcfl9OXwCjIgMCBvYmoKJSBbMjRdIAo8PAovRmlsdGVy"}
]

Exemple : Importer un fichier

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action UploadFile, 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 à la suivante dans le champ Default Value: 
    {
"ParentId": "0",
"Content": "12345"
}

    4. Cet exemple importe le contenu de la chaîne sous forme de fichier. Si l'action réussit, le paramètre de réponse connectorOutputPayload de votre tâche de connecteur aura une valeur semblable à celle-ci:

    [{
"Success": "true",
"ID": "1283902965389",
"VersionID": "1403546001389",
"Hash": "8cb2237d0679ca88db6464eac60da96345513964",
"Etag": "0"
}]

Exemple : Copier un fichier

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action CopyFile, 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: 
    {
"FileID": "1288751886061",
"DestinationFolderId": "219105724517", 
"NewName": "NewCopiedFile"
}

    4. Cet exemple copie le fichier avec l'ID 1288751886061 dans le dossier avec l'ID 219105724517. Si l'action réussit, le paramètre de réponse connectorOutputPayload de votre tâche de connecteur aura une valeur semblable à celle-ci:

    [{
"Success": "true",
"ID": "1308006018536"
}]

Exemple : Copier un dossier

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action CopyFolder, 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": "218475301279",
"DestinationFolderId": "0", 
"NewName": "NewCopiedFolder"
}

    4. Cet exemple copie le dossier avec l'ID 218475301279 dans le dossier avec l'ID 219105724517. Si l'action réussit, le paramètre de réponse connectorOutputPayload de votre tâche de connecteur aura une valeur semblable à celle-ci:

    [{
"Success": "true",
"ID": "226312444517"
}]

Exemples d'opérations d'entité

Exemple : Lister tous les fichiers

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez "Fichiers" dans la liste Entity.
  3. Sélectionnez l'opération LIST, puis cliquez sur OK.

Vous pouvez effectuer l'opération LIST sur les entités suivantes: Folders, TrashedItems, SharedItems, Collaborations, TaskAssignments et Tasks.

Exemple : Obtenir les fichiers

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez "Fichiers" dans la liste Entity.
  3. Sélectionnez l'opération GET, puis cliquez sur OK.
  4. Définissez l'ID de l'entité sur 1262397830475, qui est la clé à transmettre. Pour définir l'ID d'entité, dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur EntityId, puis saisissez 1262397830475 dans le champ Default Value (Valeur par défaut).

La valeur de l'ID de l'entité doit être transmise directement, par exemple 1262397830475. où 1262397830475 est la valeur unique de la clé primaire.

Vous pouvez effectuer l'opération GET sur les entités suivantes : "Folders" (Dossiers), "SharedItems" (Éléments partagés), "Collaborations" (Collaborations), "TaskAssignments" (Attributions de tâches) et "Tasks" (Tâches).

Exemple : Supprimer des fichiers

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez "Fichiers" dans la liste Entity.
  3. Sélectionnez l'opération DELETE, puis cliquez sur OK.
  4. Définissez l'ID de l'entité sur 1258725940971, qui est la clé à transmettre. Pour définir l'ID d'entité, dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur EntityId, puis saisissez 1258725940971 dans le champ Default Value (Valeur par défaut).

    Si l'entité possède deux clés principales ou d'entreprise composites au lieu de spécifier l'entityId, vous pouvez également définir le filterClause sur Id='1258725940971'.

Vous pouvez effectuer l'opération DELETE sur les entités suivantes: Folders, Tasks, Collaborations, SharedItems et TaskAssignments.

Exemple : Créer des dossiers

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez "Dossiers" dans la liste Entity.
  3. Sélectionnez l'opération Create, puis cliquez sur OK.
  4. 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: 
    {
"Name": "Google Cloud Platforms_created_folders",
"ParentId": "0"
}

    Si l'intégration réussit, le paramètre de réponse connectorOutputPayload de la tâche Folder aura une valeur semblable à celle-ci:

     
{
"Id": "222269371053"
}

Exemple : Créer des collaborations

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez "Collaborations" dans la liste Entity.
  3. Sélectionnez l'opération Create, puis cliquez sur OK.
  4. 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: 
    {
"ItemId": "216592737829",
"ItemType": "folder",
"AccessibleById": "27370766275",
"AccessibleByType": "user",
"AccessibleByLogin": "baklavainthebalkans@gmail.com",
"Role": "editor"
}

    Si l'intégration aboutit, le paramètre de réponse connectorOutputPayload de la tâche Folder aura une valeur semblable à la suivante :

    {
"Success": false
}

Exemple : Créer des tâches

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez "Tâches" dans la liste Entity.
  3. Sélectionnez l'opération Create, puis cliquez sur OK.
  4. 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: 
    {
"ItemId": "1253997361112",
"ItemType": "file",
"Action": "review",
"Message": "Creating a task from Google Cloud Platform",
"DueAt": "2023-12-12 09:01:15.0",
"CompletionRule": "all_assignees"
}

    Si l'intégration réussit, le paramètre de réponse connectorOutputPayload de la tâche Folder aura une valeur semblable à celle-ci:

     
{
"Id": "1253997361112"
}

Exemple : Créer des attributions de tâches

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez "TaskAssignments" dans la liste Entity.
  3. Sélectionnez l'opération Create, puis cliquez sur OK.
  4. 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: 
    {
"TaskId": "21507516872",
"AssignedToId": "27370766275"
}

    Si l'intégration réussit, le paramètre de réponse connectorOutputPayload de la tâche Folder aura une valeur semblable à celle-ci:

     
{
"Id": "50804351753"
}

Exemple : Fichiers de mise à jour

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez "Fichiers" dans la liste Entity.
  3. Sélectionnez l'opération Update, puis cliquez sur OK.
  4. 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: 
    {
"Name": "Get Started with Box Files.pdf"
}
  5. Définissez l'ID d'entité sur 1253997361112. Pour définir l'ID d'entité, cliquez sur entityId, puis saisissez 1253997361112 dans le champ Default Value (Valeur par défaut).

    Plutôt que de spécifier le entityId, vous pouvez également définir le filterClause sur 1253997361112.

    L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche de connecteur:

    {
"Id": "1253997361112"
}

Vous pouvez effectuer l'opération UPDATE sur les entités suivantes: Folders, Tasks, Collaborations, SharedItems et TaskAssignments.

Exemple : Mettre à jour des dossiers

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez "Dossiers" dans la liste Entity.
  3. Sélectionnez l'opération Update, puis cliquez sur OK.
  4. 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: 
    {
"Name": "Demo Update"
}
  5. Définissez l'ID d'entité sur 216457668125. Pour définir l'ID d'entité, cliquez sur entityId, puis saisissez 216457668125 dans le champ Default Value (Valeur par défaut).

    Plutôt que de spécifier le entityId, vous pouvez également définir le filterClause sur 216457668125.

    L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche de connecteur:

    {
"Id": "216457668125"
}

Exemple : Mettre à jour les collaborations

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez "Collaborations" dans la liste Entity.
  3. Sélectionnez l'opération Update, puis cliquez sur OK.
  4. 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: 
    {
"Role": "Viewer"
}
  5. Définissez l'ID d'entité sur 46685648757. Pour définir l'ID d'entité, cliquez sur entityId, puis saisissez 46685648757 dans le champ Default Value (Valeur par défaut).

    Plutôt que de spécifier le entityId, vous pouvez également définir le filterClause sur 46685648757.

    L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche de connecteur:

    {

}

Exemple : Mettre à jour des tâches

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez "Tâches" dans la liste Entity.
  3. Sélectionnez l'opération Update, puis cliquez sur OK.
  4. 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: 
    {
"Message": "This is a new task is updated and assigned to you by me"
}
  5. Définissez l'ID d'entité sur 21507516872. Pour définir l'ID d'entité, cliquez sur entityId, puis saisissez 21507516872 dans le champ Default Value (Valeur par défaut).

    Plutôt que de spécifier le entityId, vous pouvez également définir le filterClause sur 21507516872.

    L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche de connecteur:

    {
"Id": "21507516872"
}

Exemple : Mettre à jour les attributions de tâches

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez "TaskAssignments" dans la liste Entity.
  3. Sélectionnez l'opération Update, puis cliquez sur OK.
  4. 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: 
    {
"Message": "Looks good to me",
"ResolutionState": "completed"
}
  5. Définissez l'ID d'entité sur 49542929469. Pour définir l'ID d'entité, cliquez sur entityId, puis saisissez 49542929469 dans le champ Default Value (Valeur par défaut).

    Plutôt que de spécifier le entityId, vous pouvez également définir le filterClause sur 49542929469.

    L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche de connecteur:

    {
"Id": "49542929469"
}

Exemple : Mettre à jour Transferfolders

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez "Dossiers" dans la liste Entity.
  3. Sélectionnez l'opération Update, puis cliquez sur OK.
  4. 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: 
    {
"Name": "Demo Update"
"ParentId": "216596059374"
}
  5. Définissez l'ID d'entité sur 216457668125. Pour définir l'ID d'entité, cliquez sur entityId, puis saisissez 216457668125 dans le champ Default Value (Valeur par défaut).

    L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche de connecteur:

    {
"Id": "216457668125"
}

Utiliser Terraform pour créer des connexions

Vous pouvez utiliser la ressource Terraform pour créer une connexion.

Pour savoir comment appliquer ou supprimer une configuration Terraform, consultez la page Commandes Terraform de base.

Pour consulter un exemple de modèle Terraform permettant de créer une connexion, consultez l'exemple de modèle.

Lorsque vous créez cette connexion à l'aide de Terraform, vous devez définir les variables suivantes dans votre fichier de configuration Terraform:

Nom du paramètre Type de données Requis Description
impersonate_user_mode ENUM Vrai Spécifiez le type d'emprunt d'identité. Il doit s'agir du mode utilisateur ou du mode administrateur. Les valeurs acceptées sont : "User" (Utilisateur) et "Admin" (Administrateur).
proxy_enabled BOOLÉEN Faux Cochez cette case pour configurer un serveur proxy pour la connexion.
proxy_auth_scheme ENUM Faux Type d'authentification à utiliser pour s'authentifier auprès du proxy ProxyServer. Les valeurs acceptées sont: BASIC, DIGEST et NONE.
proxy_user STRING Faux Nom d'utilisateur à utiliser pour s'authentifier auprès du proxy ProxyServer.
proxy_password SECRET Faux Mot de passe à utiliser pour s'authentifier auprès du proxy ProxyServer.
proxy_ssltype ENUM Faux Type SSL à utiliser lors de la connexion au proxy ProxyServer. Les valeurs acceptées sont: AUTO, ALWAYS, NEVER et TUNNEL.

Utiliser la connexion Box 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 dans 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 savoir 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