Appeler l'API Data Portability à l'aide d'un script Python

Dans ce guide de démarrage rapide, vous obtenez un jeton OAuth pour votre compte et envoyez des requêtes aux points de terminaison de l'API Data Portability à l'aide d'un script Python.

Objectifs

Dans ce guide de démarrage rapide, vous allez utiliser un script Python pour effectuer les opérations suivantes:

  • Envoyez une requête authentifiée au point de terminaison InitiatePortabilityArchive en fournissant un jeton OAuth valide. La réponse est un job_id valide.
  • Envoyez une requête authentifiée au point de terminaison GetPortabilityArchiveState et téléchargez les données. La réponse doit contenir un état de tâche valide et, une fois la tâche terminée, une URL signée.
  • Envoyez une requête authentifiée au point de terminaison ResetAuthorization. Cette requête révoque tous les champs d'application OAuth accordés par l'utilisateur.

Prérequis

Pour exécuter ce guide de démarrage rapide, vous devez:

  • Vérifiez que vous avez accès à l'API Data Portability. Pour obtenir la liste des pays et régions pris en charge, consultez les questions courantes de la page "Partager une copie de vos données avec un tiers".
  • Suivez la procédure de configuration de l'API Data Portability et vérifiez que vous utilisez un nouveau projet.
  • obtenir l'accès à un compte détenu ou contrôlé par votre organisation ; Les données d'activité de recherche de ce compte sont exportées dans ce guide de démarrage rapide.

Avant de commencer à utiliser ce guide de démarrage rapide, vous devez également configurer OAuth, Python et le package OAuth pour les bibliothèques clientes Python.

Configurer OAuth

  • Suivez la procédure de configuration d'OAuth pour les applications installées. Ce flux est semblable au flux OAuth pour les applications de serveur Web. Lorsque vous configurez votre ID client OAuth :
    • Le type d'application doit être Application de bureau.
    • Après avoir créé l'ID client, téléchargez le code secret du client au format JSON et nommez le fichier: client_secrets.json.
    • Lorsque vous configurez les champs d'application pour l'API Data Portability, notez que ce guide de démarrage rapide utilise les groupes de ressources suivants :

Configurer Python

Vous devez configurer Python sur votre ordinateur local pour exécuter le script utilisé dans ce guide de démarrage rapide. Pour configurer Python:

  • Installez l'outil de gestion de packages Pip et Python 3.9 (ou une version ultérieure).
  • Installez la bibliothèque cliente des API Google pour Python.

  • Installez le package google_auth_oauthlib pour la bibliothèque cliente Python en exécutant cette commande. Ce package permet l'intégration de oauthlib avec google-auth, la bibliothèque d'authentification Google pour Python.

    pip install google-auth-oauthlib google-api-python-client --upgrade

Exécuter le script

Ce script utilise une redirection localhost dans le flux OAuth. Cette option nécessite que l'application écoute sur un port localhost, puis ouvre le navigateur système pour lancer le flux d'autorisation OAuth.

Cliquez sur ce lien pour ouvrir le script, ou téléchargez une copie du script en effectuant un clic droit dessus.

Script de démarrage rapide pour Python de l'API Data Portability

Pour exécuter le script, saisissez la commande suivante:

python3 data-portability-quickstart.py

Les actions effectuées par le script sont détaillées dans les commentaires.