Résoudre les problèmes d'utilisation des API

Cette page offre aux développeurs d'applications un aperçu de la résolution de leur utilisation des API Google et des API Google Cloud.

Contexte

Les API Google sont des API en réseau fournies par les services Google. Les applications peuvent accéder aux API Google via JSON HTTP et gRPC dans différents environnements. Nous recommandons aux développeurs d'utiliser les bibliothèques clientes fournies par Google dans leurs applications. Ces bibliothèques implémentent une logique commune, telle que la pagination, qui réduit considérablement les frais de développement et les erreurs courantes.

Pour en savoir plus, consultez la page Présentation des bibliothèques clientes.

Premiers pas

Si vous débutez avec les API Google, vous devez suivre les instructions de la page Premiers pas pour votre application. Vous devez d'abord envoyer des requêtes test aux API Google que vous souhaitez utiliser à l'aide de la commande curl -v. Vous pourrez ainsi tester les API Google sans écrire de code. Vous pouvez souvent résoudre de nombreux problèmes avant de lancer le développement d'une application.

Pour en savoir plus, consultez la section Premiers pas.

Résoudre les problèmes à l'aide de métriques

Les API Google fournissent des métriques d'API gratuites qui couvrent les aspects courants de l'utilisation des API, y compris le nombre de requêtes, les erreurs, les latences, les tailles de requête et de réponse. Elles fournissent des dimensions précises en termes d'applications et d'emplacements. Les développeurs peuvent découvrir une utilisation anormale des API et identifier les causes fondamentales potentielles. Par exemple, des codes d'erreur supérieurs à 400 peuvent indiquer des bugs logiques pour une application récemment mise à jour, ou des tailles de requête et de réponse plus élevées peuvent entraîner une charge système supplémentaire.

Pour en savoir plus, consultez la section Surveiller l'utilisation des API.

Résoudre les problèmes liés à l'utilisation des journaux

Pour des raisons de sécurité et de confidentialité, les API Google ne fournissent généralement pas de journaux d'API aux développeurs d'applications. Nous recommandons vivement aux développeurs d'applications de consigner les erreurs d'API côté client. Vous pouvez soit consigner les erreurs dans l'espace de stockage local, soit dans l'API Cloud Logging.

Les journaux contiennent généralement plus d'informations sur les erreurs que les métriques, telles que les messages d'erreur et les détails des erreurs. Elles sont extrêmement utiles et souvent nécessaires pour résoudre les erreurs d'API. Lorsque les développeurs remarquent un problème concernant leur utilisation de l'API, ils peuvent interroger les journaux pour rechercher les messages d'erreur et les détails des erreurs, puis utiliser ces informations pour résoudre les erreurs ou contacter l'assistance.

Cloud Audit Logs

Pour les activités sensibles, les produits Google Cloud peuvent générer des journaux d'audit contenant des informations détaillées sur ces activités. Ils constituent une excellente source d'informations sur la manière de résoudre les problèmes d'utilisation des API Google Cloud. Par exemple, la fonctionnalité de simulation VPC Service Controls génère des journaux d'audit pour permettre aux administrateurs d'évaluer les modifications à venir des règles.

Pour en savoir plus, consultez la page Journaux d'audit Cloud.

Résoudre les erreurs

Si vous rencontrez des problèmes liés à votre utilisation de l'API Google et que vous avez trouvé les métriques et les journaux correspondants, vous pouvez consulter la page Erreurs du guide de conception d'API pour les résoudre.

En général, chaque erreur d'API possède trois informations: le code d'erreur, le message d'erreur et les détails de l'erreur:

  • Le code d'erreur permet aux applications de gérer l'erreur au niveau supérieur, par exemple 401 et 403.
  • Le message d'erreur permet aux développeurs d'applications de comprendre l'erreur et de corriger manuellement la logique de leur application. AVERTISSEMENT: Ne codez pas avec les messages d'erreur, car ils sont susceptibles d'être modifiés sans préavis.
  • Les détails de l'erreur contiennent des informations supplémentaires que les applications peuvent utiliser pour gérer l'erreur par programmation.

Pour en savoir plus, consultez la page Erreurs.