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