Untuk melanjutkan, pastikan Anda menyelesaikan langkah-langkah dalam Prasyarat dan bahwa kami telah menyetujui project Anda untuk akses API Profil Bisnis.
Mengaktifkan API
Ada delapan API yang terkait dengan Profil Bisnis yang harus diaktifkan di Konsol API Google:
- Google My Business API
- My Business Account Management API
- My Business Lodging API
- My Business Place Actions API
- My Business Notifications API
- My Business Verifications API
- My Business Business Information API
- My Business Q&A API
Mengaktifkan API
Jika sudah menyelesaikan semua Prasyarat dan telah diberi akses ke API, tetapi masih tidak dapat menggunakan pintasan yang diberikan, Anda dapat mengaktifkan API secara manual dengan langkah-langkah berikut.
Untuk mengaktifkan API untuk project Anda, lakukan hal berikut:
- Buka API Library di Konsol API Google. Jika diminta, pilih project atau buat project baru. Library API menampilkan daftar semua API yang tersedia, yang dikelompokkan berdasarkan kelompok produk dan popularitas.
- Jika API yang ingin Anda aktifkan tidak terlihat dalam daftar, gunakan penelusuran untuk mencarinya.
- Pilih API yang ingin Anda aktifkan, lalu klik tombol Enable.
- Jika diminta, aktifkan penagihan.
- Jika diminta, setujui Persyaratan Layanan API.
Jika Anda adalah pengguna Google Workspace, pastikan Google Profil Bisnis diaktifkan untuk akun Anda di organisasi Google Workspace Anda. Anda akan mendapatkan `error 403 - PERMISSION DENIED` saat menggunakan API GBP jika Google Profil Bisnis dinonaktifkan untuk akun Anda di organisasi Google Workspace Anda.
Meminta client ID OAuth 2.0
Karena aplikasi Anda mengakses data non-publik yang dilindungi, Anda memerlukan client ID OAuth 2.0. ID ini memungkinkan aplikasi Anda meminta otorisasi untuk mengakses data lokasi organisasi Anda demi kepentingan pengguna aplikasi Anda.
Aplikasi Anda harus mengirimkan token OAuth 2.0 dengan permintaan API Profil Bisnis yang mengakses data pengguna pribadi.
Jika Anda belum melakukannya, buka bagian "Credentials" di Konsol API Google dan klik Create credentials > OAuth client ID untuk membuat kredensial OAuth 2.0 Anda. Setelah membuat kredensial, Anda dapat melihat client ID Anda pada halaman Credentials. Klik client ID untuk mendapatkan detail, seperti rahasia klien, URI pengalihan, alamat asal JavaScript, dan alamat email.
Mempelajari dasar-dasar REST
Ada dua cara untuk memanggil API:
- Mengirim permintaan HTTP dan mengurai respons.
- Menggunakan library klien.
Jika memutuskan tidak menggunakan library klien, Anda perlu memahami dasar-dasar REST.
REST adalah gaya arsitektur software yang memberikan pendekatan praktis dan konsisten untuk meminta serta mengubah data.
Istilah REST adalah singkatan dari "Representational State Transfer". Dalam konteks Google API, REST merujuk pada penggunaan kata kerja HTTP untuk mengambil dan mengubah representasi data yang disimpan oleh Google.
Sistem RESTful menyimpan resource di penyimpanan data. Klien mengirimkan permintaan agar server melakukan tindakan tertentu, seperti membuat, mengambil, memperbarui, atau menghapus resource, dan server akan melakukan tindakan serta mengirim respons. Respons tersebut sering berbentuk representasi resource yang ditentukan.
Di RESTful API Google, klien menentukan tindakan dengan kata kerja HTTP, seperti GET, POST, PUT, atau DELETE. Klien menentukan resource berdasarkan ID resource seragam (URI) yang unik secara global dengan format berikut:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
Karena semua resource API memiliki URI unik yang dapat diakses HTTP, REST memungkinkan caching data dan dioptimalkan untuk berfungsi dengan infrastruktur terdistribusi web.
Sebaiknya lihat
definisi metode dalam dokumentasi standar
HTTP 1.1. Dokumentasi ini mencantumkan spesifikasi untuk GET, POST, PUT, dan
DELETE.
REST di API Profil Bisnis
Operasi API Profil Bisnis dipetakan langsung ke kata kerja HTTP REST.
Format spesifik untuk API Profil Bisnis ditampilkan dalam URI berikut:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
Kumpulan lengkap URI yang digunakan untuk setiap operasi yang didukung di API muncul dalam dokumentasi Referensi API Profil Bisnis.
Jalur resource bervariasi berdasarkan endpoint.
Misalnya, jalur resource ke akun muncul seperti dalam contoh berikut:
accounts/accountId
Jalur resource untuk lokasi muncul dalam format berikut:
locations/locationId
Mempelajari dasar-dasar JSON
API Profil Bisnis menampilkan data dalam format JSON.
JavaScript Object Notation (JSON) adalah format data umum independen bahasa yang memberikan representasi teks sederhana untuk struktur data arbitrer. Untuk mendapatkan informasi lebih lanjut, lihat json.org.
Menggunakan Oauth Playground untuk membuat permintaan HTTP sederhana
Anda dapat menggunakan OAuth 2.0 Playground untuk bereksperimen dengan Business Profile API. Karena API Profil Bisnis bukan API publik, ada beberapa langkah tambahan yang perlu Anda lakukan agar dapat menggunakannya di Playground. Anda memerlukan client ID untuk aplikasi web agar dapat melanjutkan.
- Buka Konsol API Google dan buka project Anda. Jika Anda tidak memiliki client ID OAuth untuk aplikasi web, buat sekarang:
- Dari menu drop-down Create credentials, pilih OAuth client ID.
- Untuk Application type, klik Web Application.
Tambahkan hal berikut sebagai URI pengalihan yang valid:
https://developers.google.com/oauthplayground
- Klik Create.
- Salin client ID ke papan klip.
- Buka OAuth 2.0 Playground.
- Klik ikon roda gigi untuk membuka opsi konfigurasi dan membuat perubahan berikut:
- Tetapkan OAuth flow ke Client-side.
- Pilih Use your own OAuth credentials.
- Tempelkan client ID OAuth Anda.
- Tutup opsi konfigurasi.
Pada "Step 1 - Select & authorize APIs", tempelkan cakupan berikut untuk API Profil Bisnis ke kolom Input your own scopes:
https://www.googleapis.com/auth/business.manage
- Klik Authorize APIs.
- Klik Accept saat diminta.
-
Di bagian "Step 2 - Configure request to API", tempelkan URI berikut ke kolom Request URI:
https://mybusinessaccountmanagement.googleapis.com/v1/accounts
- Klik Send the request. Respons seharusnya menampilkan status
200 OK.
Untuk mendapatkan informasi lebih lanjut tentang cara membuat berbagai jenis permintaan, lihat Referensi API Profil Bisnis.
Library klien
Library klien API Profil Bisnis mendukung fungsi API Profil Bisnis. Library ini memberikan fungsi yang umumnya tersedia di semua Google API, seperti transpor HTTP, penanganan error, autentikasi, dan penguraian JSON.
Untuk mendownload library klien, lihat Library.