Google は AI 技術を使用して、コンテンツをご希望の言語に翻訳しています。AI 翻訳には誤りが含まれる場合があります。

履歴

history エンドポイントは、指定された期間（最長 30 日）における特定の場所の 1 時間ごとの大気質の履歴情報を提供します。返される AQI と関連情報（汚染物質の濃度レベルや健康に関する推奨事項など）を制御できます。

1 時間ごとの大気質の履歴をリクエストするには、history エンドポイントを使用します。HTTP POST リクエストを次の宛先に送信します。

https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY

JSON リクエスト本文にリクエストオプションを含めます。リクエストの本文には、1 時間ごとの大気質の履歴を取得する場所と期間が含まれます。また、レスポンスに含める大気質情報を制御するためのさまざまなオプションも含まれる場合があります。

API Explorer を使用すると、ライブリクエストを送信して、API と API オプションを理解できます。

試してみる

1 時間のリクエストの例

1 時間のリクエスト本文

次のコードは、history メソッドを使用して、1 時間の履歴リクエストのリクエスト本文を作成する方法を示しています。この例では、ロケーションと過去のタイムスタンプを設定します。

curl -X POST -d '{
  "dateTime": "2023-06-26T15:01:23Z",
  "location": {
    "latitude": 37.419734,
    "longitude": -122.0827784
  }
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'

1 時間以内の対応

上記の呼び出しにより、次の JSON レスポンスが生成されます。レスポンスデータの詳細については、レスポンスデータをご覧ください。

{
    "hoursInfo": [
        {
            "dateTime": "2023-06-26T15:00:00Z",
            "indexes": [
                {
                    "code": "uaqi",
                    "displayName": "Universal AQI",
                    "aqi": 73,
                    "aqiDisplay": "73",
                    "color": {
                        "red": 118,
                        "green": 202,
                        "blue": 51,
                        "alpha": 255
                    },
                    "category": "Good air quality",
                    "dominantPollutant": "pm10"
                }
            ]
        }
    ],
    "regionCode": "us"
}

期間リクエストの例

期間リクエスト

次のコードは、過去の 1 時間ごとの大気質の複数のレコードを返す history のリクエスト本文を作成する方法を示しています。

複数のレコードをリクエストするには、期間（開始タイムスタンプと終了タイムスタンプ）を指定するか、現在時刻から遡る時間数を指定します。

以下の例では、ページサイズを 2 に設定しているため、4 時間の大気質の履歴をリクエストすると、2 ページに分けて返されます。各ページには 2 時間分のデータが含まれます。

curl -X POST -d '{
  "hours": 4,
  "pageSize": 2,
  "pageToken":"",
  "location": {
    "latitude": 37.419734,
    "longitude": -122.0827784
  }
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'

開始タイムスタンプと終了タイムスタンプを渡すことで、同様のリクエストを行うことができます。

curl -X POST -d '{
  "period": {
      "startTime":"2023-06-15T08:00:00Z",
      "endTime":"2023-06-15T12:00:00Z"
  },
  "pageSize": 2,
  "pageToken":"",
  "location": {
    "latitude": 37.419734,
    "longitude": -122.0827784
  }
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'

期間の回答

上記の呼び出しにより、次の形式の JSON レスポンスが生成されます。レスポンスデータの詳細については、レスポンスデータをご覧ください。

上記のどちらの呼び出しも、4 時間の大気質データをリクエストします。ただし、リクエストで pageSize プロパティを 2 に設定したため、レスポンスには直近 2 時間の結果のみが含まれます。

{
    "hoursInfo": [
        {
            "dateTime": "2023-06-15T11:00:00Z",
            "indexes": [
                {
                    "code": "uaqi",
                    "displayName": "Universal AQI",
                    "aqi": 83,
                    "aqiDisplay": "83",
                    "color": {
                        "red": 74,
                        "green": 185,
                        "blue": 54,
                        "alpha": 255
                    },
                    "category": "Excellent air quality",
                    "dominantPollutant": "o3"
                }
            ]
        },
        {
            "dateTime": "2023-06-15T10:00:00Z",
            "indexes": [
                {
                    "code": "uaqi",
                    "displayName": "Universal AQI",
                    "aqi": 89,
                    "aqiDisplay": "89",
                    "color": {
                        "red": 48,
                        "green": 175,
                        "blue": 55,
                        "alpha": 255
                    },
                    "category": "Excellent air quality",
                    "dominantPollutant": "o3"
                }
            ]
        }
    ],
    "regionCode": "us",
    "nextPageToken": "ChYaEgl3gv3XubVCQBEsNMY9TTdUMTE6MDA6MDA"
}

レスポンスには nextPageToken プロパティも含まれています。このプロパティを使用して、結果の次のページにアクセスします。このページには、次の 2 時間のデータが含まれています。

次の結果ページにアクセスするには、history エンドポイントに 2 回目のリクエストを送信します。ただし、今回は pageToken プロパティを最初のレスポンスの nextPageToken の値に設定します。

curl -X POST -d '{
  "hours": 4,
  "pageSize": 2,
  "pageToken":"ChYaEgl3gv3XubVCQBEsNMY9TTdUMTE6MDA6MDA",
  "location": {
    "latitude": 37.419734,
    "longitude": -122.0827784
  }
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'

試してみよう:

API Explorer を使用すると、サンプルリクエストを作成して、API と API オプションに慣れることができます。

ページの右側にある API アイコン api を選択します。
必要に応じて、リクエストパラメータを編集します。
[Execute] ボタンを選択します。ダイアログで、リクエストに使用するアカウントを選択します。
API Explorer パネルで、全画面表示アイコン fullscreen を選択して、API Explorer ウィンドウを拡大します。