トラブルシューティング

ディスプレイ&ビデオ 360 API の使用時にエラーが発生する可能性のあるシナリオは数多くあります。これらのエラーは、コードのバグ、無効なユーザー入力、API 自体の問題に関連している可能性があります。理由が何であれ、エラーのトラブルシューティング方法を知ることは、開発プロセスの重要な部分です。このガイドでは、開始するためのベスト プラクティスのヒントをいくつか紹介します。

基本を確認する

  1. 前提条件ガイドを確認します。ディスプレイ&ビデオ 360 にアクセスできることと、API プロジェクトが適切に設定されていることを確認します。
  2. レスポンスに HTTP エラーが含まれている場合は、それらを慎重に確認し、正しい API とサービスに対してリクエストが実行されていることを確認してください。
  3. 認可ガイドを確認する。リクエストに必要な OAuth 2.0 認証情報が含まれていることを確認します。
  4. 正しい認証情報を使用してください。認証認証情報の生成について詳しくは、アプリケーションを設定するをご覧ください。アクセス トークンを Google OAuth2 API の tokeninfo エンドポイントに渡して、正しい API プロジェクトに発行され、正しいスコープで承認されていることを確認することもできます。

    POST https://www.googleapis.com/oauth2/v2/tokeninfo?access_token={YOUR_ACCESS_TOKEN}
    
    200 OK
    
    {
     "issued_to": "{API_PROJECT_CLIENT_ID}",
     "audience": "...",
     "scope": "{API_SCOPES}",
     "expires_in": ...
    }
    

エラーの把握

API でエラーが発生した場合、通常は error オブジェクトを含む JSON レスポンスが返されます。このオブジェクトは、発生した特定のエラーに関する追加のコンテキストを提供します。

{
 "error": {
  "code": 404,
  "message": "Resource type LINE_ITEM does not exist: advertisers/1/lineItems/1",
  "status": "NOT_FOUND"
 }
}

通常、error オブジェクトの内容には、問題の原因を特定するのに十分な情報が含まれています。見つからない場合は、エラーの意味を調べるために追加の調査が必要になることがあります。

エラーの調査

  1. 一般的なエラーのセクションをご覧ください。よくあるエラーの詳細が記載されています。

  2. エラーが「よくあるエラー」セクションに記載されていない場合は、リファレンス ドキュメントを参照して、エラーコード、ステータス、メッセージを検索してみてください。

  3. ドキュメントに記載されていないエラーに遭遇した場合は、お知らせください。

根本原因の特定

この時点で、エラーを特定し、その意味を理解しているはずです。問題が解決しない場合は、エラーの理解に戻るか、API で自分で修正できないエラーが発生していると思われる場合は、ヘルプへのアクセスに進んでください。

エラーを修正する前に、エラーの原因を特定する必要があります。多くの場合、これはコードのバグまたは無効な入力値が原因です。

問題がコードのバグに関連しているかどうかを判断するには、まずコードが意図したとおりに動作することを確認する必要があります。最初のステップとして、失敗したリクエストの作成に関連するコードセクションを確認して、明らかな問題がないか確認します。場合によっては、デバッグツールを使用してコードを 1 行ずつステップ実行し、正しく機能していることを確認する必要があります。

HTTP リクエストを調べることは、潜在的なバグや無効な入力のケースを特定するもう 1 つの有用な方法です。公式のクライアント ライブラリの多くは、HTTP リクエストとレスポンスをログに記録するように構成できます。詳細については、使用するライブラリのドキュメントをご覧ください。CharlesSquidFiddler などの HTTP プロキシを使用して、リクエストとレスポンスのログをキャプチャすることもできます。これらのログを取得したら、アプリから提供されるリクエスト パラメータ値が正しく、想定どおりであることを確認します。

エラーの原因となっているバグや無効な入力を特定したら、修正方法は明らかです。問題が解決しない、または問題を解決する最善の方法がわからない場合は、これまでに収集した情報をサポートに提供してください。

困ったときは

エラーを自分で解決できない場合は、ディスプレイ&ビデオ 360 ヘルプセンターのこちらのフォームからサポートチームにお問い合わせください。

このフォームに記入する際は、発生している問題とすでに試したトラブルシューティングの手順について、できるだけ多くの情報を含めてください。次のような情報が役立ちます。

  • HTTP リクエストとレスポンスのログ。OAuth 2.0 アクセス トークン、メールアドレスなどの機密情報は必ず削除してください。
  • コード スニペット。問題をコードの特定のセクションに特定できた場合や、問題が言語固有のものと思われる場合は、行おうとしていることを示す小さなスニペットを含めます。
  • ランタイム/インタープリターのバージョンやプラットフォームなどの追加情報。問題の再現を試みる他のユーザーに役立つ可能性があります。

問題の解決

問題の原因を特定して解決策を思いついたら、修正を適用します。可能であれば、本番環境にデプロイする前に、制御された環境(テスト用に特別に構成されたパートナーや広告主など)で、さまざまな正しい入力と間違った入力に対して修正をテストします。