Menjalankan contoh kode

Google APIs Explorer menghasilkan contoh kode secara dinamis. Contoh kode ini dirancang untuk disalin dan dijalankan secara lokal. Untuk melihat contoh, klik Layar penuh di panel samping API Explorer. Gambar di bawah menunjukkan API Explorer layar penuh yang diperluas:

Panel layar penuh APIs Explorer untuk Google Books API
Gambar 2: Panel layar penuh APIs Explorer untuk Google Books API.

Secara default, Penjelajah API menampilkan cara menggunakan cURL untuk menjalankan permintaan Anda. Beberapa API mungkin juga menampilkan contoh untuk bahasa lain, seperti JavaScript, Java, dan Python.

Menjalankan contoh kode secara lokal

Tab berikut menjelaskan prasyarat dan langkah-langkah untuk menjalankan contoh kode. Untuk menjalankan contoh kode, Anda harus membuat dan menggunakan kredensial otorisasi Anda sendiri. Untuk penjelasan tentang cara membuat project dan membuat kredensial, lihat dokumentasi Google API tertentu.

Kredensial adalah salah satu dari hal berikut, bergantung pada jenis data (publik atau pribadi) yang diakses metode:

  • Untuk data publik, kredensialnya adalah kunci API.

  • Untuk data pribadi, kredensialnya adalah file client_secret.json yang berisi client ID dan rahasia klien OAuth 2.0 atau token akses OAuth 2.0.

cURL

Penyiapan

  1. Ikuti petunjuk dalam dokumentasi API untuk membuat atau memilih project untuk aplikasi Anda dan mengaktifkan API.
  2. Di konsol cloud, buat kunci API.
  3. Di konsol cloud, buat kredensial client ID OAuth untuk aplikasi Web dan gunakan https://developers.google.com/oauthplayground sebagai URI pengalihan.
  4. Di OAuth 2.0 Playground, klik OAuth 2.0 Configuration .
  5. Centang Gunakan kredensial Anda sendiri.
  6. Masukkan client ID dan rahasia klien yang dibuat pada langkah 3.
  7. Di kolom cakupan, ketik cakupan yang akan digunakan dengan metode Anda, lalu klik Authorize APIs.
  8. (opsional) Jika layar Login ditampilkan, pilih akun yang akan digunakan.
  9. (opsional) Jika muncul layar otorisasi, klik Terima.
  10. Klik Exchange authorization code for tokens. Token akan ditampilkan.
  11. Dalam contoh kode cURL, ganti [YOUR_API_KEY] dengan kunci API yang dihasilkan di langkah 2: 'https://www.googleapis.com/drive/v3/files?key=[YOUR_API_KEY]' \
  12. Dalam contoh kode cURL, ganti [YOUR_ACCESS_TOKEN] dengan token akses yang dibuat di langkah 10: --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \

Menjalankan contoh kode

Dari command line, jalankan perintah cURL. Perintahnya akan mirip dengan ini:

curl \
'https://www.googleapis.com/drive/v3/files?key=AIzaSyBiKcaoXmVApwnT24hitQG_dwjGvAj6Ddw' \
--header 'Authorization: Bearer ya29.a0ARrdaM_yQn9MWBpJgKPx880BSnRYIizRYIDz0JN9e66nSliIYpqNXmPsvv2ccfplCTG_U4b1' \
--header 'Accept: application/json' \
--compressed

JavaScript

Penyiapan

  1. Ikuti petunjuk dalam dokumentasi API untuk membuat atau memilih project untuk aplikasi Anda dan mengaktifkan API.
  2. Di konsol cloud, buat kunci API.
  3. Di konsol cloud, buat kredensial client ID OAuth untuk "Aplikasi web" dan tetapkan origin JavaScript resmi untuk mengidentifikasi URL tempat Anda akan mengirim permintaan, seperti http://localhost.
  4. Salin contoh kode lengkap ke file lokal yang dapat diakses oleh server web Anda, seperti /var/www/html/example.html.

  5. Temukan baris dalam contoh kode yang menetapkan kunci API atau client ID, lalu ganti nilainya dengan nilai yang dihasilkan di langkah 2 dan 3:

    • Kunci API: gapi.client.setApiKey(YOUR_API_KEY);
    • Client ID OAuth 2.0: gapi.client.init({ 'clientId': 'YOUR_CLIENT_ID',

Menjalankan contoh kode

  1. Buka file di browser Anda, seperti http://localhost/example.html. Sebaiknya gunakan browser dengan konsol proses debug, seperti Google Chrome.
  2. (opsional) Jika layar Login ditampilkan, pilih akun yang akan digunakan.
  3. (opsional) Jika muncul layar otorisasi, klik Terima. Konsol debugging akan menampilkan respons metode sebagai objek JSON.

Java

Prasyarat

  • Java 1.7 atau yang lebih baru.
  • Gradle 7 atau yang lebih baru.

Penyiapan

  1. Ikuti petunjuk dalam dokumentasi API untuk membuat atau memilih project untuk aplikasi Anda dan mengaktifkan API.
  2. Bergantung pada jenis data yang diakses metode, buat kunci API (data publik) atau buat client ID OAuth 2.0 (data pribadi).
  3. Tetapkan jenis aplikasi ke Desktop app.
  4. Jika Anda membuat client ID OAuth 2.0, download file JSON yang berisi kredensial OAuth 2.0 Anda. File ini diberi nama yang mirip dengan client_secret_CLIENTID.json, dengan CLIENTID adalah client ID untuk project Anda.

  5. Di direktori kerja Anda, jalankan perintah berikut untuk membuat struktur project baru:

    $ gradle init --type basic
$ mkdir -p src/main/java src/main/resources

  6. Jika Anda membuat client ID OAuth 2.0 di langkah 2, ganti nama file JSON yang Anda download menjadi client_secret.json.

  7. Simpan file yang diganti namanya di direktori src/main/resources yang Anda buat di langkah 5.

  8. Di direktori kerja Anda, buka file build.gradle dan ganti kontennya dengan yang berikut ini:

    apply plugin: 'java'
apply plugin: 'application'

mainClassName = 'ApiExample'
sourceCompatibility = 1.7
targetCompatibility = 1.7
version = '1.0'

repositories {
    mavenCentral()
}

dependencies {
    compile 'com.google.api-client:google-api-client:1.23.0'
    compile 'com.google.oauth-client:google-oauth-client-jetty:1.23.0'
    API_SPECIFIC_DEPENDENCY
}

  9. Di file build.gradle, ganti baris yang bertuliskan API_SPECIFIC_DEPENDENCY dengan petunjuk untuk mengompilasi kode untuk API yang Anda panggil. Berikut adalah contoh untuk YouTube Analytics API:

    compile 'com.google.apis:google-api-services-youtubeAnalytics:v2-rev16-1.23.0'

    Petunjuknya mengikuti template ini:

    compile 'com.google.apis:google-api-services-API_NAME:API_VERSION-   revREVISION-CL_VERSION'

Dengan keterangan:

  • API_NAME adalah nama API yang tercantum di GitHub untuk API tersebut. Untuk menemukan namanya, klik link versi di samping API Anda di halaman Google API yang Didukung. Link versi akan membuka GitHub. Nama API berada di bagian tengah atas halaman dan didahului dengan googleapis/google-apis-services-. Misalnya, untuk Drive API v3, API_NAME adalah drive.
  • API_VERSION adalah versi API yang tercantum untuk API di bawah nama API di halaman API Google yang Didukung.
  • REVISION adalah nomor revisi yang tercantum dalam referensi JavaDoc untuk API. Referensi JavaDoc dapat ditemukan di https://googleapis.dev/java/google-api-services-API_NAME/latest/index.html
  • CL_VERSION adalah versi library klien. Nilai ini juga muncul dalam referensi JavaDoc.
  • Dari direktori kerja, salin contoh kode dari API Explorer ke src/main/java/ApiExample.java. (Nama class di setiap contoh adalah ApiExample sehingga Anda tidak perlu mengubah file build.gradle untuk menjalankan contoh yang berbeda.

Menjalankan contoh kode

Gunakan perintah berikut untuk menjalankan contoh:

  gradle -q run

Contoh ini akan menjalankan permintaan API Anda dan mencetak respons ke STDOUT. Anda juga dapat memeriksa layanan yang Anda panggil untuk melihat efek permintaan yang menulis data.

Node.js

Prasyarat

  • Node.js

  • Library Klien Google API untuk Node.js:

    • Jika Anda belum menginstal library klien sebelumnya, jalankan perintah:
    npm install googleapis --save
    • Jika sebelumnya Anda menginstal library klien, sebaiknya update library tersebut untuk memastikan Anda memiliki class terbaru untuk library yang diuji. Untuk mengupdate library klien, jalankan perintah:
    npm update googleapis --save

Penyiapan

  1. Ikuti petunjuk dalam dokumentasi API untuk membuat atau memilih project untuk aplikasi Anda dan mengaktifkan API.
  2. Bergantung pada jenis data yang diakses metode, buat kunci API (data publik) atau buat client ID OAuth 2.0 (data pribadi).
  3. Tetapkan jenis aplikasi ke Desktop app.
  4. Jika Anda membuat client ID OAuth 2.0, download file JSON yang berisi kredensial OAuth 2.0 Anda. File ini diberi nama yang mirip dengan client_secret_CLIENTID.json, dengan CLIENTID adalah client ID untuk project Anda.
  5. Salin contoh kode ke file lokal dan ubah contoh untuk mengidentifikasi kunci API atau file secret klien Anda dengan benar. Dalam contoh, nilai kunci API adalah YOUR_API_KEY, dan lokasi file secret klien adalah YOUR_CLIENT_SECRET_FILE.json.

Menjalankan contoh kode

Gunakan perintah berikut untuk menjalankan contoh:

  node sample.js

Sebagian besar sampel mencetak respons API (atau hal lain) ke STDOUT.

PHP

Prasyarat

  • PHP 5.4 atau yang lebih baru dengan antarmuka command line (CLI) dan ekstensi JSON.
  • Alat pengelolaan dependensi Composer diinstal secara global.

  • Library Klien Google API untuk PHP:

    • Jika Anda belum menginstal library klien sebelumnya, jalankan perintah:

      composer require google/apiclient:^2.0

    • Jika sebelumnya Anda menginstal library klien, sebaiknya update library tersebut untuk memastikan Anda memiliki class terbaru untuk library yang sedang diuji. Untuk mengupdate library klien, jalankan perintah:

      composer update google/apiclient --with-dependencies

Menjalankan contoh kode

Gunakan perintah berikut untuk menjalankan contoh:

  php sample.php

Sebagian besar sampel mencetak respons API (atau hal lain) ke STDOUT.

Python

Prasyarat

  • Python 2.7 atau Python 3.5+
  • Alat pengelolaan paket pip

  • Library Klien Google API untuk Python:

    pip install --upgrade google-api-python-client

  • Library google-auth-oauthlib dan google-auth-httplib2 untuk otorisasi pengguna:

    pip install --upgrade google-auth-oauthlib google-auth-httplib2

Penyiapan

  1. Ikuti petunjuk dalam dokumentasi API untuk membuat atau memilih project untuk aplikasi Anda dan mengaktifkan API.
  2. Bergantung pada jenis data yang diakses metode, buat kunci API (data publik) atau buat client ID OAuth 2.0 (data pribadi).
  3. Tetapkan jenis aplikasi ke Desktop app.
  4. Jika Anda membuat client ID OAuth 2.0, download file JSON yang berisi kredensial OAuth 2.0 Anda. File ini diberi nama yang mirip dengan client_secret_CLIENTID.json, dengan CLIENTID adalah client ID untuk project Anda.
  5. Salin contoh kode ke file lokal dan ubah contoh untuk mengidentifikasi kunci API atau file secret klien Anda dengan benar. Dalam contoh, nilai kunci API adalah YOUR_API_KEY, dan lokasi file secret klien adalah YOUR_CLIENT_SECRET_FILE.json.

Menjalankan contoh kode

Gunakan perintah berikut untuk menjalankan contoh:

  python sample.py

Sebagian besar sampel mencetak respons API (atau hal lain) ke STDOUT.

Ruby

Prasyarat

  • Ruby 2.0 atau yang lebih baru

  • Library Klien Google API untuk Ruby:

    gem install google-api-client`

Penyiapan

  1. Ikuti petunjuk dalam dokumentasi API untuk membuat atau memilih project untuk aplikasi Anda dan mengaktifkan API.
  2. Bergantung pada jenis data yang diakses metode, buat kunci API (data publik) atau buat client ID OAuth 2.0 (data pribadi).
  3. Tetapkan jenis aplikasi ke Desktop app.
  4. Jika Anda membuat client ID OAuth 2.0, download file JSON yang berisi kredensial OAuth 2.0 Anda. File ini diberi nama yang mirip dengan client_secret_CLIENTID.json, dengan CLIENTID adalah client ID untuk project Anda.
  5. Salin contoh kode ke file lokal dan ubah contoh untuk mengidentifikasi kunci API atau file secret klien Anda dengan benar. Dalam contoh, nilai kunci API adalah YOUR_API_KEY, dan lokasi file secret klien adalah YOUR_CLIENT_SECRET_FILE.json.

Menjalankan contoh kode

Gunakan perintah berikut untuk menjalankan contoh:

  ruby sample.rb

Sebagian besar sampel mencetak respons API (atau hal lain) ke STDOUT.

Memecahkan masalah sampel

Dialog otorisasi tidak muncul

Penjelajah API menggunakan pop-up untuk memberikan akses ke data pribadi Anda. Jika browser Anda memblokir pop-up, pop-up ini tidak akan muncul dan Anda tidak akan dapat memberikan akses.

Jika Anda mengklik "Izinkan" di layar otorisasi dan tidak ada yang terjadi, coba ubah setelan pop-up browser untuk mengaktifkan pop-up.

Menerima error 401 atau 403

Jika Anda mendapatkan error 401 atau 403 saat menguji sampel, hal ini mungkin disebabkan oleh masalah pada salah satu hal berikut:

  • API tidak diaktifkan untuk project Anda. Tinjau petunjuk untuk API Anda tentang cara membuat project dan mengaktifkan API.
  • Anda menggunakan jenis otorisasi yang salah (kunci API, bukan OAuth 2.0).
  • Anda menggunakan OAuth 2.0, tetapi dengan cakupan yang terlalu sempit.
  • Saat menyiapkan kunci API, Anda menyiapkan pembatasan untuk mencegah penggunaan kredensial tanpa izin. Namun, permintaan tersebut tidak memenuhi batasan tersebut. Untuk informasi lebih lanjut, lihat Menggunakan pembatasan kunci API.

Menerima peringatan tentang konten campuran

Jika Anda menggunakan Google Cloud Endpoints dan menjalankan endpoint di server pengembangan, browser Anda mungkin memberikan peringatan tentang konten campuran. Peringatan ini terjadi karena API Explorer dimuat melalui HTTPS, tetapi saat API Anda berjalan secara lokal, API tersebut dihosting di HTTP.

Untuk menyembunyikan peringatan ini menggunakan Chrome, mulai sesi Chrome dengan tanda khusus sebagai berikut:

path/to/chrome --user-data-dir=test --unsafely-treat-insecure-origin-as-secure=http://localhost:port

Contoh:

/usr/bin/google-chrome-stable --user-data-dir=test --unsafely-treat-insecure-origin-as-secure=http://localhost:8080

Anda hanya boleh menyembunyikan peringatan ini untuk tujuan pengujian lokal.

Khusus JavaScript: gapi tidak ditentukan

Error "gapi is not defined" terjadi saat kode JavaScript mencoba memanggil Library Klien Google API untuk JavaScript sebelum library dimuat. Pastikan kode Anda yang mereferensikan variabel gapi tidak dipanggil hingga setelah library klien dimuat.