Method: documents.get

Lấy phiên bản mới nhất của tài liệu được chỉ định.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Thông số
documentId

string

Mã nhận dạng của tài liệu cần truy xuất.

Tham số truy vấn

Thông số
suggestionsViewMode

enum (SuggestionsViewMode)

Chế độ xem đề xuất cần áp dụng cho tài liệu. Thao tác này cho phép xem tài liệu với tất cả đề xuất được chấp nhận hoặc bị từ chối. Nếu bạn không chỉ định một giá trị, hệ thống sẽ sử dụng DEFAULT_FOR_CURRENT_ACCESS.

includeTabsContent

boolean

Có nên điền vào trường Document.tabs thay vì các trường nội dung văn bản như body và documentStyle trên Document hay không.

  • Khi true: Nội dung tài liệu sẽ xuất hiện trong trường Document.tabs thay vì các trường nội dung văn bản trong Document.

  • Khi false: Nội dung của thẻ đầu tiên trong tài liệu sẽ điền sẵn vào các trường nội dung trong Document, ngoại trừ Document.tabs. Nếu một tài liệu chỉ có một thẻ, thì thẻ đó sẽ được dùng để điền sẵn nội dung tài liệu. Document.tabs sẽ trống.

Nếu bạn sử dụng một mặt nạ trường tham chiếu đến trường Document.tabs (hoặc bất kỳ trường con nào), thì API sẽ ngầm coi yêu cầu như thể bạn đặt includeTabsContent thành true.

commentsViewMode

enum (CommentsViewMode)

Chế độ xem nhận xét cần áp dụng cho tài liệu. Nhờ đó, bạn có thể xem tài liệu có hoặc không có bình luận. Nếu bạn không chỉ định một giá trị, hệ thống sẽ sử dụng COMMENTS_VIEW_MODE_OMITTED.

Nếu đặt commentsViewMode thành bất kỳ giá trị nào, bạn cũng phải đặt includeTabsContent thành true hoặc sử dụng một mặt nạ trường tham chiếu đến trường Document.tabs (hoặc bất kỳ trường con nào).

Nếu đặt commentsViewMode thành COMMENTS_VIEW_MODE_INCLUDED, bạn cũng phải đặt suggestionsViewMode thành SUGGESTIONS_INLINE một cách rõ ràng.

Nếu bạn đặt commentsViewMode thành COMMENTS_VIEW_MODE_INCLUDED hoặc COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS, thì bạn không thể đặt suggestionsViewMode thành PREVIEW_WITHOUT_SUGGESTIONS hoặc PREVIEW_SUGGESTIONS_ACCEPTED.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một thực thể của Document.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

  • 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

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.