In diesem Abschnitt werden eine Reihe von Standardnachrichtenfelder beschrieben, die Sie verwenden sollten, wenn ähnliche Konzepte erforderlich sind. Sie stellen auf diese Weise sicher, dass dasselbe Konzept innerhalb unterschiedlicher APIs denselben Namen und dieselbe Semantik hat.
Name | Typ | Beschreibung |
---|---|---|
name |
string |
Das Feld name sollte den relativen Ressourcennamen enthalten. |
parent |
string |
Bei Ressourcendefinitionen und Listen-/Erstellungsanfragen sollte das Feld parent den übergeordneten relativen Ressourcennamen enthalten. |
create_time |
Timestamp |
Der Erstellungszeitstempel einer Entität. |
update_time |
Timestamp |
Der Zeitstempel der zuletzt durchgeführten Aktualisierung einer Entität. Hinweis: update_time wird bei Ausführung des Create/Patch/Delete-Vorgangs aktualisiert. |
delete_time |
Timestamp |
Der Zeitstempel des Löschvorgangs einer Entität, sofern die Aufbewahrung unterstützt wird. |
expire_time |
Timestamp |
Der Ablaufzeitstempel einer Entität, falls diese abläuft. |
start_time |
Timestamp |
Der Startzeitstempel eines Zeitraums. |
end_time |
Timestamp |
Der Endzeitstempel eines Zeitraums oder Vorgangs (ungeachtet des Erfolgs). |
read_time |
Timestamp |
Der Zeitstempel, zu dem eine bestimmte Entität gelesen werden sollte (wenn sie in einer Anfrage verwendet wird) oder gelesen wurde (wenn sie in einer Antwort verwendet wird). |
time_zone |
string |
Der Zeitzonenname. Dieser sollte ein IANA-TZ-Name sein, beispielsweise "America/Los_Angeles". Weitere Informationen finden Sie unter https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. |
region_code |
string |
Der Länder-/Regionscode (CLDR) eines Standorts im Unicode-Format, beispielsweise "US" und "419". Weitere Informationen finden Sie unter http://www.unicode.org/reports/tr35/#unicode_region_subtag. |
language_code |
string |
Der BCP-47-Sprachcode, beispielsweise "en-US" oder "sr-Latn". Weitere Informationen finden Sie unter http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. |
mime_type |
string |
Ein von IANA veröffentlichter MIME-Typ (auch als Medientyp bezeichnet). Weitere Informationen finden Sie unter https://www.iana.org/assignments/media-types/media-types.xhtml. |
display_name |
string |
Der Anzeigename einer Entität. |
title |
string |
Der offizielle Name einer Entität, beispielsweise ein Firmenname. Er sollte als formale Version von display_name behandelt werden. |
description |
string |
Ein oder mehrere Absätze der Textbeschreibung einer Entität. |
filter |
string |
Der Standardfilterparameter für List-Methoden. Siehe AIP-160. |
query |
string |
Das gleiche wie filter , wenn es auf eine Suchmethode angewendet wird (d. h. :search ) |
page_token |
string |
Das Paginierungstoken in der List-Anfrage. |
page_size |
int32 |
Die Paginierungsgröße in der List-Anfrage. |
total_size |
int32 |
Die Gesamtzahl von Elementen in der Liste unabhängig von der Paginierung. |
next_page_token |
string |
Das nächste Paginierungstoken in der List-Antwort. Es sollte als page_token für die folgende Anfrage verwendet werden. Ein leerer Wert bedeutet, dass kein weiteres Ergebnis folgt. |
order_by |
string |
Gibt die Ergebnisreihenfolge für List-Anfragen an. |
progress_percent |
int32 |
Gibt den Fortschritt einer Aktion in Prozent (0–100) an. Der Wert -1 bedeutet, dass der Fortschritt unbekannt ist. |
request_id |
string |
Eine eindeutige String-ID zum Erkennen doppelter Anfragen. |
resume_token |
string |
Ein opakes Token zur Fortsetzung einer Streaming-Anfrage. |
labels |
map<string, string> |
Stellt Cloud-Ressourcenlabels dar. |
show_deleted |
bool |
Wenn eine Ressource ein Wiederherstellungsverhalten zulässt, muss die entsprechende List-Methode ein show_deleted -Feld haben, damit der Client die gelöschten Ressourcen erkennen kann. |
update_mask |
FieldMask |
Dieses Feld wird für die Update Anfragenachricht verwendet, um die teilweise Aktualisierung einer Ressource durchzuführen. Diese Maske bezieht sich auf die Ressource und nicht auf die Anfragenachricht. |
validate_only |
bool |
Wenn "true", soll die angegebene Anfrage nur validiert, aber nicht ausgeführt werden. |
Systemparameter
Neben den Standardfeldern unterstützen Google APIs auch einen Satz allgemeiner Anfrageparameter, die für alle API-Methoden verfügbar sind. Diese Parameter werden als Systemparameter bezeichnet. Weitere Informationen finden Sie unter Systemparameter.