Bonnes pratiques

Vidéo: Regardez la vidéo sur les bonnes pratiques présentée dans l'atelier 2019

Ce guide présente quelques bonnes pratiques que vous pouvez appliquer pour optimiser l'efficacité et les performances de vos applications.

Maintenance continue

Pour vous assurer que votre application s'exécute sans interruption:

  • Veillez à ce que votre adresse e-mail de développeur soit à jour dans le centre API. C'est l'alias que nous utilisons pour vous contacter. Si nous ne sommes pas en mesure de vous contacter au sujet de la conformité avec les conditions d'utilisation de l'API, votre accès à l'API peut être révoqué à votre insu. Évitez d'utiliser une adresse e-mail personnelle associée à un compte individuel ou non surveillé.

  • Pour être informé de problèmes tels que les modifications apportées aux produits, les temps d'arrêt pour maintenance, les dates d'abandon, etc., abonnez-vous à notre

Le forum est consulté régulièrement par l'équipe API Google Ads, 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 doutes concernant les conditions d'utilisation, vous pouvez contacter l'équipe d'examinateurs en répondant à l'e-mail qu'elle vous a envoyé lors de l'examen de votre application de jeton de développeur.

Optimisation

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 du réseau aller-retour, le traitement de la sérialisation et de la désérialisation, ainsi que 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 mutate de l'API sont conçues pour accepter un large éventail 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 en une seule opération.

Par exemple, supposons que vous ajoutez 50 000 mots clés à une campagne dans plusieurs groupes d'annonces. Au lieu d'effectuer 50 000 requêtes avec un seul mot clé chacune, effectuez 100 requêtes de 500 mots clés chacune, voire 10 requêtes de 5 000 mots clés chacune. Le nombre d'opérations autorisées dans une requête est limité. Vous devrez donc 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. La transmission d'objets complets alors que vous ne souhaitez mettre à jour que quelques champs peut augmenter le temps de traitement et réduire les performances. Pour limiter ce problème, l'API Google Ads accepte les mises à jour fragmentées, ce qui vous permet de ne remplir que les champs d'un objet que vous devez modifier ou qui sont obligatoires. Les mises à jour creuses 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és FieldMask) restent inchangés.

Par exemple, une application qui met à jour les enchères au niveau des mots clés peut tirer parti des mises à jour fragmentées, car seuls les champs "ID du groupe d'annonces", "ID de critère" et "Enchères" doivent être renseignés.

Traitement et gestion des erreurs

Au cours du développement, vous risquez de rencontrer des erreurs. Cette section décrit les éléments à 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 des demandes

Certaines applications sont principalement interactives et émettent des appels d'API directement en réponse à des actions déclenchées par l'utilisateur dans une interface utilisateur. 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 envisagez de gérer les erreurs, il peut être utile de distinguer ces différents types de requêtes.

Pour les requêtes déclenché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-leur des étapes simples pour résoudre l'erreur (consultez les suggestions ci-dessous).

Pour les requêtes lancées en 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 corriger les erreurs rares ou non rencontrées. Une bonne approche pour un gestionnaire par défaut consiste à ajouter l'opération ayant échoué et l'erreur à une file d'attente pour qu'un opérateur humain examine et détermine une résolution appropriée.

Distinguer les types d'erreurs

Connaître les différences entre les types d'erreurs dans l'API Google Ads est essentiel pour créer une gestion des erreurs robuste. Voici certains des types d'erreurs les plus courants:

  1. Erreurs d'authentification
  2. Erreurs récupérables
  3. Erreurs de validation
  4. Erreurs liées à la synchronisation

Pour en savoir plus, consultez les sections Types d'erreurs et Erreurs courantes.

Synchroniser les backends

Si les utilisateurs de votre application disposent d'un accès manuel à des comptes Google Ads, ils peuvent apporter des modifications à leur insu, entraînant la 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 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 un job 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 pour faciliter le débogage et la surveillance. Consignez au minimum l'ID de la requête, les opérations qui ont causé l'erreur et l'erreur elle-même. Les autres informations à consigner incluent le numéro client, le service d'API, la latence des requêtes aller-retour, le nombre de tentatives, ainsi que la requête et la réponse brutes.

Veillez à surveiller les tendances des erreurs d'API afin de détecter et de résoudre les problèmes liés à votre application. Pensez à créer votre propre solution ou à 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.

Development

Utilisez des comptes de test

Les comptes de test sont des comptes Google Ads qui ne diffusent aucune annonce. 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 fonctionne comme prévu. Il n'est pas nécessaire que votre jeton de développeur soit 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, avant même l'examen de votre application.