इसके लिए, अनुमति लेना ज़रूरी है
अपने तय किए हुए फ़िल्टर और पैरामीटर की मदद से, Search से आने वाले ट्रैफ़िक के डेटा पर क्वेरी करें. यह तरीका आपकी तय की गई पंक्ति कुंजियों (डाइमेंशन) के हिसाब से ग्रुप में बांटी गई शून्य या उससे ज़्यादा पंक्तियां दिखाता है. आपको एक या उससे ज़्यादा दिन की तारीख की सीमा तय करनी होगी.
जब तारीख कोई डाइमेंशन होती है, तो बिना डेटा वाले दिन को नतीजे की सूची से हटा दिया जाता है. यह जानने के लिए कि किन दिनों में डेटा उपलब्ध है, पसंद की तारीख की सीमा के लिए, तारीख के हिसाब से ग्रुप किए गए फ़िल्टर के बिना क्वेरी जारी करें.
नतीजों को क्लिक की गिनती के हिसाब से, घटते क्रम में लगाया जाता है. अगर दो पंक्तियों में क्लिक की संख्या एक जैसी है, तो उन्हें मनमुताबिक तरीके से क्रम में लगाया जाता है.
इस तरीके को कॉल करने के लिए 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 |
[ज़रूरी है] अनुरोध की गई तारीख की सीमा के शुरू होने की तारीख YYYY-MM-DD फ़ॉर्मैट में, PT समय (यूटीसी - 7:00/8:00) में होनी चाहिए. खत्म होने की तारीख से कम या उसके बराबर होनी चाहिए. यह वैल्यू इस रेंज में शामिल है. | |
endDate |
string |
[ज़रूरी है] अनुरोध की गई तारीख की सीमा के खत्म होने की तारीख YYYY-MM-DD फ़ॉर्मैट में, पीटी समय (यूटीसी - 7:00/8:00) में होनी चाहिए. शुरू होने की तारीख से बड़ी या उसके बराबर होनी चाहिए. यह वैल्यू इस रेंज में शामिल है. | |
dimensions[] |
list |
[ज़रूरी नहीं] नतीजों को ग्रुप में बांटने के लिए, शून्य या उससे ज़्यादा डाइमेंशन.नतीजों को उसी क्रम में ग्रुप किया जाता है जिस क्रम में आपने इन डाइमेंशन को दिया है.dimensionFilterGroups[].filters[].dimension के साथ-साथ "तारीख" में किसी भी डाइमेंशन का नाम इस्तेमाल किया जा सकता है.ग्रुप के डाइमेंशन की वैल्यू को मिलाकर, नतीजे की हर लाइन के लिए एक यूनीक कुंजी बनाई जाती है. अगर कोई डाइमेंशन तय नहीं किया गया है, तो सभी वैल्यू एक ही पंक्ति में जोड़ दी जाएंगी. इस बात की कोई सीमा नहीं है कि कितने डाइमेंशन के हिसाब से ग्रुप बनाया जा सकता है. हालांकि, एक ही डाइमेंशन के आधार पर दो बार ग्रुप नहीं बनाया जा सकता. उदाहरण: [देश, डिवाइस] | |
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" के सभी नतीजों को देश के डाइमेंशन के हिसाब से ग्रुप किया जाता है, तो "एमडीवी" के सभी नतीजे एक साथ ग्रुप किए जाएंगे. इसी तरह, "एमडीवी" के सभी नतीजे एक साथ ग्रुप किए जाएंगे. अगर आपने डेटा को देश और डिवाइस के हिसाब से ग्रुप में बांटा है, तो "usa, टैबलेट" के सभी नतीजों को एक साथ ग्रुप किया जाएगा. "usa, मोबाइल" वगैरह के लिए भी सभी नतीजों को एक साथ ग्रुप किया जाएगा. खोज के आंकड़ों की रिपोर्ट के दस्तावेज़ देखें और जानें कि क्लिक, इंप्रेशन वगैरह की गिनती कैसे की जाती है और उनका क्या मतलब होता है.
नतीजों को क्लिक की संख्या के हिसाब से घटते क्रम में रखा जाता है. हालांकि, अगर इन नतीजों को तारीख के हिसाब से ग्रुप में बांटा जाता है, तो नतीजों को तारीख के हिसाब से, बढ़ते क्रम में लगाया जाता है. अगर दो पंक्तियों के बीच टाई है, तो क्रम में लगाने का क्रम अपनी पसंद के मुताबिक नहीं होता है.
अनुरोध में 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 |
नतीजों को कैसे एग्रीगेट किया गया.साइट के हिसाब से और पेज के हिसाब से, डेटा की गिनती अलग-अलग तरीके से कैसे की जाती है, यह जानने के लिए सहायता से जुड़ा दस्तावेज़ देखें.
स्वीकार की जाने वाली वैल्यू हैं:
|
इसे आज़माएं!
इस तरीके को लाइव डेटा पर कॉल करने और रिस्पॉन्स देखने के लिए, नीचे दिए गए एपीआई एक्सप्लोरर का इस्तेमाल करें.