הדף הזה מבוסס על ההנחה שאתם מכירים את המדריכים למפתחים בנושא עיצוב מוכוון משאבים ושמות משאבים, והוספנו להם פרטי הטמעה ספציפיים של 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, כדי להמחיש איך משתמשים בהם יחד להגדרת נקודות קצה (endpoint) בממשק REST.