Menjalankan contoh kode

Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

Google API Explorer secara dinamis membuat contoh kode. Contoh kode ini dirancang untuk disalin dan dijalankan secara lokal. Untuk melihat contoh, klik Layar penuh di panel samping Explorer API. Gambar di bawah menunjukkan Penjelajah API 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, APIs Explorer menunjukkan 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 mendapatkan penjelasan tentang cara membuat project dan membuat kredensial, baca dokumentasi Google API khusus Anda.

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

  • Untuk data publik, kredensial adalah kunci API.
  • Untuk data pribadi, kredensial ini adalah file client_secret.json yang berisi client ID OAuth 2.0 dan rahasia klien Anda atau token akses OAuth 2.0.

cURL

Menyiapkan

  1. Ikuti petunjuk dalam dokumentasi API untuk membuat atau memilih project untuk aplikasi Anda dan mengaktifkan API.
  2. Di cloud console, buat kunci API.
  3. Di cloud console, 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 Konfigurasi OAuth 2.0 .
  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 ditampilkan dengan layar Login, pilih akun yang akan digunakan.
  9. (opsional) Jika ditampilkan dengan layar otorisasi, klik Terima.
  10. Klik Kode otorisasi Exchange untuk token. Token ditampilkan.
  11. Pada contoh kode cURL, ganti [YOUR_API_KEY] dengan kunci API yang dihasilkan pada langkah 2: 'https://www.googleapis.com/drive/v3/files?key=[YOUR_API_KEY]' \
  12. Pada contoh kode cURL, ganti [YOUR_ACCESS_TOKEN] dengan token akses yang dihasilkan pada langkah 10: --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \

Menjalankan contoh kode

Dari command line, jalankan perintah cURL. Perintahnya harus serupa 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

Menyiapkan

  1. Ikuti petunjuk dalam dokumentasi API untuk membuat atau memilih project untuk aplikasi Anda dan mengaktifkan API.
  2. Di cloud console, buat kunci API.
  3. Di konsol cloud, buat kredensial client ID OAuth untuk "Aplikasi web" dan tetapkan asal JavaScript yang diizinkan untuk mengidentifikasi URL dari mana Anda akan mengirimkan 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 dan ganti nilai dengan nilai yang dihasilkan pada 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, misalnya http://localhost/example.html. Sebaiknya gunakan browser dengan konsol debug, seperti Google Chrome.
  2. (opsional) Jika ditampilkan dengan layar Login, pilih akun yang akan digunakan.
  3. (opsional) Jika ditampilkan dengan layar otorisasi, klik Terima. Konsol debug harus menampilkan respons metode sebagai objek JSON.

Java

Prasyarat

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

Menyiapkan

  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. Setel jenis aplikasi ke aplikasi Desktop.
  4. Jika Anda membuat client ID OAuth 2.0, download file JSON yang berisi kredensial OAuth 2.0. Nama file ini mirip dengan client_secret_CLIENTID.json, dengan CLIENTID adalah client ID untuk project Anda.
  5. Dalam 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 didownload ke client_secret.json.

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

  8. Di direktori kerja, buka file build.gradle dan ganti isinya dengan kode berikut:

    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 contoh untuk YouTube Analytics API:

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

    Petunjuk mengikuti template ini:

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

Dalam hal ini:

  • API_NAME adalah nama API yang tercantum di GitHub untuk API. Untuk menemukan nama, klik link versi di samping API Anda pada halaman API Google yang Didukung. Link versi akan membuka GitHub. Nama API berada di bagian tengah atas halaman dan didahului oleh 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 Google API 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 Anda, salin contoh kode dari APIs Explorer ke src/main/java/ApiExample.java. (Nama class dalam setiap contoh adalah ApiExample sehingga Anda tidak perlu mengubah file build.gradle untuk menjalankan sampel yang berbeda.

Menjalankan contoh kode

Gunakan perintah berikut untuk menjalankan contoh:

  gradle -q run

Sampel akan menjalankan permintaan API 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 pernah menginstal library klien, jalankan perintah:
    npm install googleapis --save
    
    • Jika sebelumnya Anda telah menginstal library klien, sebaiknya update untuk memastikan bahwa Anda memiliki class terbaru untuk library yang diuji. Untuk mengupdate library klien, jalankan perintah:
    npm update googleapis --save
    

Menyiapkan

  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. Setel jenis aplikasi ke aplikasi Desktop.
  4. Jika Anda membuat client ID OAuth 2.0, download file JSON yang berisi kredensial OAuth 2.0. Nama file ini mirip dengan client_secret_CLIENTID.json, dengan CLIENTID adalah client ID untuk project Anda.
  5. Salin contoh kode ke file lokal dan ubah sampel untuk mengidentifikasi kunci API atau rahasia klien dengan benar. Dalam contoh, nilai kunci API adalah YOUR_API_KEY, dan lokasi file rahasia 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 yang lainnya) ke STDOUT.

PHP

Prasyarat

  • PHP 5.4 atau yang lebih baru dengan antarmuka command line (CLI) dan ekstensi JSON.
  • Alat pengelolaan dependensi Compose yang diinstal secara global.
  • Library Klien Google API untuk PHP:

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

      composer require google/apiclient:^2.0
      
    • Jika sebelumnya Anda telah menginstal library klien, sebaiknya update library tersebut untuk memastikan bahwa 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 yang lainnya) 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
    

Menyiapkan

  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. Setel jenis aplikasi ke aplikasi Desktop.
  4. Jika Anda membuat client ID OAuth 2.0, download file JSON yang berisi kredensial OAuth 2.0. Nama file ini mirip dengan client_secret_CLIENTID.json, dengan CLIENTID adalah client ID untuk project Anda.
  5. Salin contoh kode ke file lokal dan ubah sampel untuk mengidentifikasi kunci API atau rahasia klien dengan benar. Dalam contoh, nilai kunci API adalah YOUR_API_KEY, dan lokasi file rahasia 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 yang lainnya) ke STDOUT.

Ruby

Prasyarat

  • Ruby 2.0 atau yang lebih tinggi
  • Library Klien Google API untuk Ruby:

    gem install google-api-client`
    

Menyiapkan

  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. Setel jenis aplikasi ke aplikasi Desktop.
  4. Jika Anda membuat client ID OAuth 2.0, download file JSON yang berisi kredensial OAuth 2.0. Nama file ini mirip dengan client_secret_CLIENTID.json, dengan CLIENTID adalah client ID untuk project Anda.
  5. Salin contoh kode ke file lokal dan ubah sampel untuk mengidentifikasi kunci API atau rahasia klien dengan benar. Dalam contoh, nilai kunci API adalah YOUR_API_KEY, dan lokasi file rahasia 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 yang lainnya) ke STDOUT.

Memecahkan masalah sampel

Dialog otorisasi tidak muncul

APIs Explorer 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 Anda untuk mengaktifkan pop-up.

Menerima error 401 atau 403

Jika Anda mengalami error 401 atau 403 saat menguji sampel, kemungkinan hal tersebut terjadi karena masalah pada salah satu hal berikut:

  • API tidak diaktifkan untuk project Anda. Meninjau petunjuk API Anda tentang cara membuat project dan mengaktifkan API.
  • Anda menggunakan jenis otorisasi yang salah (kunci API dan 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, baca 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

"gapi tidak ditentukan" error terjadi saat kode JavaScript mencoba memanggil Library Klien Google API untuk JavaScript sebelum library dimuat. Pastikan kode Anda yang mereferensikan variabel gapi tidak dipanggil sampai library klien dimuat.