Developer Knowledge API

Developer Knowledge API menyediakan akses terprogram ke dokumentasi developer publik Google, sehingga Anda dapat mengintegrasikan pusat informasi ini ke dalam aplikasi dan alur kerja Anda sendiri.

Ringkasan

Developer Knowledge API dirancang untuk menjadi sumber kanonis bagi akses yang dapat dibaca mesin ke dokumentasi developer Google. API ini menawarkan dua fungsi utama:

  • SearchDocumentChunks untuk menemukan URI halaman dan cuplikan konten yang relevan berdasarkan kueri.
  • GetDocument atau BatchGetDocuments untuk mengambil konten lengkap hasil penelusuran.

Untuk memulai dengan cepat, ikuti Panduan memulai cepat.

Korpus konten yang dapat ditelusuri tercantum dalam Referensi korpus.

Catatan untuk pratinjau: Rilis pratinjau ini mendukung penelusuran dan pengambilan halaman dokumentasi sebagai konten Markdown tidak terstruktur.

Mengaktifkan API

Untuk menggunakan Developer Knowledge API, Anda harus mengaktifkannya terlebih dahulu untuk project Google Cloud Anda.

  1. Buka halaman Developer Knowledge API di library API Google.
  2. Periksa apakah Anda telah memilih project yang benar untuk menggunakan API.
  3. Klik Enable. Tidak ada peran IAM tertentu yang diperlukan untuk mengaktifkan atau menggunakan API.

Autentikasi

Kunci API Developer Knowledge diperlukan untuk menggunakan Developer Knowledge API. Untuk membuatnya:

  1. Di Konsol Google Cloud untuk project tempat Anda mengaktifkan API, buka halaman Kredensial.
  2. Klik Create credentials, lalu pilih API key dari menu. Dialog API key created akan menampilkan string untuk kunci yang baru dibuat.
  3. Klik Edit kunci API.
  4. Di kolom Name, masukkan nama untuk kunci.
  5. Pada bagian Pembatasan API, pilih Batasi kunci.
  6. Dari daftar Select APIs, aktifkan Developer Knowledge API, lalu klik OK.
    • Catatan: Jika Anda baru saja mengaktifkan Developer Knowledge API, mungkin ada penundaan sebelum API tersebut muncul di daftar Select APIs.
  7. Klik Simpan.

Sertakan kunci API Developer Knowledge ini dalam permintaan Anda. Misalnya, panggilan REST harus menyertakannya menggunakan parameter kueri key. Lihat Panduan memulai untuk mengetahui contohnya.

Dokumentasi yang disertakan

Lihat Referensi korpus untuk mengetahui informasi tentang dokumen mana yang dicari oleh API.

Batasan umum

  • Kualitas Markdown: Markdown dibuat dari HTML sumber. Mungkin ada beberapa perbedaan atau masalah pemformatan.
  • Cakupan Konten: Hanya halaman publik di Referensi korpus yang disertakan. Konten dari sumber lain seperti GitHub, situs OSS, blog, atau YouTube tidak disertakan.