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