האפליקציה הראשונה שלך: דרישות מוקדמות

לפני שתתחילו לתכנת את אפליקציית הלקוח הראשונה, כדאי לעשות כמה פעולות – אם עדיין לא עשיתם אותן.

יצירת חשבון Google וקבלת הרשאות ל-Search Ads 360

כדי להשתמש ב-Search Ads 360 API, צריך חשבון Google והרשאות מתאימות שהוקצו לחשבון הזה מ-Search Ads 360:

  1. אם עדיין אין לך חשבון Google, צריך ליצור חשבון.

  2. אפשר לבקש ממנהל חשבון סוכנות ב-Search Ads 360 ליצור משתמש ב-Search Ads 360 לחשבון Google שלך.

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

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

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

הפעלת שירות API ההמרות

אם רוצים להעלות נתונים על המרות, משתמש ב-Search Ads 360 עם הרשאות מנהל סוכנות צריך להיכנס לממשק המשתמש של Search Ads 360 ולהפעיל את שירות ההמרות של ה-API. ההוראות מפורטות במרכז העזרה של Search Ads 360.

יצירת פרויקט ב-Google API Console ופרטי כניסה ל-OAuth עבור הלקוח

  1. פותחים את כלי ההגדרה של Google API Console.
    כלי ההגדרה מנחה אתכם בתהליך יצירת הפרויקט (או שימוש בפרויקט קיים), הפעלת Search Ads 360 API ויצירת פרטי הכניסה ל-OAuth 2.0.
  2. בדף Register your application, בוחרים פרויקט קיים או לוחצים על Create a project. לאחר מכן, לוחצים על המשך.
  3. אחרי שמפעילים את Search Ads 360 API במסוף Google API, לוחצים על הלחצן Go to credentials.
  4. בדף Create credentials, מזינים את הפרטים הבאים:
    • באיזה ממשק API אתם משתמשים?: Search Ads 360 API
    • לאילו נתונים תהיה גישה? נתוני משתמשים
  5. לוחצים על הלחצן הבא.

    כלי ההגדרה מציע עכשיו עזרה ביצירת מזהה לקוח OAuth 2.0.

  6. פועלים לפי שאר השלבים בכלי ההגדרה.

התקנה של sa360Api.py

מערכת Search Ads 360 מספקת סקריפט של כלי עזר שיעזור לכם בתהליך ההגדרה של ההרשאה. אפשר להשתמש בסקריפט הזה גם כדי לשלוח ולקבל נתונים בפורמט JSON, אם רוצים לנסות לשלוח ולקבל נתונים לפני שמתכננים וכותבים אפליקציה מלאה. אפשר להעתיק הרבה מהדוגמאות ל-JSON באתר העזרה הזה ולהזין אותן ישירות בסקריפט.

כדי להתקין את הסקריפט:

  1. מתקינים את Python 2.7.
    הסקריפט לא פועל עם Python 3.x.
  2. מתקינים את cURL.
  3. מורידים את הקובץ sa360Api.zip.
  4. חילוץ של sa360Api.py מ-sa360Api.zip.
  5. יצירת קובץ הפעלה sa360Api.py.

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

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

אם תחליטו לא להשתמש בספריות לקוח, תצטרכו להכיר את העקרונות הבסיסיים של 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 ב-Search Ads 360 API

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

הפורמט הספציפי למזהי URI של Search Ads 360 API הוא:

https://www.googleapis.com/doubleclicksearch/v2/resourcePath?parameters

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

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

אם משתמשים ב-REST, צריך להשתמש בפורמט JSON לגוף הבקשה. אפשר לציין שהתשובות יהיו בפורמט JSON או CSV.

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