לפני שמתחילים לקודד את אפליקציית הלקוח הראשונה, יש מספר פעולות שצריך לעשות, אם עדיין לא עשית זאת.
יצירת חשבון Google וקבלת הרשאות ב-Search Ads 360
כדי להשתמש ב-Search Ads 360 API, צריך חשבון Google והרשאות מתאימות שהוענקו לחשבון הזה ב-Search Ads 360:
אם עדיין אין לכם חשבון Google, עליכם ליצור חשבון.
מבקשים ממנהל סוכנות ב-Search Ads 360 ליצור משתמש Search Ads 360 בחשבון Google שלכם.
כדי להוריד דוחות, תצטרכי את הרשאת הצפייה של המפרסמים שעובדים איתם.
כדי להוסיף או לערוך המרות, נדרשת הרשאת עריכה למפרסמים שעובדים איתם. בתצורה משותפת ב-Floodlight, צריך הרשאת עריכה לכל מפרסם צאצא שרוצים להעלות אליו המרות. אין לך צורך בגישה למפרסם הראשי, וגם לא לגישה לחשבונות של ילדים משניים שאליהם לא העלית המרות. אם אתה משתמש במזהי קליקים כדי לשייך המרות לביקורים, עליך לוודא שיש לך גישת עריכה למפרסם שיצר את מזהה הקליק. אם ציינת מזהה קליק של מפרסם שאין לך גישת עריכה אליו, הבקשה לא תבוצע בהצלחה.
מנהל הסוכנויות יכול להגדיר את החשבון שלך כמשתמש מפרסם עם גישה למפרסמים ספציפיים, או להגדיר את חשבוןך לרמת גישה גבוהה יותר כגון משתמש סוכנות עם גישה לכל המפרסמים בסוכנות.
הפעלת שירות ההמרה של ממשק ה-API
אם אתם רוצים להעלות נתונים לגבי המרות, משתמש של Search Ads 360 עם הרשאות מנהל סוכנות צריך להיכנס לממשק המשתמש של Search Ads 360 ולהפעיל את שירות ההמרות של ה-API. ההוראות מפורטות במרכז העזרה של Search Ads 360.
יצירת פרויקט פרטי כניסה של מסוף ממשק Google API עבור הלקוח שלך
- הפעלת כלי ההגדרה של Google API Console.
כלי ההגדרה מספק הנחיות ליצירת פרויקט (או שימוש בפרויקט קיים), להפעלת ה-API של Search Ads 360 וליצירת פרטי כניסה בפרוטוקול OAuth 2.0. - בדף Register your application, בוחרים פרויקט קיים או בוחרים באפשרות Create a project. לאחר מכן, לוחצים על המשך.
- לאחר ההפעלה של ה-API של Google API, לוחצים על כניסה לפרטי הכניסה.
- בדף Create credentials מזינים את הפרטים הבאים:
- באיזה API נעשה שימוש?: ממשק API של Search Ads 360
- לאילו נתונים תיכנסו?: נתוני משתמשים
- לוחצים על הלחצן הבא.
עכשיו כלי ההגדרה מציע לעזור לכם ליצור מספר לקוח OAuth 2.0.
- מבצעים את שאר השלבים בכלי ההגדרה.
התקנת sa360Api.py
Search Ads 360 מספק סקריפט שירות שעוזר לפשט את תהליך הגדרת ההרשאות. אפשר להשתמש בסקריפט הזה גם כדי לשלוח ולקבל נתונים בפורמט JSON, אם רוצים לנסות לשלוח ולקבל נתונים לפני שמנסחים וכותבים אפליקציה מלאה. אפשר להעתיק הרבה מהדוגמאות בפורמט JSON באתר התיעוד הזה ולהזין אותן ישירות בסקריפט.
כדי להתקין את הסקריפט:
- להתקין את Python 2.7.
הסקריפט לא עובד עם Python. 3.x. - להתקין cURL.
- מורידים את sa360Api.zip.
- חילוץ
sa360Api.pyמ-sa360Api.zip. - הגדרת ההפעלה של
sa360Api.py.
העקרונות הבסיסיים של REST
יש שתי דרכים להפעיל API:
- שימוש בספריות לקוח.
- שליחה של בקשות HTTP וניתוח התגובות.
אם תחליטו לא להשתמש בספריות לקוח, תצטרכו להבין את העקרונות הבסיסיים של 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 ב-Search Ads 360 API
הפעולות בממשק API של Search Ads 360 ממפות ישירות לפעלים של HTTP ב-REST.
הפורמט הספציפי ל-URI של API של Search Ads 360 הוא:
https://www.googleapis.com/doubleclicksearch/v2/resourcePath?parameters
הקבוצה המלאה של כתובות ה-URI המשמשות לכל פעולה נתמכת ב-API מסוכמת בהפניות API.
העקרונות הבסיסיים של JSON
אם משתמשים ב-REST, יש להשתמש בפורמט JSON עבור גוף הבקשה. ניתן לציין שהתגובות יהיו בפורמט JSON או CSV.
JSON (JavaScript Object Notation) הוא פורמט נתונים נפוץ בלתי תלוי בשפה, שמספק ייצוג טקסט פשוט של מבני נתונים שרירותיים. למידע נוסף: json.org.