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

इस दस्तावेज़ में, Google Site Verification API के इस्तेमाल का तरीका बताया गया है.

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

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

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

Google Site Verification API यूआरआई के लिए खास फ़ॉर्मैट ये हैं:

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 Site Verification API, JSON फ़ॉर्मैट में डेटा दिखाता है.

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

कार्रवाइयों की खास जानकारी

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

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

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

GET /webResource

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

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

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

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

POST /webResource

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

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

GET /webResource/resourceID

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

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

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

ध्यान दें:

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

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. insert कार्रवाई का इस्तेमाल करके, 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"
  }
}

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

आप update पर कॉल करके मालिकाना हक सौंप सकते हैं या वापस ले सकते हैं. मिटाएं पर कॉल करके अपने मालिकाना हक की जानकारी हटाई जा सकती है.

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

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 (कोई कॉन्टेंट नहीं) स्टेटस कोड, सफल होने का संकेत देता है.