فراخوانی API

این سند نحوه استفاده از Google Site Verification API را شرح می دهد.

فراخوانی API

فرمت درخواست

اکثر عملیات تأیید سایت پشتیبانی شده مستقیماً به افعال REST HTTP ( GET ، POST ، PUT ، DELETE ) نگاشت می شوند، همانطور که در عملیات Google Site Verification API توضیح داده شده است.

فرمت خاص برای URI های API تأیید سایت Google عبارتند از:

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

در جایی که resourceID شناسه یک منبع وب است، parameters هر پارامتری هستند که باید در پرس و جو اعمال شود. پارامترهای واقعی که استفاده می کنید بسته به عملیاتی که انجام می دهید متفاوت است. علاوه بر این، اگر از OAuth 2.0 استفاده می کنید، باید access_token در این پارامترها تنظیم کنید.

پرس و جوهای لیست نیازی به شناسه منبع ندارند، بنابراین قالب به صورت زیر است:

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

می توانید با URI منحصر به فرد خود با عملیات getToken تماس بگیرید. فرمت تماس با getToken این است:

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

فرمت داده

Google Site Verification API داده‌ها را در قالب JSON برمی‌گرداند.

JSON (JavaScript Object Notation) یک قالب داده رایج و مستقل از زبان است که نمایش متنی ساده ای از ساختارهای داده دلخواه را ارائه می دهد. برای اطلاعات بیشتر، به json.org مراجعه کنید.

خلاصه عملیات

همانطور که در جدول زیر توضیح داده شده است، می توانید شش روش مختلف را در مجموعه ها و منابع در Google Site Verification API فراخوانی کنید. URL های API مربوط به https://www.googleapis.com/siteVerification/v1 هستند.

عملیات توضیحات URL و نحو
فهرست

تمام منابع موجود در مجموعه کاربر تایید شده را فهرست می کند.

GET /webResource

نمونه درخواست لیست را ببینید.

درج کنید

یک سایت یا دامنه را تأیید می کند. در صورت موفقیت آمیز بودن، یک منبع وب جدید را در مجموعه کاربر درج می کند.

بدنه درخواست: به منبع وب مراجعه کنید.

پارامتر Query: verificationMethod . روش تأیید مورد استفاده برای این درخواست. مقادیر ممکن: FILE , META , ANALYTICS , TAG_MANAGER , DNS_TXT , DNS_CNAME

POST /webResource

نمونه درخواست درج را ببینید.

دریافت کنید

آخرین داده ها را برای یک منبع وب خاص دریافت می کند.

GET /webResource/ resourceID

به مثال دریافت درخواست مراجعه کنید

به روز رسانی کنید

لیست مالکان را برای یک منبع خاص تغییر می دهد.

بدنه درخواست: به منبع وب مراجعه کنید.

یادداشت ها:

  • با استفاده از به‌روزرسانی نمی‌توانید کاربر تأیید شده را از فهرست مالکان حذف کنید. به جای آن از حذف استفاده کنید.
  • می‌توانید هر کاربری را که رمز تأیید در سایت ندارد، از فهرست مالکان حذف کنید.

PUT /webResource/ resourceID

نمونه درخواست به‌روزرسانی را ببینید.

حذف کنید

یک منبع را از مجموعه کاربر حذف می کند (تأیید می کند که سایت متعلق به کاربر است).

یادداشت ها:

  • قبل از فراخوانی حذف ، ابتدا باید تمام نشانه‌های تأیید اعتبار کاربر را از سایت یا دامنه حذف کنید. اگر نشانه‌هایی هنوز وجود داشته باشد، یک خطای HTTP 400 (درخواست بد) برگردانده می‌شود.
  • حذف فقط بر داده های مالکیت کاربر احراز هویت شده تأثیر می گذارد. همه کاربران دیگر، چه واگذار شده باشند و چه به طور مستقل تأیید شده باشند، پس از حذف، مالکیت خود را حفظ می کنند.

DELETE /webResource/ resourceID

به مثال درخواست حذف مراجعه کنید.

getToken

کد تأیید را برای قرار دادن در وب سایت کاربر تأیید شده دریافت می کند.

بدن درخواستی:

  • identifier : آدرس سایت یا نام دامنه.
  • type : نوع منبعی که باید تأیید شود. مقادیر ممکن: SITE ، INET_DOMAIN .
  • verificationMethod : روشی که باید هنگام تأیید سایت خود استفاده کنید. مقادیر ممکن: FILE , META , ANALYTICS , TAG_MANAGER , DNS_TXT , DNS_CNAME

POST /token

نمونه درخواست getToken را ببینید.

نمونه تماس های API

این بخش فرض می‌کند که شما (توسعه‌دهنده) کاربر تأیید شده نیز هستید، همانطور که برای اولین بار API را با داده‌های آزمایشی خود امتحان می‌کنید.

یک سایت جدید را تأیید کنید

برای تایید یک سایت،

  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 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

پاسخ:

کد وضعیت HTTP 204 (بدون محتوا) که نشان دهنده موفقیت است.