Google의 API 플랫폼은 플랫폼을 사용해 작성되는 모든 Google API에게 공통 기능 집합을 제공합니다. 플랫폼은 이러한 기능을 사용하고 제어할 수 있도록 시스템 매개변수라고 하는 요청 매개변수 집합을 사전 정의합니다. 모든 Google REST API와 gRPC API에서 이러한 매개변수를 사용할 수 있습니다. HTTP 쿼리 매개변수 또는 HTTP 헤더를 사용하여 시스템 매개변수를 지정할 수 있습니다. Google gRPC API의 경우에는 HTTP 헤더만 지원됩니다.
대부분의 사용자는 이러한 매개변수를 직접 사용할 필요가 없습니다. 그러나 Google에서 제공하는 클라이언트 라이브러리에서는 흔히 사용됩니다. Google API에 직접 액세스할 목적으로 커스텀 코드를 작성해야 한다면 JSON 출력(pretty-printing)을 제어하거나 API 키를 지정하는 등의 경우에 시스템 매개변수가 유용할 수 있습니다.
HTTP 매핑
HTTP 요청의 경우 시스템 매개변수는 URL 쿼리 매개변수 또는 HTTP 요청 헤더로 전송됩니다. 예를 들어 $foo라는 시스템 매개변수가 있으면 URL에서 ?$foo=xxx로 전송되거나 URL 인코딩된 경우 ?%24foo=xxx로 전송됩니다. 자세한 내용은 아래 표를 참고하세요.
gRPC 매핑
gRPC 요청의 경우 시스템 매개변수는 키가 소문자인 HTTP 요청 헤더로 전송됩니다. 자세한 내용은 아래 표를 참고하세요.
정의
다음 표는 모든 시스템 매개변수와 각 정의를 나열한 것입니다.
| URL 쿼리 매개변수 | HTTP/gRPC 헤더 | 설명 |
|---|---|---|
Authorization |
사용자 인증 정보 자세한 내용은 인증 개요를 참조하세요. | |
$alt,alt |
대체 응답 형식입니다. 지원되는 값은 json(기본값), media, proto, sse(JSON 스트림)입니다. |
|
$.xgafv |
JSON 오류 형식입니다. 지원되는 값은 1, 2(기본값)입니다. Google API 클라이언트 라이브러리에서만 오류 형식 1을 사용해야 합니다. |
|
$callback,callback |
JSONP 콜백 매개변수입니다. | |
$ct |
Content-Type |
HTTP Content-Type 요청 헤더 재정의입니다. |
$fields,fields |
X-Goog-FieldMask |
FieldMask는 응답 필터링에 사용됩니다. 비어 있으면 달리 문서화되지 않는 한 모든 필드를 반환해야 합니다. |
X-HTTP-Method-Override |
요청에 사용하려고 의도한 HTTP 메서드입니다. 네트워크 프록시에 따라 허용하지 않는 HTTP 메서드가 있습니다. | |
$key,key |
X-Goog-Api-Key |
Google API 키입니다. 자세한 내용은 https://cloud.google.com/docs/authentication/api-keys를 참조하세요. |