API Reference

Search Console API menawarkan layanan berikut:

  • Analytics Penelusuran - Membuat kueri data traffic untuk situs Anda.
  • Peta situs - Buat daftar semua peta situs Anda, minta informasi tentang peta situs tertentu, dan kirim peta situs ke Google.
  • Sites - Mencantumkan/menambahkan/menghapus properti dari akun Search Console Anda.
  • Inspeksi URL - Memeriksa status halaman di indeks Google (setara dengan Inspeksi URL di Search Console).

Analisis Penelusuran

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

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

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

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

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

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 dikirimkan untuk situs ini, atau disertakan dalam file indeks peta situs (jika sitemapIndex ditentukan dalam permintaan).
kirim PUT  /sites/siteUrl/sitemaps/feedpath Mengirimkan peta situs untuk situs.

Sites

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 Mencantumkan situs Search Console pengguna.

Inspeksi URL

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

Metode Permintaan HTTP Deskripsi
URI relatif terhadap https://searchconsole.googleapis.com/v1
index.inspect POST /urlInspection/index:inspect

Informasi tentang URL yang diberikan di 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"}