La bibliothèque cliente Python est hébergée sur GitHub et le package est disponible sur PyPI.
Conditions requises
La bibliothèque nécessite Python 3.8 ou version ultérieure.
Prérequis
Avant d'installer la bibliothèque, vous aurez besoin d'un jeton de développeur et d'un numéro client. Pour savoir comment les obtenir, consultez la section Conditions préalables. Notez que vous générerez les autres jetons OAuth2 requis lors des prochaines étapes.
Compatibilité de l'environnement d'exécution et des dépendances
La bibliothèque cliente Python est compatible avec les environnements d'exécution Python de la section Versions compatibles publiée par la Python Software Foundation, à l'exception des versions dont l'état est "fonctionnalité" ou "version préliminaire".
Lorsque nous adoptons de nouvelles versions de l'environnement d'exécution Python, nous nous efforçons de publier une nouvelle version de la bibliothèque cliente Python compatible avec le dernier environnement d'exécution d'ici la fin du trimestre suivant sa publication. Par exemple, si un nouveau runtime est publié en octobre, une version compatible de la bibliothèque cliente Python sera disponible d'ici la fin mars de l'année suivante.
Les environnements d'exécution Python qui ont atteint leur fin de vie ne sont plus compatibles après la date de fin de vie indiquée dans la section Versions non compatibles de python.org.
Nous pouvons publier une version de la bibliothèque cliente Python incompatible avec les environnements d'exécution Python non compatibles à tout moment après leur date de fin de vie.
Pour les dépendances (en particulier les packages gérés par Google qui sont listés comme requis par la bibliothèque cliente Python), nous maintiendrons la compatibilité avec les packages gérés par Google et considérés comme "compatibles" conformément à la Politique de Google concernant les modifications incompatibles avec l'OSS.
Pour obtenir la liste complète des environnements d'exécution et des dépendances Python compatibles, consultez la page Dépendances.
Installation
Suivez les instructions de notre documentation sur l'installation pour installer la bibliothèque à partir de PyPi, puis revenez sur cette page.
Configuration
Une fois la bibliothèque installée, vous devrez la configurer. Il existe plusieurs façons de configurer la bibliothèque, qui sont décrites dans notre documentation sur la configuration.
Authentification
Une fois que vous avez choisi un type de configuration, vous pouvez générer les jetons OAuth2 restants nécessaires pour envoyer des requêtes à l'API. Plusieurs flux OAuth2 sont compatibles. Ils sont listés ci-dessous. Pour en savoir plus sur les différences entre les flux et déterminer celui qui convient le mieux à votre application, consultez notre documentation OAuth.
Envoyer une requête d'API
Une fois que vous avez intégré vos jetons OAuth2 à votre configuration, vous êtes prêt à envoyer une requête d'API. Consultez l'exemple get campaigns pour tester facilement si la bibliothèque est correctement configurée pour envoyer des requêtes d'API.
Pour exécuter l'exemple get_campaigns.py, exécutez la commande suivante dans le répertoire racine de la bibliothèque cliente googleads-python installée en local :
$ python examples/basic_operations/get_campaigns.py -c \
INSERT_YOUR_CUSTOMER_ID_HERE
Ressources supplémentaires
Une fois que vous êtes en mesure d'envoyer une requête d'API, passez aux utilisations suivantes de la bibliothèque cliente :