הדף הזה מתבסס על ההנחה שאתם מכירים את המדריכים למפתחים בנושא עיצוב מבוסס משאבים ושמות משאבים, ומוסיף להם פרטים ספציפיים על ההטמעה של Google Ads API.
עיצוב ממוקד משאבים
באופן כללי, העיצוב של Google Ads API מבוסס על משאבים, ונבנה כאוספים של משאבים שאפשר לטפל בהם בנפרד (שמות השמות של ה-API). ההפניה למשאבים כוללת את שמות המשאבים שלהם, ומתבצעת מניפולציה שלהם באמצעות קבוצה קטנה של methods (שנקראות גם פועלים או פעולות).
שמות המשאבים וה-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. דוגמאות ל-methods בהתאמה אישית ב-Google Ads API: search, searchStream ו-mutate.
בדפים הבאים יש פרטים נוספים על שמות המשאבים, שיטות השירות והמוסכמות למתן שמות בפורמט JSON ב-Google Ads API, כדי להמחיש איך משתמשים בהם יחד כדי להגדיר נקודות קצה בממשק REST.