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