Google Analytics Data API のリクエストには request.returnPropertyQuota を true で設定しておいた方がいい

request.returnPropertyQuota とは

API のレートリミットに関する情報を戻り値に含むかどうかのプロパティです。

デフォルトは false です。false の場合はプロパティそのものが返ってきません。

レートリミットとは(公式ドキュメント)

developers.google.com

true にするとどのような値が返ってくるか

true にするとレスポンス直下に propertyQuota というプロパティが生成されて返ってきます。その値は例えば以下のとおりです。

  "propertyQuota": {
    "potentiallyThresholdedRequestsPerHour": {
      "consumed": 0,
      "remaining": 120
    },
    "serverErrorsPerProjectPerHour": {
      "remaining": 10,
      "consumed": 0
    },
    "tokensPerDay": {
      "consumed": 1,
      "remaining": 24928
    },
    "tokensPerHour": {
      "consumed": 1,
      "remaining": 4998
    },
    "concurrentRequests": {
      "consumed": 0,
      "remaining": 10
    },
    "tokensPerProjectPerHour": {
      "remaining": 1748,
      "consumed": 1
    }
  },
Powered by はてなブログ