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