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 จะว่างเปล่า

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

commentsViewMode

enum (CommentsViewMode)

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

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

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

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

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

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ 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

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