Halaman ini memberikan ringkasan tentang cara menggunakan Google Chat API dan dokumentasi referensinya.
Google Chat API memiliki antarmuka gRPC dan REST, serta library klien yang mendukung keduanya. Secara opsional, jika library klien yang disediakan tidak memenuhi kebutuhan Anda, Anda dapat menulis library klien sendiri yang menggunakan antarmuka gRPC atau REST.
Library klien
Cara yang direkomendasikan bagi sebagian besar developer untuk memanggil Google Chat API adalah dengan Cloud Client Libraries yang didukung secara resmi untuk bahasa pilihan Anda, seperti Python, Java, atau Node.js.
Jika Anda membuat kode dengan Google Apps Script, gunakan layanan Chat Lanjutan bukan menginstal library klien.
Nama jenis, metode, dan kolom
Bergantung pada apakah Anda menggunakan library klien, gRPC, atau REST, nama jenis, metode, dan kolom untuk Google Chat API akan sedikit berbeda:
- Cloud Client Libraries diatur berdasarkan layanan gRPC dan metodenya. Google API Client Libraries diatur sebagai layanan yang berisi objek atau class yang sesuai dengan resource REST, yang juga berisi metode yang sesuai.
- gRPC diatur berdasarkan layanan dan metodenya.
- REST diatur berdasarkan hierarki resource dan metodenya.
- Nama kolom gRPC menggunakan snake case.
- Nama kolom REST menggunakan camel case, meskipun layanan API akan menerima camel case atau 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 buffering protokol. Secara khusus, layanan ini menggunakan proto3.
Saat memanggil API, beberapa kolom permintaan atau respons mungkin memerlukan pemahaman dasar tentang jenis buffering protokol yang dikenal.
Selain itu, saat memanggil REST API, perilaku nilai default untuk buffering protokol dapat menyebabkan kolom yang tidak ada dalam respons JSON. Kolom ini ditetapkan ke nilai default, sehingga tidak disertakan dalam respons.
Versi API
Versi API berikut tersedia:
- v1: Stabil.
Pratinjau Developer
Dalam dokumentasi, Anda mungkin melihat metode atau kolom API yang hanya tersedia melalui Program Pratinjau Developer. Untuk menguji dan melihat pratinjau serta memberikan masukan tentang fitur pratinjau terbaru, bergabunglah dengan Program Pratinjau Developer.