Documento di rilevamento

Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.
I documenti di rilevamento sono disponibili per versioni specifiche della maggior parte delle API. Ogni documento di rilevamento dell'API descrive la piattaforma API, come accedere all'API e come sono strutturate le richieste e le risposte dell'API. Le informazioni fornite dal documento di rilevamento includono proprietà a livello di API, come una descrizione dell'API, schemi di risorse, ambiti di autenticazione e metodi.

Metodi

Il documento Discovery si concentra sul metodo RESTful per richiamare 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 per 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",
  "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,
      "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
        ]
      }
    }
  },
  "methods": {
    (key): {
      "id": string,
      "path": string,
      "httpMethod": string,
      "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
            ]
          }
        }
      },
      "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,
          "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
                ]
              }
            }
          },
          "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): (RestResource)
      }
    }
  }
}
Nome proprietà Valore Descrizione Note
kind string Il tipo di 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, "API di Google Url Shortener".
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 sono limited_availability o deprecated.
protocol string Il protocollo descritto nel documento. ad esempio REST.
rootUrl string L'URL principale in cui sono pubblicati tutti i servizi API.
parameters object Parametri comuni che si applicano a tutti gli 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 altro schema.
parameters.(key).description string Una descrizione dell'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 o una chiave regolare aggiuntiva che limita il valore. Per maggiori dettagli, vedi Riepilogo tipo e formato.
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ò utilizzare (se è un'enumerazione).
parameters.(key).enumDescriptions[] list Le descrizioni delle enumerazioni. Ogni posizione viene mappata al valore corrispondente nell'array di enumerazioni.
parameters.(key).repeated boolean Indica se questo parametro può essere visualizzato più volte.
parameters.(key).location string Indica se questo parametro è inserito nella query o nel percorso delle richieste REST.
parameters.(key).properties object Se si tratta di uno schema per un oggetto, elenca lo schema per ogni proprietà dell'oggetto.
parameters.(key).properties.(key) nested object Una sola 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 di eventuali proprietà aggiuntive con chiavi dinamiche su questo oggetto.
parameters.(key).items nested object Se si tratta di uno schema per una matrice, questa proprietà è lo schema per ogni elemento nella matrice.
parameters.(key).annotations object Ulteriori informazioni su questa proprietà.
parameters.(key).annotations.required[] list Un elenco di metodi che richiedono questa proprietà per le 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 Descrizione di uno schema individuale.
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 altro schema.
schemas.(key).description string Una descrizione dell'oggetto.
schemas.(key).default string Il valore predefinito di questa proprietà (se esistente).
schemas.(key).required boolean Indica se il parametro è obbligatorio.
schemas.(key).format string Un'espressione o una chiave regolare aggiuntiva che limita il valore.Per maggiori dettagli, vedi Riepilogo tipo e formato.
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ò utilizzare (se è un'enumerazione).
schemas.(key).enumDescriptions[] list Le descrizioni delle enumerazioni. Ogni posizione viene mappata al valore corrispondente nell'array di enum.
schemas.(key).repeated boolean Indica se questo parametro può essere visualizzato più volte.
schemas.(key).location string Indica se questo parametro è inserito nella query o nel percorso delle richieste REST.
schemas.(key).properties object Se si tratta di uno schema per un oggetto, elenca lo schema per ogni proprietà dell'oggetto.
schemas.(key).properties.(key) nested object Una sola 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 di eventuali proprietà aggiuntive con chiavi dinamiche su questo oggetto.
schemas.(key).items nested object Se si tratta di uno schema per una matrice, questa proprietà è lo schema per ogni elemento nella matrice.
schemas.(key).annotations object Ulteriori informazioni su questa proprietà.
schemas.(key).annotations.required[] list Un elenco di metodi che richiedono questa proprietà per le richieste.
methods object Metodi a livello di API per questa API.
methods.(key) nested object Descrizione di un singolo metodo.
methods.(key).id string Un ID univoco per questo metodo. Questa proprietà può essere utilizzata per trovare corrispondenze tra i metodi tra le diverse versioni di Discovery.
methods.(key).description string Descrizione di questo metodo.
methods.(key).parameters object Dettagli di tutti i parametri in questo metodo.
methods.(key).parameters.(key) nested object Dettagli di 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. Puoi trovare un elenco di valori 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 dell'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).format string Un'espressione o una chiave regolare aggiuntiva che limita il valore.Per maggiori dettagli, vedi Riepilogo tipo e formato.
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ò utilizzare (se è un'enumerazione).
methods.(key).parameters.(key).enumDescriptions[] list Le descrizioni delle enumerazioni. Ogni posizione viene mappata al valore corrispondente nell'array di enum.
methods.(key).parameters.(key).repeated boolean Indica se questo parametro può essere visualizzato più volte.
methods.(key).parameters.(key).location string Indica se questo parametro è inserito nella query o nel percorso delle richieste REST.
methods.(key).parameters.(key).properties object Se si tratta di uno schema per un oggetto, elenca lo schema per ogni proprietà dell'oggetto.
methods.(key).parameters.(key).properties.(key) nested object Una sola 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 di eventuali proprietà aggiuntive con chiavi dinamiche su questo oggetto.
methods.(key).parameters.(key).items nested object Se si tratta di uno schema per una matrice, questa proprietà è lo schema per ogni elemento nella matrice.
methods.(key).parameters.(key).annotations object Ulteriori informazioni su questa proprietà.
methods.(key).parameters.(key).annotations.required[] list Un elenco di metodi per cui questa proprietà è richiesta per le richieste.
methods.(key).parameterOrder[] list Elenco ordinato dei parametri richiesti. Questo serve a suggerire ai clienti come strutturare le firme dei metodi. L'array è ordinato in modo che venga visualizzato per primo il parametro più significativo.
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 su questo metodo.
methods.(key).mediaUpload.maxSize string Dimensione massima di un caricamento multimediale, come "1 MB", "2GB" o "3TB".
methods.(key).supportsSubscription boolean Indica se questo metodo supporta gli abbonamenti.
baseUrl string [DEPRECATO] L'URL di base per le richieste REST.
basePath string [DEPRECATO] Il percorso di base per le richieste REST.
servicePath string Il percorso di base per tutte le richieste REST.
batchPath string Il percorso delle richieste batch REST.
methods.(key).path string Il percorso URI di questo metodo REST. Da utilizzare insieme alla proprietà servicePath a livello di API.
methods.(key).httpMethod string Metodo HTTP utilizzato da questo metodo.
methods.(key).request object Lo schema per la richiesta.
methods.(key).request.$ref string ID schema per lo schema della richiesta.
methods.(key).request.parameterName string [DEPRECATO] Alcune API hanno questo campo per motivi di compatibilità con le versioni precedenti. Può essere ignorato.
methods.(key).response object Lo schema per la 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 alla proprietà 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. Da utilizzare insieme alla proprietà rootURL a livello di API.
resources object Le risorse in questa API.
resources.(key) nested object La descrizione di una singola risorsa. Contiene metodi e risorse secondari correlati a questa risorsa.
resources.(key).methods object Metodi su questa risorsa.
resources.(key).methods.(key) nested object Descrizione di tutti i metodi in questa risorsa.
resources.(key).methods.(key).id string Un ID univoco per questo metodo. Questa proprietà può essere utilizzata per trovare corrispondenze tra i metodi tra le diverse versioni di Discovery.
resources.(key).methods.(key).path string Il percorso URI di questo metodo REST. Da utilizzare insieme alla proprietà servicePath a livello di API.
resources.(key).methods.(key).flatPath string Percorso URI di questo metodo REST in 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).parameters object Dettagli di tutti i parametri in questo metodo.
resources.(key).methods.(key).parameters.(key) nested object Dettagli di 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. Puoi trovare un elenco di valori nella sezione "type" dello schema JSON.
resources.(key).methods.(key).parameters.(key).$ref string Un riferimento a un altro schema. Il valore di questa proprietà è il "ID" di 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).format string Un'espressione o una chiave regolare aggiuntiva che limita il valore.Per maggiori dettagli, vedi Riepilogo tipo e formato.
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ò utilizzare (se è un'enumerazione).
resources.(key).methods.(key).parameters.(key).enumDescriptions[] list Le descrizioni delle enumerazioni. Ogni posizione viene mappata al valore corrispondente nell'array di enum.
resources.(key).methods.(key).parameters.(key).repeated boolean Indica se questo parametro può essere visualizzato più volte.
resources.(key).methods.(key).parameters.(key).location string Indica se questo parametro è inserito nella query o nel percorso delle richieste REST.
resources.(key).methods.(key).parameters.(key).properties object Se si tratta di uno schema per un oggetto, elenca lo schema per ogni proprietà dell'oggetto.
resources.(key).methods.(key).parameters.(key).properties.(key) nested object Una sola 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 di eventuali proprietà aggiuntive con chiavi dinamiche su questo oggetto.
resources.(key).methods.(key).parameters.(key).items nested object Se si tratta di uno schema per una matrice, questa proprietà è lo schema per ogni elemento nella matrice.
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à per le richieste.
resources.(key).methods.(key).parameterOrder[] list Elenco ordinato dei parametri richiesti. Questo serve a suggerire ai clienti come strutturare le firme dei metodi. L'array è ordinato in modo che venga visualizzato per primo il parametro più significativo.
resources.(key).methods.(key).request object Lo schema per la richiesta.
resources.(key).methods.(key).request.$ref string ID schema per lo schema della richiesta.
resources.(key).methods.(key).response object Lo schema per la 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 su questo metodo.
resources.(key).methods.(key).mediaUpload.maxSize string Dimensione massima di un caricamento multimediale, come "1 MB", "2GB" o "3TB".
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 multiparte.
resources.(key).methods.(key).mediaUpload.protocols.simple.path string Il percorso dell'URI da utilizzare per il caricamento. Da utilizzare insieme alla proprietà rootURL a livello di API.
resources.(key).methods.(key).mediaUpload.protocols.resumable object Supporta il protocollo Resumable Media Upload.
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 alla proprietà rootURL a livello di API.
resources.(key).methods.(key).supportsSubscription boolean Indica se questo metodo supporta gli abbonamenti.
resources.(key).resources object Risorse secondarie su questa risorsa.
resources.(key).resources.(key) nested object Descrizione delle eventuali risorse secondarie di questa risorsa.