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. ביצוע: לוחצים על 'ביצוע' כדי לשלוח את הבקשה. בכלי יוצגו בקשת ה-HTTP המלאה ותגובת ה-JSON בזמן אמת מה-API.

תכונות עיקריות

  • הפעלה בזמן אמת: ביצוע פעולות search ו-mutate בזמן אמת בחשבונות הייצור או הבדיקה.
  • עיצוב מטען ייעודי (payload) בפורמט JSON: אפשר ליצור באופן אינטראקטיבי אובייקטים מורכבים בפורמט JSON לבקשות, והכלי מדגיש את שדות החובה ואת מבני הסכימה התקינים.
  • מסכות שדות: אפשר לבדוק לוגיקה של update_mask כדי לראות איך מתעדכנים משאבים חלקיים בפועל.
  • בדיקת שגיאות: אפשר לראות הודעות שגיאה מפורטות וקודים (כמו QUERY_ERROR או AUTHENTICATION_ERROR) בתגובה הגולמית כדי לאפשר ניפוי באגים מהיר יותר.
  • ייצוא קוד: אפשר לייצא פקודות curl, בקשות HTTP גולמיות או קוד JavaScript לדוגמה מהתצוגה המורחבת של API Explorer.

תרחישים לדוגמה

  • בדיקת הגדרות החשבון: אפשר לאחזר במהירות הגדרות או מטא-נתונים ברמת החשבון על ידי הפעלת בקשת get או search.
  • בדיקת מוטציות: לפני פריסת הקוד בסביבת הייצור, חשוב לוודא שהקמפיין נוצר בהצלחה או שהתקציב עודכן בהצלחה.
  • ניפוי באגים ב-GAQL: משתמשים ב-Explorer כדי להריץ מחרוזת של Google Ads Query Language ‏(GAQL) ולוודא שמבנה ה-JSON שמוחזר תואם לציפיות של האפליקציה.
  • אימות פרוטוקול: בדיקה של כותרות ה-HTTP המדויקות ושל הקינון ב-JSON שנדרשים לגרסה ספציפית של API.