Methoden
Das Discovery-Dokument konzentriert sich auf die RESTful-Methode zum Aufrufen einer API. Die Methode discovery.apis.list gibt die Liste aller APIs zurück, die vom Google APIs Discovery Service unterstützt werden, einschließlich der URLs zum Abrufen der REST-basierten Discovery-Dokumente.
- list
- Liste der an diesem Endpunkt unterstützten APIs abrufen.
Ressourcendarstellungen
{ "kind": "discovery#restDescription", "discoveryVersion": "v1", "id": string, "name": string, "canonicalName": string, "version": string, "revision": string, "title": string, "description": string, "icons": { "x16": string, "x32": string }, "documentationLink": string, "labels": [ string ], "protocol": "rest", "baseUrl": string, "basePath": string, "rootUrl": string, "servicePath": string, "batchPath": "batch", "endpoints": [ { "endpointUrl": string, "location": string, "deprecated": boolean, "description": string } ], "parameters": { (key): { "id": string, "type": string, "$ref": string, "description": string, "default": string, "required": boolean, "format": string, "pattern": string, "minimum": string, "maximum": string, "enum": [ string ], "enumDescriptions": [ string ], "repeated": boolean, "location": string, "properties": { (key): (JsonSchema) }, "additionalProperties": (JsonSchema), "items": (JsonSchema), "annotations": { "required": [ string ] } } }, "auth": { "oauth2": { "scopes": { (key): { "description": string } } } }, "features": [ string ], "schemas": { (key): { "id": string, "type": string, "$ref": string, "description": string, "default": string, "required": boolean, "deprecated": boolean, "format": string, "pattern": string, "minimum": string, "maximum": string, "enum": [ string ], "enumDescriptions": [ string ], "enumDeprecated": [ boolean ], "repeated": boolean, "location": string, "properties": { (key): (JsonSchema) }, "additionalProperties": (JsonSchema), "items": (JsonSchema), "annotations": { "required": [ string ] } } }, "methods": { (key): { "id": string, "path": string, "httpMethod": string, "description": string, "deprecated": boolean, "parameters": { (key): { "id": string, "type": string, "$ref": string, "description": string, "default": string, "required": boolean, "deprecated": boolean, "format": string, "pattern": string, "minimum": string, "maximum": string, "enum": [ string ], "enumDescriptions": [ string ], "enumDeprecated": [ boolean ], "repeated": boolean, "location": string, "properties": { (key): (JsonSchema) }, "additionalProperties": (JsonSchema), "items": (JsonSchema), "annotations": { "required": [ string ] } } }, "parameterOrder": [ string ], "request": { "$ref": string }, "response": { "$ref": string }, "scopes": [ (value) ], "supportsMediaDownload": boolean, "supportsMediaUpload": boolean, "mediaUpload": { "accept": [ string ], "maxSize": string, "protocols": { "simple": { "multipart": true, "path": string }, "resumable": { "multipart": true, "path": string } } }, "supportsSubscription": boolean } }, "resources": { (key): { "methods": { (key): { "id": string, "path": string, "httpMethod": string, "description": string, "deprecated": boolean, "parameters": { (key): { "id": string, "type": string, "$ref": string, "description": string, "default": string, "required": boolean, "deprecated": boolean, "format": string, "pattern": string, "minimum": string, "maximum": string, "enum": [ string ], "enumDescriptions": [ string ], "enumDeprecated": [ boolean ], "repeated": boolean, "location": string, "properties": { (key): (JsonSchema) }, "additionalProperties": (JsonSchema), "items": (JsonSchema), "annotations": { "required": [ string ] } } }, "parameterOrder": [ string ], "request": { "$ref": string }, "response": { "$ref": string }, "scopes": [ (value) ], "supportsMediaDownload": boolean, "supportsMediaUpload": boolean, "mediaUpload": { "accept": [ string ], "maxSize": string, "protocols": { "simple": { "multipart": true, "path": string }, "resumable": { "multipart": true, "path": string } } }, "supportsSubscription": boolean } }, "deprecated": boolean, "resources": { (key): (RestResource) } } } }
Property-Name | Wert | Beschreibung |
---|---|---|
kind |
string |
Die Art für diese Antwort.Der feste String discovery#restDescription .
|
discoveryVersion |
string |
Geben Sie die Version der Discovery API an, die zum Generieren dieses Dokuments verwendet wurde. |
id |
string |
Die ID des Discovery-Dokuments für die API. Beispiel:
urlshortener:v1 .
|
name |
string |
Der Name der API. Beispiel: urlshortener . |
canonicalName |
string |
Der kanonische Name der API. Beispiel: Url
Shortener .
|
version |
string |
Die Version der API. Beispiel: v1 . |
revision |
string |
Die Version der API. |
title |
string |
Der Titel der API. Beispiel: „Google URL Shortener API“. |
description |
string |
Die Beschreibung dieser API. |
icons |
object |
Links zu den Symbolen 16 x 16 und 32 x 32, die die API darstellen. |
icons.x16 |
string |
Die URL des 16 x 16-Symbols. |
icons.x32 |
string |
Die URL des 32 x 32-Symbols. |
documentationLink |
string |
Ein Link zur für Menschen lesbaren Dokumentation für die API. |
labels[] |
list |
Labels für den Status dieser API. Gültige Werte sind limited_availability und deprecated .
|
protocol |
string |
Das im Dokument beschriebene Protokoll. Beispiel: REST. |
rootUrl |
string |
Die Stamm-URL, unter der alle API-Dienste verfügbar sind. |
endpoints[] |
list |
Eine Liste der standortbasierten Endpunktobjekte für diese API. Jedes Objekt enthält die Endpunkt-URL, den Speicherort, die Beschreibung und den Einstellungsstatus. |
endpoints[].endpointUrl |
string |
Die URL des Zielhosts des Endpunkts. |
endpoints[].location |
string |
Der Speicherort des Endpunkts. |
endpoints[].description |
string |
Ein String, der den durch die URL angegebenen Host beschreibt. |
endpoints[].deprecated |
boolean |
Gibt an, ob dieser Endpunkt verworfen wurde. |
parameters |
object |
Allgemeine Parameter, die für alle APIs gelten. |
parameters.(key) |
nested object |
Beschreibung eines einzelnen Parameters. |
parameters.(key).id |
string |
Eindeutige Kennung für dieses Schema. |
parameters.(key).type |
string |
Der Werttyp für dieses Schema. Eine Liste der Werte finden Sie im JSON-Schema im Abschnitt"type". |
parameters.(key).$ref |
string |
Ein Verweis auf ein anderes Schema. Der Wert dieser Property ist die ID eines anderen Schemas. |
parameters.(key).description |
string |
Eine Beschreibung dieses Objekts. |
parameters.(key).default |
string |
Der Standardwert dieser Property (falls vorhanden). |
parameters.(key).required |
boolean |
Gibt an, ob der Parameter erforderlich ist. |
parameters.(key).format |
string |
Ein zusätzlicher regulärer Ausdruck oder Schlüssel zur Einschränkung des Werts. Weitere Informationen finden Sie in der Zusammenfassung zu Typ und Format. |
parameters.(key).pattern |
string |
Der reguläre Ausdruck, dem dieser Parameter entsprechen muss. |
parameters.(key).minimum |
string |
Der Mindestwert dieses Parameters. |
parameters.(key).maximum |
string |
Der Maximalwert dieses Parameters. |
parameters.(key).enum[] |
list |
Mögliche Werte dieses Parameters (bei Enum). |
parameters.(key).enumDescriptions[] |
list |
Die Beschreibungen für die Enums. Jede Position entspricht dem entsprechenden Wert im enum-Array. |
parameters.(key).repeated |
boolean |
Gibt an, ob dieser Parameter mehrmals vorkommen darf. |
parameters.(key).location |
string |
Gibt an, ob dieser Parameter in die Abfrage oder in den Pfad für REST-Anfragen eingefügt werden soll. |
parameters.(key).properties |
object |
Wenn dies ein Schema für ein Objekt ist, listen Sie das Schema für jedes Attribut dieses Objekts auf. |
parameters.(key).properties.(key) |
nested object |
Ein einzelnes Attribut dieses Objekts. Der Wert ist selbst ein JSON-Schemaobjekt, das dieses Attribut beschreibt. |
parameters.(key).additionalProperties |
nested object |
Wenn dies ein Schema für ein Objekt ist, ist dieses Attribut das Schema für alle zusätzlichen Attribute mit dynamischen Schlüsseln für dieses Objekt. |
parameters.(key).items |
nested object |
Wenn dies ein Schema für ein Array ist, ist dieses Attribut das Schema für jedes Element im Array. |
parameters.(key).annotations |
object |
Weitere Informationen zu diesem Attribut. |
parameters.(key).annotations.required[] |
list |
Eine Liste der Methoden, für die diese Property bei Anfragen erforderlich ist. |
auth |
object |
Authentifizierungsdaten |
auth.oauth2 |
object |
OAuth 2.0-Authentifizierungsinformationen |
auth.oauth2.scopes |
object |
Verfügbare OAuth 2.0-Bereiche |
auth.oauth2.scopes.(key) |
object |
Der Bereichswert. |
auth.oauth2.scopes.(key).description |
string |
Beschreibung des Bereichs. |
features[] |
list |
Eine Liste der unterstützten Funktionen für diese API. |
schemas |
object |
Die Schemas für diese API. |
schemas.(key) |
nested object |
Eine einzelne Schemabeschreibung. |
schemas.(key).id |
string |
Eindeutige Kennung für dieses Schema. Beispiel: URL |
schemas.(key).type |
string |
Der Werttyp für dieses Schema. Eine Liste der Werte finden Sie im Abschnitt"type" im JSON-Schema. |
schemas.(key).$ref |
string |
Ein Verweis auf ein anderes Schema. Der Wert dieser Property ist die ID eines anderen Schemas. |
schemas.(key).description |
string |
Eine Beschreibung dieses Objekts. |
schemas.(key).default |
string |
Der Standardwert dieser Property (falls vorhanden). |
schemas.(key).required |
boolean |
Gibt an, ob der Parameter erforderlich ist. |
schemas.(key).deprecated |
boolean |
Gibt an, ob dieses Schema verworfen wurde. |
schemas.(key).format |
string |
Ein zusätzlicher regulärer Ausdruck oder Schlüssel zur Einschränkung des Werts. Weitere Informationen finden Sie in der Zusammenfassung zu Typ und Format. |
schemas.(key).pattern |
string |
Der reguläre Ausdruck, dem dieser Parameter entsprechen muss. |
schemas.(key).minimum |
string |
Der Mindestwert dieses Parameters. |
schemas.(key).maximum |
string |
Der Maximalwert dieses Parameters. |
schemas.(key).enum[] |
list |
Mögliche Werte dieses Parameters (bei Enum). |
schemas.(key).enumDescriptions[] |
list |
Die Beschreibungen für die Enums. Jede Position wird dem entsprechenden Wert im Array enum zugeordnet.
|
schemas.(key).enumDeprecated[] |
list |
Der Einstellungsstatus für die Enumerationen. Jede Position wird dem entsprechenden Wert im Array enum zugeordnet.
|
schemas.(key).repeated |
boolean |
Gibt an, ob dieser Parameter mehrmals vorkommen darf. |
schemas.(key).location |
string |
Gibt an, ob dieser Parameter in die Abfrage oder in den Pfad für REST-Anfragen eingefügt werden soll. |
schemas.(key).properties |
object |
Wenn dies ein Schema für ein Objekt ist, listen Sie das Schema für jedes Attribut dieses Objekts auf. |
schemas.(key).properties.(key) |
nested object |
Ein einzelnes Attribut dieses Objekts. Der Wert ist selbst ein JSON-Schemaobjekt, das dieses Attribut beschreibt. |
schemas.(key).additionalProperties |
nested object |
Wenn dies ein Schema für ein Objekt ist, ist dieses Attribut das Schema für alle zusätzlichen Attribute mit dynamischen Schlüsseln für dieses Objekt. |
schemas.(key).items |
nested object |
Wenn dies ein Schema für ein Array ist, ist dieses Attribut das Schema für jedes Element im Array. |
schemas.(key).annotations |
object |
Weitere Informationen zu diesem Attribut. |
schemas.(key).annotations.required[] |
list |
Eine Liste der Methoden, für die diese Property bei Anfragen erforderlich ist. |
methods |
object |
Methoden auf API-Ebene für diese API. |
methods.(key) |
nested object |
Eine einzelne Methodenbeschreibung. |
methods.(key).id |
string |
Eine eindeutige ID für diese Methode. Mit dieser Property können Methoden zwischen verschiedenen Discovery-Versionen abgeglichen werden. |
methods.(key).description |
string |
Beschreibung dieser Methode. |
methods.(key).deprecated |
boolean |
Gibt an, ob diese Methode verworfen wurde. |
methods.(key).parameters |
object |
Details zu allen Parametern in dieser Methode. |
methods.(key).parameters.(key) |
nested object |
Details für einen einzelnen Parameter in dieser Methode. |
methods.(key).parameters.(key).id |
string |
Eindeutige Kennung für dieses Schema. |
methods.(key).parameters.(key).type |
string |
Der Werttyp für dieses Schema. Eine Liste der Werte finden Sie im Abschnitt „type“ des JSON-Schemas. |
methods.(key).parameters.(key).$ref |
string |
Ein Verweis auf ein anderes Schema. Der Wert dieser Property ist die ID eines anderen Schemas. |
methods.(key).parameters.(key).description |
string |
Eine Beschreibung dieses Objekts. |
methods.(key).parameters.(key).default |
string |
Der Standardwert dieser Property (falls vorhanden). |
methods.(key).parameters.(key).required |
boolean |
Gibt an, ob der Parameter erforderlich ist. |
methods.(key).parameters.(key).deprecated |
boolean |
Gibt an, ob der Parameter veraltet ist. |
methods.(key).parameters.(key).format |
string |
Ein zusätzlicher regulärer Ausdruck oder Schlüssel zur Einschränkung des Werts. Weitere Informationen finden Sie in der Zusammenfassung zu Typ und Format. |
methods.(key).parameters.(key).pattern |
string |
Der reguläre Ausdruck, dem dieser Parameter entsprechen muss. |
methods.(key).parameters.(key).minimum |
string |
Der Mindestwert dieses Parameters. |
methods.(key).parameters.(key).maximum |
string |
Der Maximalwert dieses Parameters. |
methods.(key).parameters.(key).enum[] |
list |
Mögliche Werte dieses Parameters (bei Enum). |
methods.(key).parameters.(key).enumDescriptions[] |
list |
Die Beschreibungen für die Enums. Jede Position wird dem entsprechenden Wert im Array enum zugeordnet.
|
methods.(key).parameters.(key).enumDeprecated[] |
list |
Der Einstellungsstatus für die Enumerationen. Jede Position wird dem entsprechenden Wert im Array enum zugeordnet.
|
methods.(key).parameters.(key).repeated |
boolean |
Gibt an, ob dieser Parameter mehrmals vorkommen darf. |
methods.(key).parameters.(key).location |
string |
Gibt an, ob dieser Parameter in die Abfrage oder in den Pfad für REST-Anfragen eingefügt werden soll. |
methods.(key).parameters.(key).properties |
object |
Wenn dies ein Schema für ein Objekt ist, listen Sie das Schema für jedes Attribut dieses Objekts auf. |
methods.(key).parameters.(key).properties.(key) |
nested object |
Ein einzelnes Attribut dieses Objekts. Der Wert ist selbst ein JSON-Schemaobjekt, das dieses Attribut beschreibt. |
methods.(key).parameters.(key).additionalProperties |
nested object |
Wenn dies ein Schema für ein Objekt ist, ist dieses Attribut das Schema für alle zusätzlichen Attribute mit dynamischen Schlüsseln für dieses Objekt. |
methods.(key).parameters.(key).items |
nested object |
Wenn dies ein Schema für ein Array ist, ist dieses Attribut das Schema für jedes Element im Array. |
methods.(key).parameters.(key).annotations |
object |
Weitere Informationen zu diesem Attribut. |
methods.(key).parameters.(key).annotations.required[] |
list |
Eine Liste der Methoden, für die diese Property bei Anfragen erforderlich ist. |
methods.(key).parameterOrder[] |
list |
Geordnete Liste der erforderlichen Parameter. Dies dient als Hinweis für Kunden, wie sie ihre Methodensignaturen strukturieren sollen. Das Array ist so sortiert, dass der wichtigste Parameter zuerst angezeigt wird. |
methods.(key).scopes[] |
list |
OAuth 2.0-Bereiche für diese Methode. |
methods.(key).supportsMediaDownload |
boolean |
Gibt an, ob diese Methode Mediendownloads unterstützt. |
methods.(key).supportsMediaUpload |
boolean |
Gibt an, ob diese Methode Medienuploads unterstützt. |
methods.(key).mediaUpload |
object |
Parameter für den Medienupload |
methods.(key).mediaUpload.accept[] |
list |
MIME-Medienbereiche für zulässige Medienuploads auf diese Methode. |
methods.(key).mediaUpload.maxSize |
string |
Die maximale Größe eines Medienuploads, z. B. „1 MB“, „2 GB“ oder „3 TB“. |
methods.(key).supportsSubscription |
boolean |
Gibt an, ob diese Methode Abos unterstützt. |
baseUrl |
string |
[VERWORFEN] Die Basis-URL für REST-Anfragen. |
basePath |
string |
[VERWORFEN] Der Basispfad für REST-Anfragen. |
servicePath |
string |
Der Basispfad für alle REST-Anfragen. |
batchPath |
string |
Der Pfad für REST-Batchanfragen. |
methods.(key).path |
string |
Der URI-Pfad dieser REST-Methode. Sollte in Verbindung mit dem Attribut servicePath auf der API-Ebene verwendet werden.
|
methods.(key).httpMethod |
string |
Die von dieser Methode verwendete HTTP-Methode. |
methods.(key).request |
object |
Das Schema für die Anfrage. |
methods.(key).request.$ref |
string |
Schema-ID für das Anfrageschema. |
methods.(key).request.parameterName |
string |
[VERWORFEN] Dieses Feld ist in einigen APIs aus Gründen der Abwärtskompatibilität vorhanden. Es kann ignoriert werden. |
methods.(key).response |
object |
Das Schema für die Antwort. |
methods.(key).response.$ref |
string |
Schema-ID für das Antwortschema. |
methods.(key).mediaUpload.protocols |
object |
Unterstützte Uploadprotokolle. |
methods.(key).mediaUpload.protocols.simple |
object |
Unterstützt den Upload als einzelne HTTP-Anfrage. |
methods.(key).mediaUpload.protocols.simple.multipart |
boolean |
„True”, wenn dieser Endpunkt den Upload mehrteiliger Medien unterstützt. |
methods.(key).mediaUpload.protocols.simple.path |
string |
Der URI-Pfad, der für den Upload verwendet werden soll. Sollte in Verbindung mit dem Attribut rootURL auf der API-Ebene verwendet werden.
|
methods.(key).mediaUpload.protocols.resumable |
object |
Unterstützt das Protokoll für den fortsetzbaren Medienupload. |
methods.(key).mediaUpload.protocols.resumable.multipart |
boolean |
true , wenn dieser Endpunkt das Hochladen mehrteiliger Medien unterstützt. |
methods.(key).mediaUpload.protocols.resumable.path |
string |
Der URI-Pfad, der für den Upload verwendet werden soll. Sollte in Verbindung mit dem Attribut rootURL auf der API-Ebene verwendet werden.
|
resources |
object |
Die Ressourcen in dieser API. |
resources.(key) |
nested object |
Eine einzelne Ressourcenbeschreibung. Enthält Methoden und Unterressourcen für diese Ressource. |
resources.(key).methods |
object |
Methoden für diese Ressource. |
resources.(key).methods.(key) |
nested object |
Beschreibung aller Methoden für diese Ressource. |
resources.(key).methods.(key).id |
string |
Eine eindeutige ID für diese Methode. Mit dieser Property können Methoden zwischen verschiedenen Discovery-Versionen abgeglichen werden. |
resources.(key).methods.(key).path |
string |
Der URI-Pfad dieser REST-Methode. Sollte in Verbindung mit dem Attribut servicePath auf der API-Ebene verwendet werden.
|
resources.(key).methods.(key).flatPath |
string |
Der URI-Pfad dieser REST-Methode im Format (RFC 6570) ohne Level-2-Features ({+var}). Ergänzung zum Attribut path .
|
resources.(key).methods.(key).httpMethod |
string |
Die von dieser Methode verwendete HTTP-Methode. |
resources.(key).methods.(key).description |
string |
Beschreibung dieser Methode. |
resources.(key).methods.(key).deprecated |
boolean |
Gibt an, ob diese Methode verworfen wurde. |
resources.(key).methods.(key).parameters |
object |
Details zu allen Parametern in dieser Methode. |
resources.(key).methods.(key).parameters.(key) |
nested object |
Details für einen einzelnen Parameter in dieser Methode. |
resources.(key).methods.(key).parameters.(key).id |
string |
Eindeutige Kennung für dieses Schema. |
resources.(key).methods.(key).parameters.(key).type |
string |
Der Werttyp für dieses Schema. Eine Liste der Werte finden Sie im Abschnitt „type“ des JSON-Schemas. |
resources.(key).methods.(key).parameters.(key).$ref |
string |
Ein Verweis auf ein anderes Schema. Der Wert dieses Attributs ist die "ID" eines anderen Schemas. |
resources.(key).methods.(key).parameters.(key).description |
string |
Eine Beschreibung dieses Objekts. |
resources.(key).methods.(key).parameters.(key).default |
string |
Der Standardwert dieser Property (falls vorhanden). |
resources.(key).methods.(key).parameters.(key).required |
boolean |
Gibt an, ob der Parameter erforderlich ist. |
resources.(key).methods.(key).parameters.(key).deprecated |
boolean |
Gibt an, ob der Parameter veraltet ist. |
resources.(key).methods.(key).parameters.(key).format |
string |
Ein zusätzlicher regulärer Ausdruck oder Schlüssel zur Einschränkung des Werts. Weitere Informationen finden Sie in der Zusammenfassung zu Typ und Format. |
resources.(key).methods.(key).parameters.(key).pattern |
string |
Der reguläre Ausdruck, dem dieser Parameter entsprechen muss. |
resources.(key).methods.(key).parameters.(key).minimum |
string |
Der Mindestwert dieses Parameters. |
resources.(key).methods.(key).parameters.(key).maximum |
string |
Der Maximalwert dieses Parameters. |
resources.(key).methods.(key).parameters.(key).enum[] |
list |
Mögliche Werte dieses Parameters (bei Enum). |
resources.(key).methods.(key).parameters.(key).enumDescriptions[] |
list |
Die Beschreibungen für die Enums. Jede Position wird dem entsprechenden Wert im Array enum zugeordnet.
|
resources.(key).methods.(key).parameters.(key).enumDeprecated[] |
list |
Der Einstellungsstatus für die Enumerationen. Jede Position wird dem entsprechenden Wert im Array enum zugeordnet.
|
resources.(key).methods.(key).parameters.(key).repeated |
boolean |
Gibt an, ob dieser Parameter mehrmals vorkommen darf. |
resources.(key).methods.(key).parameters.(key).location |
string |
Gibt an, ob dieser Parameter in die Abfrage oder in den Pfad für REST-Anfragen eingefügt werden soll. |
resources.(key).methods.(key).parameters.(key).properties |
object |
Wenn dies ein Schema für ein Objekt ist, listen Sie das Schema für jedes Attribut dieses Objekts auf. |
resources.(key).methods.(key).parameters.(key).properties.(key) |
nested object |
Ein einzelnes Attribut dieses Objekts. Der Wert ist selbst ein JSON-Schemaobjekt, das dieses Attribut beschreibt. |
resources.(key).methods.(key).parameters.(key).additionalProperties |
nested object |
Wenn dies ein Schema für ein Objekt ist, ist dieses Attribut das Schema für alle zusätzlichen Attribute mit dynamischen Schlüsseln für dieses Objekt. |
resources.(key).methods.(key).parameters.(key).items |
nested object |
Wenn dies ein Schema für ein Array ist, ist dieses Attribut das Schema für jedes Element im Array. |
resources.(key).methods.(key).parameters.(key).annotations |
object |
Weitere Informationen zu diesem Attribut. |
resources.(key).methods.(key).parameters.(key).annotations.required[] |
list |
Eine Liste der Methoden, für die diese Property bei Anfragen erforderlich ist. |
resources.(key).methods.(key).parameterOrder[] |
list |
Geordnete Liste der erforderlichen Parameter. Dies dient als Hinweis für Kunden, wie sie ihre Methodensignaturen strukturieren sollen. Das Array ist so sortiert, dass der wichtigste Parameter zuerst angezeigt wird. |
resources.(key).methods.(key).request |
object |
Das Schema für die Anfrage. |
resources.(key).methods.(key).request.$ref |
string |
Schema-ID für das Anfrageschema. |
resources.(key).methods.(key).response |
object |
Das Schema für die Antwort. |
resources.(key).methods.(key).response.$ref |
string |
Schema-ID für das Antwortschema. |
resources.(key).methods.(key).scopes[] |
list |
OAuth 2.0-Bereiche für diese Methode. |
resources.(key).methods.(key).supportsMediaDownload |
boolean |
Gibt an, ob diese Methode Mediendownloads unterstützt. |
resources.(key).methods.(key).supportsMediaUpload |
boolean |
Gibt an, ob diese Methode Medienuploads unterstützt. |
resources.(key).methods.(key).mediaUpload |
object |
Parameter für den Medienupload |
resources.(key).methods.(key).mediaUpload.accept[] |
list |
MIME-Medienbereiche für zulässige Medienuploads auf diese Methode. |
resources.(key).methods.(key).mediaUpload.maxSize |
string |
Die maximale Größe eines Medienuploads, z. B. „1 MB“, „2 GB“ oder „3 TB“. |
resources.(key).methods.(key).mediaUpload.protocols |
object |
Unterstützte Uploadprotokolle. |
resources.(key).methods.(key).mediaUpload.protocols.simple |
object |
Unterstützt den Upload als einzelne HTTP-Anfrage. |
resources.(key).methods.(key).mediaUpload.protocols.simple.multipart |
boolean |
true , wenn dieser Endpunkt den Upload von mehrteiligen Medien unterstützt. |
resources.(key).methods.(key).mediaUpload.protocols.simple.path |
string |
Der URI-Pfad, der für den Upload verwendet werden soll. Sollte in Verbindung mit dem Attribut rootURL auf der API-Ebene verwendet werden.
|
resources.(key).methods.(key).mediaUpload.protocols.resumable |
object |
Unterstützt das Protokoll für den fortsetzbaren Medienupload. |
resources.(key).methods.(key).mediaUpload.protocols.resumable.multipart |
boolean |
true , wenn dieser Endpunkt das Hochladen mehrteiliger Medien unterstützt. |
resources.(key).methods.(key).mediaUpload.protocols.resumable.path |
string |
Der URI-Pfad, der für den Upload verwendet werden soll. Sollte in Verbindung mit dem Attribut rootURL auf der API-Ebene verwendet werden.
|
resources.(key).methods.(key).supportsSubscription |
boolean |
Gibt an, ob diese Methode Abos unterstützt. |
resources.(key).deprecated |
boolean |
Gibt an, ob diese Ressource eingestellt wurde. |
resources.(key).resources |
object |
Untergeordnete Ressourcen dieser Ressource. |
resources.(key).resources.(key) |
nested object |
Beschreibung aller Unterressourcen dieser Ressource. |