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