history エンドポイントは、指定された時間範囲（最長 30 日）における特定の場所の 1 時間ごとの過去の大気質情報を提供します。どの AQI と関連情報を返すか（汚染物質の濃度レベルや健康に関する推奨事項など）を制御できます。
1 時間ごとの大気質履歴をリクエストするには、次のエンドポイントに HTTP POST リクエストを送信します。history
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 ウィンドウを拡大します。