取得資料集

建立資料集並上傳資料後,您可以使用 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"
      }
    }
  ]
}

取得資料集相關資訊

如要取得特定資料集的相關資訊,請將 HTTP GET 要求傳送至取得資料集端點,該端點也包含資料集的 ID:

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"
  }
}

下載資料集

如要從最新版本的資料集下載資料,請將 HTTP GET 要求傳送至下載資料集端點,並附上資料集的 ID:

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

例如:

curl -X GET -L \
-H 'X-Goog-User-Project: PROJECT_NUMBER_OR_ID' \
-H 'Authorization: Bearer $TOKEN' \
--output LOCAL_LOCATION_TO_OUTPUT \
"https://mapsplatformdatasets.googleapis.com/download/v1/projects/PROJECT_NUMBER_OR_ID/datasets/f57074a0-a8b6-403e-9df1-e8a9e4f9fc46:download?alt=media"

在本例中,您會使用 cURL --output 選項指定儲存下載資料的檔案名稱。舉例來說,下列 --output 標記會指定將資料集下載至用來執行 cURL 指令的相同目錄中,並命名為 myjson.json

--output myjson.json

或者,您也可以使用下列旗標,將資料下載至 /tmp 目錄中的 myjson.json

--output /tmp/myjson.json