अनुमति देना ज़रूरी है
तय किए गए फ़िल्टर और पैरामीटर की मदद से, Search Network के ट्रैफ़िक डेटा की क्वेरी करें. यह तरीका, आपकी तय की गई पंक्ति कुंजियों (डाइमेंशन) के हिसाब से ग्रुप की गई शून्य या उससे ज़्यादा पंक्तियां दिखाता है. आपको एक या उससे ज़्यादा दिनों की तारीख की सीमा तय करनी होगी.
जब तारीख एक डाइमेंशन में से एक होती है, तो उन सभी दिनों को नतीजे की सूची से हटा दिया जाता है जिनमें डेटा नहीं होता. तारीख की सीमा के हिसाब से फ़िल्टर किए बिना, तारीख की सीमा के हिसाब से क्वेरी करें. इससे आपको यह जानने में मदद मिलेगी कि आपको किन-किन दिनों का डेटा दिख रहा है.
नतीजों को क्लिक की संख्या के हिसाब से घटते क्रम में लगाया जाता है. अगर दो पंक्तियों में एक ही क्लिक की संख्या है, तो उन्हें मनचाहे तरीके से क्रम में लगाया जाता है.
इस तरीके को कॉल करने के लिए, 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" के लिए सभी नतीजे "mdv" के लिए सभी नतीजे एक साथ ग्रुप किए जाएंगे को एक साथ ग्रुप किया जाएगा वगैरह. अगर आपने देश और डिवाइस के हिसाब से ग्रुप बनाया है, तो "usa, टैबलेट" के लिए सभी नतीजे "usa, Mobile" के लिए सभी नतीजे ग्रुप में शामिल किए जाएंगे को ग्रुप किया जाएगा वगैरह. क्लिक, इंप्रेशन वगैरह की गिनती करने के तरीके और उनका मतलब जानने के लिए, Search Network से जुड़े आंकड़ों की रिपोर्ट का दस्तावेज़ देखें.
नतीजों को क्लिक की संख्या के हिसाब से घटते क्रम में लगाया जाता है. हालांकि, तारीख के हिसाब से डेटा को ग्रुप में बांटा जाता है. इसमें नतीजों को तारीख के हिसाब से बढ़ते क्रम में लगाया जाता है. अगर दो पंक्तियों के बीच टाई हो जाता है, तो नतीजों को अपने हिसाब से क्रम में लगाया जा सकता है.
ज़्यादा से ज़्यादा कितनी वैल्यू मिल सकती हैं, यह जानने के लिए अनुरोध में मौजूद 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 |
नतीजे इकट्ठा करने का तरीका.साइट और पेज के हिसाब से डेटा का हिसाब कैसे लगाया जाता है, यह जानने के लिए सहायता दस्तावेज़ देखें.
ये वैल्यू स्वीकार की जाती हैं:
|
इसे आज़माएं!
लाइव डेटा पर इस तरीके को कॉल करने और जवाब देखने के लिए, नीचे दिए गए एपीआई एक्सप्लोरर का इस्तेमाल करें.