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