エラー レスポンス

標準エラー レスポンス

Multi-Channel Funnels Reporting API リクエストの処理に成功すると、API は 200 ステータス コードを返します。リクエストでエラーが発生すると、API はエラーの種類に基づいて HTTP ステータス コード、ステータス、理由をレスポンスで返します。また、レスポンスの本文にはエラーの原因の詳細な説明が含まれています。以下に、エラー レスポンスの例を示します。

{
 "error": {
  "errors": [
   {
    "domain": "global",
    "reason": "invalidParameter",
    "message": "Invalid value '-1' for max-results. Value must be within the range: [1, 1000]",
    "locationType": "parameter",
    "location": "max-results"
   }
  ],
  "code": 400,
  "message": "Invalid value '-1' for max-results. Value must be within the range: [1, 1000]"
 }
}

エラーの表

コード 理由 説明 推奨される対処方法
400 invalidParameter リクエストのパラメータに無効な値があることを示します。エラー レスポンスの locationType フィールドと location フィールドには、無効な値に関する情報が示されます。 問題を解決してから再試行します。エラー レスポンスで指定されたパラメータに有効な値を指定する必要があります。
400 badRequest クエリが無効であることを示します。たとえば、「親 ID がない」、「リクエストされたディメンションや指標の組み合わせが無効」などの理由が考えられます。 問題を解決してから再試行してください。API クエリが正常に動作するには、クエリに変更を加える必要があります。
401 invalidCredentials 認証トークンが無効であるか、期限切れであることを示します。 問題を解決してから再試行してください。新しい認証トークンを入手する必要があります。
403 insufficientPermissions クエリで指定されたエンティティに対する十分な権限がないことを示します。 問題を解決してから再試行してください。指定したエンティティに対する操作を行える権限を取得する必要があります。
403 dailyLimitExceeded ユーザーが、(プロジェクトあたり、またはビュー(旧プロファイル)あたりの)1 日の割り当てを超えたことを示します。 問題を解決してから再試行してください。1 日の割り当ての上限に達しました。API の制限と割り当てをご覧ください。
403 userRateLimitExceeded ユーザーごとの 100 秒あたりのクエリ数の上限を超過したことを示します。Google API Console で設定されているデフォルト値は、各ユーザー 100 秒あたり 100 クエリです。この上限は、Google API Console で 1,000 件まで増やすことができます。 指数バックオフを使用して再試行してください。リクエストの送信レートを下げる必要があります。
403 rateLimitExceeded プロジェクトの 100 秒あたりのクエリ数が上限を超えたことを示します。 指数バックオフを使用して再試行してください。リクエストの送信レートを下げる必要があります。
403 quotaExceeded Core Reporting API でビュー(旧プロファイル)あたりの同時リクエスト数が 10 件に達したことを示します。 指数バックオフを使用して、再試行してください。このビュー(プロファイル)で進行中のリクエストが少なくとも 1 つ完了するまで待つ必要があります。
500 internalServerError 予期しない内部サーバーエラーが発生しました。 このクエリを 2 回以上再試行しないでください。
503 backendError サーバーからエラーが返されました。 このクエリを 2 回以上再試行しないでください。

500 または 503 レスポンスの処理

500 エラーや 503 エラーは、負荷が大きいときや、複雑なリクエストを大量に送信したときに発生することがあります。リクエストを大量に送信する場合は、データをリクエストする対象期間を短くすることや、また、指数バックオフの実装も検討してください。 エラーの発生頻度は、ビュー(プロファイル)とそのビューに関連付けられたレポートデータの量によって異なります。あるビュー(プロファイル)で 500 エラーまたは 503 エラーが起きたクエリが、同じクエリで別のビュー(プロファイル)でエラーになるとは限りません。

指数バックオフの実装

指数バックオフは、失敗したリクエストをクライアントが再試行する際、失敗するごとに次の再試行までの待ち時間を増やしていく処理です。これは、ネットワーク アプリケーションに使われる標準的なエラー処理方法です。Multi-Channel Funnels Reporting API は、失敗したリクエストをクライアントが再試行する際に、指数バックオフが使われることを前提に設計されています。指数バックオフの使用は、「必須」であるということに加え、帯域利用の効率を高め、レスポンスを正しく取得するために必要なリクエストの数を減らし、同時実行環境におけるリクエストのスループットを最大化する効果もあります。

単純な指数バックオフを実装するフローを次に示します。

  1. API に対してリクエストを行います。
  2. 再試行可能なエラーコードを含むエラー レスポンスを受け取ります。
  3. 1 秒 + random_number_milliseconds 秒の待機
  4. リクエストを再試行します。
  5. 再試行可能なエラーコードを含むエラー レスポンスを受け取ります。
  6. 2 秒 + random_number_milliseconds 秒待ちます
  7. リクエストを再試行します。
  8. 再試行可能なエラーコードを含むエラー レスポンスを受け取ります。
  9. 4 秒 + random_number_milliseconds 秒待ちます
  10. リクエストを再試行します。
  11. 再試行可能なエラーコードを含むエラー レスポンスを受け取ります。
  12. 8 秒 + random_number_milliseconds 秒の待機
  13. リクエストを再試行します。
  14. 再試行可能なエラーコードを含むエラー レスポンスを受け取ります。
  15. 16 秒 + random_number_milliseconds 秒お待ちください
  16. リクエストを再試行します。
  17. まだエラーが発生する場合は、停止してエラーを記録します。

上記のフローで、random_number_milliseconds は 1, 000 ミリ秒以下の乱数です。これは、一部の同時実装で起こる特定のロックエラーを回避するために必要です。 random_number_milliseconds は、待機するたびに再定義する必要があります。

: 待機時間は常に (2 ^ n) + random_number_milliseconds となります。n は、最初は 0 として定義され、単調増加する整数です。n は、反復(リクエストごとに)ごとに 1 ずつ増加します。

上記のアルゴリズムは、n が 5 に達したら停止するように設定されています。この上限値は、クライアントが無制限に再試行しないようにするためだけに設けられたもので、リクエストが「修復不可能なエラー」と見なされるまでに合計で約 32 秒間の遅延を生じます。

以下の Python コードは、makeRequest メソッドで発生したエラーから回復するために、上記で示したフローを実装したものです。

import random
import time
from apiclient.errors import HttpError

def makeRequestWithExponentialBackoff(analytics):
  """Wrapper to request Google Analytics data with exponential backoff.

  The makeRequest method accepts the analytics service object, makes API
  requests and returns the response. If any error occurs, the makeRequest
  method is retried using exponential backoff.

  Args:
    analytics: The analytics service object

  Returns:
    The API response from the makeRequest method.
  """
  for n in range(0, 5):
    try:
      return makeRequest(analytics)

    except HttpError, error:
      if error.resp.reason in ['userRateLimitExceeded', 'quotaExceeded',
                               'internalServerError', 'backendError']:
        time.sleep((2 ** n) + random.random())
      else:
        break

  print "There has been an error, the request never succeeded."