トラブルシューティング

動画: 2019 年ワークショップのエラー処理の講演を見る

エラーの原因には、不適切な環境設定やソフトウェアのバグ、ユーザーからの無効な入力があります。いずれにしても、そのエラーの原因を突き止めて、コードを修正したり、ユーザーによるエラーを処理するロジックを追加したりする必要があります。このガイドでは Google Ads API のエラーをトラブルシューティングするためのヒントについて説明します。

接続性を確保する

Google Ads API にアクセスできるようにし、正しい設定を行ってください。レスポンスから HTTP エラーが返された場合は、それらに慎重に対処し、使用する予定のサービスにご自身のコードからアクセスしていることを確認してください。
サービスで認証を受けるために、認証情報がリクエストに埋め込まれています。特にクライアントライブラリを使用せずに呼び出しを処理する場合は、Google Ads API のリクエストとレスポンスの構造をよく理解してください。各クライアントライブラリには、設定ファイルに認証情報を含める方法に関する指示が準備されています（クライアントライブラリの README を参照してください）。

正しい認証情報を使用してください。クイックスタートに沿って、必要な正しい認証情報を取得しましょう。たとえば、次のレスポンスエラーは、ユーザーが無効な認証資格情報を送信したことが原因です。

{
  "error": {
    "code": 401,
    "message": "Request had invalid authentication credentials. Expected OAuth 2 access token, login cookie or other valid authentication credential. Visit https://developers.google.com/identity/sign-in/web/devconsole-project.",
    "status": "UNAUTHENTICATED",
    "details": [
      {
        "@type": "type.googleapis.com/google.rpc.DebugInfo",
        "detail": "Authentication error: 2"
      }
    ]
  }
}

上記の手順を行っても問題が解決しない場合は、Google Ads API のエラーのトラブルシューティングを行います。

問題を判別する

Google Ads API は通常、レスポンス内のエラーのリストを含む JSON エラーオブジェクトとしてエラーを報告します。これらのオブジェクトには、エラーコードと、それが発生した理由を詳しく説明するメッセージが含まれています。これは問題を特定するための最初のヒントになります。

{
  "errors": [
    {
      "errorCode": { "fieldMaskError": "FIELD_NOT_FOUND" },
      "message": "The field mask contained an invalid field: 'keyword/matchtype'.",
      "location": { "operationIndex": "1" }
    }
  ]
}

すべてのクライアントライブラリは、レスポンスのエラーをカプセル化する例外をスローします。これらの例外をキャプチャして、ログまたはトラブルシューティング画面にメッセージを出力することから始めましょう。この情報をアプリケーションでログに記録された他のイベントと統合すると、問題の原因についての概要を把握できます。ログでエラーを特定したら、その意味を把握する必要があります。

エラーの調査

一般的なエラーに関するドキュメントをご覧ください。このドキュメントには、最も頻繁に発生するエラーが記載されています。エラーメッセージ、関連する API リファレンス、エラーを回避または処理する方法について説明します。
よくあるエラーに関するドキュメントにエラーが具体的に記載されていない場合は、リファレンスドキュメントをお調べのうえ、エラー文字列を見つけてください。
Google のサポートチャネルを検索して、API で経験を共有している他のデベロッパーにアクセスしましょう。抱えている問題に誰かが遭遇し、解決した可能性があります。
文書化されていないエラーが発生した場合は、フォーラムで Google に連絡してください。
検証やアカウント制限の問題のトラブルシューティングについては、Google 広告のヘルプセンターをご覧ください。Google Ads API は、Google 広告サービスの主なルールと制限を継承しています。
ブログ投稿がアプリケーションのトラブルシューティングの参考になる場合もあります。

エラーを調査したら、根本的な原因を特定します。

原因を特定する

例外メッセージを調べて、エラーの原因を調べます。レスポンスを確認してから、リクエストを調べて、考えられる原因を探します。一部の Google Ads API エラーメッセージでは、GoogleAdsError の location フィールドに、リクエスト内のどこでエラーが発生したかを示す fieldPathElements が含まれます。次に例を示します。

{
  "errors": [
    {
      "errorCode": {"criterionError": "CANNOT_ADD_CRITERIA_TYPE"},
      "message": "Criteria type can not be targeted.",
      "trigger": { "stringValue": "" },
      "location": {
        "operationIndex": "0",
        "fieldPathElements": [ { "fieldName": "keyword" } ]
      }
    }
  ]
}

問題のトラブルシューティングを行う際、アプリケーションが誤った情報を API に提供している可能性があります。デバッグに役立つように、Eclipse（主に Java の開発に使用されるが、他の言語用のプラグインがある無料のオープンソース IDE）などの対話型開発環境（IDE）を使用することを強くおすすめします。IDE では、ブレークポイントを設定したり、コードを 1 行ごとにステップ実行したりすることができます。

リクエストがアプリケーションの入力と一致していることを確認します（たとえば、キャンペーンの名前がリクエストと一致するようにしてください）。行う更新に一致するフィールドマスクを送信してください。Google Ads API はスパースアップデートをサポートしています。変更リクエストでフィールドマスクからフィールドを省略すると、API はそのフィールドを放置します。アプリケーションがオブジェクトを取得して変更を行い、その値を送り返す場合、更新をサポートしていないフィールドに書き込んでいる可能性があります。リファレンスドキュメントでフィールドの説明を参照して、フィールドを更新できるタイミングやタイミングに制限がないかどうかを確認してください。

サポートの利用方法

問題を自分で特定して解決できるとは限りません。フォーラムで質問すると、何千人ものデベロッパーに質問して、同じ問題に遭遇したことがある可能性があります。

クエリにはできる限り多くの情報を含めるようにしてください。たとえば、次のような項目を含めることをお勧めします。

不要な情報を削除した JSON リクエストとレスポンス - 開発者トークンや AuthToken などの機密情報は忘れずに削除してください。
コードスニペット - 言語固有の問題や API の操作についてのサポートを求めている場合は、コードのスニペットを提供すると、行おうとしていることの説明に役立ちます。
RequestId - 本番環境でのリクエストであれば、この情報は、Google Developer Relations チームのメンバーがリクエストを探し出すのに役立ちます。ログにプロパティとして requestId を登録することをおすすめします。ログはレスポンスエラーの不要な情報を削除した例外が含まれているだけでなく、requestId 単独の場合よりも多くの情報を得られるからです。
ランタイムやインタープリターのバージョンやプラットフォームなどの補足情報もトラブルシューティングの役に立ちます。

問題の解決方法

問題を特定でき、解決方法が判明したら、実際に修正を加えて修正箇所をテストします。このとき、できればテストアカウントを使用することをおすすめします。ただし、特定の本番用アカウントのデータにのみ起こるバグの場合には、本番環境でテストする必要があります。

共有する

以前は表示されていなかったエラーについてフォーラムに質問を投稿し、解決策が見つかった場合は、スレッドに追加することを検討してください。開発者が次回同じ問題に遭遇した場合、すぐに解決できるでしょう。

次のステップ

問題の解決の過程で、コードを改良して問題の発生を未然に防ぐ方法がみつかる場合があります。

適切な一連の単体テストを作成することで、コードの品質と信頼性を大幅に向上させることができます。また、新しい変更をもすぐにテストできるため、以前の機能を壊すことがありません。適切なエラー処理戦略は、トラブルシューティングに必要なデータをすべて明らかにするうえでも重要です。

システム制限

テスト