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