Documento di rilevamento

I documenti di rilevamento sono disponibili per versioni specifiche della maggior parte delle API. Il documento di rilevamento di ogni API descrive la superficie dell'API, le modalità di accesso all'API e la struttura delle richieste e delle risposte API. Le informazioni fornite nel documento di rilevamento includono proprietà a livello di API, ad esempio una descrizione dell'API, gli schemi delle risorse, gli ambiti di autenticazione e i metodi.

Metodi

Il documento di rilevamento si concentra sul metodo RESTful di chiamata di un'API. Il metodo discovery.apis.list restituisce l'elenco di tutte le API supportate dal servizio di rilevamento delle API di Google, inclusi gli URL per il recupero dei documenti di rilevamento basati su REST.

list
Recupera l'elenco delle API supportate in questo endpoint.

Rappresentazioni delle risorse

{
  "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)
      }
    }
  }
}
Nome proprietà Valore Descrizione
kind string Il tipo di questa risposta. La stringa fissa discovery#restDescription.
discoveryVersion string Indica la versione dell'API Discovery utilizzata per generare questo documento.
id string L'ID del documento di rilevamento per l'API. Ad esempio: urlshortener:v1.
name string Il nome dell'API. ad esempio urlshortener.
canonicalName string Il nome canonico dell'API. Ad esempio, Url Shortener.
version string La versione dell'API. ad esempio v1.
revision string La revisione dell'API.
title string Il titolo dell'API. Ad esempio, "Google Url Shortener API".
description string La descrizione di questa API.
icons object Link a icone 16 x 16 e 32 x 32 che rappresentano l'API.
icons.x16 string L'URL dell'icona 16 x 16.
icons.x32 string L'URL dell'icona 32 x 32.
labels[] list Etichette per lo stato di questa API. I valori validi includono limited_availability o deprecated.
protocol string Il protocollo descritto dal documento. ad esempio REST.
rootUrl string L'URL principale in cui si trovano tutti i servizi API.
endpoints[] list Un elenco di oggetti endpoint basati sulla posizione per questa API. Ogni oggetto contiene l'URL, la posizione, la descrizione e lo stato di ritiro dell'endpoint.
endpoints[].endpointUrl string L'URL dell'host target dell'endpoint.
endpoints[].location string La posizione dell'endpoint.
endpoints[].description string Una stringa che descrive l'host designato dall'URL.
endpoints[].deprecated boolean Indica se questo endpoint è stato ritirato.
parameters object Parametri comuni che si applicano a tutte le API.
parameters.(key) nested object Descrizione di un singolo parametro.
parameters.(key).id string Identificatore univoco per questo schema.
parameters.(key).type string Il tipo di valore per questo schema. Un elenco di valori è disponibile nella sezione "type" dello schema JSON.
parameters.(key).$ref string Un riferimento a un altro schema. Il valore di questa proprietà è l'ID di un'altra .
parameters.(key).description string Una descrizione di questo oggetto.
parameters.(key).default string Il valore predefinito di questa proprietà (se esistente).
parameters.(key).required boolean Indica se il parametro è obbligatorio.
parameters.(key).format string Un'espressione regolare o una chiave aggiuntiva che consente di limitare il valore. Per maggiori dettagli, consulta il riepilogo dei tipi e dei formati.
parameters.(key).pattern string L'espressione regolare a cui deve essere conforme questo parametro.
parameters.(key).minimum string Il valore minimo di questo parametro.
parameters.(key).maximum string Il valore massimo di questo parametro.
parameters.(key).enum[] list Valori che questo parametro può assumere (se è un'enumerazione).
parameters.(key).enumDescriptions[] list Le descrizioni delle enum. Ogni posizione viene associata al valore corrispondente nell'array enumerato.
parameters.(key).repeated boolean Indica se questo parametro può apparire più volte.
parameters.(key).location string Indica se questo parametro deve essere inserito nella query o nel percorso per le richieste REST.
parameters.(key).properties object Se si tratta di uno schema per un oggetto, elencalo per ciascuna proprietà dell'oggetto.
parameters.(key).properties.(key) nested object Una singola proprietà di questo oggetto. Il valore è a sua volta un oggetto schema JSON che descrive questa proprietà.
parameters.(key).additionalProperties nested object Se si tratta di uno schema per un oggetto, questa proprietà è lo schema per eventuali proprietà aggiuntive con chiavi dinamiche su questo oggetto.
parameters.(key).items nested object Se questo è uno schema per un array, questa proprietà è lo schema per ogni elemento nel un array di dati.
parameters.(key).annotations object Ulteriori informazioni su questa proprietà.
parameters.(key).annotations.required[] list Un elenco di metodi che richiedono questa proprietà nelle richieste.
auth object Informazioni di autenticazione.
auth.oauth2 object Informazioni sull'autenticazione OAuth 2.0.
auth.oauth2.scopes object Ambiti OAuth 2.0 disponibili.
auth.oauth2.scopes.(key) object Il valore dell'ambito.
auth.oauth2.scopes.(key).description string Descrizione dell'ambito.
features[] list Un elenco delle funzionalità supportate per questa API.
schemas object Gli schemi per questa API.
schemas.(key) nested object Una singola descrizione dello schema.
schemas.(key).id string Identificatore univoco per questo schema. Esempio: URL
schemas.(key).type string Il tipo di valore per questo schema. Un elenco di valori è disponibile nella sezione "type" dello schema JSON.
schemas.(key).$ref string Un riferimento a un altro schema. Il valore di questa proprietà è l'ID di un'altra .
schemas.(key).description string Una descrizione di questo oggetto.
schemas.(key).default string Il valore predefinito di questa proprietà (se esistente).
schemas.(key).required boolean Indica se il parametro è obbligatorio.
schemas.(key).deprecated boolean Indica se questo schema è deprecato.
schemas.(key).format string Un'espressione regolare o una chiave aggiuntiva che consente di limitare il valore. Per maggiori dettagli, consulta il riepilogo dei tipi e dei formati.
schemas.(key).pattern string L'espressione regolare a cui deve essere conforme questo parametro.
schemas.(key).minimum string Il valore minimo di questo parametro.
schemas.(key).maximum string Il valore massimo di questo parametro.
schemas.(key).enum[] list Valori che questo parametro può assumere (se è un'enumerazione).
schemas.(key).enumDescriptions[] list Le descrizioni delle enum. Ogni posizione viene mappata al valore corrispondente nell'array enum.
schemas.(key).enumDeprecated[] list Lo stato di ritiro delle enum. Ogni posizione è mappata al valore corrispondente in l'array enum.
schemas.(key).repeated boolean Indica se questo parametro può apparire più volte.
schemas.(key).location string Indica se questo parametro deve essere inserito nella query o nel percorso per le richieste REST.
schemas.(key).properties object Se questo è uno schema per un oggetto, elencalo per ogni proprietà di questo .
schemas.(key).properties.(key) nested object Una singola proprietà di questo oggetto. Il valore è a sua volta un oggetto schema JSON che descrive questa proprietà.
schemas.(key).additionalProperties nested object Se si tratta di uno schema per un oggetto, questa proprietà è lo schema per eventuali proprietà aggiuntive con chiavi dinamiche su questo oggetto.
schemas.(key).items nested object Se questo è uno schema per un array, questa proprietà è lo schema per ogni elemento nel un array di dati.
schemas.(key).annotations object Ulteriori informazioni su questa proprietà.
schemas.(key).annotations.required[] list Un elenco di metodi che richiedono questa proprietà nelle richieste.
methods object Metodi a livello di API per questa API.
methods.(key) nested object Una descrizione del singolo metodo.
methods.(key).id string Un ID univoco per questo metodo. Questa proprietà può essere utilizzata per abbinare i metodi tra diverse versioni di Discovery.
methods.(key).description string Descrizione di questo metodo.
methods.(key).deprecated boolean Indica se questo metodo è deprecato.
methods.(key).parameters object Dettagli per tutti i parametri di questo metodo.
methods.(key).parameters.(key) nested object Dettagli relativi a un singolo parametro in questo metodo.
methods.(key).parameters.(key).id string Identificatore univoco per questo schema.
methods.(key).parameters.(key).type string Il tipo di valore per questo schema.   Un elenco di valori è disponibile nella sezione "type" dello schema JSON.
methods.(key).parameters.(key).$ref string Un riferimento a un altro schema. Il valore di questa proprietà è l'ID di un altro schema.
methods.(key).parameters.(key).description string Una descrizione di questo oggetto.
methods.(key).parameters.(key).default string Il valore predefinito di questa proprietà (se esistente).
methods.(key).parameters.(key).required boolean Indica se il parametro è obbligatorio.
methods.(key).parameters.(key).deprecated boolean Indica se il parametro è deprecato.
methods.(key).parameters.(key).format string Un'espressione regolare o una chiave aggiuntiva che consente di limitare il valore. Per maggiori dettagli, consulta il riepilogo dei tipi e dei formati.
methods.(key).parameters.(key).pattern string L'espressione regolare a cui deve essere conforme questo parametro.
methods.(key).parameters.(key).minimum string Il valore minimo di questo parametro.
methods.(key).parameters.(key).maximum string Il valore massimo di questo parametro.
methods.(key).parameters.(key).enum[] list Valori che questo parametro può assumere (se è un'enumerazione).
methods.(key).parameters.(key).enumDescriptions[] list Le descrizioni delle enum. Ogni posizione viene mappata al valore corrispondente nell'array enum.
methods.(key).parameters.(key).enumDeprecated[] list Lo stato di ritiro delle enum. Ogni posizione è mappata al valore corrispondente in l'array enum.
methods.(key).parameters.(key).repeated boolean Indica se questo parametro può apparire più volte.
methods.(key).parameters.(key).location string Indica se questo parametro deve essere inserito nella query o nel percorso per le richieste REST.
methods.(key).parameters.(key).properties object Se si tratta di uno schema per un oggetto, elencalo per ciascuna proprietà dell'oggetto.
methods.(key).parameters.(key).properties.(key) nested object Una singola proprietà di questo oggetto. Il valore è a sua volta un oggetto schema JSON che descrive questa proprietà.
methods.(key).parameters.(key).additionalProperties nested object Se si tratta di uno schema per un oggetto, questa proprietà è lo schema per eventuali proprietà aggiuntive con chiavi dinamiche su questo oggetto.
methods.(key).parameters.(key).items nested object Se questo è uno schema per un array, questa proprietà è lo schema per ogni elemento nel un array di dati.
methods.(key).parameters.(key).annotations object Ulteriori informazioni su questa proprietà.
methods.(key).parameters.(key).annotations.required[] list Un elenco di metodi per i quali questa proprietà è obbligatoria nelle richieste.
methods.(key).parameterOrder[] list Elenco ordinato dei parametri obbligatori. Questo serve da suggerimento ai clienti su come strutturare le firme dei metodi. L'array è ordinato in modo che il parametro più significativo venga visualizzato per primo.
methods.(key).scopes[] list Ambiti OAuth 2.0 applicabili a questo metodo.
methods.(key).supportsMediaDownload boolean Indica se questo metodo supporta i download di contenuti multimediali.
methods.(key).supportsMediaUpload boolean Indica se questo metodo supporta i caricamenti di contenuti multimediali.
methods.(key).mediaUpload object Parametri di caricamento dei contenuti multimediali.
methods.(key).mediaUpload.accept[] list Intervalli multimediali MIME per caricamenti multimediali accettabili con questo metodo.
methods.(key).mediaUpload.maxSize string Dimensioni massime di un caricamento di contenuti multimediali, ad esempio "1 MB" o "2 GB" o "3 TB".
methods.(key).supportsSubscription boolean Indica se questo metodo supporta gli abbonamenti.
baseUrl string [DEPRECATED] URL di base per le richieste REST.
basePath string [DEPRECATED] Il percorso di base per le richieste REST.
servicePath string Il percorso di base per tutte le richieste REST.
batchPath string Il percorso per le richieste batch REST.
methods.(key).path string Il percorso URI di questo metodo REST. Da utilizzare insieme a servicePath a livello di API.
methods.(key).httpMethod string Metodo HTTP utilizzato da questo metodo.
methods.(key).request object Lo schema della richiesta.
methods.(key).request.$ref string ID schema per lo schema della richiesta.
methods.(key).request.parameterName string [DEPRECATED] Alcune API hanno questo campo per motivi di compatibilità con le versioni precedenti. Può essere ignorato in tutta sicurezza.
methods.(key).response object Lo schema della risposta.
methods.(key).response.$ref string ID schema per lo schema di risposta.
methods.(key).mediaUpload.protocols object Protocolli di caricamento supportati.
methods.(key).mediaUpload.protocols.simple object Supporta il caricamento come singola richiesta HTTP.
methods.(key).mediaUpload.protocols.simple.multipart boolean True se questo endpoint supporta il caricamento di contenuti multimediali multiparte.
methods.(key).mediaUpload.protocols.simple.path string Il percorso dell'URI da utilizzare per il caricamento. Da utilizzare insieme a rootURL a livello di API.
methods.(key).mediaUpload.protocols.resumable object Supporta il protocollo Resumable Media Upload.
methods.(key).mediaUpload.protocols.resumable.multipart boolean true se questo endpoint supporta il caricamento di contenuti multimediali multiparte.
methods.(key).mediaUpload.protocols.resumable.path string Il percorso dell'URI da utilizzare per il caricamento. Deve essere utilizzato insieme alla proprietà rootURL a livello di API.
resources object Le risorse in questa API.
resources.(key) nested object Una singola descrizione della risorsa. Contiene metodi e risorse secondarie correlati a questa risorsa.
resources.(key).methods object Metodi in questa risorsa.
resources.(key).methods.(key) nested object Descrizione di tutti i metodi su questa risorsa.
resources.(key).methods.(key).id string Un ID univoco per questo metodo. Questa proprietà può essere utilizzata per trovare corrispondenze tra metodi diverse versioni di Discovery.
resources.(key).methods.(key).path string Il percorso URI di questo metodo REST. Da utilizzare insieme a servicePath a livello di API.
resources.(key).methods.(key).flatPath string Il percorso URI di questo metodo REST nel formato (RFC 6570) senza funzionalità di livello 2 ({+var}). Supplementare alla proprietà path.
resources.(key).methods.(key).httpMethod string Metodo HTTP utilizzato da questo metodo.
resources.(key).methods.(key).description string Descrizione di questo metodo.
resources.(key).methods.(key).deprecated boolean Indica se questo metodo è deprecato.
resources.(key).methods.(key).parameters object Dettagli per tutti i parametri di questo metodo.
resources.(key).methods.(key).parameters.(key) nested object Dettagli relativi a un singolo parametro in questo metodo.
resources.(key).methods.(key).parameters.(key).id string Identificatore univoco per questo schema.
resources.(key).methods.(key).parameters.(key).type string Il tipo di valore per questo schema. Un elenco di valori è disponibile alla pagina il "type" nello schema JSON.
resources.(key).methods.(key).parameters.(key).$ref string Un riferimento a un altro schema. Il valore di questa proprietà è l'"ID" di in un altro schema.
resources.(key).methods.(key).parameters.(key).description string Una descrizione dell'oggetto.
resources.(key).methods.(key).parameters.(key).default string Il valore predefinito di questa proprietà (se esistente).
resources.(key).methods.(key).parameters.(key).required boolean Indica se il parametro è obbligatorio.
resources.(key).methods.(key).parameters.(key).deprecated boolean Indica se il parametro è deprecato.
resources.(key).methods.(key).parameters.(key).format string Un'espressione regolare o una chiave aggiuntiva che consente di limitare il valore. Per maggiori dettagli, consulta il riepilogo dei tipi e dei formati.
resources.(key).methods.(key).parameters.(key).pattern string L'espressione regolare a cui deve essere conforme questo parametro.
resources.(key).methods.(key).parameters.(key).minimum string Il valore minimo di questo parametro.
resources.(key).methods.(key).parameters.(key).maximum string Il valore massimo di questo parametro.
resources.(key).methods.(key).parameters.(key).enum[] list Valori che questo parametro può assumere (se è un'enumerazione).
resources.(key).methods.(key).parameters.(key).enumDescriptions[] list Le descrizioni delle enum. Ogni posizione viene mappata al valore corrispondente nell'array enum.
resources.(key).methods.(key).parameters.(key).enumDeprecated[] list Lo stato di ritiro delle enum. Ogni posizione è mappata al valore corrispondente in l'array enum.
resources.(key).methods.(key).parameters.(key).repeated boolean Indica se questo parametro può apparire più volte.
resources.(key).methods.(key).parameters.(key).location string Indica se questo parametro deve essere inserito nella query o nel percorso per le richieste REST.
resources.(key).methods.(key).parameters.(key).properties object Se questo è uno schema per un oggetto, elencalo per ogni proprietà di questo .
resources.(key).methods.(key).parameters.(key).properties.(key) nested object Una singola proprietà di questo oggetto. Il valore è a sua volta un oggetto schema JSON che descrive questa proprietà.
resources.(key).methods.(key).parameters.(key).additionalProperties nested object Se si tratta di uno schema per un oggetto, questa proprietà è lo schema per eventuali proprietà aggiuntive con chiavi dinamiche su questo oggetto.
resources.(key).methods.(key).parameters.(key).items nested object Se questo è uno schema per un array, questa proprietà è lo schema per ogni elemento nel un array di dati.
resources.(key).methods.(key).parameters.(key).annotations object Ulteriori informazioni su questa proprietà.
resources.(key).methods.(key).parameters.(key).annotations.required[] list Un elenco di metodi che richiedono questa proprietà nelle richieste.
resources.(key).methods.(key).parameterOrder[] list Elenco ordinato dei parametri obbligatori. Questo serve da suggerimento ai clienti su come strutturare le firme dei metodi. L'array è ordinato in modo tale che le risposte viene visualizzato per primo.
resources.(key).methods.(key).request object Lo schema della richiesta.
resources.(key).methods.(key).request.$ref string ID schema per lo schema della richiesta.
resources.(key).methods.(key).response object Lo schema della risposta.
resources.(key).methods.(key).response.$ref string ID schema per lo schema di risposta.
resources.(key).methods.(key).scopes[] list Ambiti OAuth 2.0 applicabili a questo metodo.
resources.(key).methods.(key).supportsMediaDownload boolean Indica se questo metodo supporta i download di contenuti multimediali.
resources.(key).methods.(key).supportsMediaUpload boolean Indica se questo metodo supporta i caricamenti di contenuti multimediali.
resources.(key).methods.(key).mediaUpload object Parametri di caricamento dei contenuti multimediali.
resources.(key).methods.(key).mediaUpload.accept[] list Intervalli multimediali MIME per caricamenti multimediali accettabili con questo metodo.
resources.(key).methods.(key).mediaUpload.maxSize string La dimensione massima di un caricamento di contenuti multimediali, ad esempio "1 MB", "2 GB" o "3 TB".
resources.(key).methods.(key).mediaUpload.protocols object Protocolli di caricamento supportati.
resources.(key).methods.(key).mediaUpload.protocols.simple object Supporta il caricamento come singola richiesta HTTP.
resources.(key).methods.(key).mediaUpload.protocols.simple.multipart boolean true se questo endpoint supporta il caricamento di contenuti multimediali suddivisi in più parti.
resources.(key).methods.(key).mediaUpload.protocols.simple.path string Il percorso dell'URI da utilizzare per il caricamento. Deve essere utilizzato insieme alla proprietà rootURL a livello di API.
resources.(key).methods.(key).mediaUpload.protocols.resumable object Supporta il protocollo di caricamento dei contenuti multimediali con possibilità di ripresa.
resources.(key).methods.(key).mediaUpload.protocols.resumable.multipart boolean true se questo endpoint supporta il caricamento di contenuti multimediali multiparte.
resources.(key).methods.(key).mediaUpload.protocols.resumable.path string Il percorso dell'URI da utilizzare per il caricamento. Da utilizzare insieme a rootURL a livello di API.
resources.(key).methods.(key).supportsSubscription boolean Indica se questo metodo supporta gli abbonamenti.
resources.(key).deprecated boolean Indica se questa risorsa è deprecata.
resources.(key).resources object Risorse secondarie di questa risorsa.
resources.(key).resources.(key) nested object Descrizione di eventuali risorse secondarie di questa risorsa.