Vidéo: Découvrez la présentation sur les bonnes pratiques de l'atelier 2019
Ce guide présente quelques bonnes pratiques que vous pouvez mettre en œuvre pour optimiser l'efficacité et les performances de vos applications.
Maintenance continue
Pour vous assurer que votre application fonctionne sans interruption:
Maintenez à jour l'adresse e-mail de contact du développeur dans le centre API. Voici l'alias que nous utilisons pour vous contacter. Si nous ne parvenons pas à vous contacter au sujet du respect des conditions d'utilisation de l'API, votre accès à l'API pourra être révoqué sans que vous en soyez informé. Évitez d'utiliser une adresse e-mail personnelle associée à un compte individuel ou non surveillé. Pour afficher le centre API, vous devez être connecté à votre compte administrateur.
Pour être informé des problèmes tels que les modifications de produits, les temps d'arrêt liés à la maintenance, les dates d'abandon, etc., abonnez-vous à notre
L'équipe de l'API Google Ads surveille régulièrement le forum, ce qui en fait l'endroit idéal pour poser des questions sur l'API.
- Assurez-vous que votre application respecte les Conditions d'utilisation de l'API Google Ads. Si nécessaire, l'équipe chargée de l'examen des jetons et de la conformité vous contactera à l'aide de votre adresse e-mail de contact. Si vous avez des questions ou des préoccupations concernant les conditions d'utilisation, vous pouvez contacter l'équipe d'examen en répondant à l'e-mail qu'elle vous a envoyé lors de l'examen de votre demande de jeton de développeur.
Optimisation
Vous pouvez optimiser votre application en exécutant des opérations par lot et, le cas échéant, en envoyant des objets épars.
Opérations par lot
Envoyer une requête à l'API implique un certain nombre de coûts fixes, tels que la latence réseau aller-retour, le traitement de la sérialisation et de la désérialisation, et les appels aux systèmes backend. Pour réduire l'impact de ces coûts fixes et améliorer les performances globales, la plupart des méthodes de modification de l'API sont conçues pour accepter un tableau d'opérations. En regroupant plusieurs opérations dans chaque requête, vous pouvez réduire le nombre de requêtes que vous effectuez et les coûts fixes associés. Dans la mesure du possible, évitez d'effectuer des requêtes avec une seule opération.
Par exemple, supposons que vous ajoutiez 50 000 mots clés à une campagne pour plusieurs groupes d'annonces. Au lieu d'envoyer 50 000 requêtes avec un seul mot clé chacune, envoyez 100 requêtes avec 500 mots clés chacune, voire 10 requêtes avec 5 000 mots clés chacune. Le nombre d'opérations autorisées dans une requête est limité. Vous devrez peut-être ajuster la taille de votre lot pour obtenir des performances optimales.
Envoyer des objets épars
Lorsque des objets sont envoyés à l'API, les champs doivent être désérialisés, validés et stockés dans la base de données. Transmettre des objets complets alors que vous ne souhaitez mettre à jour que quelques champs peut entraîner un temps de traitement supplémentaire et une diminution des performances.
Pour atténuer ce problème, l'API Google Ads prend en charge les mises à jour sporadiques, ce qui vous permet de ne renseigner que les champs d'un objet que vous devez modifier ou qui sont obligatoires. Les mises à jour espacées sont traitées plus rapidement et sont moins susceptibles de générer des erreurs.
Les champs qui ne figurent pas dans update_mask (également appelé FieldMask) ne sont pas modifiés.
Par exemple, une application qui met à jour les enchères au niveau des mots clés peut utiliser des mises à jour espacées, car seuls les champs d'ID du groupe d'annonces, d'ID du critère et d'enchères doivent être renseignés.
Traitement et gestion des erreurs
Vous rencontrerez probablement des erreurs pendant le développement. Cette section décrit les considérations et les stratégies à prendre en compte pour intégrer la gestion des erreurs à votre application. En plus de cette section, consultez le guide de dépannage pour en savoir plus sur la gestion des erreurs.
Distinguer les sources de requêtes
Certaines applications sont principalement interactives et émettent des appels d'API directement en réponse aux actions déclenchées par l'utilisateur dans une UI. D'autres fonctionnent principalement hors connexion, en émettant des appels d'API dans le cadre d'un processus backend périodique. De nombreuses applications combinent les deux. Lorsque vous réfléchissez à la gestion des erreurs, il peut être utile de distinguer ces différents types de requêtes.
Pour les requêtes lancées par l'utilisateur, votre principale préoccupation doit être de lui offrir une bonne expérience. Utilisez l'erreur spécifique qui s'est produite pour fournir à l'utilisateur autant de contexte que possible dans l'UI. Proposez-lui des étapes simples à suivre pour résoudre l'erreur (voir les suggestions ci-dessous).
Pour les requêtes lancées sur le backend, implémentez des gestionnaires pour les différents types d'erreurs que votre application peut rencontrer. Incluez toujours un gestionnaire par défaut pour traiter les erreurs rares ou inédites. Une bonne approche pour un gestionnaire par défaut consiste à ajouter l'opération et l'erreur ayant échoué à une file d'attente afin qu'un opérateur humain puisse les examiner et déterminer une résolution appropriée.
Distinguer les types d'erreurs
Il est essentiel de connaître les différences entre les types d'erreurs dans l'API Google Ads lorsque vous créez une gestion des erreurs robuste. Voici quelques-uns des types d'erreurs les plus courants:
- Erreurs d'authentification
- Erreurs récupérables
- Erreurs de validation
- Erreurs liées à la synchronisation
Pour en savoir plus, consultez les sections Types d'erreurs et Erreurs courantes.
Fins de synchronisation
Si les utilisateurs de votre application ont un accès manuel aux comptes Google Ads, ils peuvent apporter des modifications dont votre application n'est pas au courant, ce qui peut entraîner la désynchronisation de sa base de données locale. Comme indiqué dans notre guide sur les types d'erreurs, vous pouvez résoudre les erreurs liées à la synchronisation de manière réactive lorsqu'elles se produisent, mais vous pouvez également essayer de les éviter de manière proactive. Une stratégie proactive consiste à exécuter une tâche de synchronisation quotidienne sur tous vos comptes, à récupérer les objets Google Ads dans vos comptes et à les comparer à votre base de données locale.
Erreurs du journal
Toutes les erreurs doivent être consignées pour faciliter le débogage et la surveillance. Au minimum, consignez l'ID de requête, les opérations à l'origine de l'erreur et l'erreur elle-même. D'autres informations à consigner incluent l'ID client, le service d'API, la latence de la requête aller-retour, le nombre de nouvelles tentatives, ainsi que la requête et la réponse brutes.
Surveiller les tendances
Veillez à surveiller les tendances des erreurs d'API afin de détecter et de résoudre les problèmes de votre application. Envisagez de créer votre propre solution ou d'utiliser l'un des nombreux outils commerciaux disponibles qui peuvent utiliser vos journaux pour produire des tableaux de bord interactifs et envoyer des alertes automatiques.
Développement
Utilisez des comptes de test pendant le développement.
Utilisez des comptes de test
Les comptes test sont des comptes Google Ads qui ne diffusent pas d'annonces. Vous pouvez utiliser un compte de test pour tester l'API Google Ads et vérifier que la connectivité, la logique de gestion des campagnes ou tout autre traitement de votre application fonctionnent comme prévu. Votre jeton de développeur n'a pas besoin d'être approuvé pour être utilisé dans un compte de test. Vous pouvez donc commencer à développer avec l'API Google Ads immédiatement après avoir demandé un jeton de développeur, même avant que votre application ne soit examinée.