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.