Method: documents.create

Tạo một tài liệu trống bằ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 cả mọi nội dung đã cung cấp) đều 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 như sau:

Biểu diễn dưới dạng JSON
{
  "documentId": string,
  "title": string,
  "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)
    },
    ...
  },
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
Các trường
documentId

string

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

title

string

Tiêu đề tài liệu.

body

object (Body)

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

headers

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

Chỉ đầu ra. Các tiêu đề trong tài liệu, được khóa theo mã tiêu đề.

footers

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

Chỉ đầu ra. Các chân trang trong tài liệu, có mã là chân trang.

footnotes

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

Chỉ đầu ra. Chú thích cuối trang trong tài liệu, được đặt theo ID chú thích cuối trang.

documentStyle

object (DocumentStyle)

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

suggestedDocumentStyleChanges

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

Chỉ đầu ra. Các thay đổi được đề xuất đối với kiểu tài liệu, có mã đề xuất là chính.

namedStyles

object (NamedStyles)

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

suggestedNamedStylesChanges

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

Chỉ đầ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 xác định bằng ID đề xuất.

lists

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

Chỉ đầu ra. Các danh sách trong tài liệu, được sắp xếp theo mã danh sách.

namedRanges

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

Chỉ đầu ra. Dải ô được đặt tên trong tài liệu, được khóa theo tên.

revisionId

string

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

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

suggestionsViewMode

enum (SuggestionsViewMode)

Chỉ đầu ra. Chế độ xem đề xuất đã á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.

inlineObjects

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

Chỉ đầu ra. Các đối tượng cùng dòng trong tài liệu, được xác định theo mã đối tượng.

positionedObjects

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

Chỉ đầu ra. Các đối tượng đã được định vị trong tài liệu, được xác định bằng mã đối tượ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 phiên bản mới được tạo của Document.

Phạm vi ủy 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 ủy quyền.