API Reference

Search Console API menawarkan layanan berikut:

  • Analisis Penelusuran - Mengkueri data traffic untuk situs Anda.
  • Peta situs - Cantumkan semua peta situs Anda, minta informasi tentang peta situs tertentu, dan kirimkan peta situs ke Google.
  • Sites - Mencantumkan/menambahkan/menghapus properti dari akun Search Console.
  • Inspeksi URL - Periksa status halaman di indeks Google (setara dengan Inspeksi URL di Search Console).

Analisis Penelusuran

Untuk mengetahui detail Referensi Analisis Penelusuran, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/webmasters/v3, kecuali dinyatakan lain
query POST  /sites/siteUrl/searchAnalytics/query

Mengkueri data traffic penelusuran dengan filter dan parameter yang Anda tetapkan. Metode ini menampilkan nol atau beberapa baris yang dikelompokkan menurut kunci baris (dimensi) yang Anda tentukan. Anda harus menentukan rentang tanggal untuk satu atau beberapa hari.

Jika tanggal adalah salah satu dimensi, hari tanpa data akan dihapus dari daftar hasil. Untuk mempelajari hari apa yang memiliki data, buat kueri tanpa filter yang dikelompokkan menurut tanggal, untuk rentang tanggal yang diinginkan.

Hasil diurutkan menurut jumlah klik secara menurun. Jika dua baris memiliki jumlah klik yang sama, baris tersebut akan diurutkan dengan cara acak.

Lihat contoh python untuk memanggil metode ini.

Contoh POST JSON: 
POST https://www.googleapis.com/webmasters/v3/sites/https%3A%2F%2Fwww.example.com%2F/searchAnalytics/query
{
  "startDate": "2015-04-01",
  "endDate": "2015-05-01",
  "dimensions": ["country","device"]
}

Peta situs

Untuk mengetahui detail Resource Peta Situs, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/webmasters/v3, kecuali dinyatakan lain
hapus DELETE  /sites/siteUrl/sitemaps/feedpath Menghapus peta situs dari situs ini.
dapatkan GET  /sites/siteUrl/sitemaps/feedpath Mengambil informasi tentang peta situs tertentu.
list GET  /sites/siteUrl/sitemaps Mencantumkan entri peta situs yang dikirim untuk situs ini, atau disertakan dalam file indeks peta situs (jika sitemapIndex ditentukan dalam permintaan).
kirim PUT  /sites/siteUrl/sitemaps/feedpath Mengirim peta situs untuk situs.

Situs

Untuk mengetahui detail Resource Sites, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/webmasters/v3, kecuali dinyatakan lain
tambahkan PUT  /sites/siteUrl Menambahkan situs ke kumpulan situs pengguna di Search Console.
hapus DELETE  /sites/siteUrl Menghapus situs dari kumpulan situs Search Console pengguna.
dapatkan GET  /sites/siteUrl Mengambil informasi tentang situs tertentu.
list GET  /sites Menampilkan daftar situs Search Console pengguna.

Inspeksi URL

Untuk mengetahui detail resource Inspeksi URL, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://searchconsole.googleapis.com/v1
index.inspect POST /urlInspection/index:inspect

Informasi tentang URL yang diberikan dalam indeks Google.

Contoh POST JSON: 
POST https://searchconsole.googleapis.com/v1/urlInspection/index:inspect
{
  "inspectionUrl": "https://www.example.com/mypage",
  "siteUrl": "https://www.example.com/",
  "languageCode": "en-US"}