Google Ads API Explorer הוא סביבת הפעלה אינטראקקטיבית שמאפשרת ליצור ולשלוח בקשות API בזמן אמת ישירות מהדפדפן. הוא מוטמע במסמכי העיון, ומטפל במורכבויות של אימות OAuth 2.0 ועיצוב מטען ייעודי (payload) בפורמט JSON, כך שתוכלו לבדוק שירותים ושיטות ספציפיים בלי לכתוב שורת קוד אחת.
יתרונות
- בדיקות ללא קוד: אפשר להריץ קריאות API בזמן אמת (גם קריאות קריאה וגם קריאות כתיבה) ישירות מהתיעוד בלי להגדיר סביבת פיתוח מקומית.
- גילוי פרוטוקולים: אפשר לראות את המבנה המדויק של בקשות HTTP ותגובות כדי להבין איך ה-API מתנהג.
- יצירת אב טיפוס עם חיכוך נמוך: אפשר לאמת את התנהגות נקודת הקצה ולבדוק תגובות API גולמיות באופן מיידי לפני שמטמיעים לוגיקה באפליקציה.
- אימות פשוט: הכלי מנהל את תהליכי OAuth 2.0 באופן אוטומטי, כך שאתם יכולים להתמקד בבקשת ה-API ולא בניהול פרטי הכניסה.
תחילת העבודה
- עוברים לתיעוד: עוברים אל תיעוד ההפניה ובוחרים את השירות והשיטה שרוצים לבדוק, למשל
GoogleAdsService/Search. - פותחים את Explorer: מחפשים את החלונית 'אפשר לנסות!' בצד שמאל של הדף.
- מגדירים את הבקשה:
- מזינים את פרמטרי הבקשה הנדרשים, כמו
developer-tokenו-login-customer-id. - אם השיטה דורשת מטען ייעודי (payload), כמו בפעולות
mutate, צריך להגדיר את תוכן הבקשה באמצעות עורך JSON אינטראקטיבי.
- מזינים את פרמטרי הבקשה הנדרשים, כמו
- ביצוע: לוחצים על 'ביצוע' כדי לשלוח את הבקשה. בכלי יוצגו בקשת ה-HTTP המלאה ותגובת ה-JSON בזמן אמת מה-API.
תכונות עיקריות
- הפעלה בזמן אמת: ביצוע פעולות
searchו-mutateבזמן אמת בחשבונות הייצור או הבדיקה. - עיצוב מטען ייעודי (payload) בפורמט JSON: אפשר ליצור באופן אינטראקטיבי אובייקטים מורכבים בפורמט JSON לבקשות, והכלי מדגיש את שדות החובה ואת מבני הסכימה התקינים.
- מסכות שדות: אפשר לבדוק לוגיקה של
update_maskכדי לראות איך מתבצעים בפועל עדכונים חלקיים של משאבים. - בדיקת שגיאות: אפשר לראות הודעות שגיאה מפורטות וקודים (כמו
QUERY_ERRORאוAUTHENTICATION_ERROR) בתגובה הגולמית כדי לאפשר ניפוי באגים מהיר יותר. - ייצוא קוד: ייצוא פקודות
curl, בקשות HTTP גולמיות או קוד JavaScript לדוגמה מהתצוגה המורחבת של API Explorer.
תרחישים לדוגמה
- בדיקת הגדרות החשבון: אפשר לאחזר במהירות הגדרות או מטא-נתונים ברמת החשבון על ידי הפעלת בקשת
getאוsearch. - בדיקת מוטציות: לפני שמפעילים את הקוד בסביבת הייצור, חשוב לוודא שהקמפיין נוצר בהצלחה או שהתקציב עודכן בהצלחה.
- ניפוי באגים ב-GAQL: משתמשים בכלי לבדיקת שאילתות כדי להריץ מחרוזת של Google Ads Query Language (GAQL) ולוודא שמבנה ה-JSON שמוחזר תואם למה שמצפים מהאפליקציה.
- אימות פרוטוקול: בדיקה של כותרות ה-HTTP המדויקות ושל הקינון ב-JSON שנדרשים לגרסה ספציפית של API.