검색 문서

컬렉션을 사용해 정리하기 내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.
검색 문서는 대부분의 API 특정 버전에서 사용할 수 있습니다. 각 API 검색 문서는 API 노출 영역, API 액세스 방법, API 요청 및 응답의 구조를 설명합니다. 검색 문서에서 제공하는 정보에는 API 설명, 리소스 스키마, 인증 범위, 메서드와 같은 API 수준 속성이 포함됩니다.

메서드

검색 문서에서는 API를 호출하는 RESTful 메서드. discovery.apis.list 메서드는 REST 기반 검색 문서를 가져오기 위한 URL을 포함해 Google API 검색 서비스에서 지원하는 모든 API 목록을 반환합니다.

list
이 엔드포인트에서 지원되는 API 목록을 검색합니다.

리소스 표현

{
  "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)
      }
    }
  }
}
속성 이름 값 설명 참고
kind string 이 응답의 유형입니다.고정 문자열 discovery#restDescription.
discoveryVersion string 이 문서를 생성하는 데 사용되는 Discovery API의 버전을 나타냅니다.
id string API의 검색 문서 ID입니다. 예: urlshortener:v1
name string API의 이름입니다. 예: urlshortener
canonicalName string API의 표준 이름입니다. 예: Url Shortener
version string API 버전입니다. 예: v1
revision string API 버전입니다.
title string API의 제목입니다. 예: "Google Url Shortener API"
description string 이 API에 관한 설명입니다.
icons object API를 나타내는 16x16 및 32x32 아이콘 링크
icons.x16 string 16x16 아이콘의 URL입니다.
icons.x32 string 32x32 아이콘의 URL입니다.
labels[] list 이 API의 상태 라벨입니다. 유효한 값에는 limited_availability 또는 deprecated이 포함됩니다.
protocol string 문서에 설명된 프로토콜입니다. REST를 예로 들 수 있습니다.
rootUrl string 모든 API 서비스가 배치된 루트 URL입니다.
parameters object 모든 API에 적용되는 일반적인 매개변수입니다.
parameters.(key) nested object 단일 매개변수에 대한 설명입니다.
parameters.(key).id string 이 스키마의 고유 식별자입니다.
parameters.(key).type string 이 스키마의 값 유형입니다. 값 목록은 JSON 스키마의 '유형' 섹션에서 확인할 수 있습니다.
parameters.(key).$ref string 다른 스키마에 대한 참조입니다. 이 속성의 값은 다른 스키마의 ID입니다.
parameters.(key).description string 이 객체에 대한 설명입니다.
parameters.(key).default string 이 속성의 기본값입니다 (있는 경우).
parameters.(key).required boolean 매개변수 필수인지 여부입니다.
parameters.(key).format string 값을 제한하는 데 도움이 되는 추가 정규 표현식 또는 키입니다. 자세한 내용은 유형 및 형식 요약을 참고하세요.
parameters.(key).pattern string 이 매개변수가 준수해야 하는 정규 표현식입니다.
parameters.(key).minimum string 이 매개변수의 최솟값입니다.
parameters.(key).maximum string 이 매개변수의 최댓값입니다.
parameters.(key).enum[] list 이 매개변수가 받을 수 있는 값입니다 (enum인 경우).
parameters.(key).enumDescriptions[] list enum에 대한 설명입니다. 각 위치는 enum 배열의 해당 값에 매핑됩니다.
parameters.(key).repeated boolean 이 매개변수가 여러 번 표시될 수 있는지 여부입니다.
parameters.(key).location string 이 매개변수가 쿼리와 REST 요청 경로에 들어가는지 여부입니다.
parameters.(key).properties object 객체의 스키마인 경우 이 객체의 각 속성에 대한 스키마를 나열합니다.
parameters.(key).properties.(key) nested object 이 객체의 단일 속성입니다. 값 자체는 이 속성을 설명하는 JSON 스키마 객체입니다.
parameters.(key).additionalProperties nested object 객체의 스키마인 경우 이 속성은 이 객체에 동적 키가 있는 모든 추가 속성의 스키마입니다.
parameters.(key).items nested object 배열의 스키마인 경우 이 속성은 배열의 각 요소에 대한 스키마입니다.
parameters.(key).annotations object 이 속성에 대한 추가 정보입니다.
parameters.(key).annotations.required[] list 요청에 이 속성이 필요한 메서드 목록입니다.
auth object 인증 정보
auth.oauth2 object OAuth 2.0 인증 정보
auth.oauth2.scopes object 사용 가능한 OAuth 2.0 범위
auth.oauth2.scopes.(key) object 범위 값입니다.
auth.oauth2.scopes.(key).description string 범위에 대한 설명입니다.
features[] list 이 API에서 지원되는 기능의 목록입니다.
schemas object 이 API의 스키마입니다.
schemas.(key) nested object 개별 스키마 설명
schemas.(key).id string 이 스키마의 고유 식별자입니다. 예: URL
schemas.(key).type string 이 스키마의 값 유형입니다. 값 목록은 JSON 스키마의 '유형' 섹션에서 확인할 수 있습니다.
schemas.(key).$ref string 다른 스키마에 대한 참조입니다. 이 속성의 값은 다른 스키마의 ID입니다.
schemas.(key).description string 이 객체에 대한 설명입니다.
schemas.(key).default string 이 속성의 기본값입니다 (있는 경우).
schemas.(key).required boolean 매개변수 필수인지 여부입니다.
schemas.(key).format string 값을 제한하는 데 도움이 되는 추가 정규 표현식 또는 키입니다.자세한 내용은 유형 및 형식 요약을 참고하세요.
schemas.(key).pattern string 이 매개변수가 준수해야 하는 정규 표현식입니다.
schemas.(key).minimum string 이 매개변수의 최솟값입니다.
schemas.(key).maximum string 이 매개변수의 최댓값입니다.
schemas.(key).enum[] list 이 매개변수가 받을 수 있는 값입니다 (enum인 경우).
schemas.(key).enumDescriptions[] list enum에 대한 설명입니다. 각 위치는 enum 배열에 있는 해당 값에 매핑됩니다.
schemas.(key).repeated boolean 이 매개변수가 여러 번 표시될 수 있는지 여부입니다.
schemas.(key).location string 이 매개변수가 쿼리와 REST 요청 경로에 들어가는지 여부입니다.
schemas.(key).properties object 객체의 스키마인 경우 이 객체의 각 속성에 대한 스키마를 나열합니다.
schemas.(key).properties.(key) nested object 이 객체의 단일 속성입니다. 값 자체는 이 속성을 설명하는 JSON 스키마 객체입니다.
schemas.(key).additionalProperties nested object 객체의 스키마인 경우 이 속성은 이 객체에 동적 키가 있는 모든 추가 속성의 스키마입니다.
schemas.(key).items nested object 배열의 스키마인 경우 이 속성은 배열의 각 요소에 대한 스키마입니다.
schemas.(key).annotations object 이 속성에 대한 추가 정보입니다.
schemas.(key).annotations.required[] list 요청에 이 속성이 필요한 메서드 목록입니다.
methods object 이 API의 API 수준 메서드입니다.
methods.(key) nested object 개별 메서드 설명입니다.
methods.(key).id string 이 메서드의 고유 ID입니다. 이 속성은 서로 다른 버전의 검색 간에 메서드를 일치시키는 데 사용할 수 있습니다.
methods.(key).description string 이 메서드에 대한 설명입니다.
methods.(key).parameters object 이 메서드의 모든 매개변수에 대한 세부정보입니다.
methods.(key).parameters.(key) nested object 이 메서드의 단일 매개변수에 대한 세부정보입니다.
methods.(key).parameters.(key).id string 이 스키마의 고유 식별자입니다.
methods.(key).parameters.(key).type string 이 스키마의 값 유형입니다. 값 목록은 JSON 스키마의 섹션에서 확인할 수 있습니다.
methods.(key).parameters.(key).$ref string 다른 스키마에 대한 참조입니다. 이 속성의 값은 다른 스키마의 ID입니다.
methods.(key).parameters.(key).description string 이 객체에 대한 설명입니다.
methods.(key).parameters.(key).default string 이 속성의 기본값입니다 (있는 경우).
methods.(key).parameters.(key).required boolean 매개변수 필수인지 여부입니다.
methods.(key).parameters.(key).format string 값을 제한하는 데 도움이 되는 추가 정규 표현식 또는 키입니다.자세한 내용은 유형 및 형식 요약을 참고하세요.
methods.(key).parameters.(key).pattern string 이 매개변수가 준수해야 하는 정규 표현식입니다.
methods.(key).parameters.(key).minimum string 이 매개변수의 최솟값입니다.
methods.(key).parameters.(key).maximum string 이 매개변수의 최댓값입니다.
methods.(key).parameters.(key).enum[] list 이 매개변수가 받을 수 있는 값입니다 (enum인 경우).
methods.(key).parameters.(key).enumDescriptions[] list enum에 대한 설명입니다. 각 위치는 enum 배열에 있는 해당 값에 매핑됩니다.
methods.(key).parameters.(key).repeated boolean 이 매개변수가 여러 번 표시될 수 있는지 여부입니다.
methods.(key).parameters.(key).location string 이 매개변수가 쿼리와 REST 요청 경로에 들어가는지 여부입니다.
methods.(key).parameters.(key).properties object 객체의 스키마인 경우 이 객체의 각 속성에 대한 스키마를 나열합니다.
methods.(key).parameters.(key).properties.(key) nested object 이 객체의 단일 속성입니다. 값 자체는 이 속성을 설명하는 JSON 스키마 객체입니다.
methods.(key).parameters.(key).additionalProperties nested object 객체의 스키마인 경우 이 속성은 이 객체에 동적 키가 있는 모든 추가 속성의 스키마입니다.
methods.(key).parameters.(key).items nested object 배열의 스키마인 경우 이 속성은 배열의 각 요소에 대한 스키마입니다.
methods.(key).parameters.(key).annotations object 이 속성에 대한 추가 정보입니다.
methods.(key).parameters.(key).annotations.required[] list 요청에 이 속성이 필요한 메서드의 목록입니다.
methods.(key).parameterOrder[] list 필수 매개변수의 순서가 지정된 목록 이는 클라이언트에게 메서드 서명을 구조화하는 방법에 대한 힌트 역할을 합니다. 배열은 가장 중요한 매개변수가 맨 위에 표시되도록 정렬됩니다.
methods.(key).scopes[] list 이 메서드에 적용할 수 있는 OAuth 2.0 범위입니다.
methods.(key).supportsMediaDownload boolean 이 메서드가 미디어 다운로드를 지원하는지 여부.
methods.(key).supportsMediaUpload boolean 이 메서드가 미디어 업로드를 지원하는지 여부.
methods.(key).mediaUpload object 미디어 업로드 매개변수
methods.(key).mediaUpload.accept[] list 이 메서드에 허용되는 미디어 업로드를 위한 MIME 미디어 범위입니다.
methods.(key).mediaUpload.maxSize string 미디어 업로드의 최대 크기(예: '1MB', '2GB' 또는 '3TB')
methods.(key).supportsSubscription boolean 이 메서드가 정기 결제를 지원하는지 여부.
baseUrl string [지원 중단됨] REST 요청의 기본 URL입니다.
basePath string [지원 중단됨] REST 요청의 기본 경로입니다.
servicePath string 모든 REST 요청의 기본 경로입니다.
batchPath string REST 일괄 요청의 경로입니다.
methods.(key).path string 이 REST 메서드의 URI 경로입니다. API 수준에서 servicePath 속성과 함께 사용해야 합니다.
methods.(key).httpMethod string 이 메서드에서 사용하는 HTTP 메서드입니다.
methods.(key).request object 요청의 스키마입니다.
methods.(key).request.$ref string 요청 스키마의 스키마 ID입니다.
methods.(key).request.parameterName string [지원 중단됨] 일부 API에는 이전 버전과의 호환성을 위해 이 입력란이 포함되어 있습니다. 무시해도 됩니다.
methods.(key).response object 응답의 스키마입니다.
methods.(key).response.$ref string 응답 스키마의 스키마 ID입니다.
methods.(key).mediaUpload.protocols object 지원되는 업로드 프로토콜입니다.
methods.(key).mediaUpload.protocols.simple object 단일 HTTP 요청으로 업로드하는 기능을 지원합니다.
methods.(key).mediaUpload.protocols.simple.multipart boolean 이 엔드포인트가 멀티파트 미디어 업로드를 지원하는 경우 true입니다.
methods.(key).mediaUpload.protocols.simple.path string 업로드에 사용될 URI 경로입니다. API 수준에서 rootURL 속성과 함께 사용해야 합니다.
methods.(key).mediaUpload.protocols.resumable object 재개 가능한 미디어 업로드 프로토콜을 지원합니다.
methods.(key).mediaUpload.protocols.resumable.multipart boolean true: 이 엔드포인트는 멀티파트 미디어 업로드를 지원합니다.
methods.(key).mediaUpload.protocols.resumable.path string 업로드에 사용될 URI 경로입니다. API 수준에서 rootURL 속성과 함께 사용해야 합니다.
resources object 이 API의 리소스입니다.
resources.(key) nested object 개별 리소스 설명입니다. 이 리소스와 관련된 메서드와 하위 리소스가 포함되어 있습니다.
resources.(key).methods object 이 리소스의 메서드입니다.
resources.(key).methods.(key) nested object 이 리소스의 모든 메서드에 대한 설명입니다.
resources.(key).methods.(key).id string 이 메서드의 고유 ID입니다. 이 속성은 서로 다른 버전의 검색 간에 메서드를 일치시키는 데 사용할 수 있습니다.
resources.(key).methods.(key).path string 이 REST 메서드의 URI 경로입니다. API 수준에서 servicePath 속성과 함께 사용해야 합니다.
resources.(key).methods.(key).flatPath string 레벨 2 기능({+var})이 없는 (RFC 6570) 이 REST 메서드의 URI 경로입니다. path 속성입니다.
resources.(key).methods.(key).httpMethod string 이 메서드에서 사용하는 HTTP 메서드입니다.
resources.(key).methods.(key).description string 이 메서드에 대한 설명입니다.
resources.(key).methods.(key).parameters object 이 메서드의 모든 매개변수에 대한 세부정보입니다.
resources.(key).methods.(key).parameters.(key) nested object 이 메서드의 단일 매개변수에 대한 세부정보입니다.
resources.(key).methods.(key).parameters.(key).id string 이 스키마의 고유 식별자입니다.
resources.(key).methods.(key).parameters.(key).type string 이 스키마의 값 유형입니다. 값 목록은 JSON 스키마의 섹션에서 확인할 수 있습니다.
resources.(key).methods.(key).parameters.(key).$ref string 다른 스키마에 대한 참조입니다. 이 속성의 값은 다른 스키마의 'ID'입니다.
resources.(key).methods.(key).parameters.(key).description string 이 객체에 대한 설명입니다.
resources.(key).methods.(key).parameters.(key).default string 이 속성의 기본값입니다 (있는 경우).
resources.(key).methods.(key).parameters.(key).required boolean 매개변수 필수인지 여부입니다.
resources.(key).methods.(key).parameters.(key).format string 값을 제한하는 데 도움이 되는 추가 정규 표현식 또는 키입니다.자세한 내용은 유형 및 형식 요약을 참고하세요.
resources.(key).methods.(key).parameters.(key).pattern string 이 매개변수가 준수해야 하는 정규 표현식입니다.
resources.(key).methods.(key).parameters.(key).minimum string 이 매개변수의 최솟값입니다.
resources.(key).methods.(key).parameters.(key).maximum string 이 매개변수의 최댓값입니다.
resources.(key).methods.(key).parameters.(key).enum[] list 이 매개변수가 받을 수 있는 값입니다 (enum인 경우).
resources.(key).methods.(key).parameters.(key).enumDescriptions[] list enum에 대한 설명입니다. 각 위치는 enum 배열에 있는 해당 값에 매핑됩니다.
resources.(key).methods.(key).parameters.(key).repeated boolean 이 매개변수가 여러 번 표시될 수 있는지 여부입니다.
resources.(key).methods.(key).parameters.(key).location string 이 매개변수가 쿼리와 REST 요청 경로에 들어가는지 여부입니다.
resources.(key).methods.(key).parameters.(key).properties object 객체의 스키마인 경우 이 객체의 각 속성에 대한 스키마를 나열합니다.
resources.(key).methods.(key).parameters.(key).properties.(key) nested object 이 객체의 단일 속성입니다. 값 자체는 이 속성을 설명하는 JSON 스키마 객체입니다.
resources.(key).methods.(key).parameters.(key).additionalProperties nested object 객체의 스키마인 경우 이 속성은 이 객체에 동적 키가 있는 모든 추가 속성의 스키마입니다.
resources.(key).methods.(key).parameters.(key).items nested object 배열의 스키마인 경우 이 속성은 배열의 각 요소에 대한 스키마입니다.
resources.(key).methods.(key).parameters.(key).annotations object 이 속성에 대한 추가 정보입니다.
resources.(key).methods.(key).parameters.(key).annotations.required[] list 요청에 이 속성이 필요한 메서드 목록입니다.
resources.(key).methods.(key).parameterOrder[] list 필수 매개변수의 순서가 지정된 목록 이는 클라이언트에게 메서드 서명을 구조화하는 방법에 대한 힌트 역할을 합니다. 배열은 가장 중요한 매개변수가 맨 위에 표시되도록 정렬됩니다.
resources.(key).methods.(key).request object 요청의 스키마입니다.
resources.(key).methods.(key).request.$ref string 요청 스키마의 스키마 ID입니다.
resources.(key).methods.(key).response object 응답의 스키마입니다.
resources.(key).methods.(key).response.$ref string 응답 스키마의 스키마 ID입니다.
resources.(key).methods.(key).scopes[] list 이 메서드에 적용할 수 있는 OAuth 2.0 범위입니다.
resources.(key).methods.(key).supportsMediaDownload boolean 이 메서드가 미디어 다운로드를 지원하는지 여부.
resources.(key).methods.(key).supportsMediaUpload boolean 이 메서드가 미디어 업로드를 지원하는지 여부.
resources.(key).methods.(key).mediaUpload object 미디어 업로드 매개변수
resources.(key).methods.(key).mediaUpload.accept[] list 이 메서드에 허용되는 미디어 업로드를 위한 MIME 미디어 범위입니다.
resources.(key).methods.(key).mediaUpload.maxSize string 미디어 업로드의 최대 크기(예: '1MB', '2GB' 또는 '3TB')
resources.(key).methods.(key).mediaUpload.protocols object 지원되는 업로드 프로토콜입니다.
resources.(key).methods.(key).mediaUpload.protocols.simple object 단일 HTTP 요청으로 업로드하는 기능을 지원합니다.
resources.(key).methods.(key).mediaUpload.protocols.simple.multipart boolean true: 이 엔드포인트는 멀티파트 미디어 업로드를 지원하는 경우
resources.(key).methods.(key).mediaUpload.protocols.simple.path string 업로드에 사용될 URI 경로입니다. API 수준에서 rootURL 속성과 함께 사용해야 합니다.
resources.(key).methods.(key).mediaUpload.protocols.resumable object 재개 가능한 미디어 업로드 프로토콜을 지원합니다.
resources.(key).methods.(key).mediaUpload.protocols.resumable.multipart boolean true: 이 엔드포인트는 멀티파트 미디어 업로드를 지원합니다.
resources.(key).methods.(key).mediaUpload.protocols.resumable.path string 업로드에 사용될 URI 경로입니다. API 수준에서 rootURL 속성과 함께 사용해야 합니다.
resources.(key).methods.(key).supportsSubscription boolean 이 메서드가 정기 결제를 지원하는지 여부.
resources.(key).resources object 이 리소스의 하위 리소스입니다.
resources.(key).resources.(key) nested object 이 리소스의 모든 하위 리소스에 대한 설명입니다.