การกำหนดเวอร์ชันเชิงความหมาย
Google Ads API ใช้การกำหนดเวอร์ชันเชิงความหมายที่มีหมายเลขเวอร์ชันหลักและ
หมายเลขเวอร์ชันย่อย โดยจะเขียนเวอร์ชันเป็น MAJOR.MINOR หรือ vMAJOR.MINOR
เช่น v25.0 (หรือ v25) เป็นเวอร์ชันหลัก ส่วน v25.1 เป็นเวอร์ชันย่อย
ดูรายละเอียดเกี่ยวกับเวอร์ชันปัจจุบันและเวอร์ชันที่ผ่านมาได้ที่บันทึกประจำรุ่น
เวอร์ชันหลัก
เวอร์ชันการเปิดตัวหลักจะมีการเปลี่ยนแปลงที่ส่งผลกับส่วนอื่นในระบบและไม่เข้ากันแบบย้อนหลัง การเปิดตัวเวอร์ชันหลักครั้งแรกจะลงท้ายด้วย 0 (vX.0 หรือ vX โดยที่ X คือ
หมายเลขเวอร์ชันหลัก)
แต่ละเวอร์ชันหลักจะมีเส้นทาง REST และ gRPC แยกกัน (vX) ซึ่งไม่มี
คำต่อท้ายของเวอร์ชันย่อย ใน URL ต่อไปนี้ X คือหมายเลขเวอร์ชันหลัก (เช่น v25)
https://googleads.googleapis.com/vX
หากคุณอัปเกรดจากเวอร์ชันหลักที่เก่ากว่า โค้ดอาจต้องมีการเปลี่ยนแปลง เมื่อเปลี่ยนไปใช้ปลายทางเวอร์ชันหลักใหม่ หากคุณใช้ไลบรารีของไคลเอ็นต์ โปรดอัปเกรดเป็นรุ่นไลบรารีของไคลเอ็นต์ ที่รองรับเวอร์ชันหลักใหม่ เมื่อมีการเปิดตัวเวอร์ชันหลัก เราจะ จัดทำคู่มือการอัปเกรดเพื่อช่วยคุณแก้ไขการเปลี่ยนแปลงที่ทำให้เกิดข้อขัดข้อง ในโค้ด
ตัวอย่างของการเปลี่ยนแปลงที่ส่งผลกับส่วนอื่นในระบบ ได้แก่
- การนำออกหรือการเปลี่ยนชื่อบริการ อินเทอร์เฟซ ฟิลด์ เมธอด หรือค่า Enum
- การเปลี่ยนประเภทของฟิลด์
- การเปลี่ยนรูปแบบชื่อทรัพยากร
- การเปลี่ยนรูปแบบ URL ในคำจำกัดความ HTTP
- การเปลี่ยนรูปแบบเอาต์พุต เช่น การเปลี่ยนค่าเริ่มต้น
- เปลี่ยนสาเหตุของข้อผิดพลาดที่ส่งคืนจาก A เป็น B
เวอร์ชันย่อย
เวอร์ชันย่อยจะมีการเปลี่ยนแปลงที่เข้ากันได้แบบย้อนหลังเท่านั้น สำหรับเวอร์ชันย่อย
vMAJOR.MINOR จะมีหมายเลข MINOR มากกว่า 0 (เช่น
v25.1)
เมื่อมีการเผยแพร่เวอร์ชันย่อย ระบบจะอัปเดตปลายทางเวอร์ชันหลักที่มีอยู่
(https://googleads.googleapis.com/vX) โดยอัตโนมัติ คุณไม่จำเป็นต้องเปลี่ยนเส้นทางเวอร์ชันใน URL ของปลายทาง และโค้ดที่มีอยู่จะยังคงทำงานต่อไปได้โดยไม่หยุดชะงัก
เวอร์ชันย่อยจะเพิ่มฟีเจอร์หรือการอัปเดตที่ไม่ส่งผลต่อโค้ดที่มีอยู่ หากต้องการใช้ฟิลด์หรือฟีเจอร์จากเวอร์ชันย่อยด้วยไลบรารีของไคลเอ็นต์ ให้อัปเกรดไลบรารีของไคลเอ็นต์เป็นรุ่นที่มีคำจำกัดความเวอร์ชันย่อย
การเลิกใช้งานและการสิ้นสุดการให้บริการ
Google Ads API เวอร์ชันเก่าจะถูกเลิกใช้งานเป็นระยะๆ และจะหยุดให้บริการในภายหลัง
- เลิกใช้งานแล้ว: เมื่อมีการเปิดตัวเวอร์ชันหลัก (เช่น
v25) เวอร์ชันหลักก่อนหน้าทั้งหมดจะได้รับการทำเครื่องหมายว่าเลิกใช้งานแล้ว การเรียก API ไปยังเวอร์ชันที่เลิกใช้งานแล้วจะยังคงสำเร็จจนถึงวันที่เลิกใช้งาน และการเปิดตัวไลบรารีของไคลเอ็นต์ที่มีอยู่จะยังคงรองรับเวอร์ชันเหล่านั้นต่อไป แม้ว่าการเปิดตัวไลบรารีของไคลเอ็นต์ในภายหลังจะละเว้นเวอร์ชัน API ที่เลิกใช้งานแล้วเพื่อลดขนาดแพ็กเกจ - หยุดให้บริการ: ระบบจะปิดใช้เวอร์ชันในวันที่หยุดให้บริการ และการเรียก API ทั้งหมดไปยัง ปลายทางของเวอร์ชันนั้นจะล้มเหลว
เราจะโพสต์ประกาศในบล็อกสำหรับนักพัฒนาแอปล่วงหน้าก่อนที่จะหยุดให้บริการเวอร์ชัน ดูกำหนดเวลาการเลิกใช้งานและการหยุดให้บริการสำหรับ วันที่เลิกใช้งาน วันที่หยุดให้บริการตามกำหนด และวันที่ใช้งานอยู่