Google Ads API Explorer

‫Google Ads API Explorer הוא סביבת הפעלה אינטראקקטיבית שמאפשרת ליצור ולשלוח בקשות API בזמן אמת ישירות מהדפדפן. הוא מוטמע במסמכי העיון, ומטפל במורכבויות של אימות OAuth 2.0 ועיצוב מטען ייעודי (payload) בפורמט JSON, כך שתוכלו לבדוק שירותים ושיטות ספציפיים בלי לכתוב שורת קוד אחת.

יתרונות

  • בדיקות ללא קוד: אפשר להריץ קריאות API פעילות (גם קריאות קריאה וגם קריאות כתיבה) ישירות מהתיעוד בלי להגדיר סביבת פיתוח מקומית.
  • גילוי פרוטוקולים: אפשר לראות את המבנה המדויק של בקשות ותגובות HTTP כדי להבין את התנהגות ה-API.
  • יצירת אב טיפוס עם חיכוך נמוך: אפשר לאמת את התנהגות נקודת הקצה ולבדוק תגובות גולמיות של API באופן מיידי לפני הטמעת לוגיקה באפליקציה.
  • אימות פשוט יותר: הכלי מנהל את תהליכי OAuth 2.0 באופן אוטומטי, כך שאתם יכולים להתמקד בבקשת ה-API ולא בניהול פרטי הכניסה.

תחילת העבודה

  1. עוברים לתיעוד: עוברים אל תיעוד ההפניה ובוחרים את השירות והשיטה שרוצים לבדוק, כמו GoogleAdsService/Search.
  2. פותחים את Explorer: מחפשים את החלונית 'אפשר לנסות!' בצד שמאל של הדף.
  3. מגדירים את הבקשה:
    • מזינים את פרמטרי הבקשה הנדרשים, כמו developer-token ו-login-customer-id.
    • אם השיטה דורשת מטען ייעודי (payload), כמו בפעולות mutate, צריך להגדיר את תוכן הבקשה באמצעות עורך JSON אינטראקטיבי.
  4. ביצוע: לוחצים על Execute כדי לשלוח את הבקשה. בכלי יוצגו בקשת ה-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.