ברקע

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

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

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

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

חשבונות לילדים

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

חשבונות הורה

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

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

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

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

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

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

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

המיקומים של מגישי הצעות המחיר הם מבנים שהוחזרו יחד עם משאבי החשבונות כדי לספק את כתובת ה-URL שאליה פלטפורמת המודעות צריכה לשלוח בקשות להצעות מחיר, המספר המקסימלי של שאילתות בשנייה שבורסת המודעות צריכה לשלוח. הנה דוגמה למיקום של מגיש הצעות המחיר, מבוטאת ב-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. בהקשר של 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 ב-Ad Exchange Buyer API

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

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

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

כאשר resourceID הוא המזהה של משאב החשבונות, ו-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.