Google Docs API ช่วยให้คุณสร้างและแก้ไขเอกสารได้
แอปสามารถทํางานร่วมกับ Docs API เพื่อสร้างเอกสารที่สวยงามจากทั้งข้อมูลผู้ใช้และข้อมูลที่ได้จากระบบ API ช่วยให้คุณทําสิ่งต่อไปนี้ได้
- ทําให้กระบวนการทํางานโดยอัตโนมัติ
- สร้างเอกสารพร้อมกันหลายรายการ
- สร้างใบแจ้งหนี้หรือสัญญา
ภาพรวมของ API
ทรัพยากรเอกสารมีเมธอดที่คุณใช้เพื่อเรียกใช้ API ของเอกสาร
เมธอดของ API
คุณสามารถใช้วิธีการต่อไปนี้เพื่อสร้าง อ่าน และอัปเดตเอกสารของ Google เอกสารได้
- ใช้ documents.create เพื่อสร้างเอกสาร
- ใช้ documents.get เพื่อเรียกเนื้อหาของเอกสารที่ระบุ
- ใช้ documents.batchUpdate เพื่อดําเนินการอัปเดตชุดย่อยบนเอกสารที่ระบุ
เมธอด get และ batchUpdate ต้องใช้ documentId (ดูด้านล่าง) เป็นพารามิเตอร์เพื่อระบุเอกสารเป้าหมาย เมธอด create จะแสดงผลอินสแตนซ์ของเอกสารที่สร้าง ซึ่งคุณสามารถอ่าน ID ได้
การอัปเดตเป็นกลุ่ม
เมธอด batchUpdate จะใช้รายการออบเจ็กต์คําขอและทําการอัปเดตตามลําดับเดียวกันกับที่ปรากฏในคําขอแบบกลุ่ม การอัปเดตในกลุ่ม
จะอัปเดตแบบอะตอม กล่าวคือ หากคําขอใดไม่ถูกต้อง การอัปเดตทั้งหมดจะไม่สําเร็จ และจะไม่มีการเปลี่ยนแปลงใดๆ (ขึ้นอยู่กับกรณี)
เมธอด batchUpdate จะแสดงรายการออบเจ็กต์การตอบกลับ ออบเจ็กต์ในรายการนี้จะใช้ลําดับดัชนีเดียวกันกับคําขอที่เกี่ยวข้อง
ดูแนวทางปฏิบัติแนะนําสําหรับคําขอแบบกลุ่มเพื่อดูวิธีจัดกลุ่มการเรียก API ไว้ด้วยกัน และดูเอกสารอ้างอิง batchUpdate สําหรับประเภทคําขอและการตอบกลับ
รหัสเอกสาร
รหัสเอกสารจะอ้างอิงเอกสารซึ่งสามารถดึงมาจาก URL ได้ ดังนี้
https://docs.google.com/document/d/documentId/edit
documentId เป็นสตริงที่ไม่ซ้ํากันซึ่งประกอบด้วยตัวอักษร ตัวเลข และอักขระพิเศษบางตัว คุณสามารถใช้นิพจน์ทั่วไปต่อไปนี้ดึงรหัสเอกสารจาก URL ของ Google เอกสาร
/document/d/([a-zA-Z0-9-_]+)
หากคุณคุ้นเคยกับ Google Drive API อยู่แล้ว documentId จะสอดคล้องกับรหัสของทรัพยากรไฟล์
สถานที่ภายในเอกสาร: ดัชนี
เมื่อคุณอัปเดตเนื้อหาของเอกสาร การอัปเดตแต่ละครั้งจะเกิดขึ้นที่ตําแหน่งใดตําแหน่งหนึ่งหรือข้ามช่วงภายในเอกสาร ตําแหน่งที่ตั้งและช่วงเหล่านี้ระบุโดยใช้ดัชนี ซึ่งแสดงออฟเซ็ตภายในกลุ่มเอกสารที่มี หากต้องการเรียนรู้เพิ่มเติมเกี่ยวกับดัชนีและวิธีการใช้งานโปรดดูแนวคิดในโครงสร้างของเอกสาร Google เอกสาร
เวิร์กโฟลว์การอัปเดตเอกสาร
การสร้างและเติมข้อมูลเอกสารใหม่นั้นทําได้ง่ายเนื่องจากไม่มีเนื้อหาที่ต้องกังวลและไม่มีผู้ทํางานร่วมกันที่สามารถเปลี่ยนแปลงสถานะเอกสารได้ โดยหลักการแล้ว วิธีนี้จะทํางานตามแผนผังลําดับต่อไปนี้
การอัปเดตเอกสารที่มีอยู่จะมีความซับซ้อนมากยิ่งขึ้น ก่อนเรียกใช้เอกสารที่มีความหมายเพื่อที่จะอัปเดตเอกสาร คุณจะต้องทราบสถานะปัจจุบันของเอกสาร องค์ประกอบใดที่ทําขึ้น เนื้อหาใดอยู่ในองค์ประกอบเหล่านั้น และรายการทั้งหมดเหล่านี้อยู่ที่ใดในเอกสาร แผนภาพลําดับต่อไปนี้แสดงการทํางาน
แผนภาพนี้ไม่ถือว่าเป็นเวิร์กโฟลว์ที่ผู้ทํางานร่วมกันคนอื่นอัปเดตในเอกสารเดียวกันพร้อมกัน โปรดดูที่วางแผนสําหรับการทํางานร่วมกัน สําหรับการอภิปรายของหัวข้อนี้