มีหลักการมากมายที่คุณควรปฏิบัติตามเมื่อใช้ Google เอกสาร API ซึ่งรวมถึงการใช้งานดังต่อไปนี้
- แก้ไขย้อนหลังเพื่อประสิทธิภาพ
- วางแผนสำหรับการทำงานร่วมกัน
- ตรวจสอบว่าสถานะสอดคล้องกับ
WriteControl
ส่วนต่อไปนี้จะอธิบายหลักการเหล่านี้
แก้ไขย้อนหลังเพื่อประสิทธิภาพ
ภายในการเรียกใช้เมธอด BatchUpdate ครั้งเดียว ให้เรียงลำดับคำขอตามลำดับจากมากไปน้อยของตำแหน่งดัชนี ทำให้ไม่ต้องคำนวณการเปลี่ยนแปลงดัชนีเนื่องจากการแทรกและการลบ
วางแผนสำหรับการทำงานร่วมกัน
คาดว่าสถานะของเอกสารจะเปลี่ยนแปลง ระหว่างการเรียกใช้วิธีการหนึ่งกับอีกวิธี ผู้ทำงานร่วมกันคนอื่นๆ อาจอัปเดตเอกสารตามที่แสดงในแผนภาพต่อไปนี้
ซึ่งอาจทำให้เกิดข้อผิดพลาดหากดัชนีไม่ถูกต้อง เมื่อมีผู้ใช้หลายคนแก้ไขเอกสารโดยใช้ UI ทาง Google เอกสารจะดูแลเรื่องนี้อย่างโปร่งใส แต่เนื่องจากเป็นไคลเอ็นต์ API ที่แอปของคุณต้องจัดการ แม้ว่าคุณจะไม่ได้คาดหวังที่จะทำงานร่วมกันในเอกสาร แต่สิ่งสำคัญคือต้องตั้งโปรแกรมเพื่อป้องกันปัญหาและตรวจสอบให้แน่ใจว่าสถานะของเอกสารยังคงสอดคล้องกัน โปรดอ่านส่วน WriteControl ด้านล่างเพื่อตรวจสอบความสอดคล้อง 1 วิธี
ตรวจสอบว่าสถานะตรงกับ WriteControl
เมื่ออ่านและอัปเดตเอกสารแล้ว คุณสามารถตรวจสอบว่าไม่มีการอัปเดตเอกสารได้โดยใช้ช่อง WriteControl ในเมธอด BatchUpdate วิธีนี้ช่วยให้คุณแก้ไขเอกสารได้เฉพาะในกรณีที่ไม่มีการเปลี่ยนแปลงเวอร์ชันเท่านั้น โดยมีวิธีการใช้งานดังนี้
- รับเอกสารและบันทึกสตริง
revisionIdที่รวมอยู่ในเอกสาร - เขียนคำขออัปเดต
- รวมออบเจ็กต์
WriteControlที่มีการตั้งค่า requiredRevisionId เป็นสตริงที่คุณบันทึกไว้ - เมื่อเรียกใช้
BatchUpdateหากการแก้ไขเอกสารมีการเปลี่ยนแปลง จะแสดงข้อผิดพลาดและไม่ทำการอัปเดต