एपीआई की गड़बड़ियों को ठीक करें

Google Ads API को अनुरोध भेजने पर, वह कई वजहों से पूरा नहीं हो सकता. उदाहरण के लिए, हो सकता है कि आपने कोई अमान्य तर्क दिया हो या आपके खाते में नए कैंपेन बनाने की सीमा पूरी हो गई हो. ऐसे मामलों में, एपीआई गड़बड़ी का मैसेज दिखाता है, ताकि आपको पता चल सके कि क्या गड़बड़ी हुई है.

इस गाइड में, एपीआई से जुड़ी गड़बड़ियों को पढ़ने और उन्हें ठीक करने का तरीका बताया गया है. इससे आपको बेहतर ऐप्लिकेशन बनाने में मदद मिलेगी.

गड़बड़ी का स्ट्रक्चर

अगर हमारी किसी क्लाइंट लाइब्रेरी का इस्तेमाल किया जा रहा है, तो एपीआई से जुड़ी गड़बड़ियां अपवाद के तौर पर दिखती हैं. इन अपवादों में ऐसी जानकारी होती है जिससे आपको यह समझने में मदद मिलती है कि गड़बड़ी क्यों हुई.

Google Ads API, गड़बड़ी की जानकारी को स्टैंडर्ड फ़ॉर्मैट में दिखाता है. अगर कोई गड़बड़ी होती है, तो जवाब में GoogleAdsFailure ऑब्जेक्ट शामिल होगा. इस ऑब्जेक्ट में, अलग-अलग GoogleAdsError ऑब्जेक्ट की सूची होती है. हर ऑब्जेक्ट में किसी गड़बड़ी के बारे में जानकारी होती है.

हर GoogleAdsError ऑब्जेक्ट ये जानकारी देता है:

  • error_code: यह एक खास गड़बड़ी कोड होता है. इससे आपको गड़बड़ी के टाइप के बारे में पता चलता है. जैसे, AuthenticationError.NOT_ADS_USER.
  • message: गड़बड़ी होने की वजह के बारे में ऐसी जानकारी जिसे आसानी से समझा जा सके.
  • trigger: वह वैल्यू जिसकी वजह से गड़बड़ी हुई है. जैसे, "1234".
  • location: अनुरोध के किस हिस्से की वजह से गड़बड़ी हुई, जैसे कि किसी फ़ील्ड का नाम.

गड़बड़ियों की सूची के अलावा, GoogleAdsFailure में requestId शामिल होता है. यह एपीआई अनुरोध के लिए एक यूनीक आइडेंटिफ़ायर होता है. इस अनुरोध में गड़बड़ी हुई थी.

गड़बड़ी का उदाहरण

यहां JSON फ़ॉर्मैट में गड़बड़ी का एक उदाहरण दिया गया है. इस गड़बड़ी से पता चलता है कि अनुरोध में, इंडेक्स 0 पर मौजूद ad_group का name फ़ील्ड मौजूद नहीं है.

{
  "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 सूची की जांच करें: GoogleAdsFailure ऑब्जेक्ट में मौजूद हर GoogleAdsError को देखें. error_code और message से आपको पता चलेगा कि क्या गड़बड़ी हुई है.
  2. location की जांच करें: location फ़ील्ड से, आपको यह पता लगाने में मदद मिल सकती है कि आपके अनुरोध में समस्या कहां हुई है.
  3. दस्तावेज़ देखें: गड़बड़ी के खास कोड के बारे में जानने के लिए, आम तौर पर होने वाली गड़बड़ियों वाला पेज या गड़बड़ी के कोड का पूरा रेफ़रंस देखें. इससे आपको गड़बड़ी के बारे में ज़्यादा जानकारी मिलेगी और उसे ठीक करने का तरीका पता चलेगा.
  4. अनुरोध में बदलाव करना: गड़बड़ी के मैसेज के आधार पर, अपने एपीआई अनुरोध को ठीक करें. उदाहरण के लिए, अगर आपको REQUIRED_FIELD_MISSING दिखता है, तो पक्का करें कि आपने अपने अनुरोध में वह फ़ील्ड दिया हो.
  5. request_id लॉग करें: अगर आपको किसी गड़बड़ी को ठीक करने का तरीका नहीं मिल रहा है और आपको फ़ोरम के ज़रिए सहायता टीम से संपर्क करना है, तो request_id शामिल करें. इस आईडी से, Google के इंजीनियरों को आपकी समस्या की जांच करने में मदद मिलती है.

अगले चरण