このガイドでは、Notebooks API とそのリファレンス ドキュメントの使用の概要について説明します。
REST、gRPC、クライアント ライブラリ
API へのアクセスには、 REST、gRPC、または指定されたクライアント ライブラリ（gRPC 上に構築）のいずれかを使用できます。
クライアント ライブラリ
Google では、多くの一般的な言語でこの API にアクセスするための クライアント ライブラリ を用意しています。 目的のプログラミング言語がクライアント ライブラリでサポートされている場合は、このオプションを使用する必要があります。
| 長所 | 短所 |
|---|---|
|
Google が保守。
組み込み認証。 組み込み再試行。 各言語に固有の特徴。 効率的なプロトコル バッファ HTTP リクエスト本文。 |
一部のプログラミング言語ではご利用いただけません。 |
REST
この API は REST をサポートしています。 この API の REST リファレンスをご覧ください。 Google API の呼び出し方法: REST エディションもご覧ください。 .
| 長所 | 短所 |
|---|---|
|
シンプルな JSON インターフェース。 Google とサードパーティのツールやライブラリで十分にサポートされています。 |
独自のクライアントを構築する必要があります。
認証を実装する必要があります。 再試行を実装する必要があります。 効率の悪い JSON HTTP リクエスト本文。 REST ストリーミングはこの API ではサポートされていません。 |
gRPC
この API は gRPC をサポートしています。 この API の RPC リファレンスをご覧ください。 gRPC リファレンスでは、gRPC ライブラリ用に生成される型、メソッド、 フィールドについて包括的に説明されています。 Google API の呼び出し方法: RPC エディションもご覧ください。 .
| 長所 | 短所 |
|---|---|
|
多くのプログラミング言語に対応しています。 効率的な プロトコル バッファ HTTP リクエスト本文。 |
Google 提供のプロトコル バッファから独自のクライアントを生成する必要があります。
認証を実装する必要があります。 再試行を実装する必要があります。 |
型、メソッド、フィールド名
クライアント ライブラリ、REST、gRPC のいずれを使用するかによって、API のタイプ、メソッド、フィールド名は多少異なります。
- REST は、リソース階層とそのメソッド別に配置されます。
- クライアント ライブラリと gRPC は サービスとそのメソッド別に配置されます。
- REST フィールド名ではキャメルケースが使用されますが、 API サービスではキャメルケースまたはスネークケースのいずれかが認められます。
- gRPC フィールド名はスネークケースを使用します。
- クライアント ライブラリのフィールド名は、その言語でどの名前が慣用的であるかに応じて、タイトルケース、キャメルケース、スネークケースのいずれかを使用します。
プロトコル バッファ
クライアント ライブラリ、REST、gRPC のいずれを使用する場合でも、基盤となるサービスはプロトコル バッファを使用して定義されます。特に、このサービスでは proto3が使用されます。
API を呼び出す場合、 リクエスト フィールドまたはレスポンス フィールドによっては、 プロトコル バッファの既知の型を理解しておく必要があります。
また、REST API を呼び出す場合、 プロトコル バッファのデフォルト値 の動作により、JSON レスポンスでフィールドが欠落する可能性があります。 これらのフィールドはデフォルト値に設定されるため、 レスポンスには含まれません。
API バージョン
次の API バージョンを使用できます。
- v2（一般提供）は、Gemini Enterprise Agent Platform Workbench インスタンスを 管理するためのものです。