API Reference

Search Console API के ज़रिए ये सेवाएं दी जाती हैं:

  • Search के आंकड़े - अपनी साइट के लिए ट्रैफ़िक डेटा के बारे में क्वेरी करें.
  • साइटमैप - अपने सभी साइटमैप की सूची बनाएं, किसी साइटमैप के बारे में जानकारी का अनुरोध करें, और Google को साइटमैप सबमिट करें.
  • साइटें - अपने Search Console खाते में प्रॉपर्टी की सूची बनाएं/जोड़ें/हटाएं.
  • यूआरएल की जांच करना - Google इंडेक्स में किसी पेज की स्थिति की जांच करें. यह Search Console के यूआरएल जांचने की सुविधा जैसा ही होता है.

Search के आंकड़े

खोज के आंकड़ों से जुड़े संसाधन की जानकारी के लिए, संसाधनों को दिखाने का तरीका बताने वाला पेज देखें.

तरीका एचटीटीपी अनुरोध ब्यौरा
जब तक अलग से न बताया जाए, तब तक https://www.googleapis.com/webmasters/v3 से जुड़े यूआरआई
क्वेरी POST  /sites/siteUrl/searchAnalytics/query

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

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

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

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

JSON पोस्ट का उदाहरण:
POST https://www.googleapis.com/webmasters/v3/sites/https%3A%2F%2Fwww.example.com%2F/searchAnalytics/query
{
  "startDate": "2015-04-01",
  "endDate": "2015-05-01",
  "dimensions": ["country","device"]
}

साइटमैप

साइटमैप में मौजूद संसाधनों की जानकारी के लिए, संसाधनों को दिखाने का तरीका बताने वाला पेज देखें.

तरीका एचटीटीपी अनुरोध ब्यौरा
जब तक अलग से न बताया जाए, तब तक https://www.googleapis.com/webmasters/v3 से जुड़े यूआरआई
मिटाएं DELETE  /sites/siteUrl/sitemaps/feedpath इस साइट से साइटमैप मिटाता है.
पाएं GET  /sites/siteUrl/sitemaps/feedpath किसी खास साइटमैप के बारे में जानकारी हासिल करता है.
list GET  /sites/siteUrl/sitemaps इस साइट के लिए सबमिट की गई या साइटमैप इंडेक्स फ़ाइल में शामिल की गई साइटमैप की एंट्री की सूची बनाता है, अगर अनुरोध में sitemapIndex के बारे में बताया गया है.
सबमिट करें PUT  /sites/siteUrl/sitemaps/feedpath किसी साइट के लिए साइटमैप सबमिट करता है.

साइटें

साइट पर उपलब्ध संसाधनों की जानकारी के लिए, संसाधनों को दिखाने का तरीका बताने वाला पेज देखें.

तरीका एचटीटीपी अनुरोध ब्यौरा
जब तक अलग से न बताया जाए, तब तक https://www.googleapis.com/webmasters/v3 से जुड़े यूआरआई
जोड़ें PUT  /sites/siteUrl Search Console में उपयोगकर्ता की साइटों के सेट में एक साइट जोड़ता है.
मिटाएं DELETE  /sites/siteUrl उपयोगकर्ता की Search Console साइटों के सेट से किसी साइट को हटाता है.
पाएं GET  /sites/siteUrl किसी खास साइट के बारे में जानकारी हासिल करता है.
list GET  /sites यह विकल्प, उपयोगकर्ता की Search Console साइटों की सूची बनाता है.

यूआरएल की जांच

यूआरएल की जांच करने वाले संसाधन की जानकारी के लिए, संसाधनों को दिखाने वाला पेज देखें.

तरीका एचटीटीपी अनुरोध ब्यौरा
https://searchconsole.googleapis.com/v1 से जुड़ा यूआरआई
index.inspect POST /urlInspection/index:inspect

Google इंडेक्स में दिए गए यूआरएल के बारे में जानकारी.

JSON पोस्ट का उदाहरण:
POST https://searchconsole.googleapis.com/v1/urlInspection/index:inspect
{
  "inspectionUrl": "https://www.example.com/mypage",
  "siteUrl": "https://www.example.com/",
  "languageCode": "en-US"}