अनुमति ज़रूरी है
अपने तय किए गए फ़िल्टर और पैरामीटर की मदद से, खोज ट्रैफ़िक के डेटा के बारे में क्वेरी करें. यह तरीका, आपके तय किए गए पंक्ति की कुंजी (डाइमेंशन) के हिसाब से ग्रुप बनाए गए शून्य या उससे ज़्यादा पंक्तियां दिखाता है. आपको एक या उससे ज़्यादा दिनों की तारीख की सीमा तय करनी होगी.
जब तारीख को डाइमेंशन के तौर पर चुना जाता है, तो नतीजों की सूची से ऐसे दिन हटा दिए जाते हैं जिनका डेटा मौजूद नहीं होता. यह जानने के लिए कि किन दिनों का डेटा उपलब्ध है, तारीख की अपनी पसंदीदा सीमा के लिए, तारीख के हिसाब से ग्रुप बनाए गए फ़िल्टर के बिना क्वेरी करें.
नतीजों को क्लिक की संख्या के हिसाब से घटते क्रम में लगाया जाता है. अगर दो पंक्तियों में क्लिक की संख्या एक जैसी है, तो उन्हें किसी भी क्रम में लगाया जा सकता है.
इस तरीके को कॉल करने के लिए, Python सैंपल देखें.
एपीआई, Search Console की अंदरूनी सीमाओं के तहत काम करता है. इसलिए, यह गारंटी नहीं दी जा सकती कि यह डेटा की सभी लाइनों को दिखाएगा. हालांकि, यह सबसे ऊपर की लाइनों को दिखाता है.
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"]
}अनुरोध
एचटीटीपी अनुरोध
POST https://www.googleapis.com/webmasters/v3/sites/siteUrl/searchAnalytics/query
पैरामीटर
| पैरामीटर का नाम | वैल्यू | ब्यौरा |
|---|---|---|
| पाथ पैरामीटर | ||
siteUrl |
string |
Search Console में जोड़ी गई प्रॉपर्टी का यूआरएल. उदाहरण:
http://www.example.com/ (यूआरएल-प्रीफ़िक्स प्रॉपर्टी के लिए) या
sc-domain:example.com (डोमेन प्रॉपर्टी के लिए)
|
अनुमति देना
इस अनुरोध के लिए, इनमें से कम से कम एक स्कोप के साथ अनुमति देना ज़रूरी है (पुष्टि करने और अनुमति देने के बारे में ज़्यादा जानें).
| दायरा |
|---|
https://www.googleapis.com/auth/webmasters.readonly |
https://www.googleapis.com/auth/webmasters |
अनुरोध का मुख्य भाग
अनुरोध के मुख्य हिस्से में, इस स्ट्रक्चर का डेटा दें:
{
"startDate": string,
"endDate": string,
"dimensions": [
string
],
"type": string,
"dimensionFilterGroups": [
{
"groupType": string,
"filters": [
{
"dimension": string,
"operator": string,
"expression": string
}
],
"filterLists": [
{
"dimension": string,
"expressions": [
string
]
}
]
}
],
"aggregationType": string,
"rowLimit": integer,
"startRow": integer
}| प्रॉपर्टी का नाम | वैल्यू | ब्यौरा | नोट |
|---|---|---|---|
startDate |
string |
[ज़रूरी है] अनुरोध की गई तारीख की सीमा के शुरू होने की तारीख. इसे YYYY-MM-DD फ़ॉर्मैट में और पीटी टाइम (यूटीसी - 7:00/8:00) में डालें. यह तारीख, खत्म होने की तारीख से पहले या उसके बराबर होनी चाहिए. यह वैल्यू, रेंज में शामिल होती है. | |
endDate |
string |
[ज़रूरी है] अनुरोध की गई तारीख की सीमा के खत्म होने की तारीख, YYYY-MM-DD फ़ॉर्मैट में, पीटी टाइम (यूटीसी - 7:00/8:00) में. यह तारीख, शुरू होने की तारीख या उसके बाद की होनी चाहिए. यह वैल्यू, रेंज में शामिल होती है. | |
dimensions[] |
list |
[ज़रूरी नहीं] नतीजों को ग्रुप करने के लिए, शून्य या उससे ज़्यादा डाइमेंशन. नतीजों को उसी क्रम में ग्रुप किया जाता है जिस क्रम में आपने ये डाइमेंशन दिए हैं. dimensionFilterGroups[].filters[].dimension में किसी भी डाइमेंशन के नाम के साथ-साथ, "तारीख" और "घंटा" का इस्तेमाल किया जा सकता है. ग्रुपिंग डाइमेंशन की वैल्यू को जोड़कर, हर नतीजे की लाइन के लिए एक यूनीक कुंजी बनाई जाती है. अगर कोई डाइमेंशन नहीं दिया गया है, तो सभी वैल्यू को एक ही लाइन में जोड़ दिया जाएगा. जितने चाहें उतने डाइमेंशन के हिसाब से ग्रुप बनाए जा सकते हैं. हालांकि, एक ही डाइमेंशन के हिसाब से दो बार ग्रुप नहीं बनाए जा सकते. उदाहरण: [country, device] | |
searchType |
string |
इस्तेमाल पर रोक लगा दी गई है. इसके बजाय, type का इस्तेमाल करें
|
|
type |
string |
[ज़रूरी नहीं] नतीजों को इस टाइप के हिसाब से फ़िल्टर करें:
|
|
dimensionFilterGroups[] |
list |
[ज़रूरी नहीं] डाइमेंशन ग्रुपिंग की वैल्यू पर लागू करने के लिए, फ़िल्टर के शून्य या उससे ज़्यादा ग्रुप. जवाब में कोई पंक्ति दिखाने के लिए, सभी फ़िल्टर ग्रुप मैच होने चाहिए. एक ही फ़िल्टर ग्रुप में, यह तय किया जा सकता है कि सभी फ़िल्टर मैच होने चाहिए या कम से कम एक फ़िल्टर मैच होना चाहिए. | |
dimensionFilterGroups[].groupType |
string |
इस ग्रुप के सभी फ़िल्टर को सही ("और") दिखाना चाहिए या एक या उससे ज़्यादा फ़िल्टर को सही दिखाना चाहिए (फ़िलहाल, यह सुविधा काम नहीं करती).
ये वैल्यू डाली जा सकती हैं:
|
|
dimensionFilterGroups[].filters[] |
list |
[ज़रूरी नहीं] पंक्ति के हिसाब से जांच करने के लिए, शून्य या उससे ज़्यादा फ़िल्टर. हर फ़िल्टर में एक डाइमेंशन का नाम, एक ऑपरेटर, और एक वैल्यू होती है. ज़्यादा से ज़्यादा 4,096 वर्ण इस्तेमाल किए जा सकते हैं. उदाहरण:
country equals FRA query contains mobile use device notContains tablet |
|
dimensionFilterGroups[].filters[].dimension |
string |
वह डाइमेंशन जिस पर यह फ़िल्टर लागू होता है. यहां दिए गए किसी भी डाइमेंशन के हिसाब से डेटा को फ़िल्टर किया जा सकता है. भले ही, आपने उस डाइमेंशन के हिसाब से डेटा को ग्रुप न किया हो.
ये वैल्यू डाली जा सकती हैं:
|
|
dimensionFilterGroups[].filters[].operator |
string |
[ज़रूरी नहीं] आपकी तय की गई वैल्यू, लाइन के डाइमेंशन की वैल्यू से किस तरह मैच होनी चाहिए या मैच नहीं होनी चाहिए.
ये वैल्यू डाली जा सकती हैं:
|
|
dimensionFilterGroups[].filters[].expression |
string |
ऑपरेटर के आधार पर, फ़िल्टर की वैल्यू मैच करने या बाहर रखने के लिए. | |
dimensionFilterGroups[].filterLists[] |
list |
[ज़रूरी नहीं] लाइन की जांच करने के लिए, कई वैल्यू वाले शून्य या उससे ज़्यादा डाइमेंशन फ़िल्टर.
filters[], हर एंट्री के लिए एक वैल्यू मैच करता है. इसके उलट, filterLists[] की मदद से एक ही फ़िल्टर में किसी डाइमेंशन के लिए, एग्ज़ैक्ट मैच वाली कई वैल्यू मैच की जा सकती हैं. अगर किसी पंक्ति में मौजूद dimension की वैल्यू, दिए गए किसी भी expressions के बराबर है, तो वह पंक्ति फ़िल्टर की सूची से मैच करती है. ध्यान दें कि एक ही अनुरोध में, filters और filterLists, दोनों में एक ही डाइमेंशन पर फ़िल्टर नहीं लगाया जा सकता. |
|
dimensionFilterGroups[].filterLists[].dimension |
string |
[ज़रूरी है] वह डाइमेंशन जिस पर फ़िल्टर की यह सूची लागू होती है.
ये वैल्यू डाली जा सकती हैं:
|
|
dimensionFilterGroups[].filterLists[].expressions[] |
list |
[ज़रूरी है] फ़िल्टर करने के लिए वैल्यू की सूची (string). |
|
aggregationType |
string |
[ज़रूरी नहीं] डेटा को एग्रीगेट करने का तरीका. अगर डेटा को प्रॉपर्टी के हिसाब से एग्रीगेट किया जाता है, तो एक ही प्रॉपर्टी के लिए सारा डेटा एग्रीगेट किया जाता है. अगर डेटा को पेज के हिसाब से एग्रीगेट किया जाता है, तो सारा डेटा कैननिकल यूआरआई के हिसाब से एग्रीगेट किया जाता है. अगर आपको पेज के हिसाब से फ़िल्टर या ग्रुप करना है, तो 'अपने-आप' चुनें. इसके अलावा, डेटा को प्रॉपर्टी या पेज के हिसाब से एग्रीगेट किया जा सकता है. यह इस बात पर निर्भर करता है कि आपको डेटा का हिसाब कैसे लगाना है. साइट और पेज के हिसाब से डेटा का हिसाब लगाने के तरीके में क्या अंतर है, यह जानने के लिए सहायता दस्तावेज़ देखें. ध्यान दें: अगर पेज के हिसाब से ग्रुप या फ़िल्टर किया जाता है, तो प्रॉपर्टी के हिसाब से एग्रीगेट नहीं किया जा सकता. अगर आपने अपने-आप होने वाली प्रोसेस के अलावा कोई और वैल्यू तय की है, तो नतीजे में एग्रीगेशन टाइप, अनुरोध किए गए टाइप से मैच करेगा. इसके अलावा, अगर आपने किसी अमान्य टाइप का अनुरोध किया है, तो आपको गड़बड़ी का मैसेज मिलेगा. अगर अनुरोध किया गया टाइप अमान्य है, तो एपीआई आपके एग्रीगेशन टाइप को कभी नहीं बदलेगा. ये वैल्यू डाली जा सकती हैं:
|
|
rowLimit |
integer |
[ज़रूरी नहीं; मान्य रेंज 1 से 25,000 है; डिफ़ॉल्ट वैल्यू 1,000 है] ज़्यादा से ज़्यादा कितनी लाइनें दिखानी हैं. नतीजों को पेज के हिसाब से देखने के लिए, startRow ऑफ़सेट का इस्तेमाल करें. |
|
startRow |
integer |
[ज़रूरी नहीं; डिफ़ॉल्ट वैल्यू 0 है] जवाब में पहली लाइन का शून्य पर आधारित इंडेक्स. यह ज़रूरी है कि वैल्यू नेगेटिव न हो. अगर startRow की वैल्यू, क्वेरी के लिए मिले नतीजों की संख्या से ज़्यादा है, तो जवाब में शून्य लाइनें होंगी. |
|
dataState |
string |
[ज़रूरी नहीं] अगर "all" (केस-इनसेंसिटिव) है, तो डेटा में नया डेटा शामिल होगा. अगर "final" (केस-इनसेंसिटिव) या इस पैरामीटर को शामिल नहीं किया जाता है, तो दिखाए गए डेटा में सिर्फ़ फ़ाइनल डेटा शामिल होगा. अगर "hourly_all" (केस-इनसेंसिटिव) है, तो डेटा में हर घंटे का ब्रेकडाउन शामिल होगा. इससे पता चलता है कि हर घंटे के डेटा में अधूरा डेटा शामिल है. साथ ही, इसका इस्तेमाल HOUR एपीआई डाइमेंशन के हिसाब से ग्रुप बनाते समय किया जाना चाहिए. |
जवाब
नतीजों को अनुरोध में बताए गए डाइमेंशन के हिसाब से ग्रुप में रखा जाता है. डाइमेंशन वैल्यू के एक ही सेट वाली सभी वैल्यू को एक ही लाइन में ग्रुप किया जाएगा. उदाहरण के लिए, अगर देश के डाइमेंशन के हिसाब से ग्रुप बनाया जाता है, तो "usa" के सभी नतीजे एक साथ ग्रुप किए जाएंगे, "mdv" के सभी नतीजे एक साथ ग्रुप किए जाएंगे, वगैरह. अगर आपने देश और डिवाइस के हिसाब से ग्रुप बनाया है, तो "अमेरिका, टैबलेट" के सभी नतीजे ग्रुप किए जाएंगे. साथ ही, "अमेरिका, मोबाइल" के सभी नतीजे ग्रुप किए जाएंगे. इसी तरह, अन्य नतीजे भी ग्रुप किए जाएंगे. क्लिक, इंप्रेशन वगैरह का हिसाब लगाने के तरीके और उनके मतलब के बारे में जानने के लिए, खोज के आंकड़ों की रिपोर्ट से जुड़ा दस्तावेज़ देखें.
नतीजों को क्लिक की संख्या के हिसाब से, घटते क्रम में लगाया जाता है. हालांकि, अगर नतीजों को तारीख के हिसाब से ग्रुप किया जाता है, तो उन्हें तारीख के हिसाब से बढ़ते क्रम में लगाया जाता है. इसमें सबसे पुराना नतीजा पहले और सबसे नया नतीजा आखिर में दिखता है. अगर दो पंक्तियों के बीच टाई हो जाता है, तो क्रम से लगाने का तरीका मनमुताबिक होता है.
अनुरोध में rowLimit प्रॉपर्टी देखें, ताकि यह पता चल सके कि ज़्यादा से ज़्यादा कितनी वैल्यू दिखाई जा सकती हैं.
{
"rows": [
{
"keys": [
string
],
"clicks": double,
"impressions": double,
"ctr": double,
"position": double
}
],
"responseAggregationType": string
}| प्रॉपर्टी का नाम | वैल्यू | ब्यौरा | नोट |
|---|---|---|---|
rows[] |
list |
क्वेरी में दिए गए क्रम में, मुख्य वैल्यू के हिसाब से ग्रुप में बांटी गई लाइनों की सूची. | |
rows[].keys[] |
list |
उस पंक्ति के लिए डाइमेंशन वैल्यू की सूची. इसे अनुरोध में दिए गए डाइमेंशन के हिसाब से ग्रुप किया जाता है. साथ ही, इसे अनुरोध में बताए गए क्रम में लगाया जाता है. | |
rows[].clicks |
double |
लाइन के लिए क्लिक की संख्या. | |
rows[].impressions |
double |
पंक्ति के लिए इंप्रेशन की गिनती. | |
rows[].ctr |
double |
लाइन के लिए क्लिक मिलने की दर (सीटीआर). वैल्यू, 0 से 1.0 के बीच होनी चाहिए. हालांकि, इन दोनों में से भी कोई संख्या हो सकती है. | |
rows[].position |
double |
खोज के नतीजों में औसत रैंक. | |
responseAggregationType |
string |
नतीजों को एग्रीगेट करने का तरीका. साइट और पेज के हिसाब से डेटा का हिसाब अलग-अलग तरीके से कैसे लगाया जाता है, यह जानने के लिए सहायता दस्तावेज़ देखें.
ये वैल्यू डाली जा सकती हैं:
|
|
metadata |
object |
यह एक ऐसा ऑब्जेक्ट है जो आपकी क्वेरी के नतीजों के साथ दिखाया जा सकता है. इससे डेटा की स्थिति के बारे में जानकारी मिलती है.
इस ऑब्जेक्ट में दी गई सभी तारीखें और समय, इस ऑब्जेक्ट में दिखाया गया फ़ील्ड इस बात पर निर्भर करता है कि आपने अनुरोध में अपने डेटा को किस तरह ग्रुप किया है:
|
इसे आज़माएं!
लाइव डेटा पर इस तरीके को कॉल करने और जवाब देखने के लिए, नीचे दिए गए APIs Explorer का इस्तेमाल करें.