דרישות מוקדמות

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

קבל חשבון Google

אתם צריכים חשבון Google כדי להשתמש ב-API הזה. לחשבון שלך צריכה להיות ההרשאה המתאימה ב-Search Console בנכס נתון כדי להפעיל את השיטה הזו בנכס הזה. לדוגמה, כדי להריץ את הפונקציה searchAnalytics.query צריכות להיות לכם הרשאות קריאה בנכס הזה.

כדאי לנסות את Google Search Console

מאמרי העזרה של ה-API מתבססים על ההנחה שכבר השתמשתם ב-Google Search Console ושאתם מכירים את מושגי התכנות באינטרנט ואת הפורמטים של נתוני האתרים.

אם לא השתמשתם ב-Google Search Console, לפני שתתחילו לתכנת כדאי לנסות את ממשק המשתמש. כל API מייצג את הפונקציונליות של דוח ב-Search Console. חשוב לקרוא את התיעוד של הדוח המקביל לפני שמשתמשים ב-API כדי להבין את הנתונים שמתקבלים.

יצירת פרויקט ופרטי כניסה עבור הלקוח

כדי לשלוח בקשות ל-Google Search Console, עליך לעדכן את Google על הלקוח ולהפעיל את הגישה ל-API. לשם כך, צריך ליצור פרויקט (שהוא אוסף של הגדרות ופרטי גישה ל-API) ב-Google API Console, ולרשום את האפליקציה.

כל ממשקי ה-API של Search Console מלבד Testing Tools API מחייבים פרטי כניסה מסוג OAuth2. המדריכים למתחילים של Python ו-Java מספקים פרטים על יצירת פרויקט ועל קבלת פרטי כניסה ללקוח.

העקרונות הבסיסיים של REST

יש שתי דרכים להפעיל את ה-API:

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

העקרונות הבסיסיים של REST

‏REST הוא סגנון של ארכיטקטורת תוכנה שמציע תפיסה נוחה ועקבית לבקשת נתונים ולשינוי שלהם.

המונח REST הוא קיצור של Representational State Transfer. בהקשר של Google APIs,‏ REST מתייחס לשימוש בפעלים של HTTP כדי לאחזר ולשנות ייצוגים של נתונים ש-Google מאחסנת.

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

בממשקי RESTful API של Google, הלקוח מציין פעולה באמצעות פועל של HTTP כמו POST, GET, PUT או DELETE. הוא מציין משאב לפי URI ייחודי גלובלי, באופן הבא:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

מכיוון שלכל משאבי ה-API יש מזהה URI ייחודי שאפשר לגשת אליו באמצעות HTTP,‏ ב-REST אפשר לשמור נתונים במטמון והוא מותאם לעבודה עם התשתית המבוזרת של האינטרנט.

תוכלו להיעזר בהגדרות השיטה במסמכי התיעוד של תקני HTTP 1.1 – הן כוללות מפרטים עבור GET, POST, PUT ו-DELETE.

REST ב-Google Search Console API

הפעולות של Google Search Console API ממופות ישירות לפעלים מסוג REST HTTP.

הפורמט של רוב מזהי ה-URI של Google Search Console API הוא בערך כך:

VERB https://www.googleapis.com/webmasters/v3/resourcePath?parameters

הקבוצה המלאה של מזהי URI לפעולים שמשמשים לכל שיטה מופיעה בסקירה הכללית של Google Search Console API.

העקרונות הבסיסיים של JSON

Google Search Console API מחזיר נתונים בפורמט JSON.

JSON‏ (JavaScript Object Notation) הוא פורמט נתונים נפוץ בלתי תלוי בשפה, שמספק ייצוג טקסט פשוט של מבני נתונים שרירותיים. למידע נוסף: json.org.