Campi standard

Questa sezione descrive un insieme di definizioni standard dei campi di messaggio che devono essere utilizzate quando sono necessari concetti simili. In questo modo lo stesso concetto ha lo stesso nome e la stessa semantica in API diverse.

Nome	Tipo	Descrizione
name	string	Il campo name deve contenere il nome della risorsa relativa.
parent	string	Per le definizioni delle risorse e le richieste Elenco/Crea, il campo parent deve contenere il nome della risorsa relativa padre.
create_time	Timestamp	Il timestamp di creazione di un'entità.
update_time	Timestamp	Il timestamp dell'ultimo aggiornamento di un'entità. Nota: update_time viene aggiornato quando viene eseguita l'operazione di creazione/applicazione di patch/eliminazione.
delete_time	Timestamp	Il timestamp di eliminazione di un'entità, solo se supporta la conservazione.
expire_time	Timestamp	Il timestamp di scadenza di un'entità nel caso in cui stia per scadere.
start_time	Timestamp	Il timestamp che segna l'inizio di un determinato periodo di tempo.
end_time	Timestamp	Il timestamp che segna la fine di un determinato periodo di tempo o di un'operazione (indipendentemente dall'esito positivo).
read_time	Timestamp	Il timestamp in cui una determinata entità deve essere letta (se utilizzata in una richiesta) o è stata letta (se utilizzata in una risposta).
time_zone	string	Il nome del fuso orario. Deve essere un nome IANA TZ, ad esempio "America/Los_Angeles". Per ulteriori informazioni, visita la pagina https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
region_code	string	Il codice Unicode paese/regione (CLDR) di una località, ad esempio "US" e "419". Per ulteriori informazioni, vedi http://www.unicode.org/reports/tr35/#unicode_region_subtag.
language_code	string	Il codice lingua BCP-47, ad esempio "en-US" o "sr-Latn". Per ulteriori informazioni, vedi http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
mime_type	string	Un tipo MIME pubblicato da IANA (chiamato anche tipo multimediale). Per ulteriori informazioni, visita la pagina https://www.iana.org/assignments/media-types/media-types.xhtml.
display_name	string	Il nome visualizzato di un'entità.
title	string	Il nome ufficiale di un'entità, ad esempio il nome della società. Deve essere considerata come la versione formale di display_name.
description	string	Uno o più paragrafi di descrizione testuale di un'entità.
filter	string	Il parametro di filtro standard per i metodi Elenco. Vedi AIP-160.
query	string	Uguale a filter se applicato a un metodo di ricerca (ad es. :search)
page_token	string	Il token di impaginazione nella richiesta di elenco.
page_size	int32	Le dimensioni di impaginazione nella richiesta di elenco.
total_size	int32	Il numero totale di elementi nell'elenco indipendentemente dall'impaginazione.
next_page_token	string	Il token di impaginazione successivo nella risposta List. Deve essere utilizzato come page_token per la seguente richiesta. Un valore vuoto indica che non ci sono più risultati.
order_by	string	Specifica l'ordinamento dei risultati per le richieste di elenco.
progress_percent	int32	Specifica l'avanzamento di un'azione in percentuale (da 0 a 100). Il valore -1 indica che l'avanzamento è sconosciuto.
request_id	string	Un ID stringa univoco utilizzato per rilevare le richieste duplicate.
resume_token	string	Un token opaco utilizzato per riprendere una richiesta di flussi di dati.
labels	map<string, string>	Rappresenta le etichette delle risorse Cloud.
show_deleted	bool	Se una risorsa consente il comportamento di annullamento dell'eliminazione, il metodo List corrispondente deve avere un campo show_deleted in modo che il client possa rilevare le risorse eliminate.
update_mask	FieldMask	Viene utilizzato per il messaggio di richiesta Update per l'esecuzione di un aggiornamento parziale su una risorsa. Questa maschera è relativa alla risorsa, non al messaggio di richiesta.
validate_only	bool	Se true, indica che la richiesta specificata deve essere solo convalidata, non eseguita.

Parametri di sistema

Oltre ai campi standard, le API di Google supportano anche un insieme di parametri di richiesta comuni, disponibili in tutti i metodi dell'API. Questi parametri sono noti come parametri di sistema. Per ulteriori informazioni, consulta Parametri di sistema.