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