Method: documents.create

使用要求中提供的標題建立空白文件。系統會忽略要求中的其他欄位，包括任何提供的內容。

傳回已建立的文件。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

要求主體

要求主體的資料會採用以下結構：

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)
    },
    ...
  }
}
欄位
documentId

string

僅供輸出。文件 ID。
title

string

文件的標題。
body

object (Body)

僅供輸出。文件的主要內文。
headers

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

僅供輸出。文件中的標頭，以標頭 ID 排序。
footers

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

僅供輸出。文件的頁尾，以頁尾 ID 做為索引鍵。
footnotes

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

僅供輸出。文件中的註腳，請見註腳 ID。
documentStyle

object (DocumentStyle)

僅供輸出。文件的樣式。
suggestedDocumentStyleChanges

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

僅供輸出。修訂文件的樣式建議，並依照建議 ID 排序。
namedStyles

object (NamedStyles)

僅供輸出。文件的指定樣式。
suggestedNamedStylesChanges

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

僅供輸出。建議的變更文件名稱樣式，並醒目顯示以建議 ID 排序。
lists

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

僅供輸出。文件中的清單，以清單 ID 排序。
namedRanges

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

僅供輸出。文件中的已命名範圍，以名稱做為索引鍵。
revisionId

string

僅供輸出。文件的修訂版本 ID。可用於更新要求，指定文件要套用的修訂版本，以及文件經過修改後應如何編輯。只有在使用者擁有文件編輯權限時才會填入資料。

修訂版本 ID 並非連續的數字，而是不透明字串。修訂版本 ID 的格式可能隨著時間改變。傳回的修訂版本 ID 必須在退貨後 24 小時內有效，且無法與所有使用者共用。如果呼叫之間沒有修訂版本 ID，則文件不會變更。反之，如果為文件和使用者進行了變更，通常表示文件已更新。不過，由於 ID 格式變更等內部因素，導致 ID 變更失敗。
suggestionsViewMode

enum (SuggestionsViewMode)

僅供輸出。文件已套用建議檢視模式。

注意：編輯文件時，必須依據具有 SUGGESTIONS_INLINE 的文件來進行變更。
inlineObjects

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

僅供輸出。文件中的內嵌物件，並以物件 ID 做為索引鍵。
positionedObjects

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

僅供輸出。文件中的位置物件，並以物件 ID 做為索引鍵。

回應主體

如果成功，回應主體會包含新建立的 Document 例項。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/documents
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file

詳情請參閱授權指南。