Vidéo : découvrez la présentation des 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 que votre application s'exécute sans interruption :
Veillez à ce que l'adresse e-mail de contact du développeur soit à jour dans le centre API. Il s'agit de l'alias que nous utilisons pour vous contacter. Si nous ne parvenons pas à vous contacter concernant le respect des conditions d'utilisation de l'API, votre accès à l'API pourra être révoqué sans que vous en soyez informé au préalable. É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 périodes d'indisponibilité pour maintenance, les dates d'abandon, etc., abonnez-vous à notre
L'équipe de l'API Google Ads surveille régulièrement le forum. C'est donc 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 et de la conformité des jetons vous contactera par e-mail. 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 creux.
Opérations par lot
L'envoi d'une requête à l'API entraîne 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, ainsi que les appels aux systèmes de backend. Pour réduire l'impact de ces coûts fixes et améliorer les performances globales, la plupart des méthodes de mutation 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. Si possible, évitez d'envoyer des requêtes avec une seule opération.
Par exemple, supposons que vous ajoutiez 50 000 mots clés à une campagne répartie dans plusieurs groupes d'annonces. Au lieu d'envoyer 50 000 requêtes avec un mot clé chacune, envoyez-en 100 avec 500 mots clés chacune, voire 10 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 creux
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 est compatible avec les mises à jour éparses. Vous pouvez ainsi n'inclure que les champs d'un objet que vous devez modifier ou qui sont obligatoires. Les mises à jour éparses sont traitées plus rapidement et sont moins susceptibles de générer des erreurs.
Les champs qui ne figurent pas dans le masque de mise à jour (également appelé FieldMask) restent inchangés.
Par exemple, une application qui met à jour les enchères au niveau des mots clés peut bénéficier de l'utilisation de mises à jour éparses, car seuls les champs "ID du groupe d'annonces", "ID du critère" et "Enchères" doivent être renseignés.
Gestion et traitement des erreurs
Lors du développement, vous êtes susceptible de rencontrer des erreurs. Cette section décrit les points à prendre en compte et les stratégies à adopter pour intégrer la gestion des erreurs dans 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 demandes
Certaines applications sont principalement interactives et émettent des appels d'API directement en réponse aux actions initiées par l'utilisateur dans une UI. D'autres fonctionnent principalement hors connexion et émettent des appels d'API dans le cadre d'un processus de 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 demandes initié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 (consultez les suggestions ci-dessous).
Pour les requêtes initié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 non rencontrées auparavant. Une bonne approche pour un gestionnaire par défaut consiste à ajouter l'opération et l'erreur ayant échoué à une file d'attente pour 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 pour créer 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 Types d'erreurs et Erreurs fréquentes.
Backends 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'a pas connaissance, ce qui peut entraîner une désynchronisation de la base de données locale de votre application. Comme indiqué dans notre guide sur les types d'erreurs, vous pouvez résoudre les erreurs de synchronisation de manière réactive lorsqu'elles se produisent, mais vous pouvez également essayer de les prévenir de manière proactive. Une stratégie proactive consiste à exécuter un job de synchronisation nocturne sur tous vos comptes, en récupérant les objets Google Ads dans vos comptes et en les comparant à 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, enregistrez l'ID de la requête, les opérations qui ont provoqué l'erreur et l'erreur elle-même. Les autres informations à consigner incluent l'ID client, le service d'API, la latence de la requête aller-retour, le nombre de tentatives et la requête et la réponse brutes.
Surveiller les tendances
Veillez à surveiller les tendances des erreurs d'API afin de pouvoir détecter et résoudre les problèmes liés à 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 générer 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é de votre application, la logique de gestion des campagnes ou d'autres traitements fonctionnent comme prévu. Votre jeton de développeur n'a pas besoin d'être approuvé pour être utilisé sur 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, avant même que votre application ne soit examinée.