Dokumen ini menjelaskan hal-hal yang harus Anda lakukan sebelum menulis aplikasi klien pertama Anda.
Membuat Akun Google
Anda memerlukan Akun Google untuk menggunakan API ini. Akun Anda harus memiliki izin Search Console yang sesuai di properti tertentu agar dapat memanggil metode tersebut di properti tersebut. Misalnya, untuk menjalankan searchAnalytics.query, Anda memerlukan izin baca pada properti tersebut.
Coba Google Search Console
Dokumentasi API ini mengasumsikan bahwa Anda telah menggunakan Google Search Console dan memahami konsep pemrograman web dan format data web.
Jika Anda belum pernah menggunakan Google Search Console, coba antarmuka pengguna sebelum memulai coding. Setiap API mewakili fungsi laporan di Search Console. Anda harus membaca dokumentasi untuk laporan yang setara sebelum menggunakan API agar dapat memahami data yang Anda terima.
Buat project dan kredensial untuk klien Anda
Sebelum dapat mengirim permintaan ke Google Search Console, Anda harus memberi tahu Google tentang klien Anda dan mengaktifkan akses ke API. Anda dapat melakukannya menggunakan Konsol API Google untuk membuat project, yang merupakan kumpulan bernama untuk setelan dan informasi akses API, lalu mendaftarkan aplikasi Anda.
Semua Search Console API kecuali Testing Tools API memerlukan kredensial OAuth2. Panduan memulai Python dan Java memberikan detail tentang cara membuat project dan mendapatkan kredensial untuk klien Anda.
Memahami 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 harus memahami dasar-dasar REST.
Dasar-dasar REST
REST adalah gaya arsitektur software yang memberikan pendekatan yang praktis dan konsisten untuk meminta dan memodifikasi data.
Istilah REST adalah singkatan dari "Representational State Transfer". Dalam konteks Google API, hal ini mengacu pada penggunaan kata kerja HTTP untuk mengambil dan mengubah representasi data yang disimpan oleh Google.
Dalam sistem RESTful, resource disimpan di penyimpanan data; klien mengirim permintaan agar server melakukan tindakan tertentu (seperti membuat, mengambil, memperbarui, atau menghapus resource), dan server melakukan tindakan dan mengirim respons, sering kali dalam bentuk representasi resource yang ditentukan.
Di RESTful API Google, klien menentukan tindakan menggunakan kata kerja HTTP seperti POST, GET, PUT, atau DELETE. Ini menetapkan resource melalui URI yang unik secara global dengan bentuk berikut:
https://www.googleapis.com/apiName/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.
Anda dapat memperoleh manfaat dari definisi metode dalam dokumentasi standar HTTP 1.1; dokumentasi tersebut menyertakan spesifikasi untuk GET, POST, PUT, dan DELETE.
REST di Google Search Console API
Operasi API Google Search Console dipetakan langsung ke kata kerja HTTP REST.
Format untuk sebagian besar URI Google Search Console API adalah seperti ini:
VERB https://www.googleapis.com/webmasters/v3/resourcePath?parameters
Kumpulan lengkap URI dan kata kerja yang digunakan untuk setiap metode diberikan dalam ringkasan Referensi Google Search Console API.
Memahami dasar-dasar JSON
Google Search Console API menampilkan data dalam format JSON.
JSON (JavaScript Object Notation) adalah format data umum independen bahasa yang memberikan representasi teks sederhana untuk struktur data arbitrer. Untuk informasi selengkapnya, lihat json.org.