创建数据集并向其上传数据后,您可以使用 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
标志指定将数据集下载到名为 myjson.json 的文件中,该文件位于用于运行 cURL
命令的同一目录中:
--output myjson.json
或者使用以下标志将数据下载到 /tmp
目录中的 myjson.json:
--output /tmp/myjson.json