Method: index.inspect

הצגת הסטטוס של כתובת ה-URL שסופקה באינדקס או הסטטוס 'ניתן להוספה לאינדקס'. כרגע רק הסטטוס של הגרסה באינדקס Google זמין כרגע. לא ניתן לבדוק את יכולת ההוספה לאינדקס של כתובת אתר פעילה.

בקשת 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.