จัดการข้อผิดพลาดของ API

Calendar API จะแสดงข้อมูลข้อผิดพลาด 2 ระดับ ดังนี้

• รหัสและข้อความแสดงข้อผิดพลาด HTTP ในส่วนหัว
• ออบเจ็กต์ JSON ในเนื้อหาการตอบกลับพร้อมรายละเอียดเพิ่มเติมที่จะช่วยคุณกำหนดวิธีจัดการข้อผิดพลาด

ส่วนที่เหลือของหน้านี้จะแสดงข้อมูลอ้างอิงเกี่ยวกับข้อผิดพลาดของ Calendar พร้อมคำแนะนำเกี่ยวกับวิธีจัดการข้อผิดพลาดเหล่านั้นในแอป

เราขอแนะนำอย่างยิ่ง ให้ทดสอบ การจัดการข้อผิดพลาดของแอปพลิเคชันในสภาพแวดล้อมจริง

ใช้ Exponential Backoff

เอกสารประกอบของ Cloud APIs อธิบาย Exponential Backoff และวิธีใช้กับ Google APIs ได้อย่างละเอียด

ข้อผิดพลาดและการดำเนินการที่แนะนำ

ส่วนนี้จะแสดงการแสดง JSON ที่สมบูรณ์ของข้อผิดพลาดแต่ละรายการและการดำเนินการที่แนะนำที่คุณอาจใช้เพื่อจัดการข้อผิดพลาด

400: คำขอไม่ถูกต้อง

ข้อผิดพลาดของผู้ใช้ ซึ่งอาจหมายความว่าไม่มีการระบุฟิลด์หรือพารามิเตอร์ที่จำเป็น ค่าที่ระบุไม่ถูกต้อง หรือการรวมกันของฟิลด์ที่ระบุไม่ถูกต้อง

{
 "error": {
  "errors": [
   {
    "domain": "calendar",
    "reason": "timeRangeEmpty",
    "message": "The specified time range is empty.",
    "locationType": "parameter",
    "location": "timeMax",
   }
  ],
  "code": 400,
  "message": "The specified time range is empty."
 }
}

การดำเนินการที่แนะนำ: เนื่องจากเป็นข้อผิดพลาดถาวร จึงไม่ควรลองอีกครั้ง ให้อ่านข้อความแสดงข้อผิดพลาดและเปลี่ยนคำขอตามนั้น

401: ข้อมูลเข้าสู่ระบบไม่ถูกต้อง

ส่วนหัวการให้สิทธิ์ไม่ถูกต้อง โทเค็นเพื่อการเข้าถึงที่คุณใช้อยู่หมดอายุแล้วหรือไม่ถูกต้อง

{
 "error": {
  "errors": [
   {
    "domain": "global",
    "reason": "authError",
    "message": "Invalid Credentials",
    "locationType": "header",
    "location": "Authorization",
   }
  ],
  "code": 401,
  "message": "Invalid Credentials"
 }
}

การดำเนินการที่แนะนำมีดังนี้

• รับโทเค็นเพื่อการเข้าถึงใหม่โดยใช้โทเค็นการรีเฟรชที่มีอายุการใช้งานยาวนาน
• หากดำเนินการไม่สำเร็จ ให้แนะนำผู้ใช้ให้ทำตามขั้นตอน OAuth ตามที่อธิบายไว้ใน หัวข้อการให้สิทธิ์คำขอด้วย OAuth 2.0
• หากคุณเห็นข้อผิดพลาดนี้สำหรับบัญชีบริการ ให้ตรวจสอบว่าคุณได้ ทำตามขั้นตอนทั้งหมดใน หน้าบัญชีบริการเรียบร้อยแล้ว

403: เกินขีดจำกัดอัตราของผู้ใช้

ถึงขีดจำกัดรายการใดรายการหนึ่งจาก Developer Console แล้ว

{
 "error": {
  "errors": [
   {
    "domain": "usageLimits",
    "reason": "userRateLimitExceeded",
    "message": "User Rate Limit Exceeded"
   }
  ],
  "code": 403,
  "message": "User Rate Limit Exceeded"
 }
}

การดำเนินการที่แนะนำมีดังนี้

• ตรวจสอบว่าแอปเป็นไปตามแนวทางปฏิบัติแนะนำจาก หัวข้อจัดการโควต้า
• เพิ่มโควต้าต่อผู้ใช้ในโปรเจ็กต์ Developer Console
• หากผู้ใช้รายหนึ่งส่งคำขอจำนวนมากในนามของผู้ใช้บัญชี Google Workspace หลายราย ให้พิจารณา ใช้บัญชีบริการที่มีการมอบสิทธิ์ทั่วทั้งโดเมน และตั้งค่าพารามิเตอร์ quotaUser
• ใช้ Exponential Backoff

403: เกินขีดจำกัดอัตรา

ผู้ใช้ส่งคำขอถึงอัตราการส่งคำขอสูงสุดต่อปฏิทินหรือต่อผู้ใช้ที่ตรวจสอบสิทธิ์แล้วของ Google ปฏิทิน API

{
 "error": {
  "errors": [
   {
    "domain": "usageLimits",
    "reason": "rateLimitExceeded",
    "message": "Rate Limit Exceeded"
   }
  ],
  "code": 403,
  "message": "Rate Limit Exceeded"
 }
}

การดำเนินการที่แนะนำ: ข้อผิดพลาด rateLimitExceeded อาจแสดงรหัสข้อผิดพลาด 403 หรือ 429 ซึ่งปัจจุบันมีฟังก์ชันการทำงานที่คล้ายกันและควรตอบสนอง ในลักษณะเดียวกันโดยใช้ Exponential Backoff นอกจากนี้ ให้ตรวจสอบว่าแอปเป็นไปตามแนวทางปฏิบัติแนะนำจาก หัวข้อจัดการโควต้า

403: การใช้งานปฏิทินเกินขีดจำกัด

ผู้ใช้ใช้งานถึงขีดจำกัดรายการใดรายการหนึ่งของ Google ปฏิทิน ที่กำหนดไว้เพื่อปกป้องผู้ใช้และโครงสร้างพื้นฐานของ Google จากพฤติกรรมการละเมิด

{
 "error": {
  "errors": [
   {
    "domain": "usageLimits",
    "message": "Calendar usage limits exceeded.",
    "reason": "quotaExceeded"
   }
  ],
  "code": 403,
  "message": "Calendar usage limits exceeded."
 }
}

การดำเนินการที่แนะนำมีดังนี้

• อ่านข้อมูลเพิ่มเติมเกี่ยวกับขีดจำกัดการใช้งานปฏิทินใน ความช่วยเหลือสำหรับผู้ดูแลระบบ Google Workspace

403: ไม่ได้รับอนุญาตสำหรับผู้ที่ไม่ใช่ผู้จัด

คำขออัปเดตกิจกรรมพยายามตั้งค่าพร็อพเพอร์ตี้กิจกรรมที่แชร์รายการใดรายการหนึ่งในสำเนาที่ไม่ใช่ของผู้จัด ผู้จัดเท่านั้นที่จะตั้งค่าพร็อพเพอร์ตี้ที่แชร์ (เช่น guestsCanInviteOthers, guestsCanModify หรือ guestsCanSeeOtherGuests) ได้

{
 "error": {
  "errors": [
   {
    "domain": "calendar",
    "reason": "forbiddenForNonOrganizer",
    "message": "Shared properties can only be changed by the organizer of the event."
   }
  ],
  "code": 403,
  "message": "Shared properties can only be changed by the organizer of the event."
 }
}

การดำเนินการที่แนะนำมีดังนี้

• หากคุณใช้ Events: insert, Events: import หรือ Events: update และคำขอของคุณไม่มี พร็อพเพอร์ตี้ที่แชร์ คำขอนี้จะเทียบเท่ากับการพยายามตั้งค่าพร็อพเพอร์ตี้ที่แชร์เป็น ค่าเริ่มต้น ลองใช้ Events: patch แทน
• หากคำขอมีพร็อพเพอร์ตี้ที่แชร์ ให้ตรวจสอบว่าคุณพยายามเปลี่ยนพร็อพเพอร์ตี้เหล่านี้ก็ต่อเมื่ออัปเดตสำเนาของผู้จัด

404: ไม่พบ

ไม่พบทรัพยากรที่ระบุ ซึ่งอาจเกิดขึ้นได้ในหลายกรณี ตัวอย่างเช่น

• เมื่อทรัพยากรที่ขอ (ที่มีรหัสที่ระบุ) ไม่เคยมีอยู่

• เมื่อเข้าถึงปฏิทินที่ผู้ใช้เข้าถึงไม่ได้

  { "error": { "errors": [ { "domain": "global", "reason": "notFound", "message": "Not Found" } ], "code": 404, "message": "Not Found" } }

การดำเนินการที่แนะนำ: ใช้ Exponential Backoff

409: ตัวระบุที่ขอมีอยู่แล้ว

มีอินสแตนซ์ที่มีรหัสที่ระบุอยู่ในพื้นที่เก็บข้อมูลอยู่แล้ว

{
 "error": {
  "errors": [
   {
    "domain": "global",
    "reason": "duplicate",
    "message": "The requested identifier already exists."
   }
  ],
  "code": 409,
  "message": "The requested identifier already exists."
 }
}

การดำเนินการที่แนะนำ: สร้างรหัสใหม่หากต้องการสร้างอินสแตนซ์ใหม่ หรือใช้การเรียกใช้เมธอด อัปเดต

409: เกิดความขัดแย้ง

ระบบดำเนินการตามรายการที่จัดกลุ่มไว้ภายในการดำเนินการ events.batch ไม่ได้เนื่องจากเกิดความขัดแย้งในการดำเนินการกับรายการที่จัดกลุ่มไว้ที่ขออื่นๆ

{
 "error": {
  "errors": [
   {
    "domain": "global",
    "reason": "conflict",
    "message": "Conflict"
   }
  ],
  "code": 409,
  "message": "Conflict"
 }
}

การดำเนินการที่แนะนำ: ยกเว้นรายการที่จัดกลุ่มไว้ทั้งหมดที่เสร็จสมบูรณ์แล้วและรายการที่จัดกลุ่มไว้ทั้งหมดที่ล้มเหลวอย่างแน่นอน แล้วลองอีกครั้งกับรายการที่เหลือในการดำเนินการ events.batch อื่นหรือการดำเนินการกับเหตุการณ์เดียวที่เกี่ยวข้อง

410: ไม่มีแล้ว

พารามิเตอร์ syncToken หรือ updatedMin ใช้งานไม่ได้อีกต่อไป ข้อผิดพลาดนี้อาจเกิดขึ้นได้เช่นกันหากคำขอพยายามลบกิจกรรมที่ถูกลบไปแล้ว

{
 "error": {
  "errors": [
   {
    "domain": "calendar",
    "reason": "fullSyncRequired",
    "message": "Sync token is no longer valid, a full sync is required.",
    "locationType": "parameter",
    "location": "syncToken",
    }
  ],
  "code": 410,
  "message": "Sync token is no longer valid, a full sync is required."
 }
}

หรือ

{
 "error": {
  "errors": [
   {
    "domain": "calendar",
    "reason": "updatedMinTooLongAgo",
    "message": "The requested minimum modification time lies too far in the past.",
    "locationType": "parameter",
    "location": "updatedMin",
   }
  ],
  "code": 410,
  "message": "The requested minimum modification time lies too far in the past."
 }
}

หรือ

{
 "error": {
  "errors": [
   {
    "domain": "global",
    "reason": "deleted",
    "message": "Resource has been deleted"
   }
  ],
  "code": 410,
  "message": "Resource has been deleted"
 }
}

การดำเนินการที่แนะนำ: สำหรับพารามิเตอร์ syncToken หรือ updatedMin ให้ล้างพื้นที่เก็บข้อมูลและซิงค์อีกครั้ง ดูรายละเอียดเพิ่มเติมได้ที่หัวข้อ ซิงค์ทรัพยากรอย่างมีประสิทธิภาพ สำหรับกิจกรรมที่ถูกลบไปแล้ว ไม่จำเป็นต้องดำเนินการใดๆ เพิ่มเติม

412: เงื่อนไขที่กำหนดไว้ล่วงหน้าล้มเหลว

etag ที่ระบุในส่วนหัว If-match ไม่ตรงกับ etag ปัจจุบันของทรัพยากรอีกต่อไป

{
 "error": {
  "errors": [
   {
    "domain": "global",
    "reason": "conditionNotMet",
    "message": "Precondition Failed",
    "locationType": "header",
    "location": "If-Match",
    }
  ],
  "code": 412,
  "message": "Precondition Failed"
 }
}

การดำเนินการที่แนะนำ: ดึงข้อมูลเอนทิตีอีกครั้งและใช้การเปลี่ยนแปลงอีกครั้ง ดูรายละเอียดเพิ่มเติมได้ที่ หัวข้อรับทรัพยากรเวอร์ชันที่เฉพาะเจาะจง

429: มีคำขอมากเกินไป

ข้อผิดพลาด rateLimitExceeded เกิดขึ้นเมื่อผู้ใช้ส่งคำขอมากเกินไปในช่วงเวลาที่กำหนด

{
  "error": {
    "errors": [
      {
        "domain": "usageLimits",
        "reason": "rateLimitExceeded",
        "message": "Rate Limit Exceeded"
      }
    ],
    "code": 429,
    "message": "Rate Limit Exceeded"
  }
}

การดำเนินการที่แนะนำ: ข้อผิดพลาด rateLimitExceeded อาจแสดงรหัสข้อผิดพลาด 403 หรือ 429 ซึ่งปัจจุบันมีฟังก์ชันการทำงานที่คล้ายกันและควรตอบสนอง ในลักษณะเดียวกันโดยใช้ Exponential Backoff นอกจากนี้ ให้ตรวจสอบว่าแอปเป็นไปตามแนวทางปฏิบัติแนะนำจาก หัวข้อจัดการโควต้า

500: ข้อผิดพลาดที่แบ็กเอนด์

เกิดข้อผิดพลาดที่ไม่คาดคิดขณะประมวลผลคำขอ

{
 "error": {
  "errors": [
   {
    "domain": "global",
    "reason": "backendError",
    "message": "Backend Error",
   }
  ],
  "code": 500,
  "message": "Backend Error"
 }
}

การดำเนินการที่แนะนำ: ใช้ Exponential Backoff