Panduan ini memberikan ringkasan tentang penggunaan Notebooks API dan dokumentasi referensinya.
REST, gRPC, dan library klien
Anda dapat mengakses API melalui REST, gRPC, atau salah satu library klien yang disediakan (dibuat di gRPC).
Library klien
Google menyediakan library klien untuk banyak bahasa populer guna mengakses API ini. Jika bahasa pemrograman yang Anda inginkan didukung oleh library klien, Anda harus menggunakan opsi ini.
| Kelebihan | Kekurangan |
|---|---|
|
Dikelola oleh Google.
Autentikasi bawaan. Coba lagi bawaan. Idiomatik untuk setiap bahasa. Isi permintaan HTTP buffer protokol yang efisien. |
Tidak tersedia untuk semua bahasa pemrograman. |
REST
API ini mendukung REST. Lihat referensi REST untuk API ini. Lihat juga Cara memanggil Google API: Edisi REST.
| Kelebihan | Kekurangan |
|---|---|
|
Antarmuka JSON sederhana.
Didukung dengan baik oleh banyak alat dan library Google dan pihak ketiga. |
Anda harus membuat klien Anda sendiri.
Anda harus menerapkan autentikasi. Anda harus menerapkan percobaan ulang. Isi permintaan HTTP JSON yang kurang efisien. Streaming REST tidak didukung oleh API ini. |
gRPC
API ini mendukung gRPC. Lihat referensi RPC untuk API ini, yang memberikan deskripsi umum tentang jenis, metode, dan kolom yang dihasilkan untuk library gRPC. Lihat juga Cara memanggil Google API: Edisi RPC.
| Kelebihan | Kekurangan |
|---|---|
|
Mendukung
banyak bahasa pemrograman.
Isi permintaan HTTP buffer protokol yang efisien. |
Anda harus membuat klien Anda sendiri dari buffer protokol yang disediakan Google.
Anda harus menerapkan autentikasi. Anda harus menerapkan percobaan ulang. |
Nama jenis, metode, dan kolom
Bergantung pada apakah Anda menggunakan library klien, REST, atau gRPC, nama jenis, metode, dan kolom untuk API akan sedikit berbeda:
- REST diatur berdasarkan hierarki resource dan metodenya.
- Library klien dan gRPC diatur berdasarkan layanan dan metodenya.
- Nama kolom REST menggunakan camel case, meskipun layanan API akan menerima camel case atau snake case.
- Nama kolom gRPC menggunakan snake case.
- Nama kolom library klien menggunakan title case, camel case, atau snake case, bergantung pada nama yang idiomatis untuk bahasa tersebut.
Buffering protokol
Baik Anda menggunakan library klien, REST, atau gRPC, layanan yang mendasarinya ditentukan menggunakan protocol buffer. Secara khusus, layanan ini menggunakan proto3.
Saat memanggil API, beberapa kolom permintaan atau respons dapat memerlukan pemahaman dasar tentang jenis yang sudah dikenal baik dalam buffer protokol.
Selain itu, saat memanggil REST API, perilaku nilai default untuk buffer protokol dapat menyebabkan kolom tidak ada dalam respons JSON. Kolom ini hanya ditetapkan ke nilai default, sehingga tidak disertakan dalam respons.
Versi API
Versi API berikut tersedia:
- v2 (tersedia secara umum) digunakan untuk mengelola instance Workbench Platform Agen Gemini Enterprise.