取得資料集

建立資料集並上傳資料後，您可以使用 HTTP GET 要求存取資料集。本頁說明如何列出所有資料集、取得特定資料集的相關資訊，以及從資料集下載資料。

關於資料集版本

資料上傳成功後，資料集的狀態會設為 STATE_COMPLETED，且該資料集會成為有效版本。這意味著該資料集已準備好在您的應用程式中使用。若要確定資料集的 state，您可以列出所有資料集或取得特定資料集。

你可以將新資料上傳至資料集，建立新的資料集版本：

  • 如果新資料上傳成功，則新版本將成為「活動」版本，並且是您的應用程式使用的版本。

  • 如果上傳過程中出現錯誤，則先前成功上傳的資料集版本將保留為「活動」版本，並且是您的應用程式使用的版本。

有關建立資料集新版本的更多信息，請參閱上傳新資料到資料集。

列出所有資料集

透過向 list datasets 端點傳送 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