Descripción general

La biblioteca cliente de Python está alojada 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. En la sección de requisitos previos, se describen las instrucciones para obtenerlos. Ten en cuenta que generarás los otros tokens de OAuth2 necesarios en pasos posteriores.

Compatibilidad de tiempo de ejecución y dependencias

La biblioteca cliente de Python mantiene la compatibilidad con los tiempos de ejecución de Python en la sección Versiones compatibles que publica la Python Software Foundation, excepto 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, habrá una versión compatible de la biblioteca cliente de Python disponible a fines de marzo del año siguiente.

Los tiempos de ejecución de Python que llegaron al final del ciclo de vida (EOL) no se admiten después de la fecha de finalización del ciclo de vida que se indica en la sección Versiones no admitidas de python.org.

Es posible que lancemos una versión de la biblioteca cliente de Python que sea incompatible con los tiempos de ejecución de Python no admitidos en cualquier momento después de que alcancen el final del ciclo de vida.

En el caso de las dependencias (específicamente, los paquetes que mantiene Google y que la biblioteca cliente de Python enumera como obligatorios), mantendremos la compatibilidad con los paquetes que mantiene Google y que se consideran "compatibles" según la Política de Cambios Incompatibles 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 Dependencies.

Instalación

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

Configuración

Una vez que hayas instalado la biblioteca, deberás establecer una configuración para ella. 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 que se necesitan para realizar solicitudes a la API. Existen varios flujos de OAuth2 admitidos, 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, podrás realizar una solicitud a la API. Consulta el ejemplo de 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 de 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

Después de que puedas realizar una solicitud a la API, continúa con estos usos de la biblioteca cliente: