अनुमति की ज़रूरत है
अपने तय किए गए फ़िल्टर और पैरामीटर की मदद से, खोज ट्रैफ़िक डेटा की क्वेरी करें. यह तरीका, आपकी तय की गई पंक्ति कुंजियों (डाइमेंशन) के हिसाब से ग्रुप की गई शून्य या उससे ज़्यादा पंक्तियां दिखाता है. आपको तारीख की एक या उससे ज़्यादा दिनों की सीमा तय करनी होगी.
जब तारीख एक डाइमेंशन में से एक होती है, तो उन सभी दिनों को नतीजे की सूची से हटा दिया जाता है जिनमें डेटा नहीं होता. यह जानने के लिए कि किन दिनों का डेटा है, अपनी पसंद की तारीख की सीमा के लिए, तारीख के हिसाब से व्यवस्थित किए गए फ़िल्टर के बिना क्वेरी जारी करें.
नतीजों को क्लिक की संख्या के हिसाब से, घटते क्रम में क्रम से लगाया जाता है. अगर दो पंक्तियों में क्लिक की संख्या एक जैसी है, तो उन्हें किसी भी क्रम में क्रम से लगाया जाता है.
इस तरीके को कॉल करने के लिए, 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 } ] } ], "aggregationType": string, "rowLimit": integer, "startRow": integer }
प्रॉपर्टी का नाम | मान | ब्यौरा | नोट |
---|---|---|---|
startDate |
string |
[ज़रूरी है] अनुरोध की गई तारीख की सीमा की शुरुआत की तारीख, पश्चिमी समय (यूटीसी - 7:00/8:00) में, YYYY-MM-DD फ़ॉर्मैट में. खत्म होने की तारीख से कम या उसके बराबर होना चाहिए. यह वैल्यू, रेंज में शामिल होती है. | |
endDate |
string |
[ज़रूरी है] तारीख की मांग की गई सीमा की आखिरी तारीख, पीटी टाइम (यूटीसी - 7:00/8:00) में, YYYY-MM-DD फ़ॉर्मैट में. शुरू होने की तारीख के बाद की या उससे बड़ी होनी चाहिए. यह वैल्यू, रेंज में शामिल होती है. | |
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 |
ऑपरेटर के आधार पर, फ़िल्टर की वैल्यू को मैच या बाहर रखा जाता है. | |
aggregationType |
string |
[ज़रूरी नहीं] डेटा को इकट्ठा करने का तरीका. अगर प्रॉपर्टी के हिसाब से एग्रीगेट किया जाता है, तो एक ही प्रॉपर्टी का सारा डेटा एग्रीगेट किया जाता है. अगर पेज के हिसाब से एग्रीगेट किया जाता है, तो सारा डेटा कैननिकल यूआरआई के हिसाब से एग्रीगेट किया जाता है. अगर आपको पेज के हिसाब से फ़िल्टर या ग्रुप करना है, तो अपने-आप डेटा इकट्ठा होने की सुविधा चुनें. इसके अलावा, डेटा को एग्रीगेट करने के लिए, प्रॉपर्टी या पेज में से किसी एक को चुनें. यह इस बात पर निर्भर करता है कि आपको डेटा का हिसाब कैसे लगाना है. साइट के हिसाब से डेटा का हिसाब लगाने के तरीके और पेज के हिसाब से डेटा का हिसाब लगाने के तरीके के बारे में जानने के लिए, सहायता दस्तावेज़ देखें. ध्यान दें: पेज के हिसाब से डेटा को ग्रुप में बांटने या फ़िल्टर करने पर, प्रॉपर्टी के हिसाब से डेटा इकट्ठा नहीं किया जा सकता. अगर आपने अपने-आप सेट होने की सुविधा के अलावा कोई दूसरी वैल्यू दी है, तो नतीजे में एग्रीगेशन टाइप, अनुरोध किए गए टाइप से मैच करेगा. अगर आपने अमान्य टाइप का अनुरोध किया है, तो आपको गड़बड़ी का मैसेज दिखेगा. अगर अनुरोध किया गया टाइप अमान्य है, तो एपीआई आपके एग्रीगेशन टाइप को कभी नहीं बदलेगा. ये वैल्यू डाली जा सकती हैं:
|
|
rowLimit |
integer |
[ज़रूरी नहीं; मान्य रेंज 1 से 25,000 है; डिफ़ॉल्ट तौर पर 1,000] लौटाई जाने वाली पंक्तियों की ज़्यादा से ज़्यादा संख्या. नतीजों को पेज के हिसाब से देखने के लिए, startRow ऑफ़सेट का इस्तेमाल करें. |
|
startRow |
integer |
[ज़रूरी नहीं; डिफ़ॉल्ट रूप से 0 है] रिस्पॉन्स में पहली लाइन का शून्य-आधारित इंडेक्स. यह संख्या, ज़ीरो से बड़ी होनी चाहिए. अगर startRow , क्वेरी के नतीजों की संख्या से ज़्यादा है, तो जवाब में शून्य पंक्तियां दिखेंगी. |
|
dataState |
string |
[ज़रूरी नहीं] अगर "सभी" (बड़े और छोटे अक्षरों में अंतर नहीं किया जाता) चुना जाता है, तो डेटा में नया डेटा शामिल होगा. अगर "फ़ाइनल" (बड़े और छोटे अक्षरों में अंतर नहीं किया जाता) या इस पैरामीटर को शामिल नहीं किया जाता है, तो दिखाए गए डेटा में सिर्फ़ फ़ाइनल डेटा शामिल होगा. |
जवाब
नतीजों को अनुरोध में बताए गए डाइमेंशन के हिसाब से ग्रुप में बांटा जाता है. डाइमेंशन वैल्यू के एक ही सेट वाली सभी वैल्यू को एक ही पंक्ति में ग्रुप किया जाएगा. उदाहरण के लिए, अगर देश के डाइमेंशन के हिसाब से ग्रुप किया जाता है, तो "usa" के सभी नतीजे एक साथ ग्रुप किए जाएंगे, "mdv" के सभी नतीजे एक साथ ग्रुप किए जाएंगे वगैरह. अगर आपने देश और डिवाइस के हिसाब से ग्रुप किया है, तो "usa, tablet" के सभी नतीजे एक ग्रुप में, "usa, mobile" के सभी नतीजे एक ग्रुप में, और इसी तरह के अन्य नतीजे एक ग्रुप में दिखेंगे. क्लिक, इंप्रेशन वगैरह की गिनती करने का तरीका और उनका मतलब जानने के लिए, Search Analytics रिपोर्ट का दस्तावेज़ देखें.
नतीजों को क्लिक की संख्या के हिसाब से, घटते क्रम में क्रम से लगाया जाता है. हालांकि, अगर आपने तारीख के हिसाब से ग्रुप किया है, तो नतीजों को तारीख के हिसाब से, बढ़ते क्रम में क्रम से लगाया जाता है. अगर दो पंक्तियों के बीच टाई हो जाता है, तो क्रम से लगाने का क्रम मनमुताबिक होता है.
अनुरोध में 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 |
नतीजों को कैसे इकट्ठा किया गया. साइट के हिसाब से और पेज के हिसाब से, डेटा का हिसाब अलग-अलग तरीके से कैसे लगाया जाता है, यह जानने के लिए सहायता दस्तावेज़ देखें.
इन वैल्यू का इस्तेमाल किया जा सकता है:
|
इसे आज़माएं!
लाइव डेटा पर इस तरीके को कॉल करने और जवाब देखने के लिए, नीचे दिए गए एपीआई एक्सप्लोरर का इस्तेमाल करें.