Method: documents.create

Tạo tài liệu trống bằng cách sử dụng tiêu đề đã cung cấp trong yêu cầu. Các trường khác trong yêu cầu, bao gồm mọi nội dung đã cung cấp, 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 có 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),
  "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ã của tài liệu.

title

string

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

tabs[]

object (Tab)

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

Thẻ có thể chứa các thẻ con, một thẻ được lồng trong một thẻ khá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 bản sửa đổi nào 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 sẽ hoạt động nếu tài liệu đã được chỉnh sửa kể từ bản sửa đổi đó. Chỉ được điền nếu người dùng có quyền chỉnh sửa tài liệu.

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

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.

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 để hiển thị nội dung tài liệu thực tế từ tất cả các thẻ khi thông số includeTabsContent được đặt thành true. Nếu là 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. Các tiêu đề trong tài liệu, được khoá theo mã nhận dạng tiêu đề.

Trường cũ: Thay vào đó, hãy sử dụng Document.tabs.documentTab.headers để hiển thị nội dung tài liệu thực tế từ tất cả các thẻ khi thông số includeTabsContent được đặt thành true. Nếu bạn đặt chính sách false hoặc không đặ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. Chân trang trong tài liệu, có mã nhận dạng chân trang.

Trường cũ: Thay vào đó, hãy sử dụng Document.tabs.documentTab.footers để hiển thị nội dung tài liệu thực tế từ tất cả các thẻ khi thông số includeTabsContent được đặt thành true. Nếu là 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 cuối trang trong tài liệu, có mã nhận dạng chú thích cuối trang.

Trường cũ: Thay vào đó, hãy sử dụng Document.tabs.documentTab.footnotes để hiển thị nội dung tài liệu thực tế trên tất cả các thẻ khi tham số includeTabsContent được đặt thành true. Nếu bạn đặt chính sách false hoặc không đặ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 của tài liệu.

Trường cũ: Thay vào đó, hãy sử dụng Document.tabs.documentTab.documentStyle để hiển thị nội dung tài liệu thực tế trên tất cả các thẻ khi tham số includeTabsContent được đặt thành true. Nếu bạn đặt chính sách false hoặc không đặ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á bằng mã đề xuất.

Trường cũ: Thay vào đó, hãy sử dụng Document.tabs.documentTab.suggestedDocumentStyleChanges để hiển thị nội dung tài liệu thực tế trên tất cả các thẻ khi tham số includeTabsContent được đặt thành true. Nếu bạn đặt chính sách false hoặc không đặ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. Kiểu được đặt tên của tài liệu.

Trường cũ: Thay vào đó, hãy sử dụng Document.tabs.documentTab.namedStyles để hiển thị nội dung tài liệu thực tế trên tất cả các thẻ khi tham số includeTabsContent được đặt thành true. Nếu là 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 tên 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.suggestedNamedStylesChanges để hiển thị nội dung tài liệu thực tế từ tất cả các thẻ khi thông số includeTabsContent được đặt thành true. Nếu là 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á theo mã danh sách.

Trường cũ: Thay vào đó, hãy sử dụng Document.tabs.documentTab.lists để hiển thị nội dung tài liệu thực tế từ tất cả các thẻ khi thông số includeTabsContent được đặt thành true. Nếu là 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 để hiển thị nội dung tài liệu thực tế từ tất cả các thẻ khi thông số includeTabsContent được đặt thành true. Nếu bạn đặt chính sách false hoặc không đặ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 cùng dòng trong tài liệu, được khoá theo mã đối tượng.

Trường cũ: Thay vào đó, hãy sử dụng Document.tabs.documentTab.inlineObjects để hiển thị nội dung tài liệu thực tế từ tất cả các thẻ khi thông số includeTabsContent được đặt thành true. Nếu bạn đặt chính sách false hoặc không đặ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ã đối tượng.

Trường cũ: Thay vào đó, hãy sử dụng Document.tabs.documentTab.positionedObjects để hiển thị nội dung tài liệu thực tế trên tất cả các thẻ khi tham số includeTabsContent được đặt thành true. Nếu bạn đặt chính sách false hoặc không đặ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ể Document mới tạo.

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.