Llama a la API de Data Portability con una secuencia de comandos de Python

En esta guía de inicio rápido, obtendrás un token de OAuth para tu cuenta y enviarás solicitudes a los extremos de la API de Data Portability con una secuencia de comandos de Python.

Qué aprenderá

En esta guía de inicio rápido, usarás una secuencia de comandos de Python para lo siguiente:

  • Proporciona un token de OAuth válido para enviar una solicitud autenticada al extremo InitiatePortabilityArchive. La respuesta es un job_id válido.
  • Envía una solicitud autenticada al extremo GetPortabilityArchiveState y descarga los datos. La respuesta debe contener un estado de trabajo válido y, cuando se complete, una URL firmada.
  • Almacena el token de OAuth con acceso basado en el tiempo para reutilizarlo más adelante.
  • Envía una solicitud autenticada al extremo ResetAuthorization. Esta solicitud revoca todos los permisos de OAuth otorgados por el usuario.
  • Para enviar una solicitud autenticada al extremo InitiatePortabilityArchive, proporciona un token de OAuth válido junto con start_time o end_time para aplicar un filtro de tiempo a tu solicitud.

Requisitos previos

Para ejecutar esta guía de inicio rápido, debes hacer lo siguiente:

  • Verifica que la API de Portabilidad de datos esté disponible para ti. Para obtener una lista de países y regiones compatibles, consulta Preguntas frecuentes en la página "Comparte una copia de tus datos con un tercero".
  • Completa los pasos de configuración de la API de Data Portability y verifica que estás usando un proyecto nuevo.
  • Obtener acceso a una cuenta que sea propiedad de tu organización o que esta controle En esta guía de inicio rápido, se exportan los datos de actividad de búsqueda de esta cuenta.

Antes de comenzar esta guía de inicio rápido, también debes configurar OAuth, Python y el paquete de OAuth para las bibliotecas cliente de Python.

Configura OAuth

  • Sigue los pasos para configurar OAuth para aplicaciones instaladas. Este flujo es similar al flujo de OAuth para aplicaciones de servidor web. Cuando configures tu ID de cliente de OAuth, ten en cuenta lo siguiente:
    • El Tipo de aplicación debe ser App de escritorio.
    • Después de crear el ID de cliente, descarga el secreto de cliente en formato JSON y asígnale el nombre client_secrets.json.
    • Cuando configures los permisos para la API de Data Portability, ten en cuenta que esta guía de inicio rápido usa estos grupos de recursos:

Configura Python

Debes configurar Python en tu máquina local para ejecutar la secuencia de comandos que se usa en este guía de inicio rápido. Para configurar Python, haz lo siguiente:

  • Instala la herramienta de administración de paquetes Pip y Python 3.11 (o una versión posterior).
  • Instala la biblioteca cliente de la API de Google para Python

  • Ejecuta este comando para instalar el paquete google_auth_oauthlib de la biblioteca cliente de Python. Este paquete proporciona integración de oauthlib con google-auth, la biblioteca de autenticación de Google para Python.

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

Ejecuta la secuencia de comandos:

Esta secuencia de comandos usa un redireccionamiento a localhost en el flujo de OAuth. Esta opción requiere que la aplicación escuche en un puerto localhost y, luego, abra el navegador del sistema para iniciar el flujo de autorización de OAuth.

Haz clic en este vínculo para abrir la secuencia de comandos o haz clic con el botón derecho en el vínculo para descargar una copia.

Secuencia de comandos de la guía de inicio rápido de la API de Data Portability para Python

Para ejecutar la secuencia de comandos y exportar el corpus de datos completo, ingresa el siguiente comando:

python3 data-portability-quickstart.py

Para usar diferentes permisos, especifícalos con --resources, por ejemplo:

python3 data-portability-quickstart.py --resources myactivity.shopping myactivity.play

Para aplicar el filtrado de tiempo, usa la misma secuencia de comandos con las marcas start_time y end_time. Por ejemplo:

python3 data-portability-quickstart.py --start_time 2023-01-01T12:00:00Z --end_time 2024-01-01T12:00:00Z

Las acciones que realiza la secuencia de comandos se detallan en los comentarios.