คู่มือนี้จะแนะนำเมธอดคำขอและการตอบกลับหลักๆ ที่ประกอบกันเป็น Google เอกสาร API และวิธีอัปเดตเอกสารเป็นกลุ่ม
คุณสามารถเรียกใช้ Google เอกสาร API ได้โดยใช้คำขอ HTTP หรือโดยใช้การเรียกเมธอด ในไลบรารีของไคลเอ็นต์เฉพาะภาษา client library ซึ่งโดยรวมแล้วจะมีความคล้ายคลึงกัน
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 สาธารณะที่แตกต่างกัน การพยายามใช้ documentId สาธารณะกับเมธอด documents.get จะแสดงผลการตอบกลับรหัสสถานะ HTTP 404
ในทำนองเดียวกัน คุณไม่สามารถใช้เมธอด
files.copy ของ Drive API เพื่อคัดลอกเอกสารที่เผยแพร่
หากต้องการดึงข้อมูลหรือคัดลอกเอกสารที่เผยแพร่ คุณต้องใช้ documentId เดิม ไม่มีเมธอดสำหรับแยก documentId เดิมจาก URL ที่เผยแพร่
ดูข้อมูลเพิ่มเติมได้ที่
การอัปเดตเป็นกลุ่ม
เมธอด
documents.batchUpdate
จะใช้รายการออบเจ็กต์
requestซึ่งแต่ละออบเจ็กต์จะระบุคำขอเดียวที่จะดำเนินการ เช่น จัดรูปแบบย่อหน้า แล้วเพิ่มรูปภาพแบบอินไลน์ ระบบจะตรวจสอบคำขอแต่ละรายการก่อนที่จะนำไปใช้ และจะประมวลผลคำขอตามลำดับที่ปรากฏในคำขอกลุ่ม
ระบบจะนำคำขอทั้งหมดในการอัปเดตเป็นกลุ่มไปใช้แบบอะตอมมิก นั่นคือ หากคำขอใดไม่ถูกต้อง การอัปเดตทั้งหมดจะไม่สำเร็จและระบบจะไม่นำการเปลี่ยนแปลง (ที่อาจขึ้นอยู่กับคำขอที่ไม่ถูกต้อง) ไปใช้
เมธอด documents.batchUpdate บางเมธอดจะแสดงผลการตอบกลับพร้อมข้อมูลเกี่ยวกับคำขอที่นำไปใช้ เมธอดเหล่านี้จะแสดงผลเนื้อหา
การตอบกลับ
ที่มีรายการ
responseออบเจ็กต์
คำขออื่นๆ ไม่จำเป็นต้องแสดงผลข้อมูลและแสดงผลการตอบกลับที่ว่างเปล่า ออบเจ็กต์ในรายการการตอบกลับจะอยู่ในลำดับดัชนีเดียวกับคำขอที่เกี่ยวข้อง
รูปแบบที่นิยมใช้ในการส่งคำขอกลุ่มมีลักษณะดังนี้
requests = []
requests.append(first request)
requests.append(second request)
...
body = ... & requests & ...
...batchUpdate(body)
ดูรายละเอียดทั้งหมดเกี่ยวกับวิธีส่งคำขอ Docs API เป็นกลุ่มและเอกสารอ้างอิง documents.batchUpdateสำหรับประเภทคำขอและการตอบกลับได้ที่แนวทางปฏิบัติแนะนำสำหรับคำขอกลุ่ม
การดำเนินการอัปเดตเป็นกลุ่ม
คำขออัปเดตเป็นกลุ่มมีหลายประเภท ต่อไปนี้คือรายละเอียดของ ประเภทคำขอ, ที่จัดกลุ่มเป็นหมวดหมู่ต่างๆ