Vidéo: découvrez la présentation sur les bonnes pratiques de l'atelier 2019
Ce guide décrit 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 s'exécute sans interruption:
Assurez-vous que votre adresse e-mail de contact de développeur est à jour dans le centre API. Il s'agit de l'alias que nous utilisons pour vous contacter. Si nous ne sommes pas en mesure de vous contacter au sujet du respect des conditions d'utilisation des 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é des modifications apportées aux produits, des temps d'arrêt pour maintenance, des dates d'abandon, etc., abonnez-vous à notre
Le forum est régulièrement surveillé par l'équipe API Google Ads. C'est donc l'endroit idéal pour poser vos questions concernant 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 la vérification des jetons et de la conformité vous contactera à l'aide de votre adresse e-mail de contact. Si vous avez des questions ou des inquiétudes 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 demande 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 réseau aller-retour, le traitement de sérialisation et de 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 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 en une seule opération.
Par exemple, supposons que vous ajoutiez 50 000 mots clés à une campagne dans plusieurs groupes d'annonces. Au lieu d'effectuer 50 000 requêtes contenant chacune un mot clé, 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 votre taille de 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 lorsque 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 creuse, ce qui vous permet de renseigner uniquement les champs d'un objet que vous devez modifier ou qui sont obligatoires. Les mises à jour fragmentées sont plus rapides à traiter et sont moins susceptibles de générer des erreurs.
Les champs qui ne figurent pas dans update_mask (é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 mises à jour creuses, car seuls les champs "ID du groupe d'annonces", "ID du critère" et "Enchères" devraient être renseignés.
Traitement et gestion des erreurs
Pendant le développement, vous risquez de rencontrer des erreurs. Cette section décrit les points à prendre en compte et les stratégies 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 aux actions déclenché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 backend périodique. De nombreuses applications combinent les deux. En matière de gestion des 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-lui des étapes simples pour résoudre l'erreur (consultez 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 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 afin qu'un opérateur humain puisse les examiner et déterminer une 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 efficace des erreurs. 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 plus de détails, reportez-vous aux sections Types d'erreur et Erreurs courantes.
Backends de synchronisation
Si les utilisateurs de votre application disposent d'un accès manuel aux comptes Google Ads, ils peuvent apporter des modifications dont votre application n'a pas connaissance, ce qui entraîne une désynchronisation de la base de données locale. Comme indiqué dans notre guide sur les types d'erreur, 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, à récupérer les objets Google Ads qu'ils contiennent 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. Consignez au minimum l'ID de la requête, les opérations à l'origine de l'erreur et l'erreur elle-même. Les autres informations à consigner incluent l'ID 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.
Surveillez les tendances
Veillez à surveiller les tendances dans les erreurs d'API afin de pouvoir détecter et 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.
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 tout autre traitement fonctionnent comme prévu. Il n'est pas nécessaire que votre jeton de développeur soit 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.