Obtenir un ensemble de données

Une fois que vous avez créé un ensemble de données et que vous y avez importé des données, vous pouvez utiliser des requêtes HTTP GET pour y accéder. Cette page explique comment répertorier tous vos ensembles de données, comment obtenir des informations sur un ensemble de données spécifique et comment télécharger les données d'un ensemble de données.

À propos des versions d'ensemble de données

Une fois les données importées, l'état de l'ensemble de données est défini sur STATE_COMPLETED, et cet ensemble de données devient la version active. Cela signifie que l' ensemble de données est prêt à être utilisé dans votre application. Pour déterminer l'state de l'ensemble de données, vous pouvez répertorier tous les ensembles de données ou obtenir un ensemble de données spécifique.

Vous pouvez importer de nouvelles données dans l'ensemble de données pour créer une nouvelle version de l'ensemble de données :

  • Si les nouvelles données sont importées, la nouvelle version devient la version "active" et est celle utilisée par votre application.

  • En cas d'erreur lors de l'importation, la version précédente de l'ensemble de données reste la version "active" et est celle utilisée par votre application.

Pour en savoir plus sur la création d'une version d'un ensemble de données, consultez Importer de nouvelles données dans l'ensemble de données.

Répertorier tous les ensembles de données

Répertoriez tous les ensembles de données en envoyant une requête HTTP GET au point de terminaison de la liste des ensembles de données :

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

Cette requête renvoie des informations sur la dernière version de tous les ensembles de données, qu'il s'agisse ou non de la version active. Si vous ne souhaitez répertorier que la version active de chaque ensemble de données, ajoutez le paramètre de requête tag=active à la requête :

https://mapsplatformdatasets.googleapis.com/v1/projects/PROJECT_NUMBER_OR_ID/datasets?tag=active

Par exemple, cet appel renvoie des informations sur la dernière version de tous les ensembles de données :

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"

Cet appel renvoie une réponse au format suivant :

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

Obtenir des informations sur un ensemble de données

Pour obtenir des informations sur un ensemble de données spécifique, envoyez une requête HTTP GET au point de terminaison de l'ensemble de données, qui inclut également l'ID de l'ensemble de données :

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

Cette requête renvoie des informations sur la dernière version de l'ensemble de données, qu'il s'agisse ou non de la version active. Si vous souhaitez obtenir des informations sur la version active de l'ensemble de données, ajoutez le tag @active à la requête :

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

Exemple :

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"

Cette requête renvoie une réponse au format suivant :

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

Télécharger un ensemble de données

Pour télécharger les données de la dernière version d'un ensemble de données, envoyez une requête HTTP GET au point de terminaison de l'ensemble de données , qui inclut également l'ID de l'ensemble de données :

https://mapsplatformdatasets.googleapis.com/v1/projects/PROJECT_NUMBER_OR_ID/datasets/DATASET_ID:download?alt=media

Exemple :

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"

Dans cet exemple, vous utilisez l'option cURL --output pour spécifier le nom du fichier contenant les données téléchargées. Par exemple, l'indicateur --output suivant spécifie de télécharger l'ensemble de données dans un fichier nommé myjson.json dans le même répertoire que celui utilisé pour exécuter la commande cURL :

--output myjson.json

Vous pouvez également utiliser l'indicateur suivant pour télécharger les données dans myjson.json dans le répertoire /tmp :

--output /tmp/myjson.json