Search Analytics: query

अनुमति की ज़रूरत है

अपने तय किए गए फ़िल्टर और पैरामीटर की मदद से, Search से आने वाले ट्रैफ़िक के डेटा की क्वेरी करें. यह तरीका आपकी तय की गई पंक्ति कुंजियों (डाइमेंशन) के मुताबिक समूह में डाली गई शून्य या ज़्यादा पंक्तियां दिखाता है. आपको एक या उससे ज़्यादा दिनों की तारीख की सीमा तय करनी होगी.

जब तारीख कोई डाइमेंशन होती है, तो बिना डेटा वाले दिन को खोज के नतीजों की सूची से हटा दिया जाता है. यह जानने के लिए कि किन दिनों में डेटा उपलब्ध है, पसंद की तारीख की सीमा के लिए, तारीख के हिसाब से ग्रुप किए गए फ़िल्टर के बिना क्वेरी जारी करें.

नतीजों को क्लिक की गिनती के हिसाब से, घटते क्रम में लगाया जाता है. अगर दो पंक्तियों में क्लिक की संख्या एक जैसी है, तो उन्हें मनमुताबिक तरीके से क्रम में लगाया जाता है.

इस तरीके को कॉल करने के लिए Python सैंपल देखें.

यह एपीआई, Search Console की अंदरूनी सीमाओं से जुड़ा होता है. इस वजह से, यह गारंटी नहीं देता कि डेटा की सभी पंक्तियां सबसे ऊपर दिखेंगी.

उपलब्ध डेटा की सीमा देखें.

JSON पोस्ट का उदाहरण:
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 फ़ॉर्मैट में, पीटी समय (यूटीसी - 7:00/8:00) में होनी चाहिए. खत्म होने की तारीख से कम या उसके बराबर होनी चाहिए. यह वैल्यू, रेंज में शामिल होती है.
endDate string [ज़रूरी है] अनुरोध की गई तारीख की सीमा के खत्म होने की तारीख, DD-MM-YYYY फ़ॉर्मैट में, पीटी समय (यूटीसी - 7:00/8:00) में होनी चाहिए. शुरू होने की तारीख से बड़ी या उसके बराबर होनी चाहिए. यह वैल्यू, रेंज में शामिल होती है.
dimensions[] list [ज़रूरी नहीं] नतीजों को ग्रुप करने के लिए, शून्य या उससे ज़्यादा डाइमेंशन चुनें.नतीजों को उसी क्रम में ग्रुप किया जाता है जिस क्रम में आपने उन्हें डाइमेंशन दिया है.dimensionFilterGroups[].filters[].dimension के साथ-साथ "तारीख" में किसी भी डाइमेंशन के नाम का इस्तेमाल किया जा सकता है.ग्रुप में मौजूद डाइमेंशन की वैल्यू को एक साथ जोड़ा जाता है, ताकि नतीजे की हर लाइन के लिए एक यूनीक कुंजी बनाई जा सके. अगर कोई डाइमेंशन नहीं चुना गया है, तो सभी वैल्यू एक ही पंक्ति में जोड़ दी जाएंगी. इस बात की कोई सीमा नहीं है कि कितने डाइमेंशन के हिसाब से ग्रुप बनाया जा सकता है, लेकिन एक ही डाइमेंशन के हिसाब से दो बार ग्रुप नहीं किया जा सकता. उदाहरण: [देश, डिवाइस]
searchType string अब काम नहीं करता, इसके बजाय type का इस्तेमाल करें
type string [ज़रूरी नहीं] नतीजों को इस तरह फ़िल्टर करें:
  • "discover": 'डिस्कवर' के नतीजे
  • "googleNews": Android और iOS पर, Google News ऐप्लिकेशन और news.google.com से मिले नतीजे. इस रिपोर्ट में, Google Search में "खबरें" टैब के नतीजे शामिल नहीं होते.
  • "news": Google Search में "News" टैब के खोज के नतीजे.
  • "image": Google Search में "इमेज" टैब से मिले खोज के नतीजे.
  • "video": वीडियो के खोज के नतीजे
  • "web": [डिफ़ॉल्ट] Google Search में मिले-जुले ("सभी") टैब के नतीजों को फ़िल्टर करें. इसमें 'डिस्कवर' या Google News के नतीजे शामिल नहीं हैं.
dimensionFilterGroups[] list [ज़रूरी नहीं] डाइमेंशन ग्रुप की वैल्यू पर लागू करने के लिए, फ़िल्टर का शून्य या उससे ज़्यादा ग्रुप है. जवाब में किसी लाइन को दिखाने के लिए, सभी फ़िल्टर ग्रुप का मैच होना ज़रूरी है. किसी एक फ़िल्टर ग्रुप में, यह तय किया जा सकता है कि सभी फ़िल्टर मैच होने चाहिए या कम से कम एक फ़िल्टर मैच होना चाहिए.
dimensionFilterGroups[].groupType string इस ग्रुप के सभी फ़िल्टर को 'सही' ("और") दिखाना चाहिए या एक या उससे ज़्यादा फ़िल्टर को 'सही' के तौर पर सेट करना चाहिए (फ़िलहाल, यह सुविधा काम नहीं करती).

इन वैल्यू को इस्तेमाल किया जा सकता है:
  • "and": ग्रुप के सभी फ़िल्टर के लिए यह ज़रूरी है कि ग्रुप tसही हो.
dimensionFilterGroups[].filters[] list [ज़रूरी नहीं] पंक्ति में जांच करने के लिए, एक भी फ़िल्टर नहीं लगाया जा सकता. हर फ़िल्टर में डाइमेंशन का नाम, ऑपरेटर, और वैल्यू होती है. ज़्यादा से ज़्यादा 4,096 वर्ण इस्तेमाल किए जा सकते हैं. उदाहरण:
country equals FRA
query contains mobile use
device notContains tablet
dimensionFilterGroups[].filters[].dimension string वह डाइमेंशन जिस पर यह फ़िल्टर लागू होता है. यहां दिए गए किसी भी डाइमेंशन के हिसाब से फ़िल्टर किया जा सकता है. भले ही, आपने उस डाइमेंशन के हिसाब से डेटा को ग्रुप में न रखा हो.

इन वैल्यू को इस्तेमाल किया जा सकता है:
  • "country": चुने गए देश के हिसाब से फ़िल्टर करें, जैसा कि तीन अक्षरों वाले देश का कोड (ISO 3166-1 alpha-3) में तय किया गया है.
  • "device": बताए गए डिवाइस टाइप के हिसाब से नतीजों को फ़िल्टर करें. इस्तेमाल की जा सकने वाली वैल्यू:
    • डेस्कटॉप
    • मोबाइल
    • टैबलेट
  • "page": तय की गई यूआरआई स्ट्रिंग के हिसाब से फ़िल्टर करें.
  • "query": तय की गई क्वेरी स्ट्रिंग के हिसाब से फ़िल्टर करें.
  • "searchAppearance": खोज के नतीजे की किसी खास सुविधा के हिसाब से फ़िल्टर करें. उपलब्ध वैल्यू की सूची देखने के लिए, "searchappeal" की मदद से ग्रुप की गई क्वेरी चलाएं.
dimensionFilterGroups[].filters[].operator string [ज़रूरी नहीं] आपकी तय की गई वैल्यू, लाइन की डाइमेंशन वैल्यू से किस तरह मैच होनी चाहिए या मैच नहीं होनी चाहिए.

इन वैल्यू को इस्तेमाल किया जा सकता है:
  • "contains": लाइन की वैल्यू में या तो आपका एक्सप्रेशन शामिल होना चाहिए या उसके बराबर होना चाहिए. यह एक्सप्रेशन केस-सेंसिटिव (बड़े और छोटे अक्षरों में अंतर) नहीं होता है.
  • "equals": [डिफ़ॉल्ट] आपका एक्सप्रेशन, लाइन की वैल्यू (पेज और क्वेरी डाइमेंशन के लिए केस-सेंसिटिव) के बिलकुल बराबर होना चाहिए.
  • "notContains": लाइन की वैल्यू में आपका एक्सप्रेशन, सबस्ट्रिंग के तौर पर या केस-सेंसिटिव (बड़े और छोटे अक्षरों में अंतर) होने से मैच नहीं होना चाहिए.
  • "notEquals": आपका एक्सप्रेशन, लाइन की वैल्यू के बराबर नहीं होना चाहिए (पेज और क्वेरी डाइमेंशन के लिए, केस-सेंसिटिव).
  • "includingRegex": RE2 सिंटैक्स रेगुलर एक्सप्रेशन जो मैच होना चाहिए.
  • "excludingRegex": RE2 सिंटैक्स रेगुलर एक्सप्रेशन जो मैच नहीं होना चाहिए.
dimensionFilterGroups[].filters[].expression string ऑपरेटर के आधार पर, फ़िल्टर की वह वैल्यू जिसका मिलान करना है या जिसे बाहर रखना है.
aggregationType string

[ज़रूरी नहीं] डेटा को एग्रीगेट कैसे किया जाता है. अगर डेटा को प्रॉपर्टी के हिसाब से एग्रीगेट किया जाता है, तो उस प्रॉपर्टी का पूरा डेटा एग्रीगेट किया जाता है. अगर पेज के हिसाब से डेटा एग्रीगेट किया जाता है, तो सारा डेटा कैननिकल यूआरआई के हिसाब से एग्रीगेट किया जाता है. अगर आपको डेटा को पेज के हिसाब से फ़िल्टर करना या ग्रुप के हिसाब से फ़िल्टर करना है, तो 'अपने-आप' चुनें. इसके अलावा, डेटा को प्रॉपर्टी या पेज के हिसाब से भी इकट्ठा किया जा सकता है. यह इस बात पर निर्भर करता है कि आपको डेटा का हिसाब कैसे लगाना है. सहायता दस्तावेज़ देखें और जानें कि साइट और पेज के हिसाब से डेटा का हिसाब कैसे लगाया जाता है.

ध्यान दें: अगर आपने पेज के हिसाब से डेटा को ग्रुप में दिखाया या फ़िल्टर किया है, तो प्रॉपर्टी के हिसाब से डेटा को ग्रुप में नहीं रखा जा सकता.

अगर आपने ऑटो के अलावा कोई दूसरी वैल्यू तय की है, तो नतीजे में मौजूद एग्रीगेशन का टाइप, अनुरोध किए गए टाइप से मेल खाएगा या अमान्य टाइप का अनुरोध करने पर आपको गड़बड़ी मिलेगी. अगर अनुरोध किया गया टाइप अमान्य है, तो एपीआई आपके एग्रीगेशन टाइप को कभी नहीं बदलेगा.

स्वीकार की जाने वाली वैल्यू ये हैं:
  • "auto": [डिफ़ॉल्ट] सेवा को यह तय करने दें कि आपके डिवाइस का एग्रीगेशन किस तरह का है.
  • "byNewsShowcasePanel": News शोकेस पैनल के हिसाब से वैल्यू एग्रीगेट करें. इसे NEWS_SHOWCASE searchAppearance फ़िल्टर के साथ-साथ type=discover या type=googleNews के साथ इस्तेमाल किया जाना चाहिए. अगर आपने पेज के हिसाब से ग्रुप बनाया, उसके हिसाब से फ़िल्टर किया या किसी दूसरे searchAppearance के हिसाब से फ़िल्टर किया, तो byNewsShowcasePanel के हिसाब से डेटा को एग्रीगेट नहीं किया जा सकता.
  • "byPage": यूआरआई के हिसाब से वैल्यू एग्रीगेट करें.
  • "byProperty": वैल्यू को प्रॉपर्टी के हिसाब से एग्रीगेट करें. type=discover या type=googleNews के लिए उपलब्ध नहीं है
rowLimit integer [ज़रूरी नहीं; मान्य रेंज 1 से 25,000 तक; डिफ़ॉल्ट वैल्यू 1,000 है] ज़्यादा से ज़्यादा लाइनों की संख्या दिखाई जा सकती है. नतीजों को पेज से बाहर करने के लिए, startRow ऑफ़सेट का इस्तेमाल करें.
startRow integer [ज़रूरी नहीं; डिफ़ॉल्ट तौर पर 0 है] जवाब की पहली लाइन का इंडेक्स, शून्य पर आधारित होता है. संख्या ऋणात्मक नहीं होनी चाहिए. अगर startRow, क्वेरी के नतीजों की संख्या से ज़्यादा हो जाता है, तो जवाब में किसी क्वेरी के नतीजे के तौर पर शून्य पंक्तियां होंगी.
dataState string [ज़रूरी नहीं] अगर "सभी" (केस-इनसेंसिटिव) है, तो डेटा में फ़्रेश डेटा शामिल होगा. अगर "फ़ाइनल" (केस-इनसेंसिटिव) या इस पैरामीटर को शामिल नहीं किया जाता है, तो दिखाए जाने वाले डेटा में सिर्फ़ फ़ाइनल डेटा शामिल होगा.

जवाब

नतीजों को अनुरोध में बताए गए डाइमेंशन के हिसाब से ग्रुप में रखा जाता है. डाइमेंशन वैल्यू के एक जैसे सेट वाली सभी वैल्यू, एक ही पंक्ति में ग्रुप की जाएंगी. उदाहरण के लिए, अगर देश के डाइमेंशन के हिसाब से ग्रुप बनाया जाता है, तो "usa" के लिए सभी नतीजे एक साथ दिखाए जाएंगे. "mdv" के सभी नतीजे एक साथ दिखाए जाएंगे. इसी तरह, इसी तरह के सभी नतीजे एक साथ दिखाए जाएंगे. अगर आपको देश और डिवाइस के हिसाब से ग्रुप में बांटा जाता है, तो "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 नतीजों को कैसे एग्रीगेट किया गया.साइट के हिसाब से और पेज के हिसाब से, डेटा का हिसाब लगाने के अलग-अलग तरीके जानने के लिए, सहायता दस्तावेज़ देखें.

इन वैल्यू को इस्तेमाल किया जा सकता है:
  • "auto"
  • "byPage": नतीजों को पेज के हिसाब से एग्रीगेट किया गया है.
  • "byProperty": नतीजों को प्रॉपर्टी के हिसाब से एग्रीगेट किया गया है.

इसे आज़माएं!

लाइव डेटा पर इस तरीके को कॉल करने और रिस्पॉन्स देखने के लिए, नीचे दिया गया एपीआई एक्सप्लोरर इस्तेमाल करें.