एपीआई को शुरू करना

इस दस्तावेज़ में Google साइट की पुष्टि करने वाले एपीआई को इस्तेमाल करने का तरीका बताया गया है.

एपीआई को शुरू करना

अनुरोध का फ़ॉर्मैट

जैसा कि Google साइट की पुष्टि वाले एपीआई की कार्रवाइयों में बताया गया है, साइट की पुष्टि की ज़्यादातर कार्रवाइयों को, सीधे REST एचटीटीपी कार्रवाइयों (GET, POST, PUT, DELETE) पर मैप किया जाता है.

Google साइट की पुष्टि करने वाले एपीआई यूआरआई के लिए ये खास फ़ॉर्मैट हैं:

https://www.googleapis.com/siteVerification/v1/webResource/resourceID?parameters

जहां resourceID किसी वेब रिसॉर्स का आइडेंटिफ़ायर होता है, वहां parameters क्वेरी पर लागू होने वाले पैरामीटर होते हैं. आप जो काम कर रहे हैं उसके आधार पर इस्तेमाल किए जाने वाले असल पैरामीटर अलग-अलग होते हैं. साथ ही, अगर आप OAuth 2.0 का इस्तेमाल कर रहे हैं, तो आपको इन पैरामीटर में access_token सेट करना चाहिए.

सूची क्वेरी के लिए ResourceID की ज़रूरत नहीं होती, इसलिए फ़ॉर्मैट ऐसा होता है:

https://www.googleapis.com/siteVerification/v1/webResource?parameters

getToken की खास यूआरआई के ज़रिए कॉल किए जा सकते हैं. getToken का कॉल करने का फ़ॉर्मैट यह है:

https://www.googleapis.com/siteVerification/v1/token?parameters

डेटा फ़ॉर्मैट

Google साइट पुष्टि एपीआई, JSON फ़ॉर्मैट में डेटा दिखाता है.

JSON (JavaScript ऑब्जेक्ट नोटेशन) एक सामान्य डेटा-आधारित डेटा फ़ॉर्मैट है, जो आर्बिट्रेरी डेटा स्ट्रक्चर को टेक्स्ट के रूप में आसान तरीके से दिखाता है. ज़्यादा जानकारी के लिए, json.org देखें.

ऑपरेशन की खास जानकारी

आप Google साइट पुष्टि एपीआई में संग्रह और संसाधनों के लिए छह अलग-अलग तरीकों को शुरू कर सकते हैं, जैसा कि नीचे दी गई टेबल में बताया गया है. एपीआई यूआरएल https://www.googleapis.com/siteVerification/v1 से जुड़े हुए हैं.

कार्रवाई ब्यौरा यूआरएल और सिंटैक्स
list

पुष्टि किए गए उपयोगकर्ता के संग्रह में सभी संसाधनों की सूची बनाता है.

GET /webResource

सूची का अनुरोध करने का उदाहरण देखें.
शामिल करें

किसी साइट या डोमेन की पुष्टि करता है. अगर ऐसा किया जाता है, तो उपयोगकर्ता के कलेक्शन में एक नया वेब रिसॉर्स जोड़ा जाता है.

अनुरोध का मुख्य हिस्सा: वेब रिसॉर्स देखें.

क्वेरी पैरामीटर: verificationMethod. इस अनुरोध के साथ इस्तेमाल करने के लिए, पुष्टि करने का तरीका. संभावित मान: FILE, META, ANALYTICS, TAG_MANAGER, DNS_TXT, DNS_CNAME

POST /webResource

उदाहरण insert अनुरोध देखें.
पाएं

किसी खास वेब संसाधन के लिए नया डेटा मिलता है.

GET /webResource/resourceID

उदाहरण get अनुरोध देखें
अपडेट करें

किसी खास संसाधन के लिए, मालिकों की सूची में बदलाव करता है.

अनुरोध का मुख्य हिस्सा: वेब रिसॉर्स देखें.

ध्यान दें:

  • अपडेट का इस्तेमाल करके, पुष्टि किए गए उपयोगकर्ता को मालिक की सूची से हटाया नहीं जा सकता. इसके बजाय, मिटाएं का इस्तेमाल करें.
  • आप उस मालिक को सूची से हटा सकते हैं जिसके पास साइट पर पुष्टि का टोकन नहीं है.

PUT /webResource/resourceID

उदाहरण अपडेट का अनुरोध देखें.
मिटाएं

उपयोगकर्ता के कलेक्शन से किसी रिसॉर्स को हटाता है (यह पुष्टि नहीं करता कि साइट उपयोगकर्ता से जुड़ी है).

ध्यान दें:

  • मिटाएं पर कॉल करने से पहले, आपको साइट या डोमेन से पुष्टि किए गए सभी उपयोगकर्ता टोकन को हटाना होगा. अगर कोई टोकन अब भी मौजूद है, तो एचटीटीपी 400 (गलत अनुरोध) की गड़बड़ी दिखती है.
  • डेटा मिटाने का असर सिर्फ़ पुष्टि किए गए उपयोगकर्ता के मालिकाना हक वाले डेटा पर पड़ता है. अन्य सभी उपयोगकर्ता, चाहे उन्हें सौंपा गया हो या अलग से पुष्टि की गई हो, मिटाने के बाद मालिकाना हक बरकरार रखें.

DELETE /webResource/resourceID

अनुरोध मिटाने का उदाहरण देखें.
getToken

पुष्टि किए गए उपयोगकर्ता की वेबसाइट पर पुष्टि करने के लिए पुष्टि वाला टोकन मिलता है.

अनुरोध का मुख्य हिस्सा:

  • identifier: साइट का यूआरएल या डोमेन का नाम.
  • type: पुष्टि करने के लिए संसाधन का टाइप. संभावित वैल्यू: SITE, INET_DOMAIN.
  • verificationMethod: अपनी साइट की पुष्टि करने के लिए इस्तेमाल किया जाने वाला तरीका. संभावित मान: FILE, META, ANALYTICS, TAG_MANAGER, DNS_TXT, DNS_CNAME

POST /token

देखें उदाहरण getToken अनुरोध करें.

एपीआई कॉल का उदाहरण

इस सेक्शन में यह मान लिया जाता है कि आप (डेवलपर) भी पुष्टि किए गए उपयोगकर्ता हैं. ऐसा तब होगा, जब पहली बार एपीआई को अपने टेस्ट डेटा के साथ आज़माया जा रहा हो.

नई साइट की पुष्टि करें

साइट की पुष्टि करने के लिए

  1. पहले getToken पर कॉल करके, पुष्टि करने वाले टोकन का अनुरोध करें.
  2. आपने जो तरीका चुना है उसका इस्तेमाल करके, टोकन को अपनी साइट पर रखें.
  3. शामिल करें कार्रवाई का इस्तेमाल करके, Google से अपनी साइट की पुष्टि करने के लिए कहें.

getToken (अनुमति देना ज़रूरी है)

POST https://www.googleapis.com/siteVerification/v1/token?access_token=oauth2-token

अनुरोध:

POST https://www.googleapis.com/siteVerification/v1/token?access_token=oauth2-token
Content-Type: application/json

{
  "verificationMethod": "FILE",
  "site": {
    "identifier": "http://www.example.com",
    "type": "SITE"
  }
}

जवाब:

{
  "token": "google12cfc68677988bb4.html",
  "method": "FILE"
}

शामिल करें (अनुमति देना ज़रूरी है)

POST https://www.googleapis.com/siteVerification/v1/webResource?verificationMethod=FILE&access_token=oauth2-token

अनुरोध:

POST https://www.googleapis.com/siteVerification/v1/webResource?verificationMethod=FILE&access_token=oauth2-token
Content-Type: application/json

{
  "site": {
    "identifier": "http://www.example.com",
    "type": "SITE"
  }
}

जवाब:

{
  "owners": [
    "myself@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com/",
    "type": "SITE"
  }
}

सत्यापित वेब संसाधनों के लिए जानकारी फिर से पाएं

आप सूची पर कॉल करके अपनी पुष्टि की गई साइटों और डोमेन की पूरी सूची फिर से पा सकते हैं. आप get को कॉल करके किसी एक वेब संसाधन के लिए जानकारी पा सकते हैं.

सूची (अनुमति देना ज़रूरी है)

GET https://www.googleapis.com/siteVerification/v1/webResource?access_token=oauth2-token

अनुरोध:

GET https://www.googleapis.com/siteVerification/v1/webResource?access_token=oauth2-token

जवाब:

{
  "items": [
    {
      "owners": [
        "myself@example.com",
      ],
      "id": "http%3A%2F%2Fwww.example.com%2F",
      "site": {
        "identifier": "http://www.example.com/site1",
        "type": "SITE"
      }
    },
    {
      "owners": [
        "myself@example.com",
      ],
      "id": "http%3A%2F%2Fwww.example.com%2F",
      "site": {
        "identifier": "http://www.example.com/site2",
        "type": "SITE"
      }
    }
  ]
}

पाएं (अनुमति देना ज़रूरी है)

GET https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

अनुरोध:

GET https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

जवाब:

{
  "owners": [
    "myself@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com/",
    "type": "SITE"
  }
}

पुष्टि करने से जुड़ी जानकारी में बदलाव करें

आप अपडेट करें पर कॉल करके किसी दूसरे व्यक्ति को अपना मालिकाना हक सौंप सकते हैं या उसे हटा सकते हैं. आप मिटाएं पर कॉल करके, अपना मालिकाना हक हटा सकते हैं.

अपडेट (अनुमति देना ज़रूरी है)

PUT https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

अनुरोध:

PUT https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token
Content-Type: application/json

{
  "owners": [
    "myself@example.com",
    "another@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com",
    "type": "SITE"
  }
}

जवाब:

{
  "owners": [
    "myself@example.com",
    "another@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com/",
    "type": "SITE"
  }
}

मिटाएं (अनुमति देना ज़रूरी है)

DELETE https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

अनुरोध:

DELETE https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

जवाब:

एचटीटीपी 204 (कोई कॉन्टेंट नहीं) स्टेटस कोड, जो बताता है कि सफलता मिल गई है.