Champs standards

Cette section décrit un ensemble de définitions de champs de message standards à utiliser lorsque des concepts similaires sont nécessaires. Cela garantira que le même concept a le même nom et la même sémantique dans différentes API.

Nom	Type	Description
name	string	Le champ name doit contenir le nom de ressource relatif.
parent	string	Pour les définitions de ressource et les requêtes List/Create, le champ parent doit contenir le nom de ressource relatif parent.
create_time	Timestamp	L'horodatage de création d'une entité.
update_time	Timestamp	L'horodatage de la dernière mise à jour d'une entité. Remarque : update_time est mis à jour lorsque l'opération create/patch/delete est exécutée.
delete_time	Timestamp	L'horodatage de suppression d'une entité, seulement si elle est compatible avec la conservation.
expire_time	Timestamp	L'horodatage d'expiration d'une entité si elle arrive à expiration.
start_time	Timestamp	L'horodatage marquant le début d'une période donnée.
end_time	Timestamp	L'horodatage marquant la fin d'une période ou d'une opération (qu'elle aboutisse ou non) donnée.
read_time	Timestamp	L'horodatage pendant lequel une entité particulière doit être lue (si utilisée dans une requête) ou a été lue (si utilisée dans une réponse).
time_zone	string	Le nom du fuseau horaire. Il doit s'agir d'un nom TZ IANA, tel que "America/Los_Angeles". Pour plus d'informations, consultez la page à l'adresse : https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
region_code	string	Le code de pays/région Unicode (CLDR) d'un emplacement, tel que "US" et "419". Pour plus d'informations, consultez la page à l'adresse : http://www.unicode.org/reports/tr35/#unicode_region_subtag.
language_code	string	Le code de langue BCP-47, tel que "en-US" ou "sr-Latn". Pour plus d'informations, consultez la page à l'adresse : http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
mime_type	string	Un type MIME publié par l'IANA (également appelé type de média). Pour plus d'informations, consultez la page à l'adresse : https://www.iana.org/assignments/media-types/media-types.xhtml.
display_name	string	Le nom à afficher d'une entité.
title	string	Le nom officiel d'une entité, tel que le nom de la société. Il doit être considéré comme la version officielle de display_name.
description	string	Un ou plusieurs paragraphes de texte de description d'une entité.
filter	string	Le paramètre de filtre standard pour les méthodes List. Voir AIP-160.
query	string	Identique à filter s'il est appliqué à une méthode de recherche (par exemple, :search)
page_token	string	Le jeton de pagination dans la requête List.
page_size	int32	La taille de la pagination dans la requête List.
total_size	int32	Le nombre total d'éléments dans la liste, quelle que soit la pagination.
next_page_token	string	Le prochain jeton de pagination dans la réponse List. Il devrait être utilisé comme page_token pour la requête suivante. Une valeur vide signifie qu'il n'y a plus aucun résultat.
order_by	string	Spécifie le classement des résultats des requêtes List.
progress_percent	int32	Spécifie la progression d'une action en pourcentage (0-100). La valeur -1 signifie que la progression est inconnue.
request_id	string	Un identifiant de chaîne unique utilisé pour détecter les requêtes dupliquées.
resume_token	string	Un jeton opaque utilisé pour reprendre une requête en streaming.
labels	map<string, string>	Représente des libellés de ressources Cloud.
show_deleted	bool	Si une ressource autorise le rétablissement du comportement, la méthode List correspondante doit comporter un champ show_deleted afin que le client puisse découvrir les ressources supprimées.
update_mask	FieldMask	Il est utilisé pour le message de requête Update pour effectuer une mise à jour partielle sur une ressource. Ce masque concerne la ressource et non le message de la requête.
validate_only	bool	Si la valeur est "true", cela indique que la requête donnée doit seulement être validée, mais pas exécutée.

Paramètres système

Outre les champs standards, les API Google sont également compatibles avec un ensemble de paramètres de requête communs disponibles pour toutes les méthodes d'API. Ces paramètres sont appelés paramètres système. Pour en savoir plus, consultez la section Paramètres système.