Telusuri dan pilih Google API

1. Sebelum memulai

Codelab ini menunjukkan cara menelusuri dan memilih Google API, serta melihat metrik API.

Prasyarat

  • Kemampuan untuk menjelajahi Konsol Google Cloud.

Yang akan Anda pelajari

Yang Anda butuhkan

2. Mengakses API dari Konsol Cloud

  1. Di Konsol Cloud, pilih 5854836f11d5d97b.png Navigation menu > APIs & Services > Enabled APIs & services.

Navigation menu di Konsol Cloud yang ditampilkan

  1. Di dasbor APIs & Services, klik + ENABLE APIS AND SERVICES untuk melihat API yang tersedia.

Dasbor APIs & Services yang menampilkan opsi ENABLE APIS AND SERVICES.

Dari halaman APIs & Services, ada beberapa cara yang dapat Anda gunakan untuk menelusuri API. Jika mengetahui nama API, Anda dapat memasukkannya di kolom Search for APIs & Services di bagian atas halaman. Anda juga dapat memfilter API menurut kategori dengan filter di samping halaman.

Daftar API yang dihasilkan dari kolom Search for APIs & Services.

  1. Di menu CATEGORY, pilih Machine learning agar Anda hanya melihat Machine Learning API.

API yang difilter menurut CATEGORY untuk menampilkan hanya Machine Learning API.

  1. Dari Machine Learning API, pilih Cloud Natural Language API untuk melihat detail tentang API ini.
  2. Klik ENABLE untuk mengaktifkan API ini di project yang sesuai.

Panel Cloud Natural Language API yang menampilkan tombol AKTIFKAN dan COBA API INI.

Saat Anda mengaktifkan API, halaman Ringkasan API akan ditampilkan. Anda dapat melihat metrik penggunaan API ini, yang memiliki sangat sedikit informasi karena Anda baru saja mengaktifkan API.

Halaman Ringkasan API yang dipilih menampilkan metrik untuk API tersebut.

Di codelab mendatang, Anda akan mempelajari lebih lanjut cara membuat kredensial, tetapi jika Anda ingin tahu sekarang, klik CREATE CREDENTIALS, lalu jawab pertanyaan yang ditampilkan.

  1. Klik KELOLA untuk kembali ke ringkasan di langkah sebelumnya.

Halaman ringkasan untuk Cloud Natural Language API.

  1. Untuk mencoba API (bahkan sebelum Anda mengaktifkannya), klik TRY THIS API.

Tindakan ini biasanya akan mengarahkan Anda ke halaman dalam dokumentasi untuk API. Namun, untuk beberapa API, tidak ada cara langsung untuk mencoba API karena memiliki banyak metode yang berbeda. Hal ini berlaku untuk Cloud Natural Language API.

Halaman referensi Cloud Natural Language API.

  1. Pilih metode analyzeEntitites.

Anda akan melihat halaman web dengan detail tentang metode API dan panel Try this API.

Halaman untuk metode analyzeEntitites yang menampilkan detail metode dan panel Coba API ini.

  1. Untuk mencoba kueri contoh, tambahkan objek document ke kolom Isi permintaan dengan parameter berikut. Klik ikon + untuk meluaskan opsi kolom.
  2. Di kolom content:, masukkan teks yang akan dianalisis.

Contoh ini menggunakan Michelangelo Caravaggio, Italian painter, is known for 'The Calling of Saint Matthew'.

  1. Di kolom type:, pilih PLAIN_TEXT.

Isi permintaan akan terlihat seperti ini:

Panel isi permintaan yang menampilkan parameter isi permintaan.

Untuk mengetahui informasi selengkapnya tentang setiap parameter, lihat dokumentasi.

  1. Hapus centang kotak Google OAuth 2.0, lalu klik Execute untuk mendapatkan respons dengan detail tentang entitas.

Respons 200 dengan detail tentang entitas.

  1. Hapus centang pada kotak API key, lalu klik Execute lagi.

Saat menjalankan kueri kali ini, Anda akan mendapatkan error seperti ini karena API memerlukan kredensial untuk dijalankan.

Respons 403 untuk permintaan yang tidak memiliki kredensial.

  1. Centang kotak Google OAuth 2.0, lalu klik Execute lagi.

OAuth 2.0 memberikan izin API di akun Anda dan menampilkan peringatan.

Peringatan OAuth 2.0 bahwa Google APIs Explorer ingin mengakses Akun Google Anda.

Jika Anda mengizinkan akses, Anda akan mendapatkan respons yang sama seperti yang Anda dapatkan dengan kunci API. Jika Anda menggunakan API di aplikasi dan perlu memberikan akses kepada individu yang mengetahui kredensial mereka, Anda harus menggunakan OAuth 2.0. Jika aplikasi cukup mengakses API untuk pengguna, Anda dapat menggunakan kunci API.

3. Melihat metrik API Anda dengan Metrics Explorer

Anda dapat melihat histori panggilan untuk satu API dari halaman Ringkasan API, seperti yang ditunjukkan pada langkah 6 Mengakses API dari Konsol Cloud. Namun, untuk melihat lebih banyak metrik untuk semua penggunaan API, gunakan Metrics Explorer.

  1. Di bagian Operations pada Navigation menu f6b6844bf5688982.png, klik Monitoring > Metrics explorer.

Bagian Operasi di Menu navigasi yang menampilkan opsi Monitoring dan Metrics Explorer yang dipilih.

  1. Di menu Resource type, pilih Consumed API sebagai jenis metrik. (Jika Anda tidak melihatnya, hapus centang pada kotak Only show active.)

ca850c4295ef4ec9.png

  1. Di menu Metric, pilih salah satu metrik individual untuk API, seperti Request Count, untuk melihat jumlah API yang dipanggil dalam jangka waktu tertentu.

Metrics Explorer yang menampilkan metrik Consumed API untuk Jumlah Permintaan.

  1. Untuk menyesuaikan output lebih lanjut, tetapkan penggabung dan sesuaikan jangka waktu. Metrics Explorer yang menampilkan metrik Consumed API untuk Jumlah Permintaan dengan agregator dan jangka waktu yang ditentukan.

4. Menggunakan OAuth 2.0 Playground untuk mencoba API

Anda juga dapat menggunakan OAuth 2.0 Playground untuk mencoba Google API. Dengan OAuth 2.0 Playground, Anda dapat memilih API, memberi otorisasi, lalu mengirim permintaan dan melihat respons di jendela konsol OAuth 2.0 Playground.

  1. Buka OAuth 2.0 Playground.

OAuth 2.0 Playground menampilkan daftar API yang dapat Anda coba.

  1. Klik Cloud Natural Language API > https://www.googleapis.com/auth/cloud-language > https://www.googleapis.com/auth/cloud-platform > Authorize APIs.

OAuth 2.0 Playground yang menampilkan Cloud Natural Language API yang dipilih.

  1. Jika perlu, login ke Akun Google Anda, lalu klik Izinkan untuk mendapatkan kode otorisasi.
  2. Klik Exchange authorization code for tokens.

Panel Exchange authorization code for tokens tempat Anda dapat mengklik Exchange authorization code for tokens.

Sekarang Anda dapat membuat permintaan API.

  1. Klik List possible operations untuk memeriksa semua kemungkinan panggilan API.

Anda sebelumnya membuka halaman informasi untuk dokumen analyzeEntities Natural Language API, sehingga Anda dapat melihat bahwa URL untuk permintaan HTTP adalah:

https://language.googleapis.com/v1beta2/documents:analyzeEntities

Ini adalah permintaan POST.

Panel Configure request to API, tempat Anda dapat memilih metode HTTP, mendaftarkan URI permintaan, memasukkan isi permintaan, dan mengirim permintaan.

  1. Masukkan informasi URI Permintaan dan tambahkan isi permintaan.

Anda dapat menggunakan isi yang sama dengan yang Anda gunakan di API Explorer.

Panel isi permintaan.

  1. Klik Tutup > Kirim permintaan.

Anda akan mendapatkan hasil yang mirip dengan gambar ini:

Panel Permintaan/Respons OAuth 2.0 setelah memposting permintaan.

Jangan ragu untuk bereksperimen dengan API lain di OAuth 2.0 Playground.

5. Pembersihan

Memiliki kunci API yang tidak dibatasi untuk project adalah praktik yang buruk. Jika seseorang mendapatkan akses ke pengelola sandi, orang tersebut dapat menggunakannya tanpa perlu autentikasi lebih lanjut.

Untuk menghapus kunci API ini:

  1. Klik f6b6844bf5688982.png Navigation menu > APIs & Services > Credentials.
  2. Di bagian Kunci API, pilih kunci yang akan dihapus, lalu klik 247adf2e1d1eae4b.png.
  3. Demikian pula, daripada mengkhawatirkan Kunci Pribadi Akun Layanan Anda tidak terlindungi, di bagian Akun Layanan, pilih akun layanan yang akan dihapus, lalu klik 247adf2e1d1eae4b.png.

6. Selamat

Selamat! Anda telah mempelajari cara menelusuri dan memilih Google API, serta melihat metriknya.