取得資料集

建立資料集並上傳資料後,您可以使用 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 旗標 指定將資料集下載至同樣位於相同位置且名為 myjson.json 的檔案 用於執行 cURL 指令的目錄:

--output myjson.json

或使用以下旗標,將資料下載到 /tmp 中的 myjson.json。 目錄:

--output /tmp/myjson.json