Method: index.inspect

الاطّلاع على الحالة المفهرَسة أو القابلة للفهرسة لعنوان URL المقدَّم. في الوقت الحالي، لا تتوفر سوى حالة الإصدار في فهرس Google، ولا يمكنك اختبار قابلية الفهرسة لعنوان URL منشور.

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON
{
  "inspectionUrl": string,
  "siteUrl": string,
  "languageCode": string
}
الحقول
inspectionUrl

string

مطلوبة. عنوان URL مؤهَّل بالكامل لفحصه يجب أن يكون ضمن الموقع الإلكتروني المحدّد في "siteUrl".

siteUrl

string

مطلوبة. عنوان URL للموقع الإلكتروني كما هو محدّد في Search Console. وتجدر الإشارة إلى أنّ المواقع الإلكترونية التي تحمل بادئة عنوان URL يجب أن تتضمّن علامة / لاحقة. أمثلة: https://www.example.com/ لموقع إلكتروني يبدأ بعنوان URL أو sc-domain:example.com لموقع إلكتروني على النطاق

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.