データセットの更新

データセットに関する情報を更新するには、データセットの ID も含む HTTP PATCH リクエストを データセットのパッチ適用エンドポイントに送信します。

https://mapsplatformdatasets.googleapis.com/v1/projects/PROJECT_NUMBER_OR_ID/datasets/DATASET_ID

データセットの displayName プロパティと description プロパティの一方または両方を更新できます。

次に例を示します。

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"

リクエストは、更新されたデータセットに関する情報を返します。

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

フィールド マスクを指定する

デフォルトでは、更新により、リクエストの本文で指定されたサポート対象のすべてのフィールド（displayName と description の両方）が変更されます。ただし、リクエストに updateMask クエリ パラメータを含めて、更新するリクエスト本文のフィールドを明示的に指定することもできます。

updateMask を使用して、更新するフィールドの完全修飾名のカンマ区切りリストを指定します。たとえば、displayName フィールドのみを更新するには:

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"

updateMask クエリ パラメータのデフォルト値は * です。これは、リクエストの本文で指定されたサポート対象のすべてのフィールドを更新することを意味します。