רקע

לפני שמתחילים

1. צריך לבקש מאיש הקשר להגדיר הרשאות מתאימות לחשבונות שהאפליקציה שלך תוכל לגשת אליהם.
2. אם אתם לא מכירים את המושגים של Authorized Buyers, כדאי לבקר במרכז העזרה של Authorized Buyers ולהתנסות בממשק המשתמש. אם האפליקציה צפויה לבצע בידינג בזמן אמת, כדאי לקרוא את התיעוד של פרוטוקול RTB.
3. כדי להגדיר פרויקט חדש, צריך להיכנס ל-APIs Console. יש להיכנס לחשבון Google של המפתח או ליצור חשבון. תופיע בקשה ליצור פרויקט ולחתום על כמה תנאים והגבלות.

חשבונות הורה וחשבונות צאצא

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

חשבונות צאצא

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

חשבונות הורה

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

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

מודל הנתונים ל-API ל-REST

משאב הוא ישות נתונים נפרדת שיש לה מזהה ייחודי. המשאב Accounts מייצג רשומה בחשבון Authorized Buyers, והוא סיווג הנתונים השורש של Ad Exchange Buyer API. השיטות של ה-API פועלות על משאבים נפרדים של חשבונות Google ועל אוספים של משאבים של חשבונות.

משאב Accounts כולל: מספר חשבון, מידע המשמש להתאמה של קובצי cookie, המיקומים של מגישי הצעות המחיר, כתובת ה-URL שאליה נשלחות הבקשות להצעות מחיר, ובקשה לציין את מספר השאילתות המקסימלי לשנייה שיישלחו על ידי ה-Ad Exchange.

בנוסף למשאבים ולאיסוף של החשבונות, מבני הנתונים הבאים מוגדרים על ידי Ad Exchange Buyer API:

מיקום מגיש הצעות המחיר

המיקומים של מגישי הצעות המחיר הם מבנים שמוחזרים באמצעות משאבים לחשבונות כדי לספק את כתובת ה-URL שאליה ה-Ad Exchange שולחים בקשות להצעות מחיר, ואת המספר המקסימלי של שאילתות לשנייה שפלטפורמת ה-Ad Exchange שולחת. הנה דוגמה למיקום של מגיש הצעות מחיר, שמבוטאת ב-JSON:

"bidderLocation": [
    {
      "url": "http://bid.url.com/bidder",
      "maximumQps": 1500
    }
  ],

פריטים

הפריטים מספקים רשימה של חשבונות. הנה דוגמה לפריטים, מבוטאים ב-JSON:

{
  "kind": "adexchangebuyer#accountsList",
  "items": [
    accounts Resource
  ]
}

פעולות נתמכות

תוכלו להפעיל שלוש שיטות שונות לאיסוף ולמשאבים ב-Ad Exchange Buyer API, כפי שמתואר בטבלה הבאה. כל הפעולות מחייבות הרשאה.

פעולה	התיאור	מיפויי HTTP של REST
list	בתיבת הדו-שיח הזו מפורטים כל החשבונות שהמשתמש המאומת יכול לגשת אליהם.	GET ב-URI של אוסף.
מקבלים	קבלת משאב ספציפי של 'חשבונות'.	GET ב-URI של משאב.
עדכון	עדכון של משאב ספציפי בחשבונות.	PUT ב-URI של משאב, שבו מעבירים נתונים של המשאב המעודכן.

סגנון שיחה

‏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 ב-Ad Exchange Buyer API

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

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

https://www.googleapis.com/adexchangebuyer/v1.4/resourceID?parameters

כאשר resourceID הוא המזהה של משאב Accounts, ו-parameters הם כל הפרמטרים שצריך להחיל על השאילתה. לפרטים נוספים, עיינו בפרמטרים סטנדרטיים של שאילתות ובמסמכי העזר.

הפורמט של תוספי הנתיב resourceID מאפשר לזהות את המשאב שבו אתם פועלים כרגע, לדוגמה:

https://www.googleapis.com/adexchangebuyer/v1.4/accounts
https://www.googleapis.com/adexchangebuyer/v1.4/accounts/id

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

הנה דוגמה לאופן שבו זה עובד ב-Ad Exchange Buyer API.

מקבלים את רשימת החשבונות של המשתמש המאומת:

GET https://www.googleapis.com/adexchangebuyer/v1.4/accounts

פורמט נתונים

JSON

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