Method: documents.create

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

แสดงผลเอกสารที่สร้าง

คำขอ HTTP

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

URL ใช้ไวยากรณ์ gRPC Transcoding

เนื้อหาของคำขอ

เนื้อหาของคําขอมีข้อมูลที่มีโครงสร้างต่อไปนี้

การแสดง 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

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

string

ชื่อของเอกสาร
body

object (Body)

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

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

เอาต์พุตเท่านั้น ส่วนหัวในเอกสาร แยกตามรหัสส่วนหัว
footers

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

เอาต์พุตเท่านั้น ส่วนท้ายในเอกสาร ซึ่งจัดเรียงตามรหัสส่วนท้าย
footnotes

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

เอาต์พุตเท่านั้น เชิงอรรถในเอกสารเรียงตามรหัสเชิงอรรถ
documentStyle

object (DocumentStyle)

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

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

เอาต์พุตเท่านั้น การเปลี่ยนแปลงที่แนะนําในรูปแบบของเอกสาร แยกตามรหัสคําแนะนํา
namedStyles

object (NamedStyles)

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

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

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

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

เอาต์พุตเท่านั้น รายการในเอกสาร ซึ่งจัดกลุ่มตามรหัสรายการ
namedRanges

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

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

string

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

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

enum (SuggestionsViewMode)

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

หมายเหตุ: เมื่อแก้ไขเอกสาร การเปลี่ยนแปลงจะขึ้นอยู่กับเอกสารที่ใช้ SUGGESTIONS_INLINE
inlineObjects

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

เอาต์พุตเท่านั้น ออบเจ็กต์ในบรรทัดในเอกสารซึ่งจัดเรียงตามรหัสออบเจ็กต์
positionedObjects

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

เอาต์พุตเท่านั้น วัตถุที่วางตําแหน่งในเอกสาร แยกตามรหัสวัตถุ

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

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

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

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

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

สําหรับข้อมูลเพิ่มเติม โปรดดูคู่มือการให้สิทธิ์