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 un ID de cliente. Las instrucciones para obtenerlos se describen en la sección de requisitos. Ten en cuenta que generarás los otros tokens de OAuth2 requeridos 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 que se indican en la sección Versiones admitidas que publica la Python Software Foundation, excepto por las versiones con el estado "feature" o "prerelease".

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 se lanza un nuevo entorno de ejecución en octubre, 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.

En el caso de las dependencias (en particular, cualquier paquete que Google mantenga y que la biblioteca cliente de Python enumere como obligatorio), mantendremos la compatibilidad con los paquetes que Google mantenga y que se consideren "compatibles" según la Política de Cambios Fundamentales de OSS de Google.

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 los tokens de OAuth2 restantes necesarios para realizar solicitudes a la API. Existen varios flujos de OAuth2 compatibles, que se documentan en la siguiente lista. Para obtener detalles sobre las diferencias entre los flujos y ayuda para decidir cuál es el mejor para tu aplicación, consulta nuestra documentación de OAuth.

Cómo realizar una solicitud a la API

Una vez que hayas incorporado tus tokens de OAuth2 en la configuración, estarás listo para realizar una solicitud a la API. Consulta el ejemplo de cómo obtener campañas para ver una forma sencilla de probar que la biblioteca está configurada correctamente para realizar solicitudes a la API.

Para ejecutar la muestra de get_campaigns.py, en el directorio raíz de la biblioteca cliente googleads-python instalada de forma local, 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: