API 使用に関するトラブルシューティング

このページでは、アプリケーション開発者向けに、Google API と Google Cloud API の使用のトラブルシューティング方法の概要を説明します。

背景

Google API は、Google サービスが提供するネットワーク化されている API です。アプリケーションは、異なる環境から JSON HTTP と gRPC を介して Google API にアクセスできます。デベロッパーは、Google 提供のクライアント ライブラリをアプリケーションで使用することをおすすめします。これらのライブラリは、認証やリストのページ分けなどの共通の一般的なロジックを実装しているため、開発のオーバーヘッドやよくある誤りが大幅に軽減されます。

詳しくはクライアント ライブラリの説明をご覧ください。

ご利用方法

Google API を初めて使用する場合は、ご利用方法ページに従って、アプリケーションの準備手順を完了する必要があります。まず curl -v コマンドを使用して、使用したい Google API にテスト リクエストを送信します。それによって、コードを記述せずに Google API を試すことができます。多くの場合、実際のアプリケーション開発を開始する前に多くの問題を解決できます。

詳しくは、スタートガイドをご覧ください。

指標を使用したトラブルシューティング

Google API では、リクエスト数、エラー、レイテンシ、リクエストとレスポンスのサイズなど、API の使用に関する一般的な側面を対象とする無料の API 指標を提供しています。アプリケーションとロケーションに関するきめ細かいディメンションが提供されます。デベロッパーは、異常な API 使用を発見し、潜在的な根本原因を特定できます。たとえば、エラーが 400 を超えると、最近更新されたアプリケーションに論理的なバグがあるか、リクエストとレスポンスのサイズが大きくなり、アプリケーションの性能が落ちる可能性があることを意味します。

詳細については、API 使用状況のモニタリングをご覧ください。

ログを使用したトラブルシューティング

セキュリティとプライバシーを保護するため、Google API は通常、アプリケーション デベロッパーに API ログを提供しません。アプリケーション デベロッパーがクライアント側で API エラーを記録することを強くおすすめします。エラーは、ローカル ストレージまたは Cloud Logging API などのリモート ロギング API に記録できます。

ログには通常、エラー メッセージやエラーの詳細など、指標よりも詳細なエラーに関する情報が含まれます。これは非常に有益で、API エラーのトラブルシューティングに必要になることがよくあります。デベロッパーが API の使用に関する問題に気付いた場合、ログをクエリしてエラー メッセージとエラーの詳細を確認し、その情報を使用してエラーを解決したり、サポートに問い合わせたりできます。

Cloud Audit Logs

セキュリティ上重要なアクティビティの場合、Google Cloud プロダクトはアクティビティに関する詳細情報を含む監査ログを生成することがあります。Google Cloud API の使用状況のトラブルシューティングに役立つ情報が提供されます。たとえば、VPC Service Control のドライラン機能では、管理者向けに今後のポリシー変更を評価する監査ログが生成されます。

詳しくは、Cloud Audit Logs をご覧ください。

エラーの解決

Google API の使用状況に問題があり、対応する指標とログが見つかった場合は、API 設計ガイドのエラーページに従ってエラーを解決できます。

一般に、各 API エラーには、エラーコード、エラー メッセージ、エラーの詳細の 3 つの部分があります。

  • エラーコードによって、アプリケーションで、503 エラー後の再試行や 401 エラー後のユーザーの再認証など、エラーをより高いレベルで処理できます。
  • このエラー メッセージによって、アプリケーション デベロッパーはエラーを理解し、アプリケーションのロジックを修正できます。

  • エラーの詳細には、アプリケーションでエラーをプログラムによって処理するために使用できる追加情報が含まれます。

詳細については、エラーページをご覧ください。