Yetkilendirme gerektirir
Arama trafiği verilerinizi, tanımladığınız filtre ve parametrelerle sorgulayın. Yöntem, tanımladığınız satır anahtarlarına (boyutlar) göre gruplandırılmış sıfır veya daha fazla satır döndürür. Bir veya daha fazla günden oluşan bir tarih aralığı tanımlamanız gerekir.
Tarih boyutlardan biri olduğunda, veri içermeyen günler sonuç listesinden çıkarılır. Hangi günlerde veri bulunduğunu öğrenmek üzere, ilgili tarih aralığı için tarihe göre gruplandırılmış filtre içermeyen bir sorgu yayınlayın.
Sonuçlar, tıklama sayısına göre büyükten küçüğe sıralanır. İki satır aynı tıklama sayısına sahipse bunlar rastgele bir şekilde sıralanır.
Bu yöntemi çağırmak için python örneğine bakın.
API, Search Console'un dahili sınırlamalarıyla sınırlıdır ve tüm veri satırlarını değil, en üsttekileri döndürmeyi garanti eder.
Kullanılabilir veri miktarıyla ilgili sınırları inceleyin.
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"] }
İstek
HTTP isteği
POST https://www.googleapis.com/webmasters/v3/sites/siteUrl/searchAnalytics/query
Parametreler
Parametre adı | Değer | Açıklama |
---|---|---|
Yol parametreleri | ||
siteUrl |
string |
Mülkün Search Console'da tanımlanan URL'si. Örnekler:
http://www.example.com/ (URL ön eki mülkü için) veya
sc-domain:example.com (alan mülkü için)
|
Yetkilendirme
Bu istek için aşağıdaki kapsamlardan en az biriyle yetkilendirme gerekir (kimlik doğrulama ve yetkilendirme hakkında daha fazla bilgi edinin).
Kapsam |
---|
https://www.googleapis.com/auth/webmasters.readonly |
https://www.googleapis.com/auth/webmasters |
İstek içeriği
İstek gövdesinde, verileri aşağıdaki yapıyla sağlayın:
{ "startDate": string, "endDate": string, "dimensions": [ string ], "type": string, "dimensionFilterGroups": [ { "groupType": string, "filters": [ { "dimension": string, "operator": string, "expression": string } ] } ], "aggregationType": string, "rowLimit": integer, "startRow": integer }
Mülk adı | Değer | Açıklama | Notlar |
---|---|---|---|
startDate |
string |
[Zorunlu] İstenen tarih aralığının YYYY-AA-GG biçimindeki başlangıç tarihi (PT saati (UTC - 7:00/8:00)). Bitiş tarihinden önce veya bitiş tarihine eşit olmalıdır. Bu değer, aralığa dahildir. | |
endDate |
string |
[Zorunlu] İstenen tarih aralığının YYYY-AA-GG biçiminde PT saati (UTC - 7:00/8:00) bitiş tarihi. Başlangıç tarihinden sonra veya başlangıç tarihine eşit olmalıdır. Bu değer, aralığa dahildir. | |
dimensions[] |
list |
[İsteğe bağlı] Sonuçları gruplandırmak için sıfır veya daha fazla boyut.Sonuçlar, bu boyutları sağladığınız sıraya göre gruplandırılır.dimensionFilterGroups[].filters[].dimension özelliğinde ve "tarih"te herhangi bir boyut adı kullanabilirsiniz.Gruplandırma boyut değerleri, her sonuç satırı için benzersiz bir anahtar oluşturmak üzere birleştirilir. Boyut belirtilmezse tüm değerler tek bir satırda birleştirilir. Gruplandırabileceğiniz boyut sayısına ilişkin bir sınır yoktur, ancak aynı boyuta göre iki kez gruplandıramazsınız. Örnek: [ülke, cihaz] | |
searchType |
string |
Kullanımdan kaldırıldı, bunun yerine type kullanın
|
|
type |
string |
[İsteğe bağlı] Sonuçları aşağıdaki türe göre filtreleyin:
|
|
dimensionFilterGroups[] |
list |
[İsteğe bağlı] Boyut gruplandırma değerlerine uygulanacak filtre grubu sıfır veya daha fazladır. Yanıtta bir satırın döndürülmesi için tüm filtre gruplarının eşleşmesi gerekir. Tek bir filtre grubunda, tüm filtrelerin mi eşleşmesi gerektiğini yoksa en az bir tanesinin mi eşleşmesi gerektiğini belirtebilirsiniz. | |
dimensionFilterGroups[].groupType |
string |
Bu gruptaki tüm filtrelerin doğru ("ve") döndürmesi mi yoksa bir veya daha fazla filtrenin true değerini döndürmesi (henüz desteklenmemektedir).
Kabul edilen değerler şunlardır:
|
|
dimensionFilterGroups[].filters[] |
list |
[İsteğe bağlı] Satırda test edilecek sıfır veya daha fazla filtre. Her filtre bir boyut adı, operatör ve bir değerden oluşur. Maksimum uzunluk 4.096 karakter. Örnekler:
country equals FRA query contains mobile use device notContains tablet |
|
dimensionFilterGroups[].filters[].dimension |
string |
Bu filtrenin geçerli olduğu boyut. Burada listelenen herhangi bir boyuta göre filtreleme yapabilirsiniz (söz konusu boyuta göre gruplama yapmıyor olsanız bile).
Kabul edilen değerler şunlardır:
|
|
dimensionFilterGroups[].filters[].operator |
string |
[İsteğe bağlı] Belirttiğiniz değerin satırın boyut değeriyle nasıl eşleşmesi (veya eşleşmemesi) gerektiği.
Kabul edilen değerler şunlardır:
|
|
dimensionFilterGroups[].filters[].expression |
string |
Operatöre bağlı olarak eşleştirilecek veya hariç tutulacak filtrenin değeri. | |
aggregationType |
string |
[İsteğe bağlı] Verilerin toplanma şekli. Mülke göre toplanırsa aynı mülkün tüm verileri toplanır; sayfaya göre toplanırsa tüm veriler standart URI tarafından toplanır. Sayfaya göre filtreleme veya gruplama yapıyorsanız otomatik seçeneğini belirleyin. Aksi takdirde, verilerinizin nasıl hesaplanmasını istediğinize bağlı olarak mülke veya sayfaya göre toplama yapabilirsiniz. Verilerin siteye ve sayfaya göre nasıl farklı şekilde hesaplandığını öğrenmek için yardım dokümanlarına bakın. Not: Sayfaya göre gruplandırır veya filtrelerseniz mülke göre toplama yapamazsınız. Otomatik dışında bir değer belirtirseniz sonuçtaki toplama türü, istenen türle eşleşir veya geçersiz bir tür isteğinde bulunursanız bir hata alırsınız. İstenen tür geçersizse API, toplama türünüzü hiçbir zaman değiştirmez. Kabul edilebilir değerler şunlardır:
|
|
rowLimit |
integer |
[İsteğe bağlı; Geçerli aralık 1–25.000; Varsayılan: 1.000] Döndürülecek maksimum satır sayısı. Sonuçlar arasında sayfa gezmek için startRow ofsetini kullanın. |
|
startRow |
integer |
[İsteğe bağlı; Varsayılan 0'dır] Yanıttaki ilk satırın sıfır tabanlı dizini. Negatif olmayan bir sayı olmalıdır. startRow sorgu için sonuç sayısını aşarsa yanıt, sıfır satırlı başarılı bir yanıt olur. |
|
dataState |
string |
[İsteğe bağlı] "Tümü" ise (büyük/küçük harfe duyarlı değilse) veriler yeni verileri içerir. "Nihai" (büyük/küçük harfe duyarlı değil) veya bu parametre atlanmışsa döndürülen veriler yalnızca kesinleşmiş verileri içerir. |
Yanıt
Sonuçlar, istekte belirtilen boyutlara göre gruplandırılır. Aynı boyut değerleri kümesine sahip tüm değerler tek bir satırda gruplandırılacaktır. Örneğin, ülke boyutuna göre gruplandırma yaparsanız "abd" için tüm sonuçlar birlikte gruplandırılır, "mdv" için tüm sonuçlar birlikte gruplanır ve bu şekilde devam eder. Ülkeye ve cihaza göre gruplandırırsanız, "abd, tablet" için tüm sonuçlar gruplandırılır, "abd, mobil" vb. için olan tüm sonuçlar gruplanır. Tıklamaların, gösterimlerin vb. nasıl hesaplandığına dair ayrıntıları ve bunların ne anlama geldiğini öğrenmek için Arama Analizi raporu dokümanlarına bakın.
Tarihe göre gruplandırmadığınız sürece sonuçlar tıklama sayısına göre ve azalan düzende sıralanır. Tarihe göre sıralama yapılırsa sonuçlar tarihe göre artan düzende (önce en eski, en yeni olan) sıralanır. İki satır arasında eşitlik varsa sıralama düzeni isteğe bağlı olur.
Döndürülebilecek maksimum değer sayısını öğrenmek için istekteki rowLimit özelliğine bakın.
{ "rows": [ { "keys": [ string ], "clicks": double, "impressions": double, "ctr": double, "position": double } ], "responseAggregationType": string }
Mülk adı | Değer | Açıklama | Notlar |
---|---|---|---|
rows[] |
list |
Sorguda belirtilen sırada, anahtar değerlerine göre gruplandırılmış satır listesi. | |
rows[].keys[] |
list |
İstekte belirtilen sırayla, istekteki boyutlara göre gruplandırılmış söz konusu satıra ilişkin boyut değerlerinin listesi. | |
rows[].clicks |
double |
Satır için tıklama sayısı. | |
rows[].impressions |
double |
Satır için gösterim sayısı. | |
rows[].ctr |
double |
Satırın Tıklama Oranı (TO). Değerler 0 ile 1, 0 (her iki değer dahil) arasında değişir. | |
rows[].position |
double |
Arama sonuçlarındaki ortalama konum. | |
responseAggregationType |
string |
Sonuçların toplanma biçimi.Verilerin siteye ve sayfaya göre nasıl farklı şekilde hesaplandığını öğrenmek için yardım dokümanlarına bakın.
Kabul edilen değerler şunlardır:
|
Deneyin.
Canlı verilerde bu yöntemi çağırmak ve yanıtı görmek için aşağıdaki API Gezgini'ni kullanın.