จัดการข้อผิดพลาดของ 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 ตรวจสอบปัญหาของคุณได้

ขั้นตอนถัดไป

ก่อนหน้า
คู่มือเริ่มใช้งานฉบับย่อ
ถัดไป
ข้อผิดพลาดที่พบบ่อย