Package google.maps.mapsplatformdatasets.v1

Index

MapsPlatformDatasets

Définition du service pour l'API Maps Platform Datasets.

CreateDataset

rpc CreateDataset(CreateDatasetRequest) returns (Dataset)

Crée un ensemble de données pour le projet spécifié.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform
Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • mapsplatformdatasets.datasets.create

Pour en savoir plus, consultez la documentation IAM.
DeleteDataset

rpc DeleteDataset(DeleteDatasetRequest) returns (Empty)

Supprime l'ensemble de données spécifié.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform
Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • mapsplatformdatasets.datasets.delete

Pour en savoir plus, consultez la documentation IAM.
DownloadDataset

rpc DownloadDataset(DownloadDatasetRequest) returns (DownloadDatasetResponse)

Télécharge un ensemble de données.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform
Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • mapsplatformdatasets.datasets.export

Pour en savoir plus, consultez la documentation IAM.
FetchDatasetErrors

rpc FetchDatasetErrors(FetchDatasetErrorsRequest) returns (FetchDatasetErrorsResponse)

Récupère toutes les erreurs d'un ensemble de données.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform
Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource dataset :

  • mapsplatformdatasets.datasets.get

Pour en savoir plus, consultez la documentation IAM.
GetDataset

rpc GetDataset(GetDatasetRequest) returns (Dataset)

Récupère l'ensemble de données.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform
Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • mapsplatformdatasets.datasets.get

Pour en savoir plus, consultez la documentation IAM.
ImportDataset

rpc ImportDataset(ImportDatasetRequest) returns (ImportDatasetResponse)

Importe une nouvelle version des données pour l'ensemble de données.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform
Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • mapsplatformdatasets.datasets.import

Pour en savoir plus, consultez la documentation IAM.
ListDatasets

rpc ListDatasets(ListDatasetsRequest) returns (ListDatasetsResponse)

Répertorie tous les ensembles de données du projet spécifié.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform
Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • mapsplatformdatasets.datasets.list

Pour en savoir plus, consultez la documentation IAM.
UpdateDatasetMetadata

rpc UpdateDatasetMetadata(UpdateDatasetMetadataRequest) returns (Dataset)

Met à jour les métadonnées de l'ensemble de données.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform
Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • mapsplatformdatasets.datasets.update

Pour en savoir plus, consultez la documentation IAM.

CreateDatasetRequest

Requête de création d'un ensemble de données Maps.

Champs
parent

string

Obligatoire. Projet parent qui sera propriétaire de l'ensemble de données. Format: projects/{project}
dataset

Dataset

Obligatoire. Version de l'ensemble de données à créer.

Ensemble de données

Représentation d'une ressource d'ensemble de données.

Champs
name

string

Nom de la ressource. Format: projects/{project}/datasets/{dataset_id}
display_name

string

Nom lisible, affiché dans l'interface utilisateur de la console.

Doit être unique au sein d'un projet.
description

string

Description de cet ensemble de données.
version_id

string

ID de version de l'ensemble de données.
usage[]

Usage

Cas d'utilisation spécifié pour cet ensemble de données.
status

Status

Uniquement en sortie. État de la version de cet ensemble de données.
create_time

Timestamp

Uniquement en sortie. Heure à laquelle l'ensemble de données a été créé pour la première fois.
update_time

Timestamp

Uniquement en sortie. Heure de la dernière mise à jour des métadonnées de l'ensemble de données.
version_create_time

Timestamp

Uniquement en sortie. Heure à laquelle cette version a été créée.
version_description

string

Uniquement en sortie. Description de cette version de l'ensemble de données. Il est fourni lors de l'importation de données dans l'ensemble de données.
Champ d'union data_source. Détails sur la source des données de l'ensemble de données. data_source ne peut être qu'un des éléments suivants :
local_file_source

LocalFileSource

Source de fichiers locale pour l'ensemble de données pour une seule importation.
gcs_source

GcsSource

Une source de fichiers Google Cloud Storage pour l'ensemble de données pour une seule importation.

DeleteDatasetRequest

Requête de suppression d'un ensemble de données.

Champs
name

string

Obligatoire. Nom de l'ensemble de données à supprimer. Format: projects/{project}/datasets/{dataset_id}

DownloadDatasetRequest

Requête de téléchargement de l'ensemble de données.

Champs
name

string

Nom de ressource de l'ensemble de données à extraire. Format: projects/{project}/datasets/{dataset_id}

DownloadDatasetResponse

Objet de réponse de DownloadDataset.

FetchDatasetErrorsRequest

Requête permettant de lister les erreurs détaillées appartenant à un ensemble de données.

Champs
dataset

string

Obligatoire. Nom de l'ensemble de données pour lequel répertorier toutes les erreurs. Format: projects/{project}/datasets/{dataset_id}
page_size

int32

Nombre maximal d'erreurs à renvoyer par page.

La valeur maximale est 500. les valeurs supérieures à 500 seront limitées à 500.

Si aucune valeur n'est spécifiée, 50 erreurs au maximum seront renvoyées.
page_token

string

Jeton de page, reçu d'un appel ListDatasetErrors précédent. Fournissez-le pour récupérer la page suivante.

FetchDatasetErrorsResponse

Objet de réponse de FetchDatasetErrors.

Champs
next_page_token

string

Jeton pouvant être envoyé en tant que page_token pour récupérer la page suivante.

Si ce champ est omis, il n'y a pas d'autres pages.
errors[]

Status

Erreurs associées à un ensemble de données.

FileFormat

Format du fichier importé.

Enums
FILE_FORMAT_UNSPECIFIED Format de fichier non spécifié.
FILE_FORMAT_GEOJSON GeoJson.
FILE_FORMAT_KML KML.
FILE_FORMAT_CSV CSV.

GcsSource

Détails concernant la source de données lorsqu'elle se trouve dans Google Cloud Storage.

Champs
input_uri

string

URI des données sources. Par exemple, gs://my_bucket/my_object.
file_format

FileFormat

Format de fichier de l'objet Google Cloud Storage. Elle est principalement utilisée pour la validation.

GetDatasetRequest

Requête d'obtention de l'ensemble de données spécifié.

Champs
name

string

Obligatoire. Nom de la ressource. Format: projects/{project}/datasets/{dataset_id}

Vous pouvez également récupérer certaines versions spéciales en ajoutant "@". et un tag. Format: projects/{project}/datasets/{dataset_id}@{tag}

Tag "active" : les informations sur la dernière version terminée seront incluses, et NOT_FOUND si l'ensemble de données n'en possède pas.

ImportDatasetRequest

Requête d'importation d'une nouvelle version de l'ensemble de données.

Champs
name

string

Obligatoire. Nom de la ressource. Format: projects/{project}/datasets/{dataset_id}
version_description

string

Description des nouvelles données importées.
Champ d'union data_source. Détails sur la source des données de l'ensemble de données. data_source ne peut être qu'un des éléments suivants :
local_file_source

LocalFileSource

Source de fichiers locale de l'ensemble de données pour une importation unique.
gcs_source

GcsSource

Une source de fichiers Google Cloud Storage pour l'ensemble de données pour une importation unique.

ImportDatasetResponse

Objet de réponse d'ImportDataset.

Champs
name

string

Obligatoire. Nom de ressource de la version de l'ensemble de données nouvellement créé. Format: projects/{project}/datasets/{dataset_id}@{version_id}

ListDatasetsRequest

Requête permettant de répertorier les ensembles de données du projet.

Champs
parent

string

Obligatoire. Nom du projet pour lequel répertorier tous les ensembles de données. Format: projects/{project}
page_size

int32

Nombre maximal d'ensembles de données à renvoyer par page.

Si la valeur n'est pas spécifiée (ou la valeur zéro), tous les ensembles de données sont renvoyés.
page_token

string

Jeton de page, reçu d'un appel ListDatasets précédent. Fournissez-le pour récupérer la page suivante.
tag

string

Tag qui spécifie la version souhaitée pour chaque ensemble de données.

Notez que lorsque la pagination est également spécifiée, un certain filtrage peut se produire après la pagination, ce qui peut amener la réponse à contenir moins d'ensembles de données que la taille de la page, même s'il ne s'agit pas de la dernière page.

Taguez "active" : chaque ensemble de données dans la réponse inclura les informations sur sa dernière version terminée. S'il n'en a pas, l'ensemble de données sera ignoré.

ListDatasetsResponse

Objet de réponse de ListDatasets.

Champs
datasets[]

Dataset

Tous les ensembles de données du projet.
next_page_token

string

Jeton pouvant être envoyé en tant que page_token pour récupérer la page suivante.

Si ce champ est omis, il n'y a pas d'autres pages.

LocalFileSource

Informations sur la source de données lorsqu'il s'agit d'un fichier local.

Champs
filename

string

Nom du fichier importé.
file_format

FileFormat

Format du fichier en cours d'importation.

État

État de l'ensemble de données.

Champs
state

State

Énumération de l'état pour l'état.
error_message

string

Message d'erreur indiquant la raison de l'échec. Ce champ est vide si l'état des ensembles de données n'est pas "Échec".

État

Liste des états de l'ensemble de données.

Enums
STATE_UNSPECIFIED L'état de cet ensemble de données n'est pas défini.
STATE_IMPORTING Les données sont en cours d'importation dans un ensemble de données.
STATE_IMPORT_SUCCEEDED Les données ont bien été importées dans un ensemble de données.
STATE_IMPORT_FAILED Échec de l'importation des données dans un ensemble de données.
STATE_DELETING L'ensemble de données est en cours de suppression.
STATE_DELETION_FAILED État "Échec de la suppression". Cet état indique que la suppression de l'ensemble de données a échoué. Une nouvelle tentative de suppression peut être effectuée.
STATE_PROCESSING Les données sont en cours de traitement.
STATE_PROCESSING_FAILED État d'échec du traitement. Cet état indique que le traitement a échoué et peut signaler des erreurs.
STATE_NEEDS_REVIEW Cet état n'est pas utilisé actuellement.
STATE_PUBLISHING État de publication. Cet état indique que la publication est en cours.
STATE_PUBLISHING_FAILED États "Échec de la publication". Cet état indique que la publication a échoué. Une nouvelle tentative de publication peut être effectuée.
STATE_COMPLETED État "Terminé". Cet état représente l'ensemble de données disponible pour son utilisation spécifique.

UpdateDatasetMetadataRequest

Requête pour mettre à jour les champs de métadonnées de l'ensemble de données.

Champs
dataset

Dataset

Obligatoire. Nom de ressource de l'ensemble de données à mettre à jour. Format: projects/{project}/datasets/{dataset_id}
update_mask

FieldMask

Liste des champs à mettre à jour.

La valeur "*" est utilisé pour le remplacement complet (par défaut).

Utilisation

"Utilisation" indique où les données sont destinées à être utilisées pour déterminer comment les traiter.

Enums
USAGE_UNSPECIFIED L'utilisation de cet ensemble de données n'est pas définie.
USAGE_DATA_DRIVEN_STYLING Cet ensemble de données sera utilisé pour le style basé sur les données.