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 ID client 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 étapes suivantes.
Compatibilité de l'environnement d'exécution et des dépendances
La bibliothèque cliente Python assure la compatibilité 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 "feature" ou "prerelease".
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 sortie. 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 du mois de mars de l'année suivante.
Les environnements d'exécution Python arrivés en fin de vie ne sont plus pris en charge 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 qui est incompatible avec les environnements d'exécution Python non pris en charge à tout moment après la fin de leur cycle de vie.
Pour les dépendances (en particulier, les packages listés comme obligatoires 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 non compatibles avec les logiciels open source.
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 d'installation pour installer la bibliothèque à partir de PyPi, puis revenez sur cette page.
Configuration
Une fois la bibliothèque installée, vous devrez configurer une configuration pour elle. Il existe plusieurs façons de configurer la bibliothèque, qui sont décrites dans la documentation de 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, comme indiqué dans la liste ci-dessous. Pour en savoir plus sur les différences entre les flux et vous aider à choisir celui qui convient le mieux à votre application, consultez notre documentation sur OAuth.
Envoyer une requête API
Une fois que vous avez intégré vos jetons OAuth2 à votre configuration, vous êtes prêt à envoyer une requête API. Reportez-vous à l'exemple get campaigns pour découvrir un moyen simple de vérifier que la bibliothèque est correctement configurée pour envoyer des requêtes API.
Pour exécuter l'exemple get_campaigns.py, dans le répertoire racine de votre bibliothèque cliente googleads-python installée localement, exécutez la commande suivante:
$ python examples/basic_operations/get_campaigns.py -c \
INSERT_YOUR_CUSTOMER_ID_HERE
Ressources supplémentaires
Une fois que vous pouvez envoyer une requête API, procédez aux utilisations suivantes de la bibliothèque cliente: