טיפול בשגיאות API

כששולחים בקשה אל Google Ads API, היא עלולה להיכשל מסיבות שונות. לדוגמה, יכול להיות שסיפקתם ארגומנט לא תקין, או שהגעתם למגבלה של החשבון שלכם ליצירת קמפיינים חדשים. במקרים כאלה, ה-API מחזיר שגיאה כדי להודיע לכם מה השתבש.

במדריך הזה מוסבר איך לקרוא שגיאות ב-API ולטפל בהן, כדי שתוכלו ליצור אפליקציות חזקות יותר.

מבנה השגיאה

אם אתם משתמשים באחת מספריות הלקוח שלנו, שגיאות API מוצגות כחריגים. החריגים האלה מכילים פרטים שיעזרו לכם להבין למה השגיאה התרחשה.

ה-Google Ads API מחזיר מידע על שגיאות בפורמט סטנדרטי. אם מתרחשת שגיאה, התגובה תכיל אובייקט GoogleAdsFailure. האובייקט הזה מכיל רשימה של אובייקטים נפרדים של GoogleAdsError, שכל אחד מהם מפרט שגיאה ספציפית.

כל אובייקט GoogleAdsError מספק את הפרטים הבאים:

• ‫error_code: קוד שגיאה ספציפי שמציין את סוג השגיאה, למשל AuthenticationError.NOT_ADS_USER.
• ‫message: תיאור קריא לאנשים של הסיבה להתרחשות השגיאה.
• ‫trigger: הערך שגרם לשגיאה, כמו '1234'.
• ‫location: פרטים לגבי החלק בבקשה שגרם לשגיאה, כמו שם שדה ספציפי.

בנוסף לרשימת השגיאות, GoogleAdsFailure מכיל requestId, שהוא מזהה ייחודי של בקשת ה-API שהובילה לשגיאה.

דוגמה לשגיאה

דוגמה לשגיאה בפורמט JSON. השגיאה הזו מציינת שהשדה name של ad_group באינדקס 0 חסר בבקשה.

{
  "code": 3,
  "message": "Request contains an invalid argument.",
  "details": [
    {
      "@type": "type.googleapis.com/google.ads.googleads.v22.errors.GoogleAdsFailure",
      "errors": [
        {
          "errorCode": {
            "requestError": "REQUIRED_FIELD_MISSING"
          },
          "message": "Required field is missing",
          "location": {
            "fieldPathElements": [
              {
                "fieldName": "ad_group",
                "index": 0
              },
              {
                "fieldName": "name"
              }
            ]
          }
        }
      ],
      "requestId": "unique_request_id_12345"
    }
  ]
}

איך מטפלים בשגיאות

אם נתקלתם בשגיאה, הנה השלבים שצריך לבצע:

1. בודקים את הרשימה errors: בודקים כל GoogleAdsError באובייקט GoogleAdsFailure. השגיאות יופיעו בerror_code ובmessage.
2. בודקים את location: השדה location יכול לעזור לכם לזהות באיזה חלק של הבקשה הבעיה התרחשה.
3. עיון במסמכי העזרה: לפרטים נוספים על השגיאה ועל הדרך לפתור אותה, אפשר לעיין בדף השגיאות הנפוצות או ברשימת קודי השגיאה.
4. שינוי הבקשה: בהתאם להודעת השגיאה, מתקנים את בקשת ה-API. לדוגמה, אם אתם רואים REQUIRED_FIELD_MISSING, אתם צריכים לציין את השדה הזה בבקשה.
5. רישום request_id: אם אתם לא מצליחים להבין איך לפתור שגיאה וצריכים לפנות לתמיכה דרך הפורום, עליכם לכלול את request_id. המזהה הזה עוזר למהנדסי Google לבדוק את הבעיה.

השלבים הבאים

• במאמר שגיאות נפוצות מופיעה רשימה של בעיות נפוצות והפתרונות שלהן.
• טכניקות מתקדמות יותר לטיפול בשגיאות, כולל לוגיקה של ניסיון חוזר וכשל חלקי, מפורטות במאמר הסבר על שגיאות ב-API.