Method: documents.create

สร้างเอกสารเปล่าโดยใช้ชื่อที่ระบุในคำขอ ระบบจะละเว้นช่องอื่นๆ ในคำขอ รวมถึงเนื้อหาที่ระบุ

แสดงเอกสารที่สร้างขึ้น

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลงรหัส gRPC

เนื้อความของคำขอ

เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง 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)
    },
    ...
  }
}
ช่อง
documentId

string

เอาต์พุตเท่านั้น รหัสของเอกสาร
title

string

ชื่อของเอกสาร
tabs[]

object (Tab)

แท็บที่เป็นส่วนหนึ่งของเอกสาร

แท็บสามารถมีแท็บย่อย ซึ่งเป็นแท็บที่ซ้อนอยู่ภายในแท็บอื่น แท็บย่อยจะแสดงด้วยช่อง Tab.childTabs
revisionId

string

เอาต์พุตเท่านั้น รหัสการแก้ไขของเอกสาร สามารถใช้ในคำขออัปเดตเพื่อระบุการแก้ไขเอกสารที่จะใช้การอัปเดตและลักษณะการทำงานของคำขอหากเอกสารได้รับการแก้ไขตั้งแต่การแก้ไขนั้น จะมีการป้อนข้อมูลก็ต่อเมื่อผู้ใช้มีสิทธิ์เข้าถึงเพื่อแก้ไขเอกสาร

รหัสการแก้ไขไม่ใช่ตัวเลขลำดับ แต่เป็นสตริงทึบแสง รูปแบบของรหัสการแก้ไขอาจเปลี่ยนแปลงเมื่อเวลาผ่านไป ระบบรับประกันว่ารหัสการแก้ไขที่แสดงผลจะใช้ได้เป็นเวลา 24 ชั่วโมงหลังจากที่แสดงผลเท่านั้น และจะแชร์กับผู้ใช้รายอื่นไม่ได้ หากรหัสการแก้ไขไม่เปลี่ยนแปลงระหว่างการเรียกใช้ แสดงว่าเอกสารไม่เปลี่ยนแปลง ในทางกลับกัน รหัสที่เปลี่ยนแปลง (สำหรับเอกสารและผู้ใช้รายเดียวกัน) มักจะหมายความว่าเอกสารได้รับการอัปเดต อย่างไรก็ตาม รหัสที่เปลี่ยนแปลงอาจเกิดจากปัจจัยภายใน เช่น การเปลี่ยนแปลงรูปแบบรหัส
suggestionsViewMode

enum (SuggestionsViewMode)

เอาต์พุตเท่านั้น โหมดมุมมองคำแนะนำที่ใช้กับเอกสาร

หมายเหตุ: เมื่อแก้ไขเอกสาร การเปลี่ยนแปลงต้องอิงตามเอกสารที่มี SUGGESTIONS_INLINE
commentsViewMode

enum (CommentsViewMode)

เอาต์พุตเท่านั้น โหมดมุมมองความคิดเห็นที่ใช้กับเอกสาร

comments[]

object (CommentThread)

เอาต์พุตเท่านั้น ความคิดเห็นที่เชื่อมโยงกับเอกสาร จะมีการป้อนข้อมูลก็ต่อเมื่อตั้งค่าพารามิเตอร์ commentsViewMode ให้ต้องใช้ความคิดเห็น (เช่น COMMENTS_VIEW_MODE_INCLUDED)

suggestions[]

object (SuggestionThread)

เอาต์พุตเท่านั้น คำแนะนำที่เชื่อมโยงกับเอกสาร จะมีการป้อนข้อมูลก็ต่อเมื่อตั้งค่าพารามิเตอร์ commentsViewMode ให้ต้องใช้ความคิดเห็น (เช่น COMMENTS_VIEW_MODE_INCLUDED)

body

object (Body)

เอาต์พุตเท่านั้น เนื้อหาหลักของเอกสาร

ช่องเดิม: ให้ใช้ Document.tabs.documentTab.body แทน ซึ่งจะแสดงเนื้อหาเอกสารจริงจากแท็บทั้งหมดเมื่อตั้งค่าพารามิเตอร์ includeTabsContent เป็น true หากตั้งค่าเป็น false หรือไม่ได้ตั้งค่า ช่องนี้จะมีข้อมูลเกี่ยวกับแท็บแรกในเอกสาร
headers

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

เอาต์พุตเท่านั้น ส่วนหัวในเอกสาร โดยใช้รหัสส่วนหัวเป็นคีย์

ช่องเดิม: ให้ใช้ Document.tabs.documentTab.headers แทน ซึ่งจะแสดงเนื้อหาเอกสารจริงจากแท็บทั้งหมดเมื่อตั้งค่าพารามิเตอร์ includeTabsContent เป็น true หากตั้งค่าเป็น false หรือไม่ได้ตั้งค่า ช่องนี้จะมีข้อมูลเกี่ยวกับแท็บแรกในเอกสาร
footers

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

เอาต์พุตเท่านั้น ส่วนท้ายในเอกสาร โดยใช้รหัสส่วนท้ายเป็นคีย์

ช่องเดิม: ให้ใช้ Document.tabs.documentTab.footers แทน ซึ่งจะแสดงเนื้อหาเอกสารจริงจากแท็บทั้งหมดเมื่อตั้งค่าพารามิเตอร์ includeTabsContent เป็น true หากตั้งค่าเป็น false หรือไม่ได้ตั้งค่า ช่องนี้จะมีข้อมูลเกี่ยวกับแท็บแรกในเอกสาร
footnotes

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

เอาต์พุตเท่านั้น เชิงอรรถในเอกสาร โดยใช้รหัสเชิงอรรถเป็นคีย์

ช่องเดิม: ให้ใช้ Document.tabs.documentTab.footnotes แทน ซึ่งจะแสดงเนื้อหาเอกสารจริงจากแท็บทั้งหมดเมื่อตั้งค่าพารามิเตอร์ includeTabsContent เป็น true หากตั้งค่าเป็น false หรือไม่ได้ตั้งค่า ช่องนี้จะมีข้อมูลเกี่ยวกับแท็บแรกในเอกสาร
documentStyle

object (DocumentStyle)

เอาต์พุตเท่านั้น รูปแบบของเอกสาร

ช่องเดิม: ให้ใช้ Document.tabs.documentTab.documentStyle แทน ซึ่งจะแสดงเนื้อหาเอกสารจริงจากแท็บทั้งหมดเมื่อตั้งค่าพารามิเตอร์ includeTabsContent เป็น true หากตั้งค่าเป็น false หรือไม่ได้ตั้งค่า ช่องนี้จะมีข้อมูลเกี่ยวกับแท็บแรกในเอกสาร
suggestedDocumentStyleChanges

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

เอาต์พุตเท่านั้น การเปลี่ยนแปลงที่แนะนำสำหรับรูปแบบของเอกสาร โดยใช้รหัสคำแนะนำเป็นคีย์

ช่องเดิม: ให้ใช้ Document.tabs.documentTab.suggestedDocumentStyleChanges แทน ซึ่งจะแสดงเนื้อหาเอกสารจริงจากแท็บทั้งหมดเมื่อตั้งค่าพารามิเตอร์ includeTabsContent เป็น true หากตั้งค่าเป็น false หรือไม่ได้ตั้งค่า ช่องนี้จะมีข้อมูลเกี่ยวกับแท็บแรกในเอกสาร
namedStyles

object (NamedStyles)

เอาต์พุตเท่านั้น รูปแบบที่มีชื่อของเอกสาร

ช่องเดิม: ให้ใช้ Document.tabs.documentTab.namedStyles แทน ซึ่งจะแสดงเนื้อหาเอกสารจริงจากแท็บทั้งหมดเมื่อตั้งค่าพารามิเตอร์ includeTabsContent เป็น true หากตั้งค่าเป็น false หรือไม่ได้ตั้งค่า ช่องนี้จะมีข้อมูลเกี่ยวกับแท็บแรกในเอกสาร
suggestedNamedStylesChanges

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

เอาต์พุตเท่านั้น การเปลี่ยนแปลงที่แนะนำสำหรับรูปแบบที่มีชื่อของเอกสาร โดยใช้รหัสคำแนะนำเป็นคีย์

ช่องเดิม: ให้ใช้ Document.tabs.documentTab.suggestedNamedStylesChanges แทน ซึ่งจะแสดงเนื้อหาเอกสารจริงจากแท็บทั้งหมดเมื่อตั้งค่าพารามิเตอร์ includeTabsContent เป็น true หากตั้งค่าเป็น false หรือไม่ได้ตั้งค่า ช่องนี้จะมีข้อมูลเกี่ยวกับแท็บแรกในเอกสาร
lists

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

เอาต์พุตเท่านั้น รายการในเอกสาร โดยใช้รหัสรายการเป็นคีย์

ช่องเดิม: ให้ใช้ Document.tabs.documentTab.lists แทน ซึ่งจะแสดงเนื้อหาเอกสารจริงจากแท็บทั้งหมดเมื่อตั้งค่าพารามิเตอร์ includeTabsContent เป็น true หากตั้งค่าเป็น false หรือไม่ได้ตั้งค่า ช่องนี้จะมีข้อมูลเกี่ยวกับแท็บแรกในเอกสาร
namedRanges

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

เอาต์พุตเท่านั้น ช่วงที่มีชื่อในเอกสาร โดยใช้ชื่อเป็นคีย์

ช่องเดิม: ให้ใช้ Document.tabs.documentTab.namedRanges แทน ซึ่งจะแสดงเนื้อหาเอกสารจริงจากแท็บทั้งหมดเมื่อตั้งค่าพารามิเตอร์ includeTabsContent เป็น true หากตั้งค่าเป็น false หรือไม่ได้ตั้งค่า ช่องนี้จะมีข้อมูลเกี่ยวกับแท็บแรกในเอกสาร
inlineObjects

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

เอาต์พุตเท่านั้น ออบเจ็กต์แบบอินไลน์ในเอกสาร โดยใช้รหัสออบเจ็กต์เป็นคีย์

ช่องเดิม: ให้ใช้ Document.tabs.documentTab.inlineObjects แทน ซึ่งจะแสดงเนื้อหาเอกสารจริงจากแท็บทั้งหมดเมื่อตั้งค่าพารามิเตอร์ includeTabsContent เป็น true หากตั้งค่าเป็น false หรือไม่ได้ตั้งค่า ช่องนี้จะมีข้อมูลเกี่ยวกับแท็บแรกในเอกสาร
positionedObjects

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

เอาต์พุตเท่านั้น ออบเจ็กต์ที่จัดตำแหน่งในเอกสาร โดยใช้รหัสออบเจ็กต์เป็นคีย์

ช่องเดิม: ให้ใช้ Document.tabs.documentTab.positionedObjects แทน ซึ่งจะแสดงเนื้อหาเอกสารจริงจากแท็บทั้งหมดเมื่อตั้งค่าพารามิเตอร์ includeTabsContent เป็น true หากตั้งค่าเป็น false หรือไม่ได้ตั้งค่า ช่องนี้จะมีข้อมูลเกี่ยวกับแท็บแรกในเอกสาร

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Document ที่สร้างขึ้นใหม่

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

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

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์