AI-generated Key Takeaways
-
Update dataset metadata, such as
displayNameanddescription, using an HTTPPATCHrequest to the specified endpoint with the dataset ID. -
To update the actual data within the dataset, a separate procedure outlined in the "Upload new data to the dataset" documentation should be followed.
-
By default, a
PATCHrequest updates all provided fields (displayName,description), but you can selectively update fields using theupdateMaskquery parameter. -
The
updateMaskparameter accepts a comma-separated list of field names, allowing for granular control over which dataset attributes are modified.
Update information about a dataset by sending an HTTP PATCH
request to the patch dataset
endpoint that
also includes the ID of the dataset:
https://mapsplatformdatasets.googleapis.com/v1/projects/ PROJECT_NUMBER_OR_ID /datasets/ DATASET_ID
You can update either or both of the displayName
and description
properties
of the dataset.
For example:
curl -X PATCH -d '{ "displayName": "My Updated Dataset", "description": "This is an updated description" }' \ -H 'X-Goog-User-Project: PROJECT_NUMBER_OR_ID ' \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $TOKEN" \ "https://mapsplatformdatasets.googleapis.com/v1/projects/ PROJECT_NUMBER_OR_ID /datasets/f57074a0-a8b6-403e-9df1-e8a9e4f9fc46"
The request returns information about the updated dataset:
{ "name": "projects/ PROJECT_NUMBER_OR_ID /datasets/f57074a0-a8b6-403e-9df1-e8a9e4f9fc46", "displayName": "My Updated Dataset", "description": "This is an updated description", "versionId": "5fb3b84e-1405-4ecd-8f81-9183631f1c07", "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-28T15:17:17.919351Z", "versionCreateTime": "2023-03-24T14:48:05.053114Z", "status": { "state": "STATE_COMPLETED" } }
Specify a field mask
By default, the update modifies all the supported fields specified in the body
of the request, meaning both displayName
and description
. However, you can
also include the updateMask
query parameter in the request to explicitly specify the fields in the
request body to update.
Use updateMask
to specify a comma-separated list of fully qualified names of
fields to update. For example, to update only the displayName
field:
curl -X PATCH -d '{ "displayName": "My Updated Dataset", "description": "This is an updated description" }' \ -H 'X-Goog-User-Project: PROJECT_NUMBER_OR_ID ' \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $TOKEN" \ "https://mapsplatformdatasets.googleapis.com/v1/projects/ PROJECT_NUMBER_OR_ID /datasets/f57074a0-a8b6-403e-9df1-e8a9e4f9fc46 ?updateMask=displayName"
The default value of the updateMask
query parameter is *
meaning
update all supported fields specified in the request body.
