Descripción general

La biblioteca cliente de Python se aloja en GitHub y el paquete está disponible en PyPI.

Requisitos

La biblioteca requiere Python 3.8 o una versión posterior.

Requisitos previos

Antes de instalar la biblioteca, necesitarás un token de desarrollador y ID de cliente. En el prerequisites. Ten en cuenta que generarás los otros tokens de OAuth2 necesarios en pasos posteriores.

Compatibilidad del entorno de ejecución y de las dependencias

La biblioteca cliente de Python mantiene la compatibilidad con los entornos de ejecución de Python en el Versiones compatibles publicada por el Python Software Foundation, excepto versiones con el estado "feature" o “lanzamiento previo”.

Cuando adoptamos nuevas versiones del entorno de ejecución de Python, nuestro objetivo es lanzar una nueva versión de la biblioteca cliente de Python que sea compatible con el entorno de ejecución más reciente a fines del trimestre posterior a su lanzamiento. Por ejemplo, si un entorno de ejecución nuevo se lanzó en octubre, se implementará una versión compatible de la biblioteca cliente de Python estará disponible a fines de marzo del año siguiente.

Los entornos de ejecución de Python que llegaron al final del ciclo de vida (EOL) no son compatibles después de la fecha de finalización del ciclo de vida en la sección Versiones no compatibles de python.org.

Es posible que lancemos una versión de la biblioteca cliente de Python que no sea compatible con los entornos de ejecución de Python no admitidos en cualquier momento después de que alcancen el EOL.

Para las dependencias (específicamente, cualquier paquete mantenido por Google que se como obligatorias por la biblioteca cliente de Python), mantendremos la compatibilidad con los paquetes que son mantenidos por Google y se consideran "compatibles" según la Política de cambios rotundos de OSS.

Para obtener una lista completa de los entornos de ejecución y las dependencias de Python compatibles, consulta la página Dependencias.

Instalación

Sigue las instrucciones de nuestra documentación de instalación para instalar la biblioteca desde PyPI y vuelve a esta página.

Configuración

Una vez que hayas instalado la biblioteca, deberás configurarla. Existen varias formas de configurar la biblioteca, que se describen en nuestra documentación de configuración.

Autenticación

Una vez que hayas elegido un tipo de configuración, puedes continuar con la generación de la tokens de OAuth2 restantes necesarios para hacer solicitudes a la API. Existen varios flujos de OAuth2 compatibles, que se documentan en la siguiente lista. Para obtener detalles diferencias entre los flujos y ayudarte a decidir cuál es mejor para tu consulta nuestra documentación de OAuth.

Cómo realizar una solicitud a la API

Luego de incorporar los tokens de OAuth2 a tu configuración, listo para hacer una solicitud a la API. Consulta las ejemplo get campaigns (Obtener campañas) para una manera sencilla de probar que la biblioteca está configurada correctamente para hacer que la API solicitudes.

Para ejecutar la muestra de get_campaigns.py, en el directorio raíz de tu instaló la biblioteca cliente googleads-python, ejecuta el siguiente comando:

$ python examples/basic_operations/get_campaigns.py -c \
  INSERT_YOUR_CUSTOMER_ID_HERE

Recursos adicionales

Una vez que puedas realizar una solicitud a la API, continúa con estos usos de la biblioteca cliente: