דף זה תורגם על ידי Cloud Translation API.

API Reference

Search Console API כולל את השירותים הבאים:

ניתוח נתוני חיפוש – שאילתות על נתוני תנועת הגולשים לאתר שלכם.
קובצי Sitemap – פירוט כל קובצי ה-sitemap, בקשת מידע על sitemap ספציפי ושליחת sitemap ל-Google.
אתרים – רשימה/הוספה/הסרה של נכסים מחשבון Search Console שלכם.
בדיקת כתובות URL – בדיקת הסטטוס של דף באינדקס Google (מקביל לבדיקת כתובות URL ב-Search Console).

ניתוח חיפושים

לפרטי משאבים ב-Analytics בנושא חיפוש, אפשר לעיין בדף ייצוג משאבים.

שיטה בקשת HTTP תיאור

מזהי URI ביחס ל-https://www.googleapis.com/webmasters/v3, אלא אם צוין אחרת

שיטה	בקשת HTTP	תיאור
מזהי URI ביחס ל-https://www.googleapis.com/webmasters/v3, אלא אם צוין אחרת
שאילתה	`POST /sites/siteUrl/searchAnalytics/query`	הרצת שאילתות על נתוני תנועת החיפוש באמצעות מסננים ופרמטרים שאתם מגדירים. השיטה מחזירה אפס שורות או יותר שמקובצות לפי מפתחות השורות (מאפיינים) שהגדרתם. עליך להגדיר טווח תאריכים של יום אחד או יותר. כשתאריך הוא אחד מהמאפיינים, ימים ללא נתונים מושמטים מרשימת התוצאות. כדי לדעת באילו ימים יש נתונים, אפשר ליצור שאילתה ללא מסננים שמקובצים לפי תאריך, בטווח התאריכים הרצוי. התוצאות ממוינות לפי מספר הקליקים בסדר יורד. אם בשתי שורות יש אותו מספר קליקים, הן ממוינות באופן שרירותי. כדי להפעיל את השיטה הזו, אפשר לעיין בדוגמת python. דוגמה ל-POST בפורמט JSON: POST https://www.googleapis.com/webmasters/v3/sites/https%3A%2F%2Fwww.example.com%2F/searchAnalytics/query { "startDate": "2015-04-01", "endDate": "2015-05-01", "dimensions": ["country","device"] }

שאילתה

POST /sites/siteUrl/searchAnalytics/query

הרצת שאילתות על נתוני תנועת החיפוש באמצעות מסננים ופרמטרים שאתם מגדירים. השיטה מחזירה אפס שורות או יותר שמקובצות לפי מפתחות השורות (מאפיינים) שהגדרתם. עליך להגדיר טווח תאריכים של יום אחד או יותר.

כשתאריך הוא אחד מהמאפיינים, ימים ללא נתונים מושמטים מרשימת התוצאות. כדי לדעת באילו ימים יש נתונים, אפשר ליצור שאילתה ללא מסננים שמקובצים לפי תאריך, בטווח התאריכים הרצוי.

התוצאות ממוינות לפי מספר הקליקים בסדר יורד. אם בשתי שורות יש אותו מספר קליקים, הן ממוינות באופן שרירותי.

כדי להפעיל את השיטה הזו, אפשר לעיין בדוגמת python.

דוגמה ל-POST בפורמט JSON:

POST https://www.googleapis.com/webmasters/v3/sites/https%3A%2F%2Fwww.example.com%2F/searchAnalytics/query
{
  "startDate": "2015-04-01",
  "endDate": "2015-05-01",
  "dimensions": ["country","device"]
}

קובצי Sitemap

לפרטים על משאבי קובצי Sitemap, ראו את הדף ייצוג משאבים.

שיטה	בקשת HTTP	תיאור
מזהי URI ביחס ל-https://www.googleapis.com/webmasters/v3, אלא אם צוין אחרת
מחיקה	`DELETE /sites/siteUrl/sitemaps/feedpath`	מחיקת sitemap מהאתר הזה.
הורדה	`GET /sites/siteUrl/sitemaps/feedpath`	מאחזר מידע על sitemap ספציפי.
list	`GET /sites/siteUrl/sitemaps`	מונה את רשומות ה-Sitemap שנשלחו עבור אתר זה או כלול בקובץ האינדקס של קובצי ה-Sitemap (אם צוין `sitemapIndex` בבקשה).
הגשה	`PUT /sites/siteUrl/sitemaps/feedpath`	שליחת sitemap של אתר.

אתרים

לפרטים על משאבים של Google Sites, ראו ייצוג משאבים.

שיטה	בקשת HTTP	תיאור
מזהי URI ביחס ל-https://www.googleapis.com/webmasters/v3, אלא אם צוין אחרת
הוספה	`PUT /sites/siteUrl`	הוספת אתר לקבוצת האתרים של המשתמש ב-Search Console.
מחיקה	`DELETE /sites/siteUrl`	מסיר אתר מקבוצת האתרים של המשתמש ב-Search Console.
הורדה	`GET /sites/siteUrl`	אחזור מידע על אתר ספציפי.
list	`GET /sites`	ליצירת רשימת האתרים של המשתמש ב-Search Console.

בדיקת כתובת אתר

לקבלת פרטים על המשאב לבדיקת כתובות URL, ראו את הדף ייצוג משאבים.

שיטה	בקשת HTTP	תיאור
URI ביחס ל-https://searchconsole.googleapis.com/v1
index.inspect	`POST /urlInspection/index:inspect`	מידע על כתובת ה-URL שסופקה באינדקס Google. דוגמה ל-POST בפורמט JSON: POST https://searchconsole.googleapis.com/v1/urlInspection/index:inspect { "inspectionUrl": "https://www.example.com/mypage", "siteUrl": "https://www.example.com/", "languageCode": "en-US"}