Receber um conjunto de dados

Depois de criar um conjunto de dados e fazer upload de dados para ele, use solicitações HTTP GET para acessá-lo. Nesta página, descrevemos como listar todos os conjuntos de dados, como receber informações sobre um conjunto de dados específico e como fazer o download dos dados de um conjunto de dados.

Sobre as versões do conjunto de dados

Após o upload dos dados, o estado do conjunto de dados é definido como STATE_COMPLETED, e ele se torna a versão ativa. Isso significa que o conjunto de dados está pronto para ser usado no app. Para determinar o state do conjunto de dados, liste todos os conjuntos de dados ou acesse um conjunto de dados específico.

É possível fazer upload de novos dados para o conjunto de dados para criar uma nova versão dele:

  • Se o upload dos novos dados for bem-sucedido, a nova versão se tornará a versão "ativa" e será usada pelo app.

  • Se houver um erro no upload, a versão anterior do conjunto de dados que foi enviada com sucesso permanecerá como a versão "ativa" e será usada pelo app.

Para mais informações sobre como criar uma nova versão de um conjunto de dados, consulte Fazer upload de novos dados para o conjunto de dados.

Listar todos os conjuntos de dados

Liste todos os conjuntos de dados enviando uma solicitação HTTP GET para o endpoint list datasets:

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

Essa solicitação retorna informações sobre a versão mais recente de todos os conjuntos de dados, mesmo que ela não seja a versão ativa. Se você quiser listar apenas a versão ativa de cada conjunto de dados, anexe o parâmetro de consulta tag=active à solicitação:

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

Por exemplo, esta chamada retorna informações sobre a versão mais recente de todos os conjuntos de dados:

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"

Essa chamada retorna uma resposta no formato:

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

Receber informações sobre um conjunto de dados

Para receber informações sobre um conjunto de dados específico, envie uma solicitação HTTP GET ao endpoint get dataset que também inclua o ID do conjunto de dados:

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

Essa solicitação retorna informações sobre a versão mais recente do conjunto de dados, independentemente de ela ser a versão ativa. Se você quiser informações sobre a versão ativa do conjunto de dados, anexe a tag @active à solicitação:

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

Exemplo:

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"

Essa solicitação retorna uma resposta no formato:

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

Fazer o download de um conjunto de dados

Para baixar os dados da versão mais recente de um conjunto de dados, envie uma solicitação HTTP GET ao endpoint download dataset que também inclua o ID do conjunto de dados:

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

Exemplo:

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"

Neste exemplo, você usa a opção cURL --output para especificar o nome do arquivo que contém os dados transferidos por download. Por exemplo, a flag --output a seguir especifica o download do conjunto de dados em um arquivo chamado myjson.json no mesmo diretório usado para executar o comando cURL:

--output myjson.json

Ou use a seguinte flag para fazer o download dos dados para myjson.json no diretório /tmp:

--output /tmp/myjson.json