Standardabfrageparameter

Die unten stehende Tabelle enthält Abfrageparameter, die für alle Resource Manager API-Vorgänge gelten.

Hinweise (zu API-Schlüsseln und Autorisierungstoken):

  1. Der Parameter key ist für jede Anfrage erforderlich, es sei denn, Sie stellen zusammen mit der Anfrage ein OAuth 2.0-Token bereit.
  2. Sie müssen ein Autorisierungstoken mit jeder Anfrage senden, für die ein OAuth-Bereich erforderlich ist. OAuth 2.0 ist das einzige unterstützte Autorisierungsprotokoll.
  3. Sie können ein OAuth 2.0-Token mit einer Anfrage auf zweierlei Weise bereitstellen:
    • Verwenden Sie einen Abfrageparameter access_token wie ?access_token=oauth2-token
    • Verwenden Sie einen HTTP-Header Authorization wie Authorization: Beareroauth2-token

Alle Parameter sind optional, sofern nicht anders angegeben.

Parameter Bedeutung Hinweise
access_token OAuth 2.0-Token für den aktuellen Nutzer
callback Callback-Funktion
  • Name der JavaScript Callback-Funktion für die Antwortbehandlung.
  • Wird in JavaScript JSON-P-Anfragen verwendet.
fields Auswahl, mit der eine Teilmenge von Feldern angegeben wird, die in der Antwort enthalten sein soll.
key API-Schlüssel (erforderlich*)
prettyPrint

Gibt die Antwort mit Einzügen und Zeilenumbrüchen zurück.

  • Gibt die Antwort in einem für Menschen lesbaren Format zurück, wenn true.
  • Standardwert: true.
  • Bei Einstellung auf false kann die Nutzlast der Antwort reduziert werden. Dies kann in einigen Umgebungen zu einer besseren Leistung führen.
quotaUser Alternative zu userIp.
  • Dadurch können Kontingente pro Nutzer von einer serverseitigen Anwendung erzwungen werden, selbst in Fällen, in denen die IP-Adresse des Nutzers unbekannt ist. Dies kann z. B. bei Anwendungen der Fall sein, die im Auftrag eines Nutzers Cronjobs auf App Engine ausführen.
  • Sie können einen beliebigen String auswählen, der einen Nutzer eindeutig identifiziert. Der String ist jedoch auf 40 Zeichen begrenzt.
  • Hat Vorrang vor userIp, falls beide Angaben vorhanden sind.
  • Weitere Informationen zur Deckelung der API-Nutzung.
userIp IP-Adresse des Endnutzers, für den der API-Aufruf durchgeführt wird.
  • Dadurch können Kontingente pro Nutzer erzwungen werden, wenn die API von einer serverseitigen Anwendung aufgerufen wird.
  • Weitere Informationen zur Deckelung der API-Nutzung.