คำขอและการตอบกลับ

คู่มือนี้จะแนะนำวิธีการส่งคำขอหลักและการตอบกลับที่ประกอบขึ้นเป็น Google เอกสาร API และวิธีอัปเดตเอกสารเป็นกลุ่ม

คุณสามารถเรียกใช้ Google เอกสาร API โดยใช้คำขอ HTTP หรือใช้เมธอด ในไลบรารีของไคลเอ็นต์เฉพาะภาษา ซึ่งถือว่าเทียบเท่ากันอย่างกว้างๆ

API ของ Google เอกสารจะส่งการตอบกลับ 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)

ดูรายละเอียดทั้งหมดเกี่ยวกับแนวทางปฏิบัติแนะนำเกี่ยวกับคำขอแบบกลุ่ม วิธีจัดกลุ่มการเรียกเอกสาร API และ documents.batchUpdate เอกสารอ้างอิงสำหรับประเภทคำขอและคำตอบ

การดำเนินการอัปเดตเป็นกลุ่ม

คำขออัปเดตแบบกลุ่มมีหลายประเภท ต่อไปนี้เป็นรายละเอียด ประเภทคำขอ ซึ่งจัดกลุ่มเป็น หมวดหมู่ต่างๆ ได้

ออบเจ็กต์ เพิ่ม / แทรก อัปเดต / แทนที่ ลบ
ข้อความ InsertTextRequest ReplaceAllTextRequest
รูปแบบ CreateParagraphBulletsRequest UpdateTextStyleRequest
UpdateParagraphStyleRequest
UpdateTableCellStyleRequest
UpdateTableRowStyleRequest
UpdateDocumentStyleRequest
UpdateSectionStyleRequest
DeleteParagraphBulletsRequest
ช่วงที่ตั้งชื่อแล้ว CreateNamedRangeRequest ReplaceNamedRangeContentRequest DeleteNamedRangeRequest
DeleteContentRangeRequest
รูปภาพ InsertInlineImageRequest ReplaceImageRequest
ตาราง InsertTableRequest
InsertTableRowRequest
InsertTableColumnRequest
UpdateTableColumnPropertiesRequest
MergeTableCellsRequest
UnmergeTableCellsRequest
PinTableHeaderRowsRequest
DeleteTableRowRequest
DeleteTableColumnRequest
ออบเจ็กต์หน้าเว็บ (รวมถึงส่วนหัวและส่วนท้าย) InsertPageBreakRequest
CreateHeaderRequest
CreateFooterRequest
CreateFootnoteRequest
InsertSectionBreakRequest
DeletePositionedObjectRequest
DeleteHeaderRequest
DeleteFooterRequest