Résoudre les problèmes d'utilisation de l'API

Cette page décrit les développeurs d'applications qui expliquent comment résoudre les problèmes liés à leur utilisation des API Google et des API Google Cloud.

Contexte

Les API Google sont des API 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 mettent en œuvre une logique de base de données courante, telle que la pagination, ce 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 la page Premiers pas pour réaliser les étapes de préparation de votre application. Vous devez d'abord utiliser la commande curl -v pour envoyer des requêtes de test aux API Google que vous souhaitez utiliser. Vous pourrez ainsi tester les API Google sans écrire de code. Vous pouvez souvent résoudre de nombreux problèmes avant de commencer le développement d'applications.

Pour plus d'informations, consultez le Guide de démarrage.

Résoudre les problèmes liés aux métriques

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

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

Résoudre les problèmes liés aux 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. Consignez les erreurs sur le stockage local ou 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 de l'erreur. Ils sont extrêmement utiles et souvent nécessaires pour résoudre les erreurs d'API. Lorsque les développeurs remarquent un problème dans leur utilisation de l'API, ils peuvent interroger les journaux pour rechercher les messages d'erreur et les détails de l'erreur, et utiliser les informations pour résoudre les erreurs ou contacter l'assistance.

Cloud Audit Logging

Pour les activités sensibles sur la sécurité, les produits Google Cloud peuvent générer des journaux d'audit contenant des informations détaillées sur ces activités. Vous y trouverez des informations utiles pour 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 les administrateurs.

Pour plus d'informations, consultez Journaux d'audit Cloud.

Résoudre les erreurs

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

En règle générale, chaque erreur d'API contient 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 ou 403.
  • Le message d'erreur permet aux développeurs d'applications de comprendre l'erreur et de corriger manuellement leur logique. AVERTISSEMENT: Ne codez pas avec les erreurs, car elles sont susceptibles d'être modifiées sans préavis.
  • Les détails de l'erreur contiennent des informations supplémentaires que les applications peuvent utiliser pour gérer l'erreur de manière automatisée.

Pour en savoir plus, consultez la page Erreurs.