Method: documents.create

Tạo một tài liệu trống bằng tiêu đề được cung cấp trong yêu cầu. Các trường khác trong yêu cầu, bao gồm cả nội dung được cung cấp, đều sẽ bị bỏ qua.

Trả về tài liệu đã tạo.

Yêu cầu HTTP

POST https://docs.googleapis.com/v1/documents

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

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu với cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "documentId": string,
  "title": string,
  "tabs": [
    {
      object (Tab)
    }
  ],
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "commentsViewMode": enum (CommentsViewMode),
  "comments": [
    {
      object (CommentThread)
    }
  ],
  "suggestions": [
    {
      object (SuggestionThread)
    }
  ],
  "body": {
    object (Body)
  },
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "footers": {
    string: {
      object (Footer)
    },
    ...
  },
  "footnotes": {
    string: {
      object (Footnote)
    },
    ...
  },
  "documentStyle": {
    object (DocumentStyle)
  },
  "suggestedDocumentStyleChanges": {
    string: {
      object (SuggestedDocumentStyle)
    },
    ...
  },
  "namedStyles": {
    object (NamedStyles)
  },
  "suggestedNamedStylesChanges": {
    string: {
      object (SuggestedNamedStyles)
    },
    ...
  },
  "lists": {
    string: {
      object (List)
    },
    ...
  },
  "namedRanges": {
    string: {
      object (NamedRanges)
    },
    ...
  },
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
Trường
documentId

string

Chỉ có đầu ra. Mã nhận dạng của tài liệu.
title

string

Tiêu đề của tài liệu.
tabs[]

object (Tab)

Chỉ có đầu ra. Các thẻ là một phần của tài liệu.

Các thẻ có thể chứa thẻ con, tức là một thẻ được lồng trong một thẻ khác. Các thẻ con được biểu thị bằng trường Tab.childTabs.
revisionId

string

Chỉ có đầu ra. Mã bản sửa đổi của tài liệu. Có thể dùng trong các yêu cầu cập nhật để chỉ định phiên bản của tài liệu cần áp dụng nội dung cập nhật và cách yêu cầu hoạt động nếu tài liệu đã được chỉnh sửa kể từ phiên bản đó. Chỉ được điền sẵn nếu người dùng có quyền chỉnh sửa tài liệu.

Mã nhận dạng phiên bản không phải là một số tuần tự mà là một chuỗi không rõ ràng. Định dạng của mã nhận dạng bản sửa đổi có thể thay đổi theo thời gian. Chúng tôi chỉ đảm bảo mã phiên bản được trả về là hợp lệ trong 24 giờ sau khi được trả về và không thể chia sẻ mã này giữa các người dùng. Nếu mã phiên bản không thay đổi giữa các lệnh gọi, thì tức là tài liệu không thay đổi. Ngược lại, nếu mã nhận dạng thay đổi (đối với cùng một tài liệu và người dùng), thì điều đó thường có nghĩa là tài liệu đã được cập nhật. Tuy nhiên, mã nhận dạng thay đổi cũng có thể là do các yếu tố nội bộ, chẳng hạn như thay đổi định dạng mã nhận dạng.
suggestionsViewMode

enum (SuggestionsViewMode)

Chỉ có đầu ra. Chế độ xem đề xuất được áp dụng cho tài liệu.

Lưu ý: Khi chỉnh sửa tài liệu, các thay đổi phải dựa trên tài liệu có SUGGESTIONS_INLINE.
commentsViewMode

enum (CommentsViewMode)

Chỉ có đầu ra. Chế độ xem nhận xét được áp dụng cho tài liệu.
comments[]

object (CommentThread)

Chỉ có đầu ra. Các nhận xét liên quan đến tài liệu. Chỉ được điền sẵn nếu bạn đặt tham số commentsViewMode thành bắt buộc phải có bình luận (chẳng hạn như COMMENTS_VIEW_MODE_INCLUDED).
suggestions[]

object (SuggestionThread)

Chỉ có đầu ra. Các đề xuất liên quan đến tài liệu. Chỉ được điền sẵn nếu bạn đặt tham số commentsViewMode thành bắt buộc phải có bình luận (chẳng hạn như COMMENTS_VIEW_MODE_INCLUDED).
body

object (Body)

Chỉ có đầu ra. Nội dung chính của tài liệu.

Trường cũ: Thay vào đó, hãy sử dụng Document.tabs.documentTab.body. Trường này sẽ hiển thị nội dung thực tế của tài liệu từ tất cả các thẻ khi tham số includeTabsContent được đặt thành true. Nếu false hoặc chưa đặt, trường này sẽ chứa thông tin về thẻ đầu tiên trong tài liệu.
headers

map (key: string, value: object (Header))

Chỉ có đầu ra. Tiêu đề trong tài liệu, được khoá bằng mã nhận dạng tiêu đề.

Trường cũ: Thay vào đó, hãy sử dụng Document.tabs.documentTab.headers. Trường này sẽ hiển thị nội dung thực tế của tài liệu từ tất cả các thẻ khi tham số includeTabsContent được đặt thành true. Nếu false hoặc chưa đặt, trường này sẽ chứa thông tin về thẻ đầu tiên trong tài liệu.
footers

map (key: string, value: object (Footer))

Chỉ có đầu ra. Phần chân trang trong tài liệu, được khoá bằng mã nhận dạng chân trang.

Trường cũ: Thay vào đó, hãy sử dụng Document.tabs.documentTab.footers. Trường này sẽ hiển thị nội dung thực tế của tài liệu từ tất cả các thẻ khi tham số includeTabsContent được đặt thành true. Nếu false hoặc chưa đặt, trường này sẽ chứa thông tin về thẻ đầu tiên trong tài liệu.
footnotes

map (key: string, value: object (Footnote))

Chỉ có đầu ra. Chú thích trong tài liệu, được khoá bằng mã nhận dạng chú thích.

Trường cũ: Thay vào đó, hãy sử dụng Document.tabs.documentTab.footnotes. Trường này sẽ hiển thị nội dung thực tế của tài liệu từ tất cả các thẻ khi tham số includeTabsContent được đặt thành true. Nếu false hoặc chưa đặt, trường này sẽ chứa thông tin về thẻ đầu tiên trong tài liệu.
documentStyle

object (DocumentStyle)

Chỉ có đầu ra. Kiểu tài liệu.

Trường cũ: Thay vào đó, hãy sử dụng Document.tabs.documentTab.documentStyle. Trường này sẽ hiển thị nội dung thực tế của tài liệu từ tất cả các thẻ khi tham số includeTabsContent được đặt thành true. Nếu false hoặc chưa đặt, trường này sẽ chứa thông tin về thẻ đầu tiên trong tài liệu.
suggestedDocumentStyleChanges

map (key: string, value: object (SuggestedDocumentStyle))

Chỉ có đầu ra. Các thay đổi được đề xuất đối với kiểu của tài liệu, được khoá theo mã đề xuất.

Trường cũ: Thay vào đó, hãy sử dụng Document.tabs.documentTab.suggestedDocumentStyleChanges. Trường này sẽ hiển thị nội dung thực tế của tài liệu từ tất cả các thẻ khi tham số includeTabsContent được đặt thành true. Nếu false hoặc chưa đặt, trường này sẽ chứa thông tin về thẻ đầu tiên trong tài liệu.
namedStyles

object (NamedStyles)

Chỉ có đầu ra. Các kiểu có tên của tài liệu.

Trường cũ: Thay vào đó, hãy sử dụng Document.tabs.documentTab.namedStyles. Trường này sẽ hiển thị nội dung thực tế của tài liệu từ tất cả các thẻ khi tham số includeTabsContent được đặt thành true. Nếu false hoặc chưa đặt, trường này sẽ chứa thông tin về thẻ đầu tiên trong tài liệu.
suggestedNamedStylesChanges

map (key: string, value: object (SuggestedNamedStyles))

Chỉ có đầu ra. Các thay đổi được đề xuất đối với kiểu có tên của tài liệu, được khoá theo mã nhận dạng đề xuất.

Trường cũ: Thay vào đó, hãy sử dụng Document.tabs.documentTab.suggestedNamedStylesChanges. Trường này sẽ hiển thị nội dung thực tế của tài liệu từ tất cả các thẻ khi tham số includeTabsContent được đặt thành true. Nếu false hoặc chưa đặt, trường này sẽ chứa thông tin về thẻ đầu tiên trong tài liệu.
lists

map (key: string, value: object (List))

Chỉ có đầu ra. Các danh sách trong tài liệu, được khoá bằng mã danh sách.

Trường cũ: Thay vào đó, hãy sử dụng Document.tabs.documentTab.lists. Trường này sẽ hiển thị nội dung thực tế của tài liệu từ tất cả các thẻ khi tham số includeTabsContent được đặt thành true. Nếu false hoặc chưa đặt, trường này sẽ chứa thông tin về thẻ đầu tiên trong tài liệu.
namedRanges

map (key: string, value: object (NamedRanges))

Chỉ có đầu ra. Các dải ô được đặt tên trong tài liệu, được khoá theo tên.

Trường cũ: Thay vào đó, hãy sử dụng Document.tabs.documentTab.namedRanges. Trường này sẽ hiển thị nội dung thực tế của tài liệu từ tất cả các thẻ khi tham số includeTabsContent được đặt thành true. Nếu false hoặc chưa đặt, trường này sẽ chứa thông tin về thẻ đầu tiên trong tài liệu.
inlineObjects

map (key: string, value: object (InlineObject))

Chỉ có đầu ra. Các đối tượng nội tuyến trong tài liệu, được khoá bằng mã nhận dạng đối tượng.

Trường cũ: Thay vào đó, hãy sử dụng Document.tabs.documentTab.inlineObjects. Trường này sẽ hiển thị nội dung thực tế của tài liệu từ tất cả các thẻ khi tham số includeTabsContent được đặt thành true. Nếu false hoặc chưa đặt, trường này sẽ chứa thông tin về thẻ đầu tiên trong tài liệu.
positionedObjects

map (key: string, value: object (PositionedObject))

Chỉ có đầu ra. Các đối tượng được định vị trong tài liệu, được khoá theo mã nhận dạng đối tượng.

Trường cũ: Thay vào đó, hãy sử dụng Document.tabs.documentTab.positionedObjects. Trường này sẽ hiển thị nội dung thực tế của tài liệu từ tất cả các thẻ khi tham số includeTabsContent được đặt thành true. Nếu false hoặc chưa đặt, trường này sẽ chứa thông tin về thẻ đầu tiên trong tài liệu.

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ể mới tạo 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/drive
  • https://www.googleapis.com/auth/drive.file

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