บทนำ

Google Docs API ช่วยให้คุณสร้างและแก้ไขเอกสารได้

แอปสามารถผสานรวมกับ Docs API เพื่อสร้างเอกสารที่ดูเป็นมืออาชีพจากทั้งข้อมูลผู้ใช้และข้อมูลที่ได้จากระบบ API ช่วยให้คุณทําสิ่งต่อไปนี้ได้

  • ทําให้กระบวนการเป็นอัตโนมัติ
  • สร้างเอกสารประกอบหลายรายการพร้อมกัน
  • สร้างใบแจ้งหนี้หรือสัญญา

ภาพรวมของ API

ทรัพยากรเอกสารมีเมธอดที่คุณใช้เพื่อเรียกใช้ API ของเอกสาร

เมธอด API

วิธีสร้าง อ่าน และอัปเดตเอกสาร Google เอกสารมีดังต่อไปนี้

  • ใช้ documents.create เพื่อสร้างเอกสาร
  • ใช้ documents.get เพื่อดึงเนื้อหาของเอกสารที่ระบุ
  • ใช้ documents.batchUpdate เพื่อดําเนินการต่างๆ กับชุดการอัปเดตในเอกสารที่ระบุ

เมธอด get และ batchUpdate ต้องใช้ documentId (ดูด้านล่าง) เป็นพารามิเตอร์เพื่อระบุเอกสารเป้าหมาย เมธอด create แสดงผลอินสแตนซ์ของเอกสารที่สร้าง ซึ่งคุณจะอ่านรหัสได้

การอัปเดตเป็นกลุ่ม

เมธอด 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 เอกสาร

เวิร์กโฟลว์การอัปเดตเอกสาร

การสร้างและเติมข้อมูลเอกสารใหม่นั้นไม่ซับซ้อนเพราะไม่มีเนื้อหาที่ต้องกังวลและไม่มีผู้ทํางานร่วมกันที่สามารถปรับเปลี่ยนสถานะเอกสารได้ โดยหลักการแล้ว จะทํางานตามที่แสดงในแผนภาพลําดับต่อไปนี้

เวิร์กโฟลว์เพื่อสร้างและสร้างเอกสารใหม่

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

เวิร์กโฟลว์เพื่ออัปเดตเอกสาร

แผนภาพนี้ไม่พิจารณาเวิร์กโฟลว์ที่มีการอัปเดตพร้อมกันโดยผู้ทํางานร่วมกันคนอื่นๆ ในเอกสารเดียวกัน โปรดดูส่วนวางแผนสําหรับการทํางานร่วมกัน สําหรับหัวข้อนี้