במסמך זה מתוארים השלבים שעליכם לבצע לפני כתיבת הבקשה הראשונה ללקוח.
קבל חשבון 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. ניתן לעשות זאת באמצעות מסוף Google API ליצירת פרויקט, שהוא אוסף עם שם של הגדרות ופרטי גישה ל-API, ורשום את הבקשה.
כל ממשקי ה-API של Search Console חוץ מה-API של כלי הבדיקה דורשים פרטי כניסה בפרוטוקול OAuth2. המדריכים למתחילים של Python ו-Java מספקים פרטים על האופן שבו ניתן ליצור פרויקט ולקבל את פרטי הכניסה של הלקוח.
מידע בסיסי על REST
יש שתי דרכים להפעיל API:
- שליחה של בקשות HTTP וניתוח התגובות.
- שימוש בספריות לקוח.
אם תחליטו לא להשתמש בספריות לקוח, תצטרכו להכיר את העקרונות הבסיסיים של REST.
REST - יסודות
REST הוא סגנון של ארכיטקטורת תוכנה שמציע תפיסה נוחה ועקבית לבקשת נתונים ולשינוי שלהם.
המונח REST הוא קיצור של Representational State Transfer. בהקשר של ממשקי ה-API של Google, 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
הפעולות בממשק ה-API ב-Google Search Console ממופות ישירות לפעלים מסוג HTTP מסוג REST.
הפורמט של רוב מזהי ה-URI של Google Search Console נראה כך:
VERB https://www.googleapis.com/webmasters/v3/resourcePath?parameters
המערך המלא של מזהי ה-URI והפעלים שמשמשים לכל שיטה מפורטים בסקירה הכללית על API בנושא Google Search Console.
מושגי יסוד ב-JSON
ממשק ה-API של Google Search Console מחזיר נתונים בפורמט JSON.
JSON (JavaScript Object Notation) הוא פורמט נתונים נפוץ בלתי תלוי בשפה, שמספק ייצוג טקסט פשוט של מבני נתונים שרירותיים. למידע נוסף: json.org.