履歴

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

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

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

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

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

試してみる

1 時間のリクエストの例

1 時間のリクエスト本文

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

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 を選択します。
必要に応じてリクエストパラメータを編集します。
[実行] ボタンを選択します。ダイアログで、リクエストの送信に使用するアカウントを選択します。
API Explorer パネルで、全画面表示アイコン fullscreen を選択して API Explorer ウィンドウを開きます。

履歴 コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

1 時間のリクエストの例

1 時間のリクエスト本文

1 時間のレスポンス

期間リクエストの例

期間リクエスト

期間のレスポンス

試してみる

履歴