ההנחה היא שאתם מכירים את המדריכים למפתחים בנושא עיצוב מבוסס-משאבים ושמות של משאבים, והדף הזה משלים אותם עם פרטי הטמעה ספציפיים של Google Ads API.
עיצוב מבוסס-משאבים
באופן כללי, Google Ads API מבוסס על עיצוב ממוקד משאבים, שמעוצב כאוספים של משאבים שניתן לגשת אליהם בנפרד (שמות העצם של ה-API). ההפניה למשאבים מתבצעת באמצעות שמות המשאבים, והם מטופלים באמצעות קבוצה קטנה של שיטות (שנקראות גם פעלים או פעולות). שמות המשאבים והשיטות האלה, בשילוב עם קידומת ספציפית של גרסת API, מרכיבים את כתובות ה-URL של ממשק ה-REST. לדוגמה, אפשר לפרק את כתובת ה-URL לדוגמה הזו לרכיבים נפרדים לפי הטבלה הבאה:
https://googleads.googleapis.com/v26/customers/1234567890:mutate
| קידומת של גרסת ה-API | שם המשאב (יחסי) | שיטה |
|---|---|---|
https://googleads.googleapis.com/v26
|
customers/1234567890
|
mutate
|
לכל כתובות ה-URL של REST בגרסה מסוימת של ה-API (למשל, v26) יש קידומת משותפת של גרסת ה-API. שם המשאב והשיטה ביחד מזהים לאיזה שירות API מתבצעת הקריאה.
ב-Google Ads API נעשה שימוש נרחב בשיטות בהתאמה אישית, בניגוד לרוב ממשקי ה-API בארכיטקטורת REST שמשתמשים בשיטות 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 שקריא למכונה.