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 de transférer des données et de changer de service plus facilement.

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 publier votre application, celle-ci doit être approuvée par Google.

Vous devez également vérifier que l'API Data Portability est disponible pour les utilisateurs dans 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 est redirigé vers l'application.

   5. 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. Vous devez lancer l'archivage de portabilité dans les 24 heures suivant l'autorisation de l'utilisateur.

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 "COMPLÈTE", 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. Appelez ResetAuthorization() avec un jeton OAuth associé pour réinitialiser les ressources épuisées et supprimer tous les consentements OAuth.

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 OK lorsqu'il est invité à accepter les règles de confidentialité.

4. Un écran de consentement OAuth s'affiche ensuite pour permettre à l'application d'accéder à ses données. Les options ici correspondent aux champs d'application OAuth que vous avez configurés.

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.