Method: documents.get

รับเอกสารเวอร์ชันล่าสุดที่ระบุ

คำขอ HTTP

GET https://docs.googleapis.com/v1/documents/{documentId}

URL ใช้ไวยากรณ์การแปลงรหัส gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
documentId

string

รหัสของเอกสารที่จะดึงข้อมูล

พารามิเตอร์การค้นหา

พารามิเตอร์
suggestionsViewMode

enum (SuggestionsViewMode)

โหมดมุมมองคำแนะนำที่จะใช้กับเอกสาร ซึ่งจะช่วยให้ดูเอกสารพร้อมคำแนะนำทั้งหมดแบบอินไลน์ที่ยอมรับหรือปฏิเสธแล้วได้ หากไม่ได้ระบุ ระบบจะใช้ DEFAULT_FOR_CURRENT_ACCESS
includeTabsContent

boolean

จะป้อนข้อมูลในช่อง Document.tabs แทนช่องเนื้อหาข้อความ เช่น body และ documentStyle ใน Document หรือไม่

  • เมื่อtrue: เนื้อหาเอกสารจะปรากฏในช่อง Document.tabs แทนช่องเนื้อหาข้อความใน Document

  • เมื่อ false: เนื้อหาของแท็บแรกของเอกสารจะสร้างช่องเนื้อหาใน Document ยกเว้น Document.tabs หากเอกสารมีแท็บเดียว ระบบจะใช้แท็บนั้นเพื่อป้อนข้อมูลเนื้อหาของเอกสาร Document.tabs จะว่างเปล่า

หากคุณใช้ Field Mask ที่อ้างอิงฟิลด์ Document.tabs (หรือฟิลด์ย่อยใดก็ตาม) API จะถือว่าคำขอเป็นคำขอที่คุณตั้งค่า includeTabsContent เป็น true โดยปริยาย
commentsViewMode

enum (CommentsViewMode)

โหมดมุมมองความคิดเห็นที่จะใช้กับเอกสาร ซึ่งจะช่วยให้ดูเอกสารโดยไม่แสดงความคิดเห็นหรือแสดงความคิดเห็นได้ หากไม่ได้ระบุ ระบบจะใช้ COMMENTS_VIEW_MODE_OMITTED

หากตั้งค่า commentsViewMode เป็นค่าใดก็ตาม คุณต้องตั้งค่า includeTabsContent เป็น true หรือใช้ FieldMask ที่อ้างอิงฟิลด์ Document.tabs (หรือฟิลด์ย่อยใดก็ได้)

หากตั้งค่า commentsViewMode เป็น COMMENTS_VIEW_MODE_INCLUDED คุณต้องตั้งค่า suggestionsViewMode เป็น SUGGESTIONS_INLINE ด้วย

หากตั้งค่า commentsViewMode เป็น COMMENTS_VIEW_MODE_INCLUDED หรือ COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS คุณจะตั้งค่า suggestionsViewMode เป็น PREVIEW_WITHOUT_SUGGESTIONS หรือ PREVIEW_SUGGESTIONS_ACCEPTED ไม่ได้

เนื้อความของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Document

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/documents
  • https://www.googleapis.com/auth/documents.readonly
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive.file

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์