Untuk melanjutkan, pastikan Anda telah menyelesaikan langkah-langkah yang Prasyarat dan bahwa kami telah menyetujui project Anda untuk Profil Bisnis akses API.
Mengaktifkan API
Ada delapan API yang terkait dengan Profil Bisnis yang harus diaktifkan di Google API Konsol:
- Google My Business API
- My Business Account Management API
- My Business Lodging API
- API My Business Place Actions
- My Business Notifications API
- My Business Verifications API
- My Business Business Information API
- My Business Q&A API
Mengaktifkan API
Jika Anda telah menyelesaikan semua Prasyarat dan telah diberikan akses ke API, tetapi masih tidak dapat untuk 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 atau membuat yang baru. Library API mencantumkan semua daftar yang tersedia API, 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 tombol.
- 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. Hal ini memungkinkan aplikasi Anda meminta otorisasi untuk mengakses data lokasi organisasi Anda atas nama pengguna aplikasi Anda.
Permohonan Anda harus mengirimkan token OAuth 2.0 dengan permintaan API Profil Bisnis yang mengakses data pribadi pengguna.
Jika Anda belum melakukannya, buka "Credentials" bagian dari Konsol API Google dan klik Buat kredensial > Client ID OAuth untuk membuat kredensial OAuth 2.0 Anda. Setelah Anda membuat kredensial, Anda dapat melihat client ID di halaman Credentials. Klik client ID untuk mengetahui detail, seperti rahasia klien, URI pengalihan, alamat asal JavaScript, dan email alamat IPv6
Mempelajari dasar-dasar REST
Ada dua cara untuk memanggil API:
- Mengirim permintaan HTTP dan mengurai respons.
- Menggunakan library klien.
Jika memutuskan untuk tidak menggunakan library klien, Anda perlu memahami dasar-dasar REST.
REST adalah gaya arsitektur software yang memberikan pendekatan praktis dan konsisten untuk meminta dan mengubah data.
Istilah REST adalah singkatan dari "Transfer Status Perwakilan". Dalam konteks Google API, ini merujuk hingga penggunaan kata kerja HTTP untuk mengambil dan memodifikasi representasi data yang disimpan oleh Google.
Sistem RESTful menyimpan resource di penyimpanan data. Klien mengirimkan permintaan untuk server untuk melakukan tindakan tertentu, seperti membuat, mengambil, memperbarui, atau menghapus sumber daya, dan server melakukan tindakan dan mengirimkan respons. Respons itu sering berbentuk yang mewakili resource yang ditentukan.
Di RESTful API Google, klien menentukan tindakan dengan kata kerja HTTP, seperti
GET, POST, PUT, atau DELETE. Klien menentukan
resource dengan uniform resource ID (URI) yang unik secara global dengan bentuk berikut:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
Karena semua sumber daya API memiliki URI unik yang dapat diakses HTTP, REST memungkinkan caching data dan dioptimalkan untuk bekerja dengan infrastruktur web terdistribusi.
Anda mungkin menemukan
definisi metode dalam dokumentasi standar HTTP 1.1
berguna Iklan tersebut 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 akan muncul di API Profil Bisnis Referensi.
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 menyediakan representasi teks sederhana dari struktur data arbitrer. Untuk informasi selengkapnya, lihat json.org.
Menggunakan Oauth Playground untuk membuat permintaan HTTP sederhana
Anda dapat menggunakan OAuth 2.0 Playground untuk bereksperimen dengan API Profil Bisnis. Karena API Profil Bisnis bukan API publik, ada beberapa langkah tambahan yang perlu Anda lakukan untuk menggunakannya di Playground. Anda membutuhkan ID klien agar aplikasi web dapat melanjutkan.
- Buka Konsol API Google dan membuka project Anda. Jika Anda tidak memiliki client ID OAuth untuk aplikasi web, buat client ID 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 Buat.
- Salin client ID ke papan klip.
- Buka OAuth 2.0 Playground.
- Klik ikon roda gigi untuk membuka opsi konfigurasi dan melakukan perubahan berikut:
- Tetapkan Alur OAuth ke Sisi klien.
- Pilih Use your own OAuth credentials.
- Tempel client ID OAuth Anda.
- Tutup opsi konfigurasi.
Di bagian "Langkah 1 - Pilih & mengizinkan API," tempelkan cakupan berikut ke API Profil Bisnis ke dalam kolom Masukkan cakupan Anda:
https://www.googleapis.com/auth/business.manage
- Klik Authorize APIs.
- Klik Accept saat diminta.
-
Di bagian "Langkah 2 - Konfigurasi permintaan ke API", tempelkan URI berikut ke Kolom URI Permintaan:
https://mybusinessaccountmanagement.googleapis.com/v1/accounts
- Klik Send the request. Respons akan menunjukkan status
200 OK.
Untuk informasi selengkapnya tentang cara membuat berbagai jenis permintaan, lihat Referensi API Profil Bisnis.
Library klien
Library klien API Profil Bisnis mendukung fungsi API Profil Bisnis. Keduanya menyediakan fungsi yang umumnya terdapat di semua Google API, seperti transport HTTP, penanganan error, autentikasi, dan penguraian JSON.
Untuk mendownload library klien, lihat Library.