בדף הזה מניחים שיש לכם היכרות עם המדריכים למפתחים בנושא עיצוב מבוסס-משאבים ושמות משאבים, ומוסיפים להם פרטים ספציפיים על ההטמעה של Google Ads API.
עיצוב מבוסס-משאבים
באופן כללי, Google Ads API מבוסס על עיצוב ממוקד משאבים, שמורכב מאוספים של משאבים שניתן להתייחס אליהם בנפרד (שמות העצם של ה-API). המשאבים מפנים לשמות המשאבים שלהם ומטפלים בהם באמצעות קבוצה קטנה של שיטות (שנקראות גם פעולות או פעלים). שמות המשאבים והשיטות האלה, בשילוב עם קידומת ספציפית של גרסת ה-API, מרכיבים את כתובות ה-URL של ממשק ה-REST. לדוגמה, אפשר לפרק את כתובת ה-URL לדוגמה לרכיבים נפרדים לפי הטבלה הבאה:
https://googleads.googleapis.com/v25/customers/1234567890:mutate
| קידומת של גרסת ה-API | שם המשאב (יחסי) | שיטה |
|---|---|---|
https://googleads.googleapis.com/v25
|
customers/1234567890
|
mutate
|
כל כתובות ה-URL של REST לגרסה מסוימת של ה-API (למשל, v25) חולקות קידומת משותפת של גרסת ה-API. שם המשאב והשיטה ביחד מזהים את שירות ה-API שאליו מתבצעת הקריאה.
ב-Google Ads API נעשה שימוש נרחב בשיטות מותאמות אישית, בניגוד לרוב ממשקי REST API שמשתמשים בשיטות REST רגילות כמו list, get, create, update ו-delete. דוגמאות לשיטות מותאמות אישית ב-Google Ads API כוללות את search, searchStream ו-mutate.
בדפים הבאים מפורטים שמות המשאבים, שיטות השירות ומוסכמות השמות ב-JSON של Google Ads API, כדי להמחיש איך משתמשים בהם יחד כדי להגדיר נקודות קצה של ממשק REST.
ניהול שגיאות
במאמר הסבר על שגיאות ב-API מוסבר איך לנתח ולנפות באגים בשגיאות שמתרחשות.
מסמך Discovery
כדי להקל על גילוי השיטות הזמינות ב-Google Ads API ולבצע אותו באופן אוטומטי, אפשר להשתמש במסמך Discovery שפורסם לכל גרסה.
היא זמינה בכתובת https://googleads.googleapis.com/$discovery/rest?version=<API_VERSION>.
לדוגמה, זהו מסמך Discovery של הגרסה העדכנית של Google Ads API.
מסמך Discovery מכיל מידע על כל השירותים, השיטות, המשאבים והישויות שמשמשים ב-Google Ads API, כמו מאמרי עזרה, אבל בפורמט JSON שניתן לקריאה על ידי מכונה.