Search Analytics: query

Memerlukan otorisasi

Kueri data traffic penelusuran dengan filter dan parameter yang Anda tentukan. Metode tersebut menampilkan nol atau beberapa baris yang dikelompokkan berdasarkan 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 dihilangkan dari daftar hasil. Untuk mengetahui hari yang memiliki data, buat kueri tanpa filter yang dikelompokkan menurut tanggal, untuk rentang tanggal yang diinginkan.

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

Lihat contoh Python untuk memanggil metode ini.

API ini dibatasi oleh batasan internal Search Console dan tidak menjamin untuk menampilkan semua baris data, melainkan yang teratas.

Lihat batas jumlah data yang tersedia.

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

Permintaan

Permintaan HTTP

POST https://www.googleapis.com/webmasters/v3/sites/siteUrl/searchAnalytics/query

Parameter

Nama parameter Nilai Deskripsi
Parameter jalur
siteUrl string URL properti seperti yang ditentukan di Search Console. Contoh: http://www.example.com/ (untuk properti awalan URL) atau sc-domain:example.com (untuk Properti domain)

Otorisasi

Permintaan ini memerlukan otorisasi dengan setidaknya salah satu cakupan berikut (baca selengkapnya tentang autentikasi dan otorisasi).

Cakupan
https://www.googleapis.com/auth/webmasters.readonly
https://www.googleapis.com/auth/webmasters

Isi permintaan

Dalam isi permintaan, berikan data dengan struktur berikut:

{
  "startDate": string,
  "endDate": string,
  "dimensions": [
    string
  ],
  "type": string,
  "dimensionFilterGroups": [
    {
      "groupType": string,
      "filters": [
        {
          "dimension": string,
          "operator": string,
          "expression": string
        }
      ]
    }
  ],
  "aggregationType": string,
  "rowLimit": integer,
  "startRow": integer
}
Nama properti Nilai Deskripsi Catatan
startDate string [Wajib] Tanggal mulai dari rentang tanggal yang diminta, dalam format YYYY-MM-DD, dalam waktu PT (UTC - 7:00/8:00). Harus lebih kecil dari atau sama dengan tanggal akhir. Nilai ini disertakan dalam rentang.
endDate string [Wajib] Tanggal akhir rentang tanggal yang diminta, dalam format YYYY-MM-DD, dalam waktu PT (UTC - 7:00/8:00). Harus lebih besar dari atau sama dengan tanggal mulai. Nilai ini disertakan dalam rentang.
dimensions[] list [Opsional] Nol atau beberapa dimensi untuk mengelompokkan hasil.Hasil dikelompokkan sesuai urutan Anda memberikan dimensi tersebut.Anda dapat menggunakan nama dimensi apa pun di dimensionFilterGroups[].filters[].dimension serta "tanggal".Nilai dimensi pengelompokan digabungkan untuk membuat kunci unik untuk setiap baris hasil. Jika tidak ada dimensi yang ditentukan, semua nilai akan digabungkan ke dalam satu baris. Tidak ada batasan jumlah dimensi yang dapat dikelompokkan, tetapi Anda tidak dapat mengelompokkan menurut dimensi yang sama dua kali. Contoh: [negara, perangkat]
searchType string Tidak digunakan lagi, gunakan type sebagai gantinya
type string [Opsional] Filter hasil ke jenis berikut:
  • "discover": Hasil Discover
  • "googleNews": Hasil dari news.google.com dan aplikasi Google Berita di Android dan iOS. Tidak menyertakan hasil dari tab "Berita" di Google Penelusuran.
  • "news": Hasil penelusuran dari tab "Berita" di Google Penelusuran.
  • "image": Hasil penelusuran dari tab "Gambar" di Google Penelusuran.
  • "video": Hasil penelusuran video
  • "web": [Default] Filter hasil ke tab gabungan ("Semua") di Google Penelusuran. Tidak menyertakan hasil Discover atau Google Berita.
dimensionFilterGroups[] list [Opsional] Nol atau beberapa grup filter yang akan diterapkan pada nilai pengelompokan dimensi. Semua grup filter harus cocok agar baris ditampilkan dalam respons. Dalam satu grup filter, Anda dapat menentukan apakah semua filter harus cocok, atau setidaknya satu filter harus cocok.
dimensionFilterGroups[].groupType string Apakah semua filter dalam grup ini harus menampilkan true ("dan"), atau satu atau beberapa filter harus menampilkan true (belum didukung).

Nilai yang dapat diterima adalah:
  • "and": Semua filter dalam grup harus menampilkan true untuk grup filter to menjadi true.
dimensionFilterGroups[].filters[] list [Opsional] Nol atau beberapa filter untuk diuji terhadap baris. Setiap filter terdiri dari nama dimensi, operator, dan nilai. Panjang maksimal 4.096 karakter. Contoh: 
country equals FRA
query contains mobile use
device notContains tablet
dimensionFilterGroups[].filters[].dimension string Dimensi tempat filter ini diterapkan. Anda dapat memfilter menurut dimensi apa pun yang tercantum di sini, meskipun Anda tidak mengelompokkan menurut dimensi tersebut.

Nilai yang dapat diterima adalah:
  • "country": Filter berdasarkan negara yang ditentukan, seperti yang ditentukan oleh kode negara 3 huruf (ISO 3166-1 alpha-3).
  • "device": Memfilter hasil berdasarkan jenis perangkat yang ditentukan. Nilai yang didukung:
    • DESKTOP
    • SELULER
    • TABLET
  • "page": Memfilter string URI yang ditentukan.
  • "query": Filter berdasarkan string kueri yang ditentukan.
  • "searchAppearance": Memfilter berdasarkan fitur hasil penelusuran tertentu. Untuk melihat daftar nilai yang tersedia, jalankan kueri yang dikelompokkan berdasarkan "searchAppearance".
dimensionFilterGroups[].filters[].operator string [Opsional] Bagaimana nilai yang ditentukan harus cocok dengan (atau tidak cocok) dengan nilai dimensi untuk baris.

Nilai yang dapat diterima adalah:
  • "contains": Nilai baris harus berisi atau sama dengan ekspresi Anda (tidak peka huruf besar/kecil).
  • "equals": [Default] Ekspresi Anda harus sama persis dengan nilai baris (peka huruf besar/kecil untuk dimensi halaman dan kueri).
  • "notContains": Nilai baris tidak boleh berisi ekspresi Anda sebagai substring atau pencocokan lengkap (tidak peka huruf besar/kecil).
  • "notEquals": Ekspresi Anda tidak boleh sama persis dengan nilai baris (peka huruf besar/kecil untuk dimensi halaman dan kueri).
  • "includingRegex": Ekspresi reguler sintaksis RE2 yang harus dicocokkan.
  • "excludingRegex": Ekspresi reguler sintaksis RE2 yang tidak boleh dicocokkan.
dimensionFilterGroups[].filters[].expression string Nilai untuk filter yang akan dicocokkan atau dikecualikan, bergantung pada operator.
aggregationType string

[Opsional] Cara data digabungkan. Jika digabungkan berdasarkan properti, semua data untuk properti yang sama akan digabungkan; jika digabungkan berdasarkan halaman, semua data akan digabungkan berdasarkan URI kanonis. Jika Anda memfilter atau mengelompokkan menurut halaman, pilih otomatis; jika tidak, Anda dapat menggabungkan berdasarkan properti atau halaman, bergantung pada cara Anda ingin data dihitung; lihat dokumentasi bantuan untuk mempelajari cara data dihitung secara berbeda berdasarkan situs versus berdasarkan halaman.

Catatan: Jika Anda mengelompokkan atau memfilter berdasarkan halaman, Anda tidak dapat menggabungkan berdasarkan properti.

Jika Anda menentukan nilai selain otomatis, jenis agregasi dalam hasil akan cocok dengan jenis yang diminta, atau jika Anda meminta jenis yang tidak valid, Anda akan mendapatkan error. API tidak akan pernah mengubah jenis agregasi jika jenis yang diminta tidak valid.

Nilai yang dapat diterima:
  • "auto": [Default] Mengizinkan layanan menentukan jenis agregasi yang sesuai.
  • "byNewsShowcasePanel": Menggabungkan nilai berdasarkan panel Berita Pilihan dari Google Berita. Ini harus digunakan bersama dengan filter NEWS_SHOWCASE searchAppearance dan type=discover atau type=googleNews. Jika Anda mengelompokkan menurut halaman, memfilter berdasarkan halaman, atau memfilter ke searchAppearance lain, Anda tidak dapat menggabungkan menurut byNewsShowcasePanel.
  • "byPage": Nilai gabungan berdasarkan URI.
  • "byProperty": Menggabungkan nilai berdasarkan properti. Tidak didukung untuk type=discover atau type=googleNews
rowLimit integer [Opsional; Rentang yang valid adalah 1–25.000; Defaultnya adalah 1.000] Jumlah baris maksimum untuk ditampilkan. Untuk melihat-lihat hasil, gunakan offset startRow.
startRow integer [Opsional; Defaultnya adalah 0] Indeks berbasis nol dari baris pertama dalam respons. Harus berupa angka yang tidak negatif. Jika startRow melebihi jumlah hasil untuk kueri, respons akan menjadi respons yang berhasil dengan nol baris.
dataState string [Opsional] Jika "semua" (tidak peka huruf besar/kecil), data akan menyertakan data baru. Jika "final" (tidak peka huruf besar/kecil) atau jika parameter ini dihilangkan, data yang ditampilkan hanya akan menyertakan data akhir.

Respons

Hasil dikelompokkan sesuai dengan dimensi yang ditentukan dalam permintaan. Semua nilai dengan kumpulan nilai dimensi yang sama akan dikelompokkan ke dalam satu baris. Misalnya, jika Anda mengelompokkan berdasarkan dimensi negara, semua hasil untuk "usa" akan dikelompokkan bersama, semua hasil untuk "mdv" akan dikelompokkan bersama, dan seterusnya. Jika Anda mengelompokkan berdasarkan negara dan perangkat, semua hasil untuk "usa, tablet" akan dikelompokkan, semua hasil untuk "usa, seluler" akan dikelompokkan, dan seterusnya. Lihat dokumentasi laporan Analisis Penelusuran untuk mempelajari cara menghitung klik, tayangan, dan sebagainya secara spesifik, serta artinya.

Hasil diurutkan berdasarkan jumlah klik dalam urutan menurun, kecuali jika Anda mengelompokkan berdasarkan tanggal, dalam hal ini hasil diurutkan berdasarkan tanggal, dalam urutan menaik (terlama dulu, terbaru terakhir). Jika ada ikatan di antara dua baris, tata urutannya bersifat arbitrer.

Lihat properti rowLimit dalam permintaan untuk mempelajari jumlah nilai maksimum yang dapat ditampilkan.

{
  "rows": [
    {
      "keys": [
        string
      ],
      "clicks": double,
      "impressions": double,
      "ctr": double,
      "position": double
    }
  ],
  "responseAggregationType": string
}
Nama properti Nilai Deskripsi Catatan
rows[] list Daftar baris yang dikelompokkan berdasarkan nilai kunci dalam urutan yang ditentukan dalam kueri.
rows[].keys[] list Daftar nilai dimensi untuk baris tersebut, yang dikelompokkan sesuai dengan dimensi dalam permintaan, dalam urutan yang ditentukan dalam permintaan.
rows[].clicks double Jumlah klik untuk baris.
rows[].impressions double Jumlah tayangan iklan untuk baris.
rows[].ctr double Rasio Klik-Tayang (CTR) untuk baris. Rentang nilai dari 0 hingga 1.0, inklusif.
rows[].position double Posisi rata-rata di hasil penelusuran.
responseAggregationType string Cara penggabungan hasil.Lihat dokumentasi bantuan untuk mempelajari cara data dihitung secara berbeda berdasarkan situs dibandingkan berdasarkan halaman.

Nilai yang dapat diterima adalah:
  • "auto"
  • "byPage": Hasil digabungkan berdasarkan halaman.
  • "byProperty": Hasil digabungkan berdasarkan properti.

Cobalah!

Gunakan APIs Explorer di bawah untuk memanggil metode ini pada data live dan melihat respons.