לפני שמתחילים לקודד את אפליקציית הלקוח הראשונה, יש כמה פעולות שצריך לבצע, אם עדיין לא עשית זאת.
קבל חשבון Google
יש צורך בחשבון Google כדי ליצור פרויקט ב-Google API Console. אם כבר יש לך חשבון, הכול מוכן.
ייתכן שתרצו גם חשבון Google נפרד למטרות בדיקה.
רוצה לנסות את דוח חוויית הצופים במודעות של Google?
התיעוד של ממשק ה-API הזה מבוסס על ההנחה שהשתמשת בדוח חוויית הצופים במודעות של Google ושאתם מכירים את המושגים 'תכנות אינטרנט' ואת הפורמטים של נתוני האתר.
אם עדיין לא השתמשתם בדוח חוויית הצופים במודעות ב-Google, כדאי לנסות את ממשק המשתמש לפני שמתחילים לקוד.
יצירת פרויקט עבור הלקוח
לפני שתוכלו לשלוח בקשות לדוח 'חוויית הצופים במודעה של Google', עליכם להודיע ל-Google לגבי הלקוח ולהפעיל את הגישה ל-API. לשם כך, משתמשים ב-Google API Console כדי ליצור פרויקט – אוסף שם של הגדרות ופרטי גישה ל-API, ולרשום את האפליקציה שלכם.
מידע בסיסי על REST
יש שתי דרכים להפעיל את ה-API:
- שליחת בקשות HTTP וניתוח התגובות.
- שימוש בספריות לקוח.
אם תחליטו לא להשתמש בספריות לקוח, תצטרכו להבין את העקרונות הבסיסיים של REST.
REST הוא סגנון של ארכיטקטורת תוכנה שמספק גישה נוחה ועקבית לבקשת נתונים ולשינוים.
המונח REST הוא ראשי תיבות של "Transfer and State State Transfer." בהקשר של Google APIs, הכוונה היא להשתמש בפעלים מסוג HTTP כדי לאחזר ולשנות ייצוגים של נתונים המאוחסנים על ידי Google.
במערכת RESTful, משאבים מאוחסנים במאגר נתונים; לקוח שולח בקשה שהשרת מבצע פעולה מסוימת (כגון יצירה, אחזור, עדכון או מחיקה של משאב), והשרת מבצע את הפעולה ושולח תגובה, לעיתים קרובות בצורת ייצוג של המשאב שצוין.
בממשקי ה-API של RESTful של 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 Ad Experience Report API
מיפוי הפעולות של ממשק ה-API לדוח חוויית המשתמש של Google Ads מתבצע ישירות לפעלים מסוג HTTP של REST.
הפורמטים הספציפיים ל-URI של דוח חוויית הצופים במודעות ב-Google הם:
https://adexperiencereport.googleapis.com/v1/resourcePath?parameters
הקבוצה המלאה של מזהי URI המשמשים לכל פעולה נתמכת ב-API מסוכמת במסמך Google Ad Experience Report API API.
מידע בסיסי על JSON
Google Ad Experience Report API מחזיר נתונים בפורמט JSON.
JSON (JavaScript Object Notation) הוא פורמט נתונים נפוץ שאינו תלוי בשפה, שמספק ייצוג טקסט פשוט של מבני נתונים שרירותיים. מידע נוסף זמין בכתובת json.org.