בדף הזה נדרש להכיר את המדריכים למפתחים בנושא עיצוב שמבוסס על משאבים ושמות משאבים, ומוסיפים להם פרטי הטמעה ספציפיים של Google Ads API.
עיצוב שמתמקד במשאבים
באופן כללי, Google Ads API מבוסס על תכנון שמתמקד במשאבים, שמודל כאוספים של משאבים שניתן לגשת אליהם בנפרד (השמות העצם של ה-API). ההפניות למשאבים נעשות באמצעות שמות המשאבים, והפעולות עליהם מתבצעות באמצעות קבוצה קטנה של שיטות (שנקראות גם פעלים או פעולות).
שמות המשאבים והשיטות האלה, בשילוב עם קידומת ספציפית של גרסת ה-API, מהווים את כתובות ה-URL של ממשק ה-REST. לדוגמה, אפשר לפרק את כתובת ה-URL הבאה לרכיבים הנפרדים האלה לפי הטבלה הבאה:
https://googleads.googleapis.com/v18/customers/1234567890:mutate
| הקידומת של גרסת ה-API | שם המשאב (יחסי) | שיטה |
|---|---|---|
https://googleads.googleapis.com/v18
|
customers/1234567890
|
mutate
|
כל כתובות ה-URL ל-REST של גרסת API מסוימת (למשל, v18) יש להם קידומת משותפת לגרסאות ה-API. השם והשיטה של המשאב מזהים יחד לאיזה שירות API מתבצעת הקריאה.
ב-Google Ads API נעשה שימוש נרחב בשיטות בהתאמה אישית, בניגוד לרוב ממשקי ה-API הרגילים ל-REST שמשתמשים בשיטות רגילות של REST כמו list, get, create, update ו-delete. דוגמאות לשיטות בהתאמה אישית ב-Google Ads API הן search, searchStream ו-mutate.
בדפים הבאים מוסבר בפירוט על שמות המשאבים, שיטות השירות וכללי השמות של JSON ב-Google Ads API, כדי להמחיש איך משתמשים בהם יחד כדי להגדיר נקודות קצה של ממשק REST.