คู่มือนี้จะแนะนำวิธีการส่งคำขอและการตอบกลับหลักๆ ที่ประกอบกันเป็น Google Docs 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.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
สำหรับประเภทคำขอและการตอบกลับได้ที่แนวทางปฏิบัติแนะนำสำหรับคำขอแบบกลุ่ม
การดำเนินการอัปเดตเป็นกลุ่ม
คำขออัปเดตแบบกลุ่มมีหลายประเภท รายละเอียดของ ประเภทคำขอ ที่จัดกลุ่มเป็นหมวดหมู่ต่างๆ มีดังนี้