Notebooks API 사용 개요

이 가이드에서는 Notebooks API 사용 및 참고 문서에 대한 개요를 제공합니다.

REST, gRPC, 클라이언트 라이브러리

REST, gRPC 또는 제공된 클라이언트 라이브러리 (gRPC로 빌드) 중 하나를 통해 API에 액세스할 수 있습니다.

Google에서는 이 API에 액세스할 수 있도록 여러 인기 언어에 대해 클라이언트 라이브러리를 제공합니다. 원하는 프로그래밍 언어가 클라이언트 라이브러리에서 지원되는 경우 이 옵션을 사용해야 합니다.

장점	단점
Google이 관리 기본 제공되는 인증 기본 제공되는 재시도 각 언어에 관용적인 사용 효율적인 프로토콜 버퍼 HTTP 요청 본문	일부 프로그래밍 언어에서는 사용할 수 없습니다.

이 API는 REST를 지원합니다. 이 API의 REST 참조를 확인하세요. Google API 호출 방법: REST 버전도 참고하세요.

장점	단점
간단한 JSON 인터페이스 다양한 Google 및 타사 도구 및 라이브러리에서 지원	자체 클라이언트 빌드 필요 인증 구현 필요 재시도 구현 필요 비효율적인 JSON HTTP 요청 본문 이 API에서 REST 스트리밍이 지원되지 않음

이 API는 gRPC를 지원합니다. 이 API의 RPC 참조를 참고하세요. 여기에는 gRPC 라이브러리에 생성된 유형, 메서드, 필드에 대한 일반적인 설명이 나와 있습니다. Google API 호출 방법: RPC 버전도 참고하세요.

장점	단점
다양한 프로그래밍 언어 지원 효율적인 프로토콜 버퍼 HTTP 요청 본문	Google에서 제공하는 프로토콜 버퍼에서 자체 클라이언트 생성 필요 인증 구현 필요 재시도 구현 필요

클라이언트 라이브러리, REST, gRPC 중 어떤 것을 사용하는지에 따라 API의 유형, 메서드, 필드 이름이 약간 달라집니다.

REST는 리소스 계층 구조와 해당 메서드를 기준으로 정렬됩니다.
클라이언트 라이브러리와 gRPC는 서비스와 해당 메서드를 기준으로 정렬됩니다.
API 서비스에서는 카멜 표기법이나 스네이크 표기법을 허용하지만 REST 필드 이름에서는 카멜 표기법을 사용합니다.
gRPC 필드 이름은 스네이크 표기법을 사용합니다.
클라이언트 라이브러리 필드 이름은 어떤 이름이 해당 언어에 자연스러운지에 따라 타이틀 표기법, 카멜 표기법, 스네이크 표기법 중 하나를 사용합니다.

클라이언트 라이브러리, REST, gRPC 중 어떤 것을 사용하는지에 관계없이 기본 서비스는 프로토콜 버퍼를 사용하여 정의됩니다. 특히 서비스는 proto3를 사용합니다.

API를 호출할 때 일부 요청 또는 응답 필드에는 프로토콜 버퍼 잘 알려진 유형에 대한 기본적인 이해가 필요할 수 있습니다.

또한 REST API를 호출할 때 프로토콜 버퍼의 기본값 동작으로 인해 JSON 응답에서 필드가 누락될 수 있습니다. 이러한 필드는 기본값으로 설정되므로 응답에 포함되지 않습니다.

다음 API 버전을 사용할 수 있습니다.