Introduction: Développer des applications à l'aide de l'API Data Portability

L'API Portabilité des données vous permet de créer des applications qui demandent l'autorisation d'un utilisateur pour transférer une copie des données des services Google vers votre application. Cela permet la portabilité des données et facilite le changement de service.

Pour en savoir plus sur la façon dont les utilisateurs partagent des données, consultez Partager une copie de vos données avec un tiers.

Prérequis

Avant de pouvoir publier votre application, elle doit être approuvée par Google.

Vous devez également vérifier que l'API Data Portability est disponible pour les utilisateurs de votre région. Pour obtenir la liste des pays et régions acceptés, consultez les questions fréquentes sur la page "Partager une copie de vos données avec un tiers".

Workflow de développement

Voici la procédure à suivre pour créer une application qui utilise l'API Data Portability.

1. Implémentez le flux de consentement OAuth pour l'utilisateur. Dans cet exemple, l'utilisateur fournit l'accès aux données vidéo YouTube.

   1. L'utilisateur clique sur Importer des vidéos YouTube et se connecte à son compte Google.

   2. L'application redirige l'utilisateur vers une URL de consentement OAuth. Notez que cet exemple d'URL est simplifié et que certains paramètres sont manquants:

      https://accounts.google.com/o/oauth2/v2/auth?scope=https://www.googleapis.com/auth/dataportability.myactivity.youtube

   3. L'utilisateur clique sur Suivant sur l'écran de consentement OAuth, accepte de partager ses données et fournit l'accès au compte.

   4. L'utilisateur sélectionne les données à partager et la durée pendant laquelle l'application peut y accéder (accès unique à ses données ou accès basé sur le temps pendant 30 ou 180 jours), puis clique sur Continuer.

      Remarque : Jusqu'à 90 jours avant l'expiration de votre jeton OAuth, l'utilisateur peut renouveler votre accès à ses données. Le bouton de renouvellement ne s'affiche pas si les champs d'application de l'utilisateur n'expirent pas dans les 90 jours.

   5. L'utilisateur est redirigé vers l'application.

   6. Le développeur obtient un jeton OAuth pour l'utilisateur.

2. Votre application appelle InitiatePortabilityArchive(resources = ["myactivity.youtube"]) avec un jeton OAuth associé contenant ce champ d'application OAuth:

   https://www.googleapis.com/auth/dataportability.myactivity.youtube

   Cet appel lance le processus de création de l'archive de données et renvoie un ID de tâche et indique si l'utilisateur a accordé un accès ponctuel ou basé sur le temps.

   Remarque : L'accès unique correspond à une exportation par champ d'application. Si l'utilisateur accorde plusieurs champs d'application, vous pouvez choisir de créer des tâches distinctes pour chacune des ressources autorisées par le jeton.

3. Votre application appelle GetPortabilityArchiveState(job_id) avec un jeton OAuth associé qui contient ce champ d'application OAuth:

   https://www.googleapis.com/auth/dataportability.myactivity.youtube

   Vous pouvez appeler cette méthode plusieurs fois pour récupérer l'état de la tâche d'archivage. La méthode renvoie l'état de la tâche. Si l'état est COMPLETE, l'archive est prête et des URL Cloud Storage signées sont fournies. Notez que le temps nécessaire pour traiter la requête d'archivage peut varier de quelques minutes à plusieurs heures, en fonction de la taille des données.

4. Téléchargez l'archive de données à l'aide des URL signées.

5. Si l'utilisateur accorde un accès unique, appelez ResetAuthorization() avec un jeton OAuth associé pour réinitialiser les ressources épuisées et supprimer tous les consentements OAuth.

6. Si l'utilisateur accorde un accès basé sur le temps, vous pouvez exporter des ressources toutes les 24 heures jusqu'à l'expiration du consentement.

Pour en savoir plus sur l'utilisation des méthodes de l'API Data Portability, consultez la section Appeler les méthodes de l'API Data Portability.

Comment les utilisateurs interagissent-ils avec une application de l'API Data Portability ?

Ce diagramme montre comment les utilisateurs interagissent avec une application intégrée à l'API Data Portability.

1. Tout d'abord, l'utilisateur a la possibilité de récupérer ses données.

2. L'utilisateur se connecte ensuite à son compte Google.

3. L'utilisateur clique ensuite sur Suivant lorsqu'il est invité à partager ses données, puis sur Je comprends lorsqu'il est invité à accepter les règles de confidentialité.

4. Un écran de consentement OAuth s'affiche ensuite pour autoriser l'application à accéder aux données de l'utilisateur. Les options ici correspondent aux champs d'application OAuth que vous avez configurés. L'utilisateur sélectionne les données à partager et la durée pendant laquelle l'application peut y accéder (accès unique à ses données ou accès basé sur le temps pendant 30 ou 180 jours), puis clique sur Continuer.

5. Une fois l'accès autorisé, l'importation des données commence. Selon la taille des données, la requête peut prendre de quelques minutes à plusieurs heures.