API Reference

ה-API של Search Console מציע את השירותים הבאים:

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

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

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

‏Method בקשת HTTP תיאור
כתובות URI ביחס ל-https://www.googleapis.com/webmasters/v3, אלא אם צוין אחרת
שאילתה POST  /sites/siteUrl/searchAnalytics/query

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

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

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

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

דוגמה לפוסט 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, אפשר לעיין בדף ייצוג משאבים.

‏Method בקשת 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, אפשר לעיין בדף ייצוג משאבים.

‏Method בקשת 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' בדף ייצוג המשאבים.

‏Method בקשת HTTP תיאור
URI ביחס ל-https://searchconsole.googleapis.com/v1
index.inspect POST /urlInspection/index:inspect

מידע על כתובת ה-URL שסופקה באינדקס של Google.

דוגמה לפוסט JSON:
POST https://searchconsole.googleapis.com/v1/urlInspection/index:inspect
{
  "inspectionUrl": "https://www.example.com/mypage",
  "siteUrl": "https://www.example.com/",
  "languageCode": "en-US"}