בדף הזה נעזרים במדריכים למפתחים בנושא עיצוב שמתמקד במשאבים ושמות משאבים, ומוסיפים להם פרטי הטמעה ספציפיים של Search Ads 360 Reporting API.
עיצוב שמתמקד במשאבים
באופן כללי, Search Ads 360 Reporting API מבוסס על תכנון שמתמקד במשאבים, ומתבסס על אוספים של משאבים שניתן לגשת אליהם בנפרד (השמות העצם של ה-API). ההפניות למשאבים נעשות באמצעות שמות המשאבים, והפעולות עליהם מתבצעות באמצעות קבוצה קטנה של שיטות (שנקראות גם פעלים או פעולות).
שמות המשאבים והשיטות האלה, בשילוב עם קידומת ספציפית של גרסת ה-API, מהווים את כתובות ה-URL של ממשק ה-REST. לדוגמה, אפשר לפרק את כתובת ה-URL הבאה לרכיבים הנפרדים האלה לפי הטבלה הבאה:
https://searchads360.googleapis.com/v0/customers/1234567890/searchAds360:search
| הקידומת של גרסת ה-API | שם המשאב (יחסי) | שיטה |
|---|---|---|
https://searchads360.googleapis.com/v0
|
customers/1234567890
|
search
|
כל כתובות ה-URL ל-REST של גרסת API מסוימת (למשל, v0) יש להם קידומת משותפת של גרסת API. השם והשיטה של המשאב מזהים יחד לאיזה שירות API מתבצעת הקריאה.
ב-Search Ads 360 Reporting API נעשה שימוש נרחב בשיטות בהתאמה אישית, בניגוד לרוב ממשקי ה-API הרגילים של REST שמשתמשים בשיטות רגילות של REST כמו list ו-get. Search Ads 360 Reporting API כולל שתי שיטות בהתאמה אישית: search ו-searchStream.
בדפים הבאים מוסבר בפירוט על שמות המשאבים, שיטות השירות וכללי השמות של JSON ב-Search Ads 360 Reporting API, כדי להמחיש איך משתמשים בהם יחד כדי להגדיר נקודות קצה של ממשק REST.