Obtenir un ensemble de données

Après avoir créé un ensemble de données et y avoir importé des données, vous pouvez utiliser des requêtes HTTP GET pour accéder à l'ensemble de données. Cette page explique comment répertorier tous vos jeux de données, comment obtenir des informations sur un jeu de données spécifique et comment télécharger les données à partir d'un jeu de données.

À propos des versions d'ensembles de données

Après une importation de données réussie, l’état du jeu de données est défini sur STATE_COMPLETED et cet ensemble de données devient la version active. Cela signifie que est prêt à être utilisé dans votre application. Pour déterminer le state de l'ensemble de données, vous pouvez soit répertorier tous les ensembles de données, soit obtenir un jeu de données spécifique.

Vous pouvez importer de nouvelles données dans le jeu de données pour créer une nouvelle version du ensemble de données:

  • Si les nouvelles données sont correctement importées, la nouvelle version devient "active" et il s'agit de la version utilisée par votre application.

  • Si une erreur se produit lors de l'importation, la version précédente de l'ensemble de données ayant abouti reste à l'état "actif" et il s'agit de la version utilisée par votre application.

Pour en savoir plus sur la création d'une nouvelle version d'un ensemble de données, consultez la section Importez 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 list dataset (répertorier les 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 de la version active ou non. Si vous souhaitez seulement listez la version active de chaque ensemble de données et 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 toutes 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 du point de terminaison get dataset, inclut 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 du jeu de données, qu'il s'agisse de la version active ou non. Si vous voulez des informations sur la version active de l'ensemble de données, ajoutez le tag @active au tag 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 jeu de données

Pour télécharger les données à partir de la dernière version d'un ensemble de données, envoyez une requête HTTP GET à télécharger 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 contenant les données téléchargées. Par exemple, l'option --output suivante spécifie de télécharger l'ensemble de données dans un fichier nommé myjson.json figurant dans le même fichier : 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 le fichier myjson.json de l'/tmp répertoire:

--output /tmp/myjson.json