คู่มือนี้จะแนะนำวิธีการส่งคำขอและการตอบกลับหลักที่ประกอบกันเป็น Google เอกสาร API และวิธีอัปเดตเอกสารทีละหลายรายการ
คุณสามารถเรียกใช้ Google เอกสาร API โดยใช้คำขอ HTTP หรือใช้การเรียกใช้เมธอดในไลบรารีของไคลเอ็นต์สำหรับภาษาใดภาษาหนึ่ง ซึ่งมีความเทียบเท่ากันโดยคร่าวๆ
Google เอกสาร API จะแสดงการตอบกลับ HTTP ซึ่งโดยทั่วไปจะรวมผลลัพธ์ของการเรียกใช้คำขอ เมื่อใช้ไลบรารีของไคลเอ็นต์เพื่อส่งคำขอ ระบบจะแสดงผลลัพธ์ตามภาษาที่เฉพาะเจาะจง
วิธีการส่งคำขอ
Docs API รองรับเมธอดต่อไปนี้
documents.create: สร้างเอกสาร Google เอกสารเปล่าdocuments.get: แสดงอินสแตนซ์ที่สมบูรณ์ของเอกสารที่ระบุ คุณสามารถแยกวิเคราะห์ JSON ที่แสดงผลเพื่อดึงข้อมูลเนื้อหาเอกสาร การจัดรูปแบบ และฟีเจอร์อื่นๆdocuments.batchUpdate: ส่งรายการคำขอแก้ไขเพื่อใช้กับเอกสารแบบเป็นกลุ่ม และแสดงรายการผลลัพธ์
เมธอด documents.get และ documents.batchUpdate ต้องใช้ documentId
เป็นพารามิเตอร์เพื่อระบุเอกสารเป้าหมาย เมธอด documents.create จะแสดงผลอินสแตนซ์ของเอกสารที่สร้าง ซึ่งคุณสามารถอ่าน documentId ได้จากอินสแตนซ์นี้ ดูข้อมูลเพิ่มเติมเกี่ยวกับ documentId ได้ที่ Document
ID
โปรดทราบว่าคุณใช้เมธอด documents.get เพื่อเรียกข้อมูลเอกสารที่เผยแพร่แล้วไม่ได้ เมื่อเผยแพร่แล้ว เอกสารสาธารณะจะใช้รูปแบบ URL อื่น การพยายามใช้ documentId ใหม่ของ URL ด้วยเมธอด documents.get จะแสดงการตอบกลับรหัสสถานะ HTTP 404 ไม่มีวิธีเรียกข้อมูล documentId ต้นฉบับจาก URL ที่เผยแพร่ หากต้องการแก้ปัญหานี้ คุณสามารถใช้ Drive API เพื่อคัดลอกเอกสารที่เผยแพร่ไปยังเอกสารที่แชร์ แล้วเข้าถึงไฟล์นี้แทน ดูข้อมูลเพิ่มเติมได้ที่หัวข้อทำให้ Google เอกสาร ชีต สไลด์ และฟอร์มเป็นสาธารณะ
การอัปเดตแบบเป็นกลุ่ม
วิธีการ documents.batchUpdate ใช้รายการออบเจ็กต์ request โดยแต่ละรายการจะระบุคําขอเดียวที่จะดําเนินการ เช่น จัดรูปแบบย่อหน้าแล้วเพิ่มรูปภาพในบรรทัด ระบบจะตรวจสอบคําขอแต่ละรายการก่อนนำไปใช้ และประมวลผลคําขอตามลําดับที่ปรากฏในคําขอกลุ่ม
ระบบจะใช้คําขอทั้งหมดในการอัปเดตแบบเป็นกลุ่มพร้อมกัน กล่าวคือ หากคำขอใดไม่ถูกต้อง การอัปเดตทั้งหมดจะไม่สำเร็จและจะไม่มีการใช้การเปลี่ยนแปลง (ที่อาจขึ้นอยู่กับ) ใดๆ
เมธอด documents.batchUpdate บางรายการจะแสดงคำตอบพร้อมข้อมูลเกี่ยวกับคำขอที่ใช้ เมธอดเหล่านี้จะแสดงคำตอบที่มีรายการออบเจ็กต์ response
คำขออื่นๆ ไม่จำเป็นต้องแสดงข้อมูลและแสดงการตอบกลับที่ว่างเปล่า ออบเจ็กต์ในรายการคำตอบจะอยู่ในลําดับดัชนีเดียวกันกับคำขอที่เกี่ยวข้อง
รูปแบบยอดนิยมในการทำคําขอแบบเป็นกลุ่มมีลักษณะดังนี้
requests = []
requests.append(first request)
requests.append(second request)
...
body = ... & requests & ...
...batchUpdate(body)
ดูแนวทางปฏิบัติแนะนำสำหรับคำขอกลุ่มเพื่อดูรายละเอียดทั้งหมดเกี่ยวกับวิธีเรียกใช้ Docs API แบบเป็นกลุ่ม และเอกสารอ้างอิง documents.batchUpdate สำหรับประเภทคำขอและคำตอบ
การดำเนินการอัปเดตเป็นกลุ่ม
คำขออัปเดตแบบเป็นกลุ่มมีหลายประเภท ต่อไปนี้เป็นรายละเอียดของคำขอประเภทต่างๆ ซึ่งจัดกลุ่มเป็นหมวดหมู่ต่างๆ