データセットの取得

データセットを作成してデータをアップロードしたら、HTTP GET リクエストを使用してデータセットにアクセスできます。このページでは、すべてのデータセットを一覧表示する方法、特定のデータセットに関する情報を取得する方法、データセットからデータをダウンロードする方法について説明します。

データセットのバージョンについて

データのアップロードが正常に完了すると、データセットの状態は STATE_COMPLETED に設定され、そのデータセットはアクティブ バージョンになります。つまり、データセットはアプリで使用できる状態です。データセットの state を確認するには、すべてのデータセットを一覧表示するか、特定のデータセットを取得します。

データセットに新しいデータをアップロードして、データセットの新しいバージョンを作成できます。

新しいデータが正常にアップロードされると、新しいバージョンが「有効な」バージョンになり、アプリで使用されるバージョンになります。
アップロード中にエラーが発生した場合、以前の正常なデータセットバージョンが「有効な」バージョン（アプリで使用されるバージョン）のままになります。

データセットの新しいバージョンの作成の詳細については、データセットに新しいデータをアップロードするをご覧ください。

すべてのデータセットを一覧表示する

データセットを一覧表示エンドポイントに HTTP GET リクエストを送信して、すべてのデータセットを一覧表示します。

https://mapsplatformdatasets.googleapis.com/v1/projects/PROJECT_NUMBER_OR_ID/datasets

このリクエストは、バージョンがアクティブなバージョンかどうかにかかわらず、すべてのデータセットの最新バージョンに関する情報を返します。各データセットのアクティブなバージョンのみを一覧表示する場合は、tag=active クエリパラメータをリクエストに追加します。

https://mapsplatformdatasets.googleapis.com/v1/projects/PROJECT_NUMBER_OR_ID/datasets?tag=active

たとえば、次の呼び出しは、すべてのデータセットの最新バージョンに関する情報を返します。

curl -X GET \
-H 'X-Goog-User-Project: PROJECT_NUMBER_OR_ID' \
-H 'Authorization: Bearer $TOKEN' \
"https://mapsplatformdatasets.googleapis.com/v1/projects/PROJECT_NUMBER_OR_ID/datasets"

この呼び出しを行うと、レスポンスが次の形式で返されます。

{
  "datasets": [
    {
      "name": "projects/PROJECT_NUMBER_OR_ID/datasets/f57074a0-a8b6-403e-9df1-e8a9e4f9fc46",
      "displayName": "My Test Dataset",
      "versionId": "5fb34e-1405-4ecd-8f81-31f1c07",
      "usage": [
        "USAGE_DATA_DRIVEN_STYLING"
      ],
      "gcsSource": {
        "inputUri": "gs://mybucket/my.csv",
        "fileFormat": "FILE_FORMAT_CSV"
      },
      "createTime": "2023-03-24T14:47:37.308977Z",
      "updateTime": "2023-03-24T14:48:05.053114Z",
      "versionCreateTime": "2023-03-24T14:48:05.053114Z",
      "status": {
        "state": "STATE_COMPLETED"
      }
    },
    {
      "name": "projects/PROJECT_NUMBER_OR_ID/datasets/2c8ae479-96704-89c6435ca959",
      "displayName": "My Other Test Dataset",
      "versionId": "0d2e3-b9da-47cc-819f-7ac67562",
      "usage": [
        "USAGE_DATA_DRIVEN_STYLING"
      ],
      "localFileSource": {
        "fileFormat": "FILE_FORMAT_CSV"
      },
      "createTime": "2023-03-24T14:41:52.579755Z",
      "updateTime": "2023-03-24T14:42:56.784122Z",
      "versionCreateTime": "2023-03-24T14:42:56.784122Z",
      "status": {
        "state": "STATE_COMPLETED"
      }
    }
  ]
}

データセットに関する情報を取得する

特定のデータセットの情報を取得するには、データセットの ID も含めて get dataset エンドポイントに HTTP GET リクエストを送信します。

https://mapsplatformdatasets.googleapis.com/v1/projects/PROJECT_NUMBER_OR_ID/datasets/DATASET_ID

このリクエストは、バージョンがアクティブなバージョンかどうかに関係なく、データセットの最新バージョンに関する情報を返します。データセットのアクティブなバージョンに関する情報を取得するには、リクエストに @active タグを追加します。

https://mapsplatformdatasets.googleapis.com/v1/projects/PROJECT_NUMBER_OR_ID/datasets/DATASET_ID@active

次に例を示します。

curl -X GET \
-H 'X-Goog-User-Project: PROJECT_NUMBER_OR_ID' \
-H 'Authorization: Bearer $TOKEN' \
"https://mapsplatformdatasets.googleapis.com/v1/projects/PROJECT_NUMBER_OR_ID/datasets/f57074a0-a8b6-403e-9df1-e8a9e4f9fc46@active"

このリクエストは、次の形式でレスポンスを返します。

{
  "name": "projects/PROJECT_NUMBER_OR_ID/datasets/f57074a0-a8b6-403e-9df1-e8a9e4f9fc46",
  "displayName": "My Test Dataset",
  "versionId": "5fb34e-1405-4ecd-8f81-31f1c07",
  "usage": [
    "USAGE_DATA_DRIVEN_STYLING"
  ],
  "gcsSource": {
    "inputUri": "gs://mybucket/my.csv",
    "fileFormat": "FILE_FORMAT_CSV"
  },
  "createTime": "2023-03-24T14:47:37.308977Z",
  "updateTime": "2023-03-24T14:48:05.053114Z",
  "versionCreateTime": "2023-03-24T14:48:05.053114Z",
  "status": {
    "state": "STATE_COMPLETED"
  }
}

データセットをダウンロードする

最新バージョンのデータセットからデータをダウンロードするには、データセットの ID も含めてデータセットをダウンロードするエンドポイントに HTTP GET リクエストを送信します。

https://mapsplatformdatasets.googleapis.com/v1/projects/PROJECT_NUMBER_OR_ID/datasets/DATASET_ID:download?alt=media