En esta sección, se describe un conjunto de definiciones de campo de mensaje estándar que deben usarse cuando se necesitan conceptos similares. Así se garantizará que el mismo concepto tenga el mismo nombre y la misma semántica en las diferentes API.
| Nombre | Tipo | Descripción |
|---|---|---|
name |
string |
El campo name debe contener el nombre de recurso relativo. |
parent |
string |
Para las definiciones de recursos y las solicitudes de List y Create, el campo parent debe contener el nombre de recurso relativo superior. |
create_time |
Timestamp |
La marca de tiempo de la creación de una entidad. |
update_time |
Timestamp |
La última marca de tiempo de actualización de una entidad. Nota: update_time se actualiza cuando se realiza una operación de create, patch o delete. |
delete_time |
Timestamp |
La marca de tiempo de eliminación de una entidad, solo si es compatible con la retención. |
expire_time |
Timestamp |
La marca de tiempo del vencimiento de una entidad, en caso de que tenga vencimiento. |
start_time |
Timestamp |
La marca de tiempo del comienzo de algún período. |
end_time |
Timestamp |
La marca de tiempo del final de alguna operación o período (sin importar si se tuvo éxito). |
read_time |
Timestamp |
La marca de tiempo en la que una entidad en particular debe leerse (si se usa en una solicitud) o se leyó (si se usa en una respuesta). |
time_zone |
string |
El nombre de la zona horaria. Debe ser un nombre de IANA TZ, como “America/Los_Angeles”. Para obtener más información, consulta https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. |
region_code |
string |
El código Unicode de país o región (CLDR) de una ubicación, como “EE.UU.” y “419”. Para obtener más información, consulta http://www.unicode.org/reports/tr35/#unicode_region_subtag. |
language_code |
string |
El código de idioma BCP-47, como "en-US" o "sr-Latn". Para obtener más información, consulta http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. |
mime_type |
string |
Un tipo MIME que publicó IANA (también denominado tipo de medio). Para obtener más información, consulta https://www.iana.org/assignments/media-types/media-types.xhtml. |
display_name |
string |
El nombre comercial de una entidad. |
title |
string |
El nombre oficial de una entidad, como el nombre de la empresa. Debe tratarse como la versión formal de display_name. |
description |
string |
Uno o más párrafos de descripción de texto de una entidad. |
filter |
string |
El parámetro de filtro estándar para los métodos List. Consulta AIP-160. |
query |
string |
Es igual que filter si se aplica a un método de búsqueda (es decir, :search). |
page_token |
string |
El token de paginación de la solicitud de List. |
page_size |
int32 |
El tamaño de paginación de la solicitud de List. |
total_size |
int32 |
El conteo total de elementos de la lista, sin importar la paginación. |
next_page_token |
string |
El siguiente token de paginación de la respuesta de List. Debe usarse como page_token para la siguiente solicitud. Un valor vacío significa que no hay más resultados. |
order_by |
string |
Especifica el orden de los resultados para las solicitudes de List. |
progress_percent |
int32 |
Especifica el progreso de una acción en porcentaje (0-100). El valor -1 significa que se desconoce el progreso. |
request_id |
string |
Un ID de string único usado para detectar solicitudes duplicadas. |
resume_token |
string |
Un token opaco usado para reanudar una solicitud de transmisión. |
labels |
map<string, string> |
Representa las etiquetas de recursos de Cloud. |
show_deleted |
bool |
Si un recurso admite un comportamiento de recuperación, el método de List correspondiente debe tener un campo show_deleted para que el cliente pueda descubrir los recursos borrados. |
update_mask |
FieldMask |
Se usa para el mensaje de solicitud de Update a fin de realizar una actualización parcial en un recurso. Esta máscara se relaciona con el recurso, no con el mensaje de solicitud. |
validate_only |
bool |
Si es verdadero, indica que la solicitud dada solo debe validarse, no ejecutarse. |
Parámetros del sistema
Además de los campos estándar, las APIs de Google también admiten un conjunto de parámetros de solicitud comunes disponibles en todos los métodos de la API. Estos parámetros se conocen como parámetros del sistema. Para obtener más información, consulta Parámetros del sistema.