Dokument Discovery

Dokumenty Discovery są dostępne dla określonych wersji większości interfejsów API. Każdy dokument Discovery API opisuje powierzchnię interfejsu API, sposób dostępu do niego oraz strukturę żądań i odpowiedzi interfejsu API. Informacje podane w dokumencie wykrywania obejmują właściwości na poziomie interfejsu API, takie jak opis interfejsu API, schematy zasobów, zakresy uwierzytelniania i metody.

Metody

Dokument Discovery skupia się na metodzie REST API wywoływanej przez interfejs API. Metoda discovery.apis.list zwraca listę wszystkich interfejsów API obsługiwanych przez usługę Google APIs Discovery, w tym adresy URL używane do pobierania dokumentów wykrywania opartych na REST.

list
Pobierz listę interfejsów API obsługiwanych przez ten punkt końcowy.

Informacje o zasobach

{
  "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)
      }
    }
  }
}
Nazwa właściwości Wartość Opis Uwagi
kind string Rodzaj tej odpowiedzi.Ciąg stały. discovery#restDescription
discoveryVersion string Określ wersję interfejsu Discovery API, która została użyta do wygenerowania tego dokumentu.
id string Identyfikator dokumentu opisującego interfejs API. na przykład urlshortener:v1.
name string Nazwa interfejsu API. na przykład urlshortener.
canonicalName string Nazwa kanoniczna interfejsu API. na przykład Url Shortener.
version string Wersja interfejsu API. na przykład v1.
revision string Wersja interfejsu API.
title string Tytuł interfejsu API. Na przykład "Google Url Shortener&&quot.
description string Opis tego interfejsu API.
icons object Linki z ikonami 16 x 16 i 32 x 32 symbolizujące interfejs API.
icons.x16 string Adres URL ikony 16 x 16.
icons.x32 string Adres URL ikony 32 x 32.
labels[] list Etykiety stanu tego interfejsu API. Prawidłowe wartości to limited_availability lub deprecated.
protocol string Protokół opisany w dokumencie. na przykład REST.
rootUrl string Główny adres URL, pod którym działają wszystkie usługi API.
parameters object Typowe parametry stosowane we wszystkich interfejsach API.
parameters.(key) nested object Opis pojedynczego parametru.
parameters.(key).id string Unikalny identyfikator tego schematu.
parameters.(key).type string Typ wartości tego schematu. Listę wartości można znaleźć w sekcji "type" w schemacie JSON.
parameters.(key).$ref string Odniesienie do innego schematu. Wartość tej właściwości to identyfikator innego schematu.
parameters.(key).description string Opis tego obiektu.
parameters.(key).default string Wartość domyślna tej właściwości (jeśli istnieje).
parameters.(key).required boolean Określa, czy parametr jest wymagany.
parameters.(key).format string Dodatkowe wyrażenie regularne lub klucz, które pomagają ograniczyć wartość. Więcej informacji znajdziesz w artykule Podsumowanie typu i formatu.
parameters.(key).pattern string Wyrażenie regularne, do którego musi należeć ten parametr.
parameters.(key).minimum string Minimalna wartość tego parametru.
parameters.(key).maximum string Maksymalna wartość tego parametru.
parameters.(key).enum[] list Wartości tego parametru mogą być przyjmowane (jeśli jest to wyliczenie).
parameters.(key).enumDescriptions[] list Opisy wyliczeń. Każda pozycja jest mapowana na odpowiednią wartość w tabeli wyliczenia.
parameters.(key).repeated boolean Określa, czy ten parametr może występować wiele razy.
parameters.(key).location string Określa, czy ten parametr występuje w zapytaniu czy w ścieżce żądań REST.
parameters.(key).properties object Jeśli jest to schemat obiektu, podaj go dla każdej właściwości tego obiektu.
parameters.(key).properties.(key) nested object Jedna właściwość tego obiektu. Wartość jest sama obiektem schematu JSON opisującym tę właściwość.
parameters.(key).additionalProperties nested object Jeśli to jest schemat obiektu, ta właściwość jest schematem dla wszystkich dodatkowych właściwości z kluczami dynamicznymi dla tego obiektu.
parameters.(key).items nested object Jeśli to jest schemat tablicy, ta właściwość jest schematem dla każdego elementu w tablicy.
parameters.(key).annotations object Dodatkowe informacje o tej właściwości.
parameters.(key).annotations.required[] list Lista metod, które wymagają tej właściwości w przypadku żądań.
auth object Informacje dotyczące uwierzytelniania.
auth.oauth2 object Informacje o uwierzytelnianiu przez OAuth 2.0.
auth.oauth2.scopes object Zakresy OAuth 2.0.
auth.oauth2.scopes.(key) object Wartość zakresu.
auth.oauth2.scopes.(key).description string Opis zakresu.
features[] list Lista funkcji, które obsługują ten interfejs API.
schemas object Schematy dla tego interfejsu API.
schemas.(key) nested object Opis pojedynczego schematu.
schemas.(key).id string Unikalny identyfikator tego schematu. Przykład: URL
schemas.(key).type string Typ wartości tego schematu. Listę wartości można znaleźć w sekcji "type" w schemacie JSON.
schemas.(key).$ref string Odniesienie do innego schematu. Wartość tej właściwości to identyfikator innego schematu.
schemas.(key).description string Opis tego obiektu.
schemas.(key).default string Wartość domyślna tej właściwości (jeśli istnieje).
schemas.(key).required boolean Określa, czy parametr jest wymagany.
schemas.(key).format string Dodatkowe wyrażenie regularne lub klucz, które pomagają ograniczyć wartość.Więcej informacji znajdziesz w podsumowaniu typów i formatów.
schemas.(key).pattern string Wyrażenie regularne, do którego musi należeć ten parametr.
schemas.(key).minimum string Minimalna wartość tego parametru.
schemas.(key).maximum string Maksymalna wartość tego parametru.
schemas.(key).enum[] list Wartości tego parametru mogą być przyjmowane (jeśli jest to wyliczenie).
schemas.(key).enumDescriptions[] list Opisy wyliczeń. Każda pozycja jest mapowana na odpowiednią wartość w tablicy enum.
schemas.(key).repeated boolean Określa, czy ten parametr może występować wiele razy.
schemas.(key).location string Określa, czy ten parametr występuje w zapytaniu czy w ścieżce żądań REST.
schemas.(key).properties object Jeśli jest to schemat obiektu, podaj go dla każdej właściwości tego obiektu.
schemas.(key).properties.(key) nested object Jedna właściwość tego obiektu. Wartość jest sama obiektem schematu JSON opisującym tę właściwość.
schemas.(key).additionalProperties nested object Jeśli to jest schemat obiektu, ta właściwość jest schematem dla wszystkich dodatkowych właściwości z kluczami dynamicznymi dla tego obiektu.
schemas.(key).items nested object Jeśli to jest schemat tablicy, ta właściwość jest schematem dla każdego elementu w tablicy.
schemas.(key).annotations object Dodatkowe informacje o tej właściwości.
schemas.(key).annotations.required[] list Lista metod, które wymagają tej właściwości w przypadku żądań.
methods object Metody na poziomie interfejsu API dla tego interfejsu API.
methods.(key) nested object Indywidualny opis metody.
methods.(key).id string Unikalny identyfikator tej metody. Tej właściwości można używać do dopasowywania metod do różnych wersji Discovery.
methods.(key).description string Opis tej metody.
methods.(key).parameters object Szczegóły wszystkich parametrów w tej metodzie.
methods.(key).parameters.(key) nested object Szczegóły pojedynczego parametru w tej metodzie.
methods.(key).parameters.(key).id string Unikalny identyfikator tego schematu.
methods.(key).parameters.(key).type string Typ wartości tego schematu. Listę wartości można znaleźć w sekcji "type" w schemacie JSON.
methods.(key).parameters.(key).$ref string Odniesienie do innego schematu. Wartość tej właściwości to identyfikator innego schematu.
methods.(key).parameters.(key).description string Opis tego obiektu.
methods.(key).parameters.(key).default string Wartość domyślna tej właściwości (jeśli istnieje).
methods.(key).parameters.(key).required boolean Określa, czy parametr jest wymagany.
methods.(key).parameters.(key).format string Dodatkowe wyrażenie regularne lub klucz, które pomagają ograniczyć wartość.Więcej informacji znajdziesz w podsumowaniu typów i formatów.
methods.(key).parameters.(key).pattern string Wyrażenie regularne, do którego musi należeć ten parametr.
methods.(key).parameters.(key).minimum string Minimalna wartość tego parametru.
methods.(key).parameters.(key).maximum string Maksymalna wartość tego parametru.
methods.(key).parameters.(key).enum[] list Wartości tego parametru mogą być przyjmowane (jeśli jest to wyliczenie).
methods.(key).parameters.(key).enumDescriptions[] list Opisy wyliczeń. Każda pozycja jest mapowana na odpowiednią wartość w tablicy enum.
methods.(key).parameters.(key).repeated boolean Określa, czy ten parametr może występować wiele razy.
methods.(key).parameters.(key).location string Określa, czy ten parametr występuje w zapytaniu czy w ścieżce żądań REST.
methods.(key).parameters.(key).properties object Jeśli jest to schemat obiektu, podaj go dla każdej właściwości tego obiektu.
methods.(key).parameters.(key).properties.(key) nested object Jedna właściwość tego obiektu. Wartość jest sama obiektem schematu JSON opisującym tę właściwość.
methods.(key).parameters.(key).additionalProperties nested object Jeśli to jest schemat obiektu, ta właściwość jest schematem dla wszystkich dodatkowych właściwości z kluczami dynamicznymi dla tego obiektu.
methods.(key).parameters.(key).items nested object Jeśli to jest schemat tablicy, ta właściwość jest schematem dla każdego elementu w tablicy.
methods.(key).parameters.(key).annotations object Dodatkowe informacje o tej właściwości.
methods.(key).parameters.(key).annotations.required[] list Lista metod, w przypadku których ta właściwość jest wymagana w przypadku żądań.
methods.(key).parameterOrder[] list Lista kolejności wymaganych parametrów. Dla klientów jest to wskazówka, jak uporządkować podpisy metod. Tablica jest uporządkowana w taki sposób, że pierwszy parametr jest wyświetlany jako pierwszy.
methods.(key).scopes[] list Zakresy OAuth 2.0 odpowiednie dla tej metody.
methods.(key).supportsMediaDownload boolean Określa, czy ta metoda obsługuje pobieranie multimediów.
methods.(key).supportsMediaUpload boolean Określa, czy ta metoda obsługuje przesyłanie multimediów.
methods.(key).mediaUpload object Parametry przesyłania multimediów.
methods.(key).mediaUpload.accept[] list Zakresy multimediów MIME do dopuszczalnego przesyłania multimediów do tej metody.
methods.(key).mediaUpload.maxSize string Maksymalny rozmiar przesyłanego pliku multimedialnego, np. "1 MB", "2 GB" lub "3TB".
methods.(key).supportsSubscription boolean Określa, czy ta metoda obsługuje subskrypcje.
baseUrl string [WYCOFANO] Podstawowy URL dla żądań REST.
basePath string [WYCOFANO] Ścieżka podstawowa żądań REST.
servicePath string Ścieżka podstawowa dla wszystkich żądań REST.
batchPath string Ścieżka do żądań zbiorczych REST.
methods.(key).path string Ścieżka URI tej metody REST. Powinien być używany w połączeniu z właściwością servicePath na poziomie interfejsu API.
methods.(key).httpMethod string Metoda HTTP używana przez tę metodę.
methods.(key).request object Schemat żądania.
methods.(key).request.$ref string Identyfikator schematu dla żądania.
methods.(key).request.parameterName string [WYCOFANO] Niektóre interfejsy API mają to pole ze względu na zgodność z wcześniejszymi rozwiązaniami. Możesz ją zignorować.
methods.(key).response object Schemat odpowiedzi.
methods.(key).response.$ref string Identyfikator schematu dla schematu odpowiedzi.
methods.(key).mediaUpload.protocols object Obsługiwane protokoły przesyłania.
methods.(key).mediaUpload.protocols.simple object Obsługuje przesyłanie jako pojedyncze żądanie HTTP.
methods.(key).mediaUpload.protocols.simple.multipart boolean Prawda, jeśli ten punkt końcowy obsługuje przesyłanie multimediów wieloczęściowych.
methods.(key).mediaUpload.protocols.simple.path string Ścieżka identyfikatora URI używana do przesyłania. Powinien być używany w połączeniu z właściwością rootURL na poziomie interfejsu API.
methods.(key).mediaUpload.protocols.resumable object Obsługuje protokół wznawiania przesyłania multimediów.
methods.(key).mediaUpload.protocols.resumable.multipart boolean true, jeśli ten punkt końcowy obsługuje przesyłanie multimediów wieloczęściowych.
methods.(key).mediaUpload.protocols.resumable.path string Ścieżka identyfikatora URI używana do przesyłania. Powinien być używany w połączeniu z właściwością rootURL na poziomie interfejsu API.
resources object Zasoby w tym interfejsie API.
resources.(key) nested object Opis konkretnego zasobu. Zawiera metody i zasoby podrzędne związane z tym zasobem.
resources.(key).methods object Metody dostępne w tym zasobie.
resources.(key).methods.(key) nested object Opis metod należących do tego zasobu.
resources.(key).methods.(key).id string Unikalny identyfikator tej metody. Tej właściwości można używać do dopasowywania metod do różnych wersji Discovery.
resources.(key).methods.(key).path string Ścieżka URI tej metody REST. Powinien być używany w połączeniu z właściwością servicePath na poziomie interfejsu API.
resources.(key).methods.(key).flatPath string Ścieżka identyfikatora URI tej metody REST w formacie RFC 6570 bez funkcji poziomu 2 ({+var}). Jest uzupełnieniem właściwości path.
resources.(key).methods.(key).httpMethod string Metoda HTTP używana przez tę metodę.
resources.(key).methods.(key).description string Opis tej metody.
resources.(key).methods.(key).parameters object Szczegóły wszystkich parametrów w tej metodzie.
resources.(key).methods.(key).parameters.(key) nested object Szczegóły pojedynczego parametru w tej metodzie.
resources.(key).methods.(key).parameters.(key).id string Unikalny identyfikator tego schematu.
resources.(key).methods.(key).parameters.(key).type string Typ wartości tego schematu.Listę wartości można znaleźć w sekcji "type" w schemacie JSON.
resources.(key).methods.(key).parameters.(key).$ref string Odniesienie do innego schematu. Wartość tej właściwości to &"ID" innego schematu.
resources.(key).methods.(key).parameters.(key).description string Opis tego obiektu.
resources.(key).methods.(key).parameters.(key).default string Wartość domyślna tej właściwości (jeśli istnieje).
resources.(key).methods.(key).parameters.(key).required boolean Określa, czy parametr jest wymagany.
resources.(key).methods.(key).parameters.(key).format string Dodatkowe wyrażenie regularne lub klucz, które pomagają ograniczyć wartość.Więcej informacji znajdziesz w podsumowaniu typów i formatów.
resources.(key).methods.(key).parameters.(key).pattern string Wyrażenie regularne, do którego musi należeć ten parametr.
resources.(key).methods.(key).parameters.(key).minimum string Minimalna wartość tego parametru.
resources.(key).methods.(key).parameters.(key).maximum string Maksymalna wartość tego parametru.
resources.(key).methods.(key).parameters.(key).enum[] list Wartości tego parametru mogą być przyjmowane (jeśli jest to wyliczenie).
resources.(key).methods.(key).parameters.(key).enumDescriptions[] list Opisy wyliczeń. Każda pozycja jest mapowana na odpowiednią wartość w tablicy enum.
resources.(key).methods.(key).parameters.(key).repeated boolean Określa, czy ten parametr może występować wiele razy.
resources.(key).methods.(key).parameters.(key).location string Określa, czy ten parametr występuje w zapytaniu czy w ścieżce żądań REST.
resources.(key).methods.(key).parameters.(key).properties object Jeśli jest to schemat obiektu, podaj go dla każdej właściwości tego obiektu.
resources.(key).methods.(key).parameters.(key).properties.(key) nested object Jedna właściwość tego obiektu. Wartość jest sama obiektem schematu JSON opisującym tę właściwość.
resources.(key).methods.(key).parameters.(key).additionalProperties nested object Jeśli to jest schemat obiektu, ta właściwość jest schematem dla wszystkich dodatkowych właściwości z kluczami dynamicznymi dla tego obiektu.
resources.(key).methods.(key).parameters.(key).items nested object Jeśli to jest schemat tablicy, ta właściwość jest schematem dla każdego elementu w tablicy.
resources.(key).methods.(key).parameters.(key).annotations object Dodatkowe informacje o tej właściwości.
resources.(key).methods.(key).parameters.(key).annotations.required[] list Lista metod, które wymagają tej właściwości w przypadku żądań.
resources.(key).methods.(key).parameterOrder[] list Lista kolejności wymaganych parametrów. Dla klientów jest to wskazówka, jak uporządkować podpisy metod. Tablica jest uporządkowana w taki sposób, że pierwszy parametr jest wyświetlany jako pierwszy.
resources.(key).methods.(key).request object Schemat żądania.
resources.(key).methods.(key).request.$ref string Identyfikator schematu dla żądania.
resources.(key).methods.(key).response object Schemat odpowiedzi.
resources.(key).methods.(key).response.$ref string Identyfikator schematu dla schematu odpowiedzi.
resources.(key).methods.(key).scopes[] list Zakresy OAuth 2.0 odpowiednie dla tej metody.
resources.(key).methods.(key).supportsMediaDownload boolean Określa, czy ta metoda obsługuje pobieranie multimediów.
resources.(key).methods.(key).supportsMediaUpload boolean Określa, czy ta metoda obsługuje przesyłanie multimediów.
resources.(key).methods.(key).mediaUpload object Parametry przesyłania multimediów.
resources.(key).methods.(key).mediaUpload.accept[] list Zakresy multimediów MIME do dopuszczalnego przesyłania multimediów do tej metody.
resources.(key).methods.(key).mediaUpload.maxSize string Maksymalny rozmiar przesyłanego pliku multimedialnego, np. "1 MB", "2 GB" lub "3TB".
resources.(key).methods.(key).mediaUpload.protocols object Obsługiwane protokoły przesyłania.
resources.(key).methods.(key).mediaUpload.protocols.simple object Obsługuje przesyłanie jako pojedyncze żądanie HTTP.
resources.(key).methods.(key).mediaUpload.protocols.simple.multipart boolean true, jeśli ten punkt końcowy obsługuje przesyłanie multimediów wieloczęściowych.
resources.(key).methods.(key).mediaUpload.protocols.simple.path string Ścieżka identyfikatora URI używana do przesyłania. Powinien być używany w połączeniu z właściwością rootURL na poziomie interfejsu API.
resources.(key).methods.(key).mediaUpload.protocols.resumable object Obsługuje protokół wznawiania przesyłania multimediów.
resources.(key).methods.(key).mediaUpload.protocols.resumable.multipart boolean true, jeśli ten punkt końcowy obsługuje przesyłanie multimediów wieloczęściowych.
resources.(key).methods.(key).mediaUpload.protocols.resumable.path string Ścieżka identyfikatora URI używana do przesyłania. Powinien być używany w połączeniu z właściwością rootURL na poziomie interfejsu API.
resources.(key).methods.(key).supportsSubscription boolean Określa, czy ta metoda obsługuje subskrypcje.
resources.(key).resources object Zasoby podrzędne tego zasobu.
resources.(key).resources.(key) nested object Opis wszystkich zasobów podrzędnych tego zasobu.