Method: index.inspect

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

एचटीटीपी अनुरोध

POST https://searchconsole.googleapis.com/v1/urlInspection/index:inspect

यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

अनुरोध का मुख्य भाग

अनुरोध के मुख्य हिस्से में, यहां दिए गए स्ट्रक्चर का डेटा शामिल होता है:

JSON के काेड में दिखाना 
{
  "inspectionUrl": string,
  "siteUrl": string,
  "languageCode": string
}
फ़ील्ड
inspectionUrl

string

ज़रूरी है. जांच करने के लिए पूरी तरह क्वालिफ़ाइड यूआरएल. "siteUrl" में दी गई प्रॉपर्टी के तहत होना चाहिए.
siteUrl

string

ज़रूरी है. Search Console में बताई गई प्रॉपर्टी का यूआरएल. ध्यान दें कि यूआरएल-प्रीफ़िक्स प्रॉपर्टी के आखिर में / का निशान होना चाहिए. उदाहरण: यूआरएल-प्रीफ़िक्स प्रॉपर्टी के लिए https://www.example.com/ या डोमेन प्रॉपर्टी के लिए sc-domain:example.com.
languageCode

string

ज़रूरी नहीं. आईईटीएफ़ BCP-47 वाला भाषा कोड, जो समस्या के अनुवाद किए गए मैसेज के लिए अनुरोध की गई भाषा दिखाता है, जैसे कि "en-US", "या "de-CH". डिफ़ॉल्ट वैल्यू "en-US" है.

जवाब का मुख्य भाग

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

इंडेक्स-स्टेटस की जांच से जुड़ा जवाब.

JSON के काेड में दिखाना 
{
  "inspectionResult": {
    object (UrlInspectionResult)
  }
}
फ़ील्ड
inspectionResult

object (UrlInspectionResult)

यूआरएल की जांच के नतीजे.

अनुमति पाने के लिंक

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/webmasters
  • https://www.googleapis.com/auth/webmasters.readonly

ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.