Vidéo : Découvrez les bonnes pratiques présentées lors de l'atelier de 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 en cours
Pour vous assurer que votre application fonctionne sans interruption :
Assurez-vous que la liste des administrateurs et des propriétaires de votre projet Google Cloud est à jour. Nous contacterons ces utilisateurs en cas d'urgence ou pour toute question liée au respect des conditions d'utilisation de l'API. Si nous ne parvenons pas à vous contacter concernant le respect des conditions d'utilisation de l'API, votre accès à l'API pourra être limité ou révoqué.
Pour être informé des problèmes tels que les modifications de produits, les temps d'arrêt de maintenance et les dates d'abandon, abonnez-vous à nos
Assurez-vous que votre application respecte les conditions d' utilisation de l'API Google Ads (T&C). Si nécessaire, l'équipe chargée du respect des règles concernant l'API contactera les administrateurs et les propriétaires de votre projet Google Cloud ayant accès à l'API. Si vous avez des questions ou des remarques concernant les conditions d'utilisation, vous pouvez contacter l'équipe chargée du respect des règles en répondant à l'e-mail qu'elle vous a envoyé lors de l'examen de votre demande d'accès à l'API.
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, et 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.
Supposons, par exemple,que vous ajoutiez 50 000 mots clés à une campagne dans plusieurs groupes d'annonces. Au lieu d'envoyer 50 000 requêtes avec un mot clé chacune, envoyez 100 requêtes avec 500 mots clés chacune, ou même 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 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. Le fait de transmettre des objets complets lorsque vous ne souhaitez mettre à jour que quelques champs peut entraîner un temps de traitement supplémentaire et une baisse des performances. Pour éviter cela, l'API Google Ads prend en charge les mises à jour creuses, ce qui vous permet de ne renseigner que les champs d'un objet que vous devez modifier ou qui sont obligatoires.
Les mises à jour creuses sont plus rapides et 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 creuses, car seuls les champs d'ID de groupe d'annonces, d'ID de critère et d'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 requêtes
Certaines applications sont principalement interactives et émettent des appels d'API directement en réponse à des actions initiées par l'utilisateur dans une interface utilisateur. 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 requêtes initiées par l'utilisateur, votre principale préoccupation doit être d'offrir une bonne expérience à vos utilisateurs. Utilisez l'erreur spécifique qui s'est produite pour fournir à l'utilisateur autant de contexte que possible dans l'interface utilisateur. 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 qui n'ont pas été 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 courantes.
Synchroniser les backends
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 informée, ce qui entraîne une désynchronisation de la base de données locale de votre application. Comme indiqué dans notre Types d'erreurs guide, vous pouvez traiter 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 nocturne sur tous vos comptes, en récupérant les objets Google Ads de vos comptes et en les comparant à votre base de données locale.
Erreurs du journal
Toutes les erreurs doivent être consignées dans un journal pour faciliter le débogage et la surveillance. Au minimum, consignez l'ID de requête, les opérations qui ont provoqué l'erreur et l'erreur elle-même. Parmi les autres informations à consigner, citons l'ID client, le service 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 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 automatisées.
Développement
Utilisez des comptes de test lors du développement.
Utiliser des comptes de test
Les comptes de 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 tout autre traitement fonctionnent comme prévu. Votre projet Google Cloud n'a besoin que du niveau d'accès Compte de test pour être utilisé sur un compte de test. Vous pouvez donc commencer à développer avec l'API Google Ads immédiatement, en attendant que Google examine votre demande pour des niveaux d'accès à l'API plus élevés.