Method: index.inspect

وضعیت نمایه شده یا قابل نمایه سازی URL ارائه شده را مشاهده کنید. در حال حاضر فقط وضعیت نسخه در فهرست Google موجود است. شما نمی توانید نمایه سازی یک URL زنده را آزمایش کنید.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "inspectionUrl": string,
  "siteUrl": string,
  "languageCode": string
}
فیلدها
inspectionUrl

string

مورد نیاز. URL کاملا واجد شرایط برای بازرسی. باید تحت ویژگی مشخص شده در "siteUrl" باشد.

siteUrl

string

مورد نیاز. URL ویژگی همانطور که در کنسول جستجو تعریف شده است. توجه داشته باشید که ویژگی‌های پیشوند URL باید شامل یک علامت / دنباله باشد. مثال‌ها: https://www.example.com/ برای یک ویژگی URL-prefix، یا sc-domain:example.com برای یک ویژگی Domain.

languageCode

string

اختیاری. یک کد زبان IETF BCP-47 که نشان دهنده زبان درخواستی برای پیام های شماره ترجمه شده است، به عنوان مثال "en-US"، "یا "de-CH". مقدار پیش فرض "en-US" است.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

پاسخ بازرسی شاخص-وضعیت.

نمایندگی JSON 
{
  "inspectionResult": {
    object (UrlInspectionResult)
  }
}
فیلدها
inspectionResult

object ( UrlInspectionResult )

نتایج بازرسی URL

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.