REST Resource: documents

แหล่งข้อมูล: เอกสาร

เอกสาร Google เอกสาร

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

string

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

title

string

ชื่อเอกสาร

tabs[]

object (Tab)

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

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

revisionId

string

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

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

suggestionsViewMode

enum (SuggestionsViewMode)

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

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

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 หรือไม่ได้ตั้งค่า ช่องนี้จะมีข้อมูลเกี่ยวกับแท็บแรกในเอกสาร

แท็บ

แท็บในเอกสาร

การแสดง JSON
{
  "tabProperties": {
    object (TabProperties)
  },
  "childTabs": [
    {
      object (Tab)
    }
  ],

  // Union field content can be only one of the following:
  "documentTab": {
    object (DocumentTab)
  }
  // End of list of possible types for union field content.
}
ช่อง
tabProperties

object (TabProperties)

พร็อพเพอร์ตี้ของแท็บ เช่น รหัสและชื่อ

childTabs[]

object (Tab)

แท็บย่อยที่ฝังอยู่ในแท็บนี้

ฟิลด์สหภาพ content เนื้อหาของแท็บ content ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
documentTab

object (DocumentTab)

แท็บที่มีเนื้อหาเอกสาร เช่น ข้อความและรูปภาพ

TabProperties

คุณสมบัติของแท็บ

การแสดง JSON
{
  "tabId": string,
  "title": string,
  "parentTabId": string,
  "index": integer,
  "nestingLevel": integer
}
ช่อง
tabId

string

เอาต์พุตเท่านั้น รหัสของแท็บ ช่องนี้เปลี่ยนแปลงไม่ได้

title

string

ชื่อแท็บที่ผู้ใช้มองเห็น

parentTabId

string

ไม่บังคับ รหัสของแท็บหลัก ว่างเปล่าเมื่อแท็บปัจจุบันเป็นแท็บระดับรูท ซึ่งหมายความว่าไม่มีแท็บหลัก

index

integer

ดัชนีฐาน 0 ของแท็บภายในแท็บหลัก

nestingLevel

integer

เอาต์พุตเท่านั้น ความลึกของแท็บภายในเอกสาร แท็บระดับรูทจะเริ่มต้นที่ 0

DocumentTab

แท็บที่มีเนื้อหาเอกสาร

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

ช่วงที่ตั้งชื่อในแท็บเอกสาร โดยจัดเรียงตามชื่อ

inlineObjects

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

ออบเจ็กต์ในบรรทัดในแท็บเอกสาร โดยจัดเรียงตามรหัสออบเจ็กต์

positionedObjects

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

ออบเจ็กต์ที่จัดตำแหน่งในแท็บเอกสาร โดยจัดเรียงตามรหัสออบเจ็กต์

เนื้อความ

เนื้อความของเอกสาร

โดยปกติแล้ว เนื้อความจะมีเนื้อหาเอกสารฉบับเต็ม ยกเว้น headers, footers และ footnotes

การแสดง JSON
{
  "content": [
    {
      object (StructuralElement)
    }
  ]
}
ช่อง
content[]

object (StructuralElement)

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

ดัชนีของเนื้อหาส่วนเนื้อหาจะเริ่มต้นที่ 0

StructuralElement

StructuralElement อธิบายเนื้อหาที่ให้โครงสร้างแก่เอกสาร

การแสดง JSON
{
  "startIndex": integer,
  "endIndex": integer,

  // Union field content can be only one of the following:
  "paragraph": {
    object (Paragraph)
  },
  "sectionBreak": {
    object (SectionBreak)
  },
  "table": {
    object (Table)
  },
  "tableOfContents": {
    object (TableOfContents)
  }
  // End of list of possible types for union field content.
}
ช่อง
startIndex

integer

ดัชนีเริ่มต้นแบบนับจาก 0 ขององค์ประกอบเชิงโครงสร้างนี้ในหน่วยโค้ด UTF-16

endIndex

integer

ดัชนีสิ้นสุดแบบนับจาก 0 ขององค์ประกอบโครงสร้างนี้แบบไม่รวมในหน่วยโค้ด UTF-16

ฟิลด์สหภาพ content เนื้อหาขององค์ประกอบโครงสร้าง content ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
paragraph

object (Paragraph)

องค์ประกอบเชิงโครงสร้างประเภทย่อหน้า

sectionBreak

object (SectionBreak)

องค์ประกอบโครงสร้างประเภทการแบ่งส่วน

table

object (Table)

องค์ประกอบโครงสร้างประเภทตาราง

tableOfContents

object (TableOfContents)

องค์ประกอบเชิงโครงสร้างประเภทสารบัญ

ย่อหน้า

StructuralElement ที่แสดงถึงย่อหน้า ย่อหน้าคือช่วงของเนื้อหาที่ลงท้ายด้วยอักขระขึ้นบรรทัดใหม่

การแสดง JSON
{
  "elements": [
    {
      object (ParagraphElement)
    }
  ],
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "suggestedParagraphStyleChanges": {
    string: {
      object (SuggestedParagraphStyle)
    },
    ...
  },
  "bullet": {
    object (Bullet)
  },
  "suggestedBulletChanges": {
    string: {
      object (SuggestedBullet)
    },
    ...
  },
  "positionedObjectIds": [
    string
  ],
  "suggestedPositionedObjectIds": {
    string: {
      object (ObjectReferences)
    },
    ...
  }
}
ช่อง
elements[]

object (ParagraphElement)

เนื้อหาของย่อหน้าซึ่งแบ่งออกเป็นส่วนประกอบ

paragraphStyle

object (ParagraphStyle)

รูปแบบของย่อหน้านี้

suggestedParagraphStyleChanges

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

รูปแบบย่อหน้าแนะนำจะเปลี่ยนเป็นย่อหน้านี้ โดยระบบจะกำหนดรหัสคำแนะนำ

bullet

object (Bullet)

หัวข้อย่อยของย่อหน้านี้ หากไม่มี แสดงว่าย่อหน้าไม่ได้อยู่ในรายการ

suggestedBulletChanges

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

การเปลี่ยนแปลงที่แนะนำสำหรับหัวข้อย่อยของย่อหน้านี้

positionedObjectIds[]

string

รหัสของออบเจ็กต์ที่วางตำแหน่งไว้ซึ่งเชื่อมโยงกับย่อหน้านี้

suggestedPositionedObjectIds

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

รหัสของออบเจ็กต์ที่วางตำแหน่งไว้ซึ่งแนะนำให้แนบไปกับย่อหน้านี้ โดยจัดเรียงตามรหัสคำแนะนำ

ParagraphElement

ParagraphElement อธิบายเนื้อหาภายใน Paragraph

การแสดง JSON
{
  "startIndex": integer,
  "endIndex": integer,

  // Union field content can be only one of the following:
  "textRun": {
    object (TextRun)
  },
  "autoText": {
    object (AutoText)
  },
  "pageBreak": {
    object (PageBreak)
  },
  "columnBreak": {
    object (ColumnBreak)
  },
  "footnoteReference": {
    object (FootnoteReference)
  },
  "horizontalRule": {
    object (HorizontalRule)
  },
  "equation": {
    object (Equation)
  },
  "inlineObjectElement": {
    object (InlineObjectElement)
  },
  "person": {
    object (Person)
  },
  "richLink": {
    object (RichLink)
  }
  // End of list of possible types for union field content.
}
ช่อง
startIndex

integer

ดัชนีเริ่มต้นแบบนับจาก 0 ขององค์ประกอบย่อหน้านี้ในหน่วยโค้ด UTF-16

endIndex

integer

ดัชนีสิ้นสุดฐาน 0 ขององค์ประกอบย่อหน้านี้แบบไม่รวมในหน่วยโค้ด UTF-16

ฟิลด์สหภาพ content เนื้อหาขององค์ประกอบย่อหน้า content ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
textRun

object (TextRun)

องค์ประกอบย่อหน้าของข้อความ

autoText

object (AutoText)

องค์ประกอบย่อหน้าข้อความอัตโนมัติ

pageBreak

object (PageBreak)

องค์ประกอบย่อหน้าตัวแบ่งหน้า

columnBreak

object (ColumnBreak)

องค์ประกอบย่อหน้าตัวแบ่งคอลัมน์

footnoteReference

object (FootnoteReference)

องค์ประกอบย่อหน้าการอ้างอิงเชิงอรรถ

horizontalRule

object (HorizontalRule)

องค์ประกอบย่อหน้าของเส้นแนวนอน

equation

object (Equation)

องค์ประกอบย่อหน้าของสมการ

inlineObjectElement

object (InlineObjectElement)

องค์ประกอบย่อหน้าออบเจ็กต์ในบรรทัด

person

object (Person)

องค์ประกอบย่อหน้าซึ่งลิงก์ไปยังบุคคลหรืออีเมล

TextRun

ParagraphElement ที่แสดงถึงข้อความที่มีการจัดรูปแบบเหมือนกันทั้งหมด

การแสดง JSON
{
  "content": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
ช่อง
content

string

ข้อความของการเรียกใช้นี้

ระบบจะแทนที่องค์ประกอบที่ไม่ใช่ข้อความทั้งหมดในรันไทม์ด้วยอักขระ Unicode U+E907

suggestedInsertionIds[]

string

รหัสการแทรกที่แนะนํา TextRun อาจมีรหัสการแทรกหลายรายการหากเป็นการเปลี่ยนแปลงที่แนะนำแบบซ้อนกัน หากเป็นค่าว่าง แสดงว่านี่ไม่ใช่การแทรกที่แนะนำ

suggestedDeletionIds[]

string

รหัสการลบที่แนะนำ หากช่องนี้ว่าง แสดงว่าไม่มีคำแนะนำให้ลบเนื้อหานี้

textStyle

object (TextStyle)

รูปแบบข้อความของการทำงานนี้

suggestedTextStyleChanges

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

รูปแบบข้อความที่แนะนำจะเปลี่ยนเป็นรูปแบบนี้สำหรับรอบนี้ โดยคีย์ตามรหัสคำแนะนำ

TextStyle

แสดงการจัดรูปแบบที่ใช้กับข้อความได้

รูปแบบข้อความที่รับค่ามาจะแสดงเป็นช่องที่ไม่ได้ตั้งค่าในข้อความนี้ รูปแบบข้อความหลักจะขึ้นอยู่กับตำแหน่งที่กำหนดรูปแบบข้อความ ดังนี้

  • TextStyle ของข้อความใน Paragraph จะรับค่ามาจาก named style type ที่สอดคล้องกันของย่อหน้า
  • TextStyle ใน named style รับค่ามาจากสไตล์ที่มีชื่อ normal text
  • TextStyle ของรูปแบบที่มีชื่อ normal text จะรับค่ารูปแบบข้อความเริ่มต้นในเครื่องมือแก้ไขเอกสาร
  • TextStyle ในองค์ประกอบ Paragraph ที่มีอยู่ในตารางอาจรับรูปแบบข้อความมาจากรูปแบบตาราง

หากรูปแบบข้อความไม่ได้รับค่าจากรูปแบบหลัก การยกเลิกการตั้งค่าช่องจะทำให้รูปแบบเปลี่ยนกลับไปเป็นค่าที่ตรงกับค่าเริ่มต้นในตัวแก้ไขเอกสาร

การแสดง JSON
{
  "bold": boolean,
  "italic": boolean,
  "underline": boolean,
  "strikethrough": boolean,
  "smallCaps": boolean,
  "backgroundColor": {
    object (OptionalColor)
  },
  "foregroundColor": {
    object (OptionalColor)
  },
  "fontSize": {
    object (Dimension)
  },
  "weightedFontFamily": {
    object (WeightedFontFamily)
  },
  "baselineOffset": enum (BaselineOffset),
  "link": {
    object (Link)
  }
}
ช่อง
bold

boolean

ข้อความแสดงผลเป็นตัวหนาหรือไม่

italic

boolean

ข้อความเป็นตัวเอียงหรือไม่

underline

boolean

ข้อความมีขีดเส้นใต้หรือไม่

strikethrough

boolean

ข้อความถูกขีดฆ่าหรือไม่

smallCaps

boolean

ข้อความเป็นตัวพิมพ์ใหญ่แบบเล็กหรือไม่

backgroundColor

object (OptionalColor)

สีพื้นหลังของข้อความ หากตั้งค่าไว้ สีจะเป็นสี RGB หรือโปร่งใส ขึ้นอยู่กับช่อง color

foregroundColor

object (OptionalColor)

สีพื้นหน้าของข้อความ หากตั้งค่าไว้ สีจะเป็นสี RGB หรือโปร่งใส ขึ้นอยู่กับช่อง color

fontSize

object (Dimension)

ขนาดแบบอักษรของข้อความ

weightedFontFamily

object (WeightedFontFamily)

ชุดแบบอักษรและน้ำหนักแบบอักษรที่แสดงผลของข้อความ

หากคำขออัปเดตระบุค่าสำหรับทั้ง weightedFontFamily และ bold ระบบจะใช้ weightedFontFamily ก่อนแล้วตามด้วย bold

หากไม่ได้ตั้งค่า weightedFontFamily#weight ระบบจะใช้ 400 เป็นค่าเริ่มต้น

หากตั้งค่า weightedFontFamily แล้ว ก็ต้องตั้งค่า weightedFontFamily#fontFamily ด้วยโดยให้มีค่าที่ไม่ใช่ค่าว่าง มิฉะนั้น ระบบจะแสดงข้อผิดพลาด 400 Bad Request

baselineOffset

enum (BaselineOffset)

ระยะห่างแนวตั้งของข้อความจากตําแหน่งปกติ

ข้อความที่มีการเลื่อนบรรทัดฐาน SUPERSCRIPT หรือ SUBSCRIPT จะแสดงผลโดยอัตโนมัติด้วยขนาดแบบอักษรที่เล็กลง ซึ่งคำนวณตามช่อง fontSize การเปลี่ยนแปลงในช่องนี้ไม่ส่งผลต่อ fontSize

OptionalColor

สีที่ทึบแสงหรือโปร่งแสงได้ทั้งหมด

การแสดง JSON
{
  "color": {
    object (Color)
  }
}
ช่อง
color

object (Color)

หากตั้งค่าไว้ ระบบจะใช้สีนี้เป็นสีทึบ หากไม่ได้ตั้งค่า จะเป็นค่าที่แสดงถึงสีโปร่งใส

สี

สีทึบ

การแสดง JSON
{
  "rgbColor": {
    object (RgbColor)
  }
}
ช่อง
rgbColor

object (RgbColor)

ค่าสี RGB

RgbColor

สี RGB

การแสดง JSON
{
  "red": number,
  "green": number,
  "blue": number
}
ช่อง
red

number

ส่วนประกอบสีแดงของสี ตั้งแต่ 0.0 ถึง 1.0

green

number

ส่วนประกอบสีเขียวของสี ตั้งแต่ 0.0 ถึง 1.0

blue

number

องค์ประกอบสีน้ำเงินของสี ตั้งแต่ 0.0 ถึง 1.0

มิติข้อมูล

ขนาดในทิศทางเดียวในหน่วยที่ระบุ

การแสดง JSON
{
  "magnitude": number,
  "unit": enum (Unit)
}
ช่อง
magnitude

number

ขนาด

unit

enum (Unit)

หน่วยของขนาด

หน่วย

หน่วยวัด

Enum
UNIT_UNSPECIFIED ไม่ทราบหน่วย
PT จุด 1/72 นิ้ว

WeightedFontFamily

แสดงชุดแบบอักษรและน้ำหนักของข้อความ

การแสดง JSON
{
  "fontFamily": string,
  "weight": integer
}
ช่อง
fontFamily

string

ชุดแบบอักษรของข้อความ

ชุดแบบอักษรอาจเป็นแบบอักษรใดก็ได้จากเมนูแบบอักษรในเอกสารหรือจาก Google Fonts หากระบบไม่รู้จักชื่อแบบอักษร ระบบจะแสดงผลข้อความเป็น Arial

weight

integer

น้ำหนักของแบบอักษร ช่องนี้อาจมีค่าใดก็ได้ที่หารด้วย 100 ได้ตั้งแต่ 100 ถึง 900 ช่วงนี้สอดคล้องกับค่าตัวเลขที่อธิบายไว้ในข้อกำหนดเฉพาะของ CSS 2.1 ส่วนที่ 15.6 ซึ่งไม่อนุญาตให้ใช้ค่าที่ไม่ใช่ตัวเลข

ค่าเริ่มต้นคือ 400 ("ปกติ")

น้ำหนักแบบอักษรเป็นเพียงองค์ประกอบหนึ่งของน้ำหนักแบบอักษรที่แสดงผล ค่า weight และ bold ที่แก้ไขแล้วของสไตล์ข้อความจะกำหนดน้ำหนักที่แสดงผลหลังจากพิจารณาการสืบทอดแล้ว ดังนี้

  • หากข้อความเป็นตัวหนาและน้ำหนักน้อยกว่า 400 น้ำหนักที่แสดงผลจะเป็น 400
  • หากข้อความเป็นตัวหนาและน้ำหนักมากกว่าหรือเท่ากับ 400 แต่น้อยกว่า 700 น้ำหนักที่แสดงผลจะเป็น 700
  • หากน้ำหนักมากกว่าหรือเท่ากับ 700 น้ำหนักที่แสดงผลจะเท่ากับน้ำหนัก
  • หากข้อความไม่ใช่ตัวหนา น้ำหนักที่แสดงผลจะเท่ากับน้ำหนัก

BaselineOffset

วิธีเลื่อนข้อความในแนวตั้งออกจากตำแหน่งปกติ

Enum
BASELINE_OFFSET_UNSPECIFIED ส่วนการเลื่อนเส้นฐานของข้อความจะรับค่ามาจากองค์ประกอบหลัก
NONE ข้อความไม่เลื่อนในแนวตั้ง
SUPERSCRIPT ข้อความจะเลื่อนขึ้นด้านบนในแนวตั้ง (ตัวยก)
SUBSCRIPT ข้อความมีการเลื่อนในแนวตั้งลง (ตัวห้อย)

SuggestedTextStyle

การเปลี่ยนแปลงที่แนะนำใน TextStyle

การแสดง JSON
{
  "textStyle": {
    object (TextStyle)
  },
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}
ช่อง
textStyle

object (TextStyle)

TextStyle ที่มีเฉพาะการเปลี่ยนแปลงที่ทำในคําแนะนํานี้ ซึ่งสามารถใช้ร่วมกับ textStyleSuggestionState เพื่อดูว่าฟิลด์ใดมีการเปลี่ยนแปลงและค่าใหม่ของฟิลด์นั้น

textStyleSuggestionState

object (TextStyleSuggestionState)

มาสก์ที่ระบุว่าช่องใดใน TextStyle พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้

TextStyleSuggestionState

มาสก์ที่ระบุว่าช่องใดใน TextStyle พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้ สำหรับช่องใดก็ตามที่ตั้งค่าเป็น "จริง" จะมีค่าใหม่ที่แนะนำ

การแสดง JSON
{
  "boldSuggested": boolean,
  "italicSuggested": boolean,
  "underlineSuggested": boolean,
  "strikethroughSuggested": boolean,
  "smallCapsSuggested": boolean,
  "backgroundColorSuggested": boolean,
  "foregroundColorSuggested": boolean,
  "fontSizeSuggested": boolean,
  "weightedFontFamilySuggested": boolean,
  "baselineOffsetSuggested": boolean,
  "linkSuggested": boolean
}
ช่อง
boldSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน bold หรือไม่

italicSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน italic หรือไม่

underlineSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน underline หรือไม่

strikethroughSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน strikethrough หรือไม่

smallCapsSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน smallCaps หรือไม่

backgroundColorSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน backgroundColor หรือไม่

foregroundColorSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน foregroundColor หรือไม่

fontSizeSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน fontSize หรือไม่

weightedFontFamilySuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน weightedFontFamily หรือไม่

baselineOffsetSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน baselineOffset หรือไม่

AutoText

ParagraphElement ที่แสดงตำแหน่งในข้อความซึ่งระบบจะแทนที่ด้วยเนื้อหาแบบไดนามิกที่เปลี่ยนแปลงได้เมื่อเวลาผ่านไป เช่น หมายเลขหน้า

การแสดง JSON
{
  "type": enum (Type),
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
ช่อง
type

enum (Type)

ประเภทของข้อความอัตโนมัตินี้

suggestedInsertionIds[]

string

รหัสการแทรกที่แนะนํา AutoText อาจมีรหัสการแทรกหลายรายการหากเป็นการเปลี่ยนแปลงที่แนะนำแบบซ้อนกัน หากเป็นค่าว่าง แสดงว่านี่ไม่ใช่การแทรกที่แนะนำ

suggestedDeletionIds[]

string

รหัสการลบที่แนะนำ หากช่องนี้ว่าง แสดงว่าไม่มีคำแนะนำให้ลบเนื้อหานี้

textStyle

object (TextStyle)

รูปแบบข้อความของข้อความอัตโนมัตินี้

suggestedTextStyleChanges

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

รูปแบบข้อความที่แนะนำจะเปลี่ยนเป็นข้อความอัตโนมัตินี้ โดยระบบจะจัดเก็บตามรหัสคำแนะนำ

ประเภท

ประเภทของข้อความอัตโนมัติ

Enum
TYPE_UNSPECIFIED ประเภทข้อความอัตโนมัติที่ไม่ระบุ
PAGE_NUMBER พิมพ์ข้อความอัตโนมัติที่แสดงหมายเลขหน้าปัจจุบัน
PAGE_COUNT พิมพ์ข้อความอัตโนมัติที่แสดงจํานวนหน้าทั้งหมดในเอกสาร

PageBreak

ParagraphElement ที่แสดงตัวแบ่งหน้า ตัวแบ่งหน้าจะทำให้ข้อความถัดๆ ไปเริ่มต้นที่ด้านบนของหน้าถัดไป

การแสดง JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
ช่อง
suggestedInsertionIds[]

string

รหัสการแทรกที่แนะนํา PageBreak อาจมีรหัสการแทรกหลายรายการหากเป็นการเปลี่ยนแปลงที่แนะนำแบบซ้อนกัน หากเป็นค่าว่าง แสดงว่านี่ไม่ใช่การแทรกที่แนะนำ

suggestedDeletionIds[]

string

รหัสการลบที่แนะนำ หากช่องนี้ว่าง แสดงว่าไม่มีคำแนะนำให้ลบเนื้อหานี้

textStyle

object (TextStyle)

รูปแบบข้อความของส่วนแบ่งหน้านี้

รูปแบบข้อความของหน้าแบ่งอาจส่งผลต่อเลย์เอาต์ของเนื้อหา รวมถึงรูปแบบของข้อความที่แทรกไว้ข้างๆ เช่นเดียวกับเนื้อหาข้อความ เช่น ข้อความต่อเนื่องและการอ้างอิงเชิงอรรถ

suggestedTextStyleChanges

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

รูปแบบข้อความที่แนะนำจะเปลี่ยนเป็น PageBreak นี้ โดยคีย์ตามรหัสคำแนะนำ

ColumnBreak

ParagraphElement ที่แสดงตัวแบ่งคอลัมน์ การแบ่งคอลัมน์จะทำให้ข้อความที่ตามมาเริ่มต้นที่ด้านบนของคอลัมน์ถัดไป

การแสดง JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
ช่อง
suggestedInsertionIds[]

string

รหัสการแทรกที่แนะนํา ColumnBreak อาจมีรหัสการแทรกหลายรายการหากเป็นการเปลี่ยนแปลงที่แนะนำแบบซ้อนกัน หากเป็นค่าว่าง แสดงว่านี่ไม่ใช่การแทรกที่แนะนำ

suggestedDeletionIds[]

string

รหัสการลบที่แนะนำ หากช่องนี้ว่าง แสดงว่าไม่มีคำแนะนำให้ลบเนื้อหานี้

textStyle

object (TextStyle)

รูปแบบข้อความของ ColumnBreak นี้

รูปแบบข้อความของการตัดคอลัมน์อาจส่งผลต่อเลย์เอาต์ของเนื้อหา รวมถึงรูปแบบของข้อความที่แทรกไว้ข้างๆ เช่นเดียวกับเนื้อหาข้อความ เช่น ข้อความต่อเนื่องและการอ้างอิงเชิงอรรถ

suggestedTextStyleChanges

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

รูปแบบข้อความที่แนะนำจะเปลี่ยนเป็น ColumnBreak นี้ โดยคีย์ตามรหัสคำแนะนำ

FootnoteReference

ParagraphElement ที่แสดงการอ้างอิงเชิงอรรถ การอ้างอิงเชิงอรรถคือเนื้อหาในบรรทัดที่มีการแสดงผลด้วยตัวเลขและใช้ในการระบุเชิงอรรถ

การแสดง JSON
{
  "footnoteId": string,
  "footnoteNumber": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
ช่อง
footnoteId

string

รหัสของ footnote ที่มีเนื้อหาของการอ้างอิงเชิงอรรถนี้

footnoteNumber

string

หมายเลขที่แสดงผลของเชิงอรรถนี้

suggestedInsertionIds[]

string

รหัสการแทรกที่แนะนํา FootnoteReference อาจมีรหัสการแทรกหลายรายการหากเป็นการเปลี่ยนแปลงที่แนะนำแบบซ้อนกัน หากเป็นค่าว่าง แสดงว่านี่ไม่ใช่การแทรกที่แนะนำ

suggestedDeletionIds[]

string

รหัสการลบที่แนะนำ หากช่องนี้ว่าง แสดงว่าไม่มีคำแนะนำให้ลบเนื้อหานี้

textStyle

object (TextStyle)

รูปแบบข้อความของ FootnoteReference นี้

suggestedTextStyleChanges

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

รูปแบบข้อความที่แนะนำจะเปลี่ยนเป็น FootnoteReference นี้ โดยคีย์ตามรหัสคำแนะนำ

HorizontalRule

ParagraphElement ที่แสดงเส้นแนวนอน

การแสดง JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
ช่อง
suggestedInsertionIds[]

string

รหัสการแทรกที่แนะนํา HorizontalRule อาจมีรหัสการแทรกหลายรายการหากเป็นการเปลี่ยนแปลงที่แนะนำซึ่งซ้อนกัน หากเป็นค่าว่าง แสดงว่านี่ไม่ใช่การแทรกที่แนะนำ

suggestedDeletionIds[]

string

รหัสการลบที่แนะนำ หากช่องนี้ว่าง แสดงว่าไม่มีคำแนะนำให้ลบเนื้อหานี้

textStyle

object (TextStyle)

รูปแบบข้อความของ HorizontalRule นี้

รูปแบบข้อความของเส้นแนวนอนอาจส่งผลต่อเลย์เอาต์ของเนื้อหา รวมถึงการจัดรูปแบบข้อความที่แทรกไว้ข้างๆ เช่นเดียวกับเนื้อหาข้อความ เช่น บรรทัดข้อความและการอ้างอิงเชิงอรรถ

suggestedTextStyleChanges

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

รูปแบบข้อความที่แนะนำจะเปลี่ยนเป็น HorizontalRule นี้ โดยคีย์ตามรหัสคำแนะนำ

สมการ

ParagraphElement ที่แสดงสมการ

การแสดง JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}
ช่อง
suggestedInsertionIds[]

string

รหัสการแทรกที่แนะนํา Equation อาจมีรหัสการแทรกหลายรายการหากเป็นการเปลี่ยนแปลงที่แนะนำแบบซ้อนกัน หากเป็นค่าว่าง แสดงว่านี่ไม่ใช่การแทรกที่แนะนำ

suggestedDeletionIds[]

string

รหัสการลบที่แนะนำ หากช่องนี้ว่าง แสดงว่าไม่มีคำแนะนำให้ลบเนื้อหานี้

InlineObjectElement

ParagraphElement ที่มี InlineObject

การแสดง JSON
{
  "inlineObjectId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
ช่อง
inlineObjectId

string

รหัสของ InlineObject ที่องค์ประกอบนี้มี

suggestedInsertionIds[]

string

รหัสการแทรกที่แนะนํา InlineObjectElement อาจมีรหัสการแทรกหลายรายการหากเป็นการเปลี่ยนแปลงที่แนะนำแบบซ้อนกัน หากเป็นค่าว่าง แสดงว่านี่ไม่ใช่การแทรกที่แนะนำ

suggestedDeletionIds[]

string

รหัสการลบที่แนะนำ หากช่องนี้ว่าง แสดงว่าไม่มีคำแนะนำให้ลบเนื้อหานี้

textStyle

object (TextStyle)

รูปแบบข้อความของ InlineObjectElement นี้

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

suggestedTextStyleChanges

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

รูปแบบข้อความที่แนะนำจะเปลี่ยนเป็น InlineObject นี้ โดยคีย์ตามรหัสคำแนะนำ

บุคคล

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

การแสดง JSON
{
  "personId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  },
  "personProperties": {
    object (PersonProperties)
  }
}
ช่อง
personId

string

เอาต์พุตเท่านั้น รหัสที่ไม่ซ้ำกันของลิงก์นี้

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

รหัสสำหรับคำแนะนำที่นำลิงก์ของบุคคลนี้ออกจากเอกสาร Person อาจมีรหัสการลบหลายรายการ เช่น ในกรณีที่ผู้ใช้หลายคนแนะนำให้ลบ หากว่างเปล่า ระบบจะไม่แนะนำให้ลบลิงก์ของบุคคลนี้

textStyle

object (TextStyle)

รูปแบบข้อความของ Person นี้

suggestedTextStyleChanges

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

รูปแบบข้อความที่แนะนำจะเปลี่ยนเป็น Person นี้ โดยคีย์ตามรหัสคำแนะนำ

personProperties

object (PersonProperties)

เอาต์พุตเท่านั้น พร็อพเพอร์ตี้ของ Person นี้ ช่องนี้จะแสดงอยู่เสมอ

PersonProperties

พร็อพเพอร์ตี้เฉพาะของ Person ที่ลิงก์

การแสดง JSON
{
  "name": string,
  "email": string
}
ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อของบุคคล หากแสดงในข้อความลิงก์แทนอีเมลของบุคคลนั้น

email

string

เอาต์พุตเท่านั้น อีเมลที่ลิงก์กับ Person นี้ ช่องนี้จะแสดงอยู่เสมอ

RichLinkProperties

พร็อพเพอร์ตี้เฉพาะสำหรับ RichLink

การแสดง JSON
{
  "title": string,
  "uri": string,
  "mimeType": string
}
ช่อง
title

string

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

uri

string

เอาต์พุตเท่านั้น URI ไปยัง RichLink รายการนี้แสดงอยู่เสมอ

mimeType

string

เอาต์พุตเท่านั้น ประเภท MIME ของ RichLink หากมี (เช่น เมื่อเป็นไฟล์ในไดรฟ์)

ParagraphStyle

รูปแบบที่ใช้กับทั้งย่อหน้า

รูปแบบย่อหน้าแบบรับค่ามาจะแสดงเป็นช่องที่ไม่ได้ตั้งค่าในข้อความนี้ สไตล์หลักของสไตล์ย่อหน้าจะขึ้นอยู่กับตำแหน่งที่กำหนดสไตล์ย่อหน้า ดังนี้

  • ParagraphStyle ใน Paragraph จะรับค่ามาจาก named style type ที่เกี่ยวข้องของย่อหน้า
  • ParagraphStyle ใน named style รับค่ามาจากรูปแบบที่มีชื่อ normal text
  • ParagraphStyle ของรูปแบบที่มีชื่อ normal text จะรับค่ามาจากรูปแบบย่อหน้าเริ่มต้นในเครื่องมือแก้ไขของ Google เอกสาร
  • ParagraphStyle ในองค์ประกอบ Paragraph ที่รวมอยู่ในตารางอาจรับรูปแบบย่อหน้ามาจากรูปแบบตาราง

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

การแสดง JSON
{
  "headingId": string,
  "namedStyleType": enum (NamedStyleType),
  "alignment": enum (Alignment),
  "lineSpacing": number,
  "direction": enum (ContentDirection),
  "spacingMode": enum (SpacingMode),
  "spaceAbove": {
    object (Dimension)
  },
  "spaceBelow": {
    object (Dimension)
  },
  "borderBetween": {
    object (ParagraphBorder)
  },
  "borderTop": {
    object (ParagraphBorder)
  },
  "borderBottom": {
    object (ParagraphBorder)
  },
  "borderLeft": {
    object (ParagraphBorder)
  },
  "borderRight": {
    object (ParagraphBorder)
  },
  "indentFirstLine": {
    object (Dimension)
  },
  "indentStart": {
    object (Dimension)
  },
  "indentEnd": {
    object (Dimension)
  },
  "tabStops": [
    {
      object (TabStop)
    }
  ],
  "keepLinesTogether": boolean,
  "keepWithNext": boolean,
  "avoidWidowAndOrphan": boolean,
  "shading": {
    object (Shading)
  },
  "pageBreakBefore": boolean
}
ช่อง
headingId

string

รหัสส่วนหัวของย่อหน้า หากเป็นค่าว่าง แสดงว่าย่อหน้านี้ไม่ใช่ส่วนหัว

พร็อพเพอร์ตี้นี้เป็นแบบอ่านอย่างเดียว

namedStyleType

enum (NamedStyleType)

ประเภทสไตล์ที่มีชื่อของย่อหน้า

เนื่องจากการอัปเดตประเภทสไตล์ที่มีชื่อจะส่งผลต่อพร็อพเพอร์ตี้อื่นๆ ภายใน ParagraphStyle ระบบจึงจะใช้ประเภทสไตล์ที่มีชื่อก่อนอัปเดตพร็อพเพอร์ตี้อื่นๆ

alignment

enum (Alignment)

การจัดข้อความของย่อหน้านี้

lineSpacing

number

ระยะห่างระหว่างบรรทัดเป็นเปอร์เซ็นต์ของค่าปกติ โดยที่ค่าปกติแสดงเป็น 100.0 หากไม่ได้ตั้งค่าไว้ ระบบจะรับค่ามาจากรายการหลัก

direction

enum (ContentDirection)

ทิศทางข้อความของย่อหน้านี้ หากไม่ได้ตั้งค่า ค่าเริ่มต้นจะเป็น LEFT_TO_RIGHT เนื่องจากระบบจะไม่รับค่าทิศทางย่อหน้า

spacingMode

enum (SpacingMode)

โหมดระยะห่างของย่อหน้า

spaceAbove

object (Dimension)

จำนวนช่องว่างด้านบนย่อหน้า หากไม่ได้ตั้งค่าไว้ ระบบจะรับค่ามาจากรายการหลัก

spaceBelow

object (Dimension)

ระยะห่างเพิ่มเติมใต้ย่อหน้า หากไม่ได้ตั้งค่าไว้ ระบบจะรับค่ามาจากรายการหลัก

borderBetween

object (ParagraphBorder)

เส้นขอบระหว่างย่อหน้านี้กับย่อหน้าก่อนหน้าและถัดไป หากไม่ได้ตั้งค่าไว้ ระบบจะรับค่ามาจากรายการหลัก

ระบบจะแสดงผลเส้นขอบระหว่างเมื่อย่อหน้าที่อยู่ติดกันมีพร็อพเพอร์ตี้เส้นขอบและการเยื้องเดียวกัน

คุณจะอัปเดตเส้นขอบย่อหน้าเพียงบางส่วนไม่ได้ เมื่อเปลี่ยนเส้นขอบของย่อหน้า คุณต้องระบุเส้นขอบใหม่ทั้งหมด

borderTop

object (ParagraphBorder)

เส้นขอบที่ด้านบนของย่อหน้านี้ หากไม่ได้ตั้งค่าไว้ ระบบจะรับค่ามาจากรายการหลัก

ระบบจะแสดงผลเส้นขอบด้านบนเมื่อย่อหน้าด้านบนมีพร็อพเพอร์ตี้เส้นขอบและการเยื้องต่างกัน

อัปเดตเส้นขอบย่อหน้าเพียงบางส่วนไม่ได้ เมื่อเปลี่ยนเส้นขอบของย่อหน้า คุณต้องระบุเส้นขอบใหม่ทั้งหมด

borderBottom

object (ParagraphBorder)

เส้นขอบที่ด้านล่างของย่อหน้านี้ หากไม่ได้ตั้งค่าไว้ ระบบจะรับค่ามาจากรายการหลัก

ระบบจะแสดงผลเส้นขอบด้านล่างเมื่อย่อหน้าด้านล่างมีพร็อพเพอร์ตี้เส้นขอบและการเยื้องต่างกัน

อัปเดตเส้นขอบย่อหน้าเพียงบางส่วนไม่ได้ เมื่อเปลี่ยนเส้นขอบของย่อหน้า คุณต้องระบุเส้นขอบใหม่ทั้งหมด

borderLeft

object (ParagraphBorder)

เส้นขอบด้านซ้ายของย่อหน้านี้ หากไม่ได้ตั้งค่าไว้ ระบบจะรับค่ามาจากรายการหลัก

อัปเดตเส้นขอบย่อหน้าเพียงบางส่วนไม่ได้ เมื่อเปลี่ยนเส้นขอบของย่อหน้า คุณต้องระบุเส้นขอบใหม่ทั้งหมด

borderRight

object (ParagraphBorder)

เส้นขอบทางด้านขวาของย่อหน้านี้ หากไม่ได้ตั้งค่าไว้ ระบบจะรับค่ามาจากรายการหลัก

อัปเดตเส้นขอบย่อหน้าเพียงบางส่วนไม่ได้ เมื่อเปลี่ยนเส้นขอบของย่อหน้า คุณต้องระบุเส้นขอบใหม่ทั้งหมด

indentFirstLine

object (Dimension)

จำนวนการเยื้องสำหรับบรรทัดแรกของย่อหน้า หากไม่ได้ตั้งค่าไว้ ระบบจะรับค่ามาจากรายการหลัก

indentStart

object (Dimension)

ระยะเยื้องของย่อหน้าทางด้านที่สอดคล้องกับจุดเริ่มต้นของข้อความ โดยอิงตามทิศทางของย่อหน้าปัจจุบัน หากไม่ได้ตั้งค่าไว้ ระบบจะรับค่ามาจากรายการหลัก

indentEnd

object (Dimension)

ระยะเยื้องของย่อหน้าทางด้านที่สอดคล้องกับส่วนท้ายของข้อความ โดยอิงตามทิศทางของย่อหน้าปัจจุบัน หากไม่ได้ตั้งค่าไว้ ระบบจะรับค่ามาจากรายการหลัก

tabStops[]

object (TabStop)

รายการการหยุดแท็บของย่อหน้านี้ รายการการหยุดแท็บจะไม่รับค่ามา

พร็อพเพอร์ตี้นี้เป็นแบบอ่านอย่างเดียว

keepLinesTogether

boolean

กำหนดว่าควรจัดวางบรรทัดทั้งหมดของย่อหน้าในหน้าหรือคอลัมน์เดียวกันหรือไม่ (หากเป็นไปได้) หากไม่ได้ตั้งค่าไว้ ระบบจะรับค่ามาจากรายการหลัก

keepWithNext

boolean

ควรจะจัดวางย่อหน้านี้อย่างน้อยบางส่วนในหน้าหรือคอลัมน์เดียวกับย่อหน้าถัดไปหรือไม่ หากเป็นไปได้ หากไม่ได้ตั้งค่าไว้ ระบบจะรับค่ามาจากรายการหลัก

avoidWidowAndOrphan

boolean

หลีกเลี่ยงบรรทัดแรกและบรรทัดสุดท้ายของย่อหน้าหรือไม่ หากไม่ได้ตั้งค่าไว้ ระบบจะรับค่ามาจากรายการหลัก

shading

object (Shading)

การลงสีของย่อหน้า หากไม่ได้ตั้งค่าไว้ ระบบจะรับค่ามาจากรายการหลัก

pageBreakBefore

boolean

ย่อหน้าปัจจุบันควรเริ่มต้นที่ด้านบนของหน้าเสมอหรือไม่ หากไม่ได้ตั้งค่าไว้ ระบบจะรับค่ามาจากรายการหลัก

การพยายามอัปเดต pageBreakBefore สำหรับย่อหน้าในภูมิภาคที่ไม่รองรับ ซึ่งรวมถึง Table, Header, Footer และ Footnote อาจส่งผลให้สถานะเอกสารไม่ถูกต้องซึ่งแสดงข้อผิดพลาด 400 คำขอไม่ถูกต้อง

NamedStyleType

ประเภทของรูปแบบที่มีชื่อ

Enum
NAMED_STYLE_TYPE_UNSPECIFIED ไม่ได้ระบุประเภทของสไตล์ที่มีชื่อ
NORMAL_TEXT ข้อความปกติ
TITLE ชื่อ
SUBTITLE คำบรรยาย
HEADING_1 หัวข้อ 1
HEADING_2 หัวข้อ 2
HEADING_3 หัวข้อ 3
HEADING_4 หัวข้อ 4
HEADING_5 หัวข้อ 5
HEADING_6 หัวข้อ 6

การจัดข้อความ

ประเภทการจัดแนวข้อความของย่อหน้า

Enum
ALIGNMENT_UNSPECIFIED การจัดแนวย่อหน้าจะรับค่ามาจากระดับบน
START ย่อหน้าจะจัดแนวกับจุดเริ่มต้นของบรรทัด จัดชิดซ้ายสำหรับข้อความแบบ LTR และจัดชิดขวาสำหรับข้อความแบบอื่นๆ
CENTER ย่อหน้าอยู่กึ่งกลาง
END ย่อหน้าจะจัดแนวกับส่วนท้ายของบรรทัด จัดชิดขวาสำหรับข้อความแบบ LTR และจัดชิดซ้ายสำหรับข้อความแบบอื่นๆ
JUSTIFIED ย่อหน้ามีการจัดข้อความให้ชิดขอบ

ContentDirection

เนื้อหาเส้นทางจะแสดงตามลำดับ

Enum
CONTENT_DIRECTION_UNSPECIFIED ไม่ได้ระบุทิศทางของเนื้อหา
LEFT_TO_RIGHT เนื้อหาจะแสดงจากซ้ายไปขวา
RIGHT_TO_LEFT เนื้อหาจะเลื่อนจากขวาไปซ้าย

SpacingMode

โหมดต่างๆ ของการเว้นวรรคระหว่างย่อหน้า

Enum
SPACING_MODE_UNSPECIFIED โหมดระยะห่างจะรับค่ามาจากเทมเพลตหลัก
NEVER_COLLAPSE ระบบจะแสดงผลระยะบรรทัดของย่อหน้าเสมอ
COLLAPSE_LISTS ระบบจะข้ามการเว้นวรรคระหว่างองค์ประกอบรายการ

ParagraphBorder

เส้นขอบรอบๆ ย่อหน้า

การแสดง JSON
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "padding": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}
ช่อง
color

object (OptionalColor)

สีของเส้นขอบ

width

object (Dimension)

ความกว้างของเส้นขอบ

padding

object (Dimension)

ระยะห่างจากขอบของเส้นขอบ

dashStyle

enum (DashStyle)

รูปแบบเส้นประของเส้นขอบ

DashStyle

ประเภทขีดกลางที่แสดงผลเรขาคณิตเชิงเส้นได้ ค่าเหล่านี้อิงตามประเภทพื้นฐาน "ST_PresetLineDashVal" ที่อธิบายไว้ในส่วน 20.1.10.48 ของ "รูปแบบไฟล์ Office Open XML - ข้อมูลเบื้องต้นและข้อมูลอ้างอิงภาษามาร์กอัป" ส่วนที่ 1 ของ ECMA-376 ฉบับที่ 4

Enum
DASH_STYLE_UNSPECIFIED รูปแบบขีดคั่นที่ไม่ได้ระบุ
SOLID เส้นทึบ สอดคล้องกับค่า ST_PresetLineDashVal "solid" ของ ECMA-376 รูปแบบขีดกลางเริ่มต้น
DOT เส้นประ สอดคล้องกับค่า ST_PresetLineDashVal ของ ECMA-376 "dot"
DASH เส้นประ สอดคล้องกับค่า ST_PresetLineDashVal ของ ECMA-376 "dash"

TabStop

จุดเริ่มต้นแท็บภายในย่อหน้า

การแสดง JSON
{
  "offset": {
    object (Dimension)
  },
  "alignment": enum (TabStopAlignment)
}
ช่อง
offset

object (Dimension)

ส่วนต่างระหว่างการหยุดแท็บนี้กับระยะขอบเริ่มต้น

alignment

enum (TabStopAlignment)

การจัดแนวของแท็บหยุดนี้ หากไม่ได้ตั้งค่า ค่าเริ่มต้นจะเป็น START

TabStopAlignment

การจัดแนวของแท็บหยุด

Enum
TAB_STOP_ALIGNMENT_UNSPECIFIED ไม่ได้ระบุการจัดแนวการหยุดแท็บ
START การหยุดแท็บจะจัดแนวกับจุดเริ่มต้นของบรรทัด ซึ่งเป็นค่าเริ่มต้น
CENTER จุดหยุดแท็บจะจัดแนวให้อยู่ตรงกลางของบรรทัด
END การหยุดแท็บจะจัดแนวกับส่วนท้ายของบรรทัด

การแรเงา

การจัดเฉดสีของย่อหน้า

การแสดง JSON
{
  "backgroundColor": {
    object (OptionalColor)
  }
}
ช่อง
backgroundColor

object (OptionalColor)

สีพื้นหลังของแรเงาย่อหน้านี้

SuggestedParagraphStyle

การเปลี่ยนแปลงที่แนะนำใน ParagraphStyle

การแสดง JSON
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}
ช่อง
paragraphStyle

object (ParagraphStyle)

ParagraphStyle ที่มีเฉพาะการเปลี่ยนแปลงที่ทำในคำแนะนำนี้ ซึ่งสามารถใช้ร่วมกับ paragraphStyleSuggestionState เพื่อดูว่าฟิลด์ใดมีการเปลี่ยนแปลงและค่าใหม่ของฟิลด์นั้น

paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

มาสก์ที่ระบุว่าช่องใดใน ParagraphStyle พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้

ParagraphStyleSuggestionState

มาสก์ที่ระบุว่าช่องใดใน ParagraphStyle พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้ สำหรับช่องใดๆ ที่ตั้งค่าเป็น "จริง" จะมีค่าใหม่ที่แนะนำ

การแสดง JSON
{
  "headingIdSuggested": boolean,
  "namedStyleTypeSuggested": boolean,
  "alignmentSuggested": boolean,
  "lineSpacingSuggested": boolean,
  "directionSuggested": boolean,
  "spacingModeSuggested": boolean,
  "spaceAboveSuggested": boolean,
  "spaceBelowSuggested": boolean,
  "borderBetweenSuggested": boolean,
  "borderTopSuggested": boolean,
  "borderBottomSuggested": boolean,
  "borderLeftSuggested": boolean,
  "borderRightSuggested": boolean,
  "indentFirstLineSuggested": boolean,
  "indentStartSuggested": boolean,
  "indentEndSuggested": boolean,
  "keepLinesTogetherSuggested": boolean,
  "keepWithNextSuggested": boolean,
  "avoidWidowAndOrphanSuggested": boolean,
  "shadingSuggestionState": {
    object (ShadingSuggestionState)
  },
  "pageBreakBeforeSuggested": boolean
}
ช่อง
headingIdSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน headingId หรือไม่

namedStyleTypeSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน namedStyleType หรือไม่

alignmentSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน alignment หรือไม่

lineSpacingSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน lineSpacing หรือไม่

directionSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน direction หรือไม่

spacingModeSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน spacingMode หรือไม่

spaceAboveSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน spaceAbove หรือไม่

spaceBelowSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน spaceBelow หรือไม่

borderBetweenSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน borderBetween หรือไม่

borderTopSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน borderTop หรือไม่

borderBottomSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน borderBottom หรือไม่

borderLeftSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน borderLeft หรือไม่

borderRightSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน borderRight หรือไม่

indentFirstLineSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน indentFirstLine หรือไม่

indentStartSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน indentStart หรือไม่

indentEndSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน indentEnd หรือไม่

keepLinesTogetherSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน keepLinesTogether หรือไม่

keepWithNextSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน keepWithNext หรือไม่

avoidWidowAndOrphanSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน avoidWidowAndOrphan หรือไม่

shadingSuggestionState

object (ShadingSuggestionState)

มาสก์ที่ระบุช่องใน shading ที่มีการเปลี่ยนแปลงในคำแนะนำนี้

pageBreakBeforeSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน pageBreakBefore หรือไม่

ShadingSuggestionState

มาสก์ที่ระบุช่องใน Shading พื้นฐานที่มีการเปลี่ยนแปลงในการเปลี่ยนแปลงที่แนะนํานี้ สำหรับช่องใดก็ตามที่ตั้งค่าเป็น "จริง" จะมีค่าใหม่ที่แนะนำ

การแสดง JSON
{
  "backgroundColorSuggested": boolean
}
ช่อง
backgroundColorSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน Shading หรือไม่

สัญลักษณ์หัวข้อย่อย

อธิบายหัวข้อย่อยของย่อหน้า

การแสดง JSON
{
  "listId": string,
  "nestingLevel": integer,
  "textStyle": {
    object (TextStyle)
  }
}
ช่อง
listId

string

รหัสของรายการที่ย่อหน้านี้อยู่

nestingLevel

integer

ระดับการซ้อนของย่อหน้านี้ในรายการ

textStyle

object (TextStyle)

รูปแบบข้อความเฉพาะย่อหน้าที่ใช้กับหัวข้อย่อยนี้

SuggestedBullet

การเปลี่ยนแปลงที่แนะนำใน Bullet

การแสดง JSON
{
  "bullet": {
    object (Bullet)
  },
  "bulletSuggestionState": {
    object (BulletSuggestionState)
  }
}
ช่อง
bullet

object (Bullet)

Bullet ที่มีเฉพาะการเปลี่ยนแปลงที่ทำในคำแนะนำนี้ ซึ่งสามารถใช้ร่วมกับ bulletSuggestionState เพื่อดูว่าฟิลด์ใดมีการเปลี่ยนแปลงและค่าใหม่ของฟิลด์นั้น

bulletSuggestionState

object (BulletSuggestionState)

มาสก์ที่ระบุว่าช่องใดใน Bullet พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้

BulletSuggestionState

มาสก์ที่ระบุว่าช่องใดใน Bullet พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้ สำหรับช่องใดก็ตามที่ตั้งค่าเป็น "จริง" จะมีค่าใหม่ที่แนะนำ

การแสดง JSON
{
  "listIdSuggested": boolean,
  "nestingLevelSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}
ช่อง
listIdSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน listId หรือไม่

nestingLevelSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน nestingLevel หรือไม่

textStyleSuggestionState

object (TextStyleSuggestionState)

มาสก์ที่ระบุช่องใน text style ที่มีการเปลี่ยนแปลงในคำแนะนำนี้

ObjectReferences

คอลเล็กชันรหัสออบเจ็กต์

การแสดง JSON
{
  "objectIds": [
    string
  ]
}
ช่อง
objectIds[]

string

รหัสออบเจ็กต์

SectionBreak

StructuralElement ที่แสดงตัวแบ่งส่วน ส่วนคือช่วงของเนื้อหาที่มี SectionStyle เดียวกัน ตัวแบ่งส่วนแสดงถึงจุดเริ่มต้นของส่วนใหม่ และสไตล์ส่วนจะมีผลกับส่วนที่อยู่หลังตัวแบ่งส่วน

เนื้อความของเอกสารจะขึ้นต้นด้วยตัวแบ่งส่วนเสมอ

การแสดง JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "sectionStyle": {
    object (SectionStyle)
  }
}
ช่อง
suggestedInsertionIds[]

string

รหัสการแทรกที่แนะนํา SectionBreak อาจมีรหัสการแทรกหลายรายการหากเป็นการเปลี่ยนแปลงที่แนะนำแบบซ้อนกัน หากเป็นค่าว่าง แสดงว่านี่ไม่ใช่การแทรกที่แนะนำ

suggestedDeletionIds[]

string

รหัสการลบที่แนะนำ หากช่องนี้ว่าง แสดงว่าไม่มีคำแนะนำให้ลบเนื้อหานี้

sectionStyle

object (SectionStyle)

สไตล์ของส่วนที่อยู่ถัดจากส่วนแบ่งนี้

SectionStyle

การจัดรูปแบบที่ใช้กับส่วน

การแสดง JSON
{
  "columnProperties": [
    {
      object (SectionColumnProperties)
    }
  ],
  "columnSeparatorStyle": enum (ColumnSeparatorStyle),
  "contentDirection": enum (ContentDirection),
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "marginHeader": {
    object (Dimension)
  },
  "marginFooter": {
    object (Dimension)
  },
  "sectionType": enum (SectionType),
  "defaultHeaderId": string,
  "defaultFooterId": string,
  "firstPageHeaderId": string,
  "firstPageFooterId": string,
  "evenPageHeaderId": string,
  "evenPageFooterId": string,
  "useFirstPageHeaderFooter": boolean,
  "pageNumberStart": integer,
  "flipPageOrientation": boolean
}
ช่อง
columnProperties[]

object (SectionColumnProperties)

พร็อพเพอร์ตี้คอลัมน์ของส่วน

หากว่างเปล่า ส่วนจะมี 1 คอลัมน์ที่มีพร็อพเพอร์ตี้เริ่มต้นในเครื่องมือแก้ไขเอกสาร อัปเดตส่วนให้มีคอลัมน์ได้ไม่เกิน 3 คอลัมน์

เมื่ออัปเดตพร็อพเพอร์ตี้นี้ คุณต้องตั้งค่าที่แน่ชัด การยกเลิกการตั้งค่าพร็อพเพอร์ตี้นี้จะทำให้เกิดข้อผิดพลาด 400 Bad Request

columnSeparatorStyle

enum (ColumnSeparatorStyle)

รูปแบบตัวคั่นคอลัมน์

คุณตั้งค่าสไตล์นี้ได้แม้ว่าจะมีเพียง 1 คอลัมน์ในส่วน

เมื่ออัปเดตพร็อพเพอร์ตี้นี้ คุณจะต้องตั้งค่าที่แน่ชัด การยกเลิกการตั้งค่าพร็อพเพอร์ตี้นี้จะทำให้เกิดข้อผิดพลาด 400 Bad Request

contentDirection

enum (ContentDirection)

ทิศทางเนื้อหาของส่วนนี้ หากไม่ได้ตั้งค่า ค่าเริ่มต้นจะเป็น LEFT_TO_RIGHT

เมื่ออัปเดตพร็อพเพอร์ตี้นี้ คุณจะต้องตั้งค่าที่แน่ชัด การยกเลิกการตั้งค่าพร็อพเพอร์ตี้นี้จะทำให้เกิดข้อผิดพลาด 400 Bad Request

marginTop

object (Dimension)

ระยะขอบด้านบนของหน้าในส่วน หากไม่ได้ตั้งค่าไว้ ค่าเริ่มต้นจะเป็น marginTop จาก DocumentStyle

เมื่ออัปเดตพร็อพเพอร์ตี้นี้ คุณจะต้องตั้งค่าที่แน่ชัด การยกเลิกการตั้งค่าพร็อพเพอร์ตี้นี้จะทำให้เกิดข้อผิดพลาด 400 Bad Request

marginBottom

object (Dimension)

ระยะขอบด้านล่างของหน้าในส่วน หากไม่ได้ตั้งค่าไว้ ค่าเริ่มต้นจะเป็น marginBottom จาก DocumentStyle

เมื่ออัปเดตพร็อพเพอร์ตี้นี้ คุณจะต้องตั้งค่าที่แน่ชัด การยกเลิกการตั้งค่าพร็อพเพอร์ตี้นี้จะทำให้เกิดข้อผิดพลาด 400 Bad Request

marginRight

object (Dimension)

ระยะขอบด้านขวาของหน้าในส่วน หากไม่ได้ตั้งค่า ค่าเริ่มต้นจะเป็น marginRight จาก DocumentStyle การอัปเดตระยะขอบด้านขวาจะทำให้คอลัมน์ในส่วนนี้ปรับขนาด เนื่องจากระยะขอบมีผลต่อความกว้างของคอลัมน์ ระบบจึงใช้ระยะขอบก่อนใช้พร็อพเพอร์ตี้ของคอลัมน์

เมื่ออัปเดตพร็อพเพอร์ตี้นี้ คุณต้องตั้งค่าที่แน่ชัด การยกเลิกการตั้งค่าพร็อพเพอร์ตี้นี้จะทำให้เกิดข้อผิดพลาด 400 Bad Request

marginLeft

object (Dimension)

ระยะขอบด้านซ้ายของหน้าในส่วน หากไม่ได้ตั้งค่าไว้ ค่าเริ่มต้นจะเป็น marginLeft จาก DocumentStyle การอัปเดตระยะขอบด้านซ้ายจะทำให้คอลัมน์ในส่วนนี้ปรับขนาด เนื่องจากระยะขอบมีผลต่อความกว้างของคอลัมน์ ระบบจึงใช้ระยะขอบก่อนใช้พร็อพเพอร์ตี้ของคอลัมน์

เมื่ออัปเดตพร็อพเพอร์ตี้นี้ คุณต้องตั้งค่าที่แน่ชัด การยกเลิกการตั้งค่าพร็อพเพอร์ตี้นี้จะทำให้เกิดข้อผิดพลาด 400 Bad Request

marginHeader

object (Dimension)

ระยะขอบส่วนหัวของส่วน หากไม่ได้ตั้งค่า ค่าเริ่มต้นจะเป็น marginHeader จาก DocumentStyle หากอัปเดตแล้ว ระบบจะตั้งค่า useCustomHeaderFooterMargins เป็น "จริง" ใน DocumentStyle ค่าของ useCustomHeaderFooterMargins ใน DocumentStyle จะระบุว่ามีการคำนึงถึงระยะขอบส่วนหัวสำหรับส่วนนี้หรือไม่

เมื่ออัปเดตพร็อพเพอร์ตี้นี้ คุณต้องตั้งค่าที่แน่ชัด การยกเลิกการตั้งค่าพร็อพเพอร์ตี้นี้จะทำให้เกิดข้อผิดพลาด 400 Bad Request

sectionType

enum (SectionType)

เอาต์พุตเท่านั้น ประเภทของส่วน

defaultHeaderId

string

รหัสของส่วนหัวเริ่มต้น หากไม่ได้ตั้งค่า ค่าจะรับค่ามาจาก SectionBreak's SectionStyle ก่อนหน้า หากไม่ได้ตั้งค่าใน SectionBreak แรก ค่าดังกล่าวจะรับค่าจาก defaultHeaderId ของ DocumentStyle

พร็อพเพอร์ตี้นี้เป็นแบบอ่านอย่างเดียว

firstPageHeaderId

string

รหัสของส่วนหัวที่ใช้กับหน้าแรกของส่วนเท่านั้น หาก useFirstPageHeaderFooter เป็นจริง ระบบจะใช้ค่านี้สำหรับส่วนหัวในหน้าแรกของส่วน หากเป็นเท็จ ส่วนหัวในหน้าแรกของส่วนจะใช้ defaultHeaderId หากไม่ได้ตั้งค่า ค่าจะรับค่ามาจาก SectionBreak's SectionStyle ก่อนหน้า หากไม่ได้ตั้งค่าใน SectionBreak แรก ค่าดังกล่าวจะรับค่าจาก firstPageHeaderId ของ DocumentStyle

พร็อพเพอร์ตี้นี้เป็นแบบอ่านอย่างเดียว

evenPageHeaderId

string

รหัสของส่วนหัวที่ใช้กับหน้าเลขคู่เท่านั้น หากค่า useEvenPageHeaderFooter ของ DocumentStyle เป็น "จริง" ระบบจะใช้ค่านี้สำหรับส่วนหัวในหน้าคู่ในส่วน หากเป็นเท็จ ส่วนหัวในหน้าคู่จะใช้ defaultHeaderId หากไม่ได้ตั้งค่า ค่าจะรับค่ามาจาก SectionBreak's SectionStyle ก่อนหน้า หากไม่ได้ตั้งค่าใน SectionBreak แรก ค่าดังกล่าวจะรับค่าจาก evenPageHeaderId ของ DocumentStyle

พร็อพเพอร์ตี้นี้เป็นแบบอ่านอย่างเดียว

pageNumberStart

integer

หมายเลขหน้าที่จะเริ่มต้นนับจํานวนหน้าในส่วนนี้ หากไม่ได้ตั้งค่าไว้ ระบบจะจัดเลขหน้าต่อจากส่วนก่อนหน้า หากไม่ได้ตั้งค่าใน SectionBreak แรก ให้ดู pageNumberStart ของ DocumentStyle

เมื่ออัปเดตพร็อพเพอร์ตี้นี้ คุณจะต้องตั้งค่าที่แน่ชัด การยกเลิกการตั้งค่าพร็อพเพอร์ตี้นี้จะทำให้เกิดข้อผิดพลาด 400 Bad Request

flipPageOrientation

boolean

ไม่บังคับ ระบุว่าจะพลิกขนาดของ pageSize ของ DocumentStyle สำหรับส่วนนี้หรือไม่ ซึ่งจะเปลี่ยนการวางแนวหน้ากระดาษระหว่างแนวตั้งและแนวนอนได้ หากไม่ได้ตั้งค่า ค่าจะรับค่าจาก flipPageOrientation ของ DocumentStyle

เมื่ออัปเดตพร็อพเพอร์ตี้นี้ คุณต้องตั้งค่าที่แน่ชัด การยกเลิกการตั้งค่าพร็อพเพอร์ตี้นี้จะทำให้เกิดข้อผิดพลาด 400 Bad Request

SectionColumnProperties

พร็อพเพอร์ตี้ที่ใช้กับคอลัมน์ของส่วน

การแสดง JSON
{
  "width": {
    object (Dimension)
  },
  "paddingEnd": {
    object (Dimension)
  }
}
ช่อง
width

object (Dimension)

เอาต์พุตเท่านั้น ความกว้างของคอลัมน์

paddingEnd

object (Dimension)

ระยะห่างจากขอบที่ส่วนท้ายของคอลัมน์

ColumnSeparatorStyle

สไตล์ตัวคั่นคอลัมน์ระหว่างคอลัมน์

Enum
COLUMN_SEPARATOR_STYLE_UNSPECIFIED รูปแบบตัวแบ่งคอลัมน์ที่ไม่ระบุ
NONE ไม่มีเส้นแบ่งคอลัมน์ระหว่างคอลัมน์
BETWEEN_EACH_COLUMN แสดงผลเส้นคั่นคอลัมน์ระหว่างแต่ละคอลัมน์

SectionType

แสดงตําแหน่งเริ่มต้นของส่วนปัจจุบันสัมพันธ์กับส่วนก่อนหน้า

Enum
SECTION_TYPE_UNSPECIFIED ไม่ได้ระบุประเภทส่วน
CONTINUOUS ส่วนจะเริ่มขึ้นทันทีหลังย่อหน้าสุดท้ายของส่วนก่อนหน้า
NEXT_PAGE ส่วนจะเริ่มในหน้าถัดไป

ตาราง

StructuralElement ที่แสดงตาราง

การแสดง JSON
{
  "rows": integer,
  "columns": integer,
  "tableRows": [
    {
      object (TableRow)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableStyle": {
    object (TableStyle)
  }
}
ช่อง
rows

integer

จํานวนแถวในตาราง

columns

integer

จํานวนคอลัมน์ในตาราง

ตารางอาจไม่ได้เป็นรูปสี่เหลี่ยมผืนผ้า ดังนั้นบางแถวจึงอาจมีจํานวนเซลล์ไม่เท่ากัน

tableRows[]

object (TableRow)

เนื้อหาและสไตล์ของแต่ละแถว

suggestedInsertionIds[]

string

รหัสการแทรกที่แนะนํา Table อาจมีรหัสการแทรกหลายรายการหากเป็นการเปลี่ยนแปลงที่แนะนำแบบซ้อนกัน หากเป็นค่าว่าง แสดงว่านี่ไม่ใช่การแทรกที่แนะนำ

suggestedDeletionIds[]

string

รหัสการลบที่แนะนำ หากช่องนี้ว่าง แสดงว่าไม่มีคำแนะนำให้ลบเนื้อหานี้

tableStyle

object (TableStyle)

รูปแบบของตาราง

TableRow

เนื้อหาและสไตล์ของแถวในTable

การแสดง JSON
{
  "startIndex": integer,
  "endIndex": integer,
  "tableCells": [
    {
      object (TableCell)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "suggestedTableRowStyleChanges": {
    string: {
      object (SuggestedTableRowStyle)
    },
    ...
  }
}
ช่อง
startIndex

integer

ดัชนีเริ่มต้นแบบนับจาก 0 ของแถวนี้ในหน่วยโค้ด UTF-16

endIndex

integer

ดัชนีสิ้นสุดแบบนับจาก 0 ของแถวนี้แบบไม่รวมในหน่วยโค้ด UTF-16

tableCells[]

object (TableCell)

เนื้อหาและรูปแบบของเซลล์แต่ละเซลล์ในแถวนี้

ตารางอาจไม่ได้เป็นรูปสี่เหลี่ยมผืนผ้า ดังนั้นบางแถวอาจมีจํานวนเซลล์แตกต่างจากแถวอื่นๆ ในตารางเดียวกัน

suggestedInsertionIds[]

string

รหัสการแทรกที่แนะนํา TableRow อาจมีรหัสการแทรกหลายรายการหากเป็นการเปลี่ยนแปลงที่แนะนำแบบซ้อนกัน หากเป็นค่าว่าง แสดงว่านี่ไม่ใช่การแทรกที่แนะนำ

suggestedDeletionIds[]

string

รหัสการลบที่แนะนำ หากช่องนี้ว่าง แสดงว่าไม่มีคำแนะนำให้ลบเนื้อหานี้

tableRowStyle

object (TableRowStyle)

รูปแบบของแถวในตาราง

suggestedTableRowStyleChanges

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

การเปลี่ยนแปลงสไตล์ที่แนะนำในแถวนี้ โดยจัดเรียงตามรหัสคำแนะนำ

TableCell

เนื้อหาและสไตล์ของเซลล์ใน Table

การแสดง JSON
{
  "startIndex": integer,
  "endIndex": integer,
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "suggestedTableCellStyleChanges": {
    string: {
      object (SuggestedTableCellStyle)
    },
    ...
  }
}
ช่อง
startIndex

integer

ดัชนีเริ่มต้นแบบนับจาก 0 ของเซลล์นี้ในหน่วยโค้ด UTF-16

endIndex

integer

ดัชนีสิ้นสุดแบบนับจาก 0 ของเซลล์นี้แบบไม่รวมในหน่วยโค้ด UTF-16

content[]

object (StructuralElement)

เนื้อหาของเซลล์

tableCellStyle

object (TableCellStyle)

รูปแบบของเซลล์

suggestedInsertionIds[]

string

รหัสการแทรกที่แนะนํา TableCell อาจมีรหัสการแทรกหลายรายการหากเป็นการเปลี่ยนแปลงที่แนะนำแบบซ้อนกัน หากเป็นค่าว่าง แสดงว่านี่ไม่ใช่การแทรกที่แนะนำ

suggestedDeletionIds[]

string

รหัสการลบที่แนะนำ หากช่องนี้ว่าง แสดงว่าไม่มีคำแนะนำให้ลบเนื้อหานี้

suggestedTableCellStyleChanges

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

การเปลี่ยนแปลงที่แนะนำในสไตล์เซลล์ตาราง โดยจัดเรียงตามรหัสคำแนะนำ

TableCellStyle

สไตล์ของ TableCell

รูปแบบเซลล์ตารางที่รับค่ามาจะแสดงเป็นช่องที่ไม่ได้ตั้งค่าในข้อความนี้ รูปแบบเซลล์ตารางรับค่ารูปแบบของตารางได้

การแสดง JSON
{
  "rowSpan": integer,
  "columnSpan": integer,
  "backgroundColor": {
    object (OptionalColor)
  },
  "borderLeft": {
    object (TableCellBorder)
  },
  "borderRight": {
    object (TableCellBorder)
  },
  "borderTop": {
    object (TableCellBorder)
  },
  "borderBottom": {
    object (TableCellBorder)
  },
  "paddingLeft": {
    object (Dimension)
  },
  "paddingRight": {
    object (Dimension)
  },
  "paddingTop": {
    object (Dimension)
  },
  "paddingBottom": {
    object (Dimension)
  },
  "contentAlignment": enum (ContentAlignment)
}
ช่อง
rowSpan

integer

ช่วงแถวของเซลล์

พร็อพเพอร์ตี้นี้เป็นแบบอ่านอย่างเดียว

columnSpan

integer

ช่วงของคอลัมน์ของเซลล์

พร็อพเพอร์ตี้นี้เป็นแบบอ่านอย่างเดียว

backgroundColor

object (OptionalColor)

สีพื้นหลังของเซลล์

borderLeft

object (TableCellBorder)

เส้นขอบด้านซ้ายของเซลล์

borderRight

object (TableCellBorder)

เส้นขอบด้านขวาของเซลล์

borderTop

object (TableCellBorder)

เส้นขอบด้านบนของเซลล์

borderBottom

object (TableCellBorder)

เส้นขอบด้านล่างของเซลล์

paddingLeft

object (Dimension)

ระยะห่างจากขอบด้านซ้ายของเซลล์

paddingRight

object (Dimension)

ระยะห่างจากขอบด้านขวาของเซลล์

paddingTop

object (Dimension)

ระยะห่างจากขอบด้านบนของเซลล์

paddingBottom

object (Dimension)

ระยะห่างจากขอบด้านล่างของเซลล์

contentAlignment

enum (ContentAlignment)

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

TableCellBorder

เส้นขอบรอบเซลล์ตาราง

เส้นขอบเซลล์ตารางต้องไม่โปร่งใส หากต้องการซ่อนเส้นขอบเซลล์ตาราง ให้ตั้งค่าความกว้างเป็น 0

การแสดง JSON
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}
ช่อง
color

object (OptionalColor)

สีของเส้นขอบ

สีนี้ต้องไม่โปร่งใส

width

object (Dimension)

ความกว้างของเส้นขอบ

dashStyle

enum (DashStyle)

รูปแบบเส้นประของเส้นขอบ

ContentAlignment

ประเภทการปรับเนื้อหา

มาจากชุดย่อยของค่าประเภทพื้นฐาน "ST_TextAnchoringType" ในส่วน 20.1.10.59 ของ "รูปแบบไฟล์ Office Open XML - ข้อมูลเบื้องต้นและข้อมูลอ้างอิงภาษามาร์กอัป" ส่วนที่ 1 ของ ECMA-376 ฉบับที่ 4

Enum
CONTENT_ALIGNMENT_UNSPECIFIED การจัดแนวเนื้อหาที่ไม่ได้ระบุ เนื้อหาจะรับค่ามาจากการเชื่อมโยงระดับบนหากมี
CONTENT_ALIGNMENT_UNSUPPORTED การจัดแนวเนื้อหาที่ไม่รองรับ
TOP การจัดแนวที่ปรับเนื้อหาให้ตรงกับด้านบนของที่ยึดเนื้อหา สอดคล้องกับ ECMA-376 ST_TextAnchoringType 't'
MIDDLE การจัดแนวที่ปรับเนื้อหาให้ตรงกับตรงกลางของที่ยึดเนื้อหา สอดคล้องกับ ECMA-376 ST_TextAnchoringType "ctr"
BOTTOM การจัดตำแหน่งที่ปรับเนื้อหาให้ตรงกับด้านล่างของที่ยึดเนื้อหา สอดคล้องกับ ECMA-376 ST_TextAnchoringType 'b'

SuggestedTableCellStyle

การเปลี่ยนแปลงที่แนะนำใน TableCellStyle

การแสดง JSON
{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "tableCellStyleSuggestionState": {
    object (TableCellStyleSuggestionState)
  }
}
ช่อง
tableCellStyle

object (TableCellStyle)

TableCellStyle ที่มีเฉพาะการเปลี่ยนแปลงที่ทำในคำแนะนำนี้ ซึ่งสามารถใช้ร่วมกับ tableCellStyleSuggestionState เพื่อดูว่าฟิลด์ใดมีการเปลี่ยนแปลงและค่าใหม่ของฟิลด์นั้น

tableCellStyleSuggestionState

object (TableCellStyleSuggestionState)

มาสก์ที่ระบุว่าช่องใดใน TableCellStyle พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้

TableCellStyleSuggestionState

มาสก์ที่ระบุว่าช่องใดใน TableCellStyle พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้ สำหรับช่องใดก็ตามที่ตั้งค่าเป็น "จริง" จะมีค่าใหม่ที่แนะนำ

การแสดง JSON
{
  "rowSpanSuggested": boolean,
  "columnSpanSuggested": boolean,
  "backgroundColorSuggested": boolean,
  "borderLeftSuggested": boolean,
  "borderRightSuggested": boolean,
  "borderTopSuggested": boolean,
  "borderBottomSuggested": boolean,
  "paddingLeftSuggested": boolean,
  "paddingRightSuggested": boolean,
  "paddingTopSuggested": boolean,
  "paddingBottomSuggested": boolean,
  "contentAlignmentSuggested": boolean
}
ช่อง
rowSpanSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน rowSpan หรือไม่

columnSpanSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน columnSpan หรือไม่

backgroundColorSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน backgroundColor หรือไม่

borderLeftSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน borderLeft หรือไม่

borderRightSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน borderRight หรือไม่

borderTopSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน borderTop หรือไม่

borderBottomSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน borderBottom หรือไม่

paddingLeftSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน paddingLeft หรือไม่

paddingRightSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน paddingRight หรือไม่

paddingTopSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน paddingTop หรือไม่

paddingBottomSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน paddingBottom หรือไม่

contentAlignmentSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน contentAlignment หรือไม่

TableRowStyle

รูปแบบที่ใช้กับแถวในตาราง

การแสดง JSON
{
  "minRowHeight": {
    object (Dimension)
  },
  "tableHeader": boolean,
  "preventOverflow": boolean
}
ช่อง
minRowHeight

object (Dimension)

ความสูงขั้นต่ำของแถว ระบบจะแสดงผลแถวในเครื่องมือแก้ไขเอกสารที่ความสูงเท่ากับหรือมากกว่าค่านี้เพื่อแสดงเนื้อหาทั้งหมดในเซลล์ของแถว

tableHeader

boolean

ระบุว่าแถวเป็นส่วนหัวของตารางหรือไม่

preventOverflow

boolean

แถวจะแสดงเกินขอบเขตหน้าหรือคอลัมน์ไม่ได้หรือไม่

SuggestedTableRowStyle

การเปลี่ยนแปลงที่แนะนำใน TableRowStyle

การแสดง JSON
{
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "tableRowStyleSuggestionState": {
    object (TableRowStyleSuggestionState)
  }
}
ช่อง
tableRowStyle

object (TableRowStyle)

TableRowStyle ที่มีเฉพาะการเปลี่ยนแปลงที่ทำในคำแนะนำนี้ ซึ่งสามารถใช้ร่วมกับ tableRowStyleSuggestionState เพื่อดูว่าฟิลด์ใดมีการเปลี่ยนแปลงและค่าใหม่ของฟิลด์นั้น

tableRowStyleSuggestionState

object (TableRowStyleSuggestionState)

มาสก์ที่ระบุว่าช่องใดใน TableRowStyle พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้

TableRowStyleSuggestionState

มาสก์ที่ระบุว่าช่องใดใน TableRowStyle พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้ สำหรับช่องใดๆ ที่ตั้งค่าเป็น "จริง" จะมีค่าใหม่ที่แนะนำ

การแสดง JSON
{
  "minRowHeightSuggested": boolean
}
ช่อง
minRowHeightSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน minRowHeight หรือไม่

TableStyle

รูปแบบที่ใช้กับตาราง

การแสดง JSON
{
  "tableColumnProperties": [
    {
      object (TableColumnProperties)
    }
  ]
}
ช่อง
tableColumnProperties[]

object (TableColumnProperties)

พร็อพเพอร์ตี้ของแต่ละคอลัมน์

โปรดทราบว่าในเอกสาร ตารางจะมีแถวและแถวจะมีเซลล์ คล้ายกับ HTML คุณจึงดูพร็อพเพอร์ตี้ของแถวได้ใน tableRowStyle ของแถวนั้น

TableColumnProperties

พร็อพเพอร์ตี้ของคอลัมน์ในตาราง

การแสดง JSON
{
  "widthType": enum (WidthType),
  "width": {
    object (Dimension)
  }
}
ช่อง
widthType

enum (WidthType)

ประเภทความกว้างของคอลัมน์

width

object (Dimension)

ความกว้างของคอลัมน์ ตั้งค่าเมื่อ widthType ของคอลัมน์เป็น FIXED_WIDTH

WidthType

ประเภทความกว้างของคอลัมน์

Enum
WIDTH_TYPE_UNSPECIFIED ไม่ได้ระบุประเภทความกว้างของคอลัมน์
EVENLY_DISTRIBUTED

คอลัมน์จะกระจายความกว้างเท่าๆ กันกับคอลัมน์อื่นๆ ที่กระจายความกว้างเท่าๆ กัน

ระบบจะกำหนดความกว้างของคอลัมน์โดยอัตโนมัติ และจะเหลือความกว้างเท่าๆ กันสำหรับตารางหลังจากพิจารณาคอลัมน์ทั้งหมดที่มีความกว้างที่ระบุแล้ว

FIXED_WIDTH ความกว้างคอลัมน์แบบคงที่ พร็อพเพอร์ตี้ [width][google.apps.docs.v1.TableColumnProperties.width ประกอบด้วยความกว้างของคอลัมน์

TableOfContents

StructuralElement ที่แสดงถึงสารบัญ

การแสดง JSON
{
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}
ช่อง
content[]

object (StructuralElement)

เนื้อหาของสารบัญ

suggestedInsertionIds[]

string

รหัสการแทรกที่แนะนํา TableOfContents อาจมีรหัสการแทรกหลายรายการหากเป็นการเปลี่ยนแปลงที่แนะนำซึ่งซ้อนกัน หากเป็นค่าว่าง แสดงว่านี่ไม่ใช่การแทรกที่แนะนำ

suggestedDeletionIds[]

string

รหัสการลบที่แนะนำ หากช่องนี้ว่าง แสดงว่าไม่มีคำแนะนำให้ลบเนื้อหานี้

หมายเหตุ

เชิงอรรถของเอกสาร

การแสดง JSON
{
  "footnoteId": string,
  "content": [
    {
      object (StructuralElement)
    }
  ]
}
ช่อง
footnoteId

string

รหัสของเชิงอรรถ

content[]

object (StructuralElement)

เนื้อหาของเชิงอรรถ

ดัชนีของเนื้อหาเชิงอรรถจะเริ่มต้นที่ 0

DocumentStyle

รูปแบบของเอกสาร

การแสดง JSON
{
  "background": {
    object (Background)
  },
  "defaultHeaderId": string,
  "defaultFooterId": string,
  "evenPageHeaderId": string,
  "evenPageFooterId": string,
  "firstPageHeaderId": string,
  "firstPageFooterId": string,
  "useFirstPageHeaderFooter": boolean,
  "useEvenPageHeaderFooter": boolean,
  "pageNumberStart": integer,
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "pageSize": {
    object (Size)
  },
  "marginHeader": {
    object (Dimension)
  },
  "marginFooter": {
    object (Dimension)
  },
  "useCustomHeaderFooterMargins": boolean,
  "flipPageOrientation": boolean
}
ช่อง
background

object (Background)

พื้นหลังของเอกสาร เอกสารต้องไม่มีสีพื้นหลังโปร่งใส

defaultHeaderId

string

รหัสของส่วนหัวเริ่มต้น หากไม่ได้ตั้งค่าไว้ ระบบจะไม่ระบุส่วนหัวเริ่มต้น

พร็อพเพอร์ตี้นี้เป็นแบบอ่านอย่างเดียว

evenPageHeaderId

string

รหัสของส่วนหัวที่ใช้กับหน้าเลขคู่เท่านั้น ค่าของ useEvenPageHeaderFooter จะกำหนดว่าจะใช้ defaultHeaderId หรือค่านี้สำหรับส่วนหัวในหน้าคู่ หากไม่ได้ตั้งค่าไว้ ก็จะไม่มีส่วนหัวของหน้าคู่

พร็อพเพอร์ตี้นี้เป็นแบบอ่านอย่างเดียว

firstPageHeaderId

string

รหัสของส่วนหัวที่ใช้กับหน้าแรกเท่านั้น หากไม่ได้ตั้งค่า จะไม่มีส่วนหัวที่ไม่ซ้ำกันสําหรับหน้าแรก ค่าของ useFirstPageHeaderFooter จะกำหนดว่าจะใช้ defaultHeaderId หรือค่านี้สำหรับส่วนหัวในหน้าแรก หากไม่ได้ตั้งค่า จะไม่มีส่วนหัวของหน้าแรก

พร็อพเพอร์ตี้นี้เป็นแบบอ่านอย่างเดียว

pageNumberStart

integer

หมายเลขหน้าที่จะเริ่มนับจำนวนหน้า

marginTop

object (Dimension)

ระยะขอบด้านบนของหน้า

การอัปเดตระยะขอบด้านบนของหน้าในสไตล์เอกสารจะล้างระยะขอบด้านบนของหน้าในสไตล์ส่วนทั้งหมด

marginBottom

object (Dimension)

ขอบล่างของหน้า

การอัปเดตระยะขอบด้านล่างของหน้าในสไตล์เอกสารจะล้างระยะขอบด้านล่างของหน้าในสไตล์ส่วนทั้งหมด

marginRight

object (Dimension)

ขอบขวาของหน้า

การอัปเดตระยะขอบด้านขวาของหน้าในสไตล์เอกสารจะล้างระยะขอบด้านขวาของหน้าในสไตล์ส่วนทั้งหมด และอาจทำให้คอลัมน์ปรับขนาดในทุกส่วนด้วย

marginLeft

object (Dimension)

ระยะขอบด้านซ้ายของหน้า

การอัปเดตระยะขอบด้านซ้ายของหน้าในสไตล์เอกสารจะล้างระยะขอบด้านซ้ายของหน้าในสไตล์ส่วนทั้งหมด และอาจทำให้คอลัมน์ปรับขนาดในทุกส่วนด้วย

pageSize

object (Size)

ขนาดของหน้าในเอกสาร

marginHeader

object (Dimension)

ระยะห่างระหว่างด้านบนของหน้ากับเนื้อหาส่วนหัว

flipPageOrientation

boolean

ไม่บังคับ ระบุว่าจะพลิกขนาดของ pageSize หรือไม่ ซึ่งจะเปลี่ยนการวางแนวหน้าระหว่างแนวตั้งและแนวนอนได้

ข้อมูลเบื้องต้น

แสดงพื้นหลังของเอกสาร

การแสดง JSON
{
  "color": {
    object (OptionalColor)
  }
}
ช่อง
color

object (OptionalColor)

สีพื้นหลัง

ขนาด

ความกว้างและความสูง

การแสดง JSON
{
  "height": {
    object (Dimension)
  },
  "width": {
    object (Dimension)
  }
}
ช่อง
height

object (Dimension)

ความสูงของวัตถุ

width

object (Dimension)

ความกว้างของวัตถุ

SuggestedDocumentStyle

การเปลี่ยนแปลงที่แนะนำใน DocumentStyle

การแสดง JSON
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "documentStyleSuggestionState": {
    object (DocumentStyleSuggestionState)
  }
}
ช่อง
documentStyle

object (DocumentStyle)

DocumentStyle ที่มีเฉพาะการเปลี่ยนแปลงที่ทำในคําแนะนํานี้ ซึ่งสามารถใช้ร่วมกับ documentStyleSuggestionState เพื่อดูว่าฟิลด์ใดมีการเปลี่ยนแปลงและค่าใหม่ของฟิลด์นั้น

documentStyleSuggestionState

object (DocumentStyleSuggestionState)

มาสก์ที่ระบุว่าช่องใดใน DocumentStyle พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้

DocumentStyleSuggestionState

มาสก์ที่ระบุว่าช่องใดใน DocumentStyle พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้ สำหรับช่องใดก็ตามที่ตั้งค่าเป็น "จริง" จะมีค่าใหม่ที่แนะนำ

การแสดง JSON
{
  "backgroundSuggestionState": {
    object (BackgroundSuggestionState)
  },
  "defaultHeaderIdSuggested": boolean,
  "defaultFooterIdSuggested": boolean,
  "evenPageHeaderIdSuggested": boolean,
  "evenPageFooterIdSuggested": boolean,
  "firstPageHeaderIdSuggested": boolean,
  "firstPageFooterIdSuggested": boolean,
  "useFirstPageHeaderFooterSuggested": boolean,
  "useEvenPageHeaderFooterSuggested": boolean,
  "pageNumberStartSuggested": boolean,
  "marginTopSuggested": boolean,
  "marginBottomSuggested": boolean,
  "marginRightSuggested": boolean,
  "marginLeftSuggested": boolean,
  "pageSizeSuggestionState": {
    object (SizeSuggestionState)
  },
  "marginHeaderSuggested": boolean,
  "marginFooterSuggested": boolean,
  "useCustomHeaderFooterMarginsSuggested": boolean,
  "flipPageOrientationSuggested": boolean
}
ช่อง
backgroundSuggestionState

object (BackgroundSuggestionState)

มาสก์ที่ระบุช่องใน background ที่มีการเปลี่ยนแปลงในคำแนะนำนี้

defaultHeaderIdSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน defaultHeaderId หรือไม่

evenPageHeaderIdSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน evenPageHeaderId หรือไม่

firstPageHeaderIdSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน firstPageHeaderId หรือไม่

pageNumberStartSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน pageNumberStart หรือไม่

marginTopSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน marginTop หรือไม่

marginBottomSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน marginBottom หรือไม่

marginRightSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน marginRight หรือไม่

marginLeftSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน marginLeft หรือไม่

pageSizeSuggestionState

object (SizeSuggestionState)

มาสก์ที่ระบุช่องใน [size] [google.apps.docs.v1.DocumentStyle.size] ที่มีการเปลี่ยนแปลงในคำแนะนำนี้

marginHeaderSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน marginHeader หรือไม่

flipPageOrientationSuggested

boolean

ไม่บังคับ ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน flipPageOrientation หรือไม่

BackgroundSuggestionState

มาสก์ที่ระบุว่าช่องใดใน Background พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้ สำหรับช่องใดก็ตามที่ตั้งค่าเป็น "จริง" Backgound จะมีค่าที่แนะนำใหม่

การแสดง JSON
{
  "backgroundColorSuggested": boolean
}
ช่อง
backgroundColorSuggested

boolean

ระบุว่ามีการแก้ไขสีพื้นหลังปัจจุบันในคำแนะนำนี้หรือไม่

SizeSuggestionState

มาสก์ที่ระบุว่าช่องใดใน Size พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้ สำหรับช่องใดก็ตามที่ตั้งค่าเป็น "จริง" Size จะมีค่าที่แนะนำใหม่

การแสดง JSON
{
  "heightSuggested": boolean,
  "widthSuggested": boolean
}
ช่อง
heightSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน height หรือไม่

widthSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน width หรือไม่

NamedStyles

รูปแบบที่มีชื่อ ย่อหน้าในเอกสารจะรับค่า TextStyle และ ParagraphStyle จากรูปแบบที่มีชื่อเหล่านี้ได้

การแสดง JSON
{
  "styles": [
    {
      object (NamedStyle)
    }
  ]
}
ช่อง
styles[]

object (NamedStyle)

รูปแบบที่มีชื่อ

แต่ละ named style types ที่เป็นไปได้จะมีรายการ

NamedStyle

รูปแบบที่มีชื่อ ย่อหน้าในเอกสารจะรับค่า TextStyle และ ParagraphStyle จากรูปแบบที่มีชื่อนี้เมื่อย่อหน้าเหล่านั้นมีประเภทรูปแบบที่มีชื่อเดียวกัน

การแสดง JSON
{
  "namedStyleType": enum (NamedStyleType),
  "textStyle": {
    object (TextStyle)
  },
  "paragraphStyle": {
    object (ParagraphStyle)
  }
}
ช่อง
namedStyleType

enum (NamedStyleType)

ประเภทของสไตล์ที่มีชื่อนี้

textStyle

object (TextStyle)

รูปแบบข้อความของรูปแบบที่มีชื่อนี้

paragraphStyle

object (ParagraphStyle)

ลักษณะของย่อหน้าของสไตล์ที่มีชื่อนี้

SuggestedNamedStyles

การเปลี่ยนแปลงที่แนะนำใน NamedStyles

การแสดง JSON
{
  "namedStyles": {
    object (NamedStyles)
  },
  "namedStylesSuggestionState": {
    object (NamedStylesSuggestionState)
  }
}
ช่อง
namedStyles

object (NamedStyles)

NamedStyles ที่มีเฉพาะการเปลี่ยนแปลงที่ทำในคําแนะนํานี้ ซึ่งสามารถใช้ร่วมกับ namedStylesSuggestionState เพื่อดูว่าฟิลด์ใดมีการเปลี่ยนแปลงและค่าใหม่ของฟิลด์นั้น

namedStylesSuggestionState

object (NamedStylesSuggestionState)

มาสก์ที่ระบุว่าช่องใดใน NamedStyles พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้

NamedStylesSuggestionState

สถานะคำแนะนำของข้อความ NamedStyles

การแสดง JSON
{
  "stylesSuggestionStates": [
    {
      object (NamedStyleSuggestionState)
    }
  ]
}
ช่อง
stylesSuggestionStates[]

object (NamedStyleSuggestionState)

มาสก์ที่ระบุช่องใน NamedStyle ของ styles ที่เกี่ยวข้องซึ่งมีการเปลี่ยนแปลงในคำแนะนำนี้

ลําดับสถานะการแนะนำสไตล์ที่มีชื่อเหล่านี้จะตรงกับลําดับของสไตล์ที่มีชื่อที่เกี่ยวข้องภายในคำแนะนำ named styles

NamedStyleSuggestionState

สถานะคำแนะนำของข้อความ NamedStyle

การแสดง JSON
{
  "namedStyleType": enum (NamedStyleType),
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}
ช่อง
namedStyleType

enum (NamedStyleType)

ประเภทสไตล์ที่มีชื่อซึ่งสถานะคำแนะนำนี้สอดคล้องกับ

ช่องนี้มีไว้เพื่อความสะดวกในการจับคู่ NamedStyleSuggestionState กับ NamedStyle ที่เกี่ยวข้อง

textStyleSuggestionState

object (TextStyleSuggestionState)

มาสก์ที่ระบุช่องใน text style ที่มีการเปลี่ยนแปลงในคำแนะนำนี้

paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

มาสก์ที่ระบุช่องใน paragraph style ที่มีการเปลี่ยนแปลงในคำแนะนำนี้

รายการ

รายการแสดงแอตทริบิวต์รายการสำหรับกลุ่มย่อหน้าทั้งหมดที่อยู่ในรายการเดียวกัน ย่อหน้าที่อยู่ในรายการมีการอ้างอิงถึงรหัสของรายการใน bullet

การแสดง JSON
{
  "listProperties": {
    object (ListProperties)
  },
  "suggestedListPropertiesChanges": {
    string: {
      object (SuggestedListProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
ช่อง
listProperties

object (ListProperties)

พร็อพเพอร์ตี้ของรายการ

suggestedListPropertiesChanges

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

การเปลี่ยนแปลงที่แนะนําในพร็อพเพอร์ตี้รายการ โดยคีย์ตามรหัสคําแนะนํา

suggestedInsertionId

string

รหัสการแทรกที่แนะนํา หากเป็นค่าว่าง แสดงว่านี่ไม่ใช่การแทรกที่แนะนำ

suggestedDeletionIds[]

string

รหัสการลบที่แนะนำ หากเป็นค่าว่าง แสดงว่าไม่มีการลบรายการนี้ตามที่แนะนำ

ListProperties

พร็อพเพอร์ตี้ของ list ที่อธิบายลักษณะของสัญลักษณ์หัวข้อซึ่งอยู่ในการย่อหน้าที่เกี่ยวข้องกับรายการ

การแสดง JSON
{
  "nestingLevels": [
    {
      object (NestingLevel)
    }
  ]
}
ช่อง
nestingLevels[]

object (NestingLevel)

อธิบายคุณสมบัติของหัวข้อในระดับที่เกี่ยวข้อง

รายการมีการซ้อนกันสูงสุด 9 ระดับ โดยระดับการซ้อน 0 สอดคล้องกับระดับบนสุด และระดับการซ้อน 8 สอดคล้องกับระดับที่ซ้อนมากที่สุด ระบบจะแสดงระดับการฝังตามลําดับจากน้อยไปมาก โดยแสดงระดับการฝังน้อยที่สุดก่อน

NestingLevel

มีพร็อพเพอร์ตี้ที่อธิบายลักษณะที่ปรากฏของสัญลักษณ์หัวข้อรายการในระดับการฝังหนึ่งๆ

การแสดง JSON
{
  "bulletAlignment": enum (BulletAlignment),
  "glyphFormat": string,
  "indentFirstLine": {
    object (Dimension)
  },
  "indentStart": {
    object (Dimension)
  },
  "textStyle": {
    object (TextStyle)
  },
  "startNumber": integer,

  // Union field glyph_kind can be only one of the following:
  "glyphType": enum (GlyphType),
  "glyphSymbol": string
  // End of list of possible types for union field glyph_kind.
}
ช่อง
bulletAlignment

enum (BulletAlignment)

การจัดแนวหัวข้อภายในพื้นที่ที่กําหนดไว้สําหรับการแสดงผลหัวข้อ

glyphFormat

string

สตริงรูปแบบที่ใช้โดยหัวข้อย่อยในระดับการฝังนี้

รูปแบบสัญลักษณ์มีตัวยึดตําแหน่งอย่างน้อย 1 ตัว และระบบจะแทนที่ตัวยึดตําแหน่งเหล่านี้ด้วยค่าที่เหมาะสมโดยขึ้นอยู่กับ glyphType หรือ glyphSymbol ตัวยึดตําแหน่งเป็นไปตามรูปแบบ %[nestingLevel] นอกจากนี้ ตัวยึดตําแหน่งยังมีส่วนหน้าและส่วนท้ายได้ ดังนั้น รูปแบบสัญลักษณ์จึงเป็นไปตามรูปแบบ <prefix>%[nestingLevel]<suffix> โปรดทราบว่าคุณจะใส่คำนำหน้าและคำต่อท้ายหรือไม่ก็ได้ และสามารถใส่สตริงใดก็ได้

ตัวอย่างเช่น รูปแบบแบบอักษร %0. บ่งบอกว่าแบบอักษรที่แสดงผลจะแทนที่ตัวยึดตําแหน่งด้วยแบบอักษรที่สอดคล้องกันสําหรับการฝังระดับ 0 ตามด้วยเครื่องหมายจุดเป็นส่วนต่อท้าย ดังนั้น รายการที่มีประเภทสัญลักษณ์ UPPER_ALPHA และรูปแบบสัญลักษณ์ %0. ที่ระดับการซ้อน 0 จะส่งผลให้รายการมีสัญลักษณ์ที่ผ่านการจัดการแสดงผล

A.

B.

C.

รูปแบบสัญลักษณ์อาจมีตัวยึดตําแหน่งสําหรับระดับการซ้อนปัจจุบัน รวมถึงตัวยึดตําแหน่งสําหรับระดับการซ้อนหลัก เช่น รายการอาจมีรูปแบบอักขระ %0. ที่ระดับการซ้อน 0 และรูปแบบอักขระ %0.%1. ที่ระดับการซ้อน 1 สมมติว่าทั้ง 2 ระดับการฝังมีประเภทสัญลักษณ์ DECIMAL รายการที่ได้จะเป็นรายการที่มีสัญลักษณ์ที่ผ่านการจัดการแสดงผล

1.

2.

2.1.

2.2.

3.

สำหรับระดับการฝังที่มีลําดับ สตริงที่จะแทนที่ตัวยึดตําแหน่งในรูปแบบสัญลักษณ์สําหรับย่อหน้าหนึ่งๆ จะขึ้นอยู่กับลําดับของย่อหน้าภายในรายการ

indentFirstLine

object (Dimension)

จำนวนการเยื้องสำหรับบรรทัดแรกของย่อหน้าในระดับการฝังนี้

indentStart

object (Dimension)

จำนวนการเยื้องสำหรับย่อหน้าในระดับการฝังนี้ ใช้กับด้านที่สอดคล้องกับจุดเริ่มต้นของข้อความ โดยอิงตามทิศทางเนื้อหาของย่อหน้า

textStyle

object (TextStyle)

รูปแบบข้อความของหัวข้อย่อยในระดับการฝังนี้

startNumber

integer

จํานวนรายการแรกของรายการในระดับการซ้อนนี้

ระบบจะถือว่าค่า 0 เป็นค่า 1 สำหรับรายการตัวอักษรและรายการเลขโรมัน สำหรับค่าทั้ง 0 และ 1 รายการตัวอักษรและตัวเลขโรมันจะเริ่มต้นที่ a และ i ตามลำดับ

ระบบจะละเว้นค่านี้สำหรับระดับการฝังที่มีอักขระแบบไม่เรียงลำดับ

ฟิลด์สหภาพ glyph_kind ประเภทของสัญลักษณ์ที่ใช้กับหัวข้อ คำสั่งนี้กำหนดสัญลักษณ์หัวข้อที่จะแทนที่ตัวยึดตําแหน่งใน glyph_format glyph_kind ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
glyphType

enum (GlyphType)

ประเภทสัญลักษณ์ที่ใช้โดยสัญลักษณ์หัวข้อเมื่อจัดเรียงย่อหน้าในระดับการฝังนี้

ประเภทสัญลักษณ์กำหนดประเภทของสัญลักษณ์ที่ใช้แทนตัวยึดตําแหน่งภายใน glyphFormat เมื่อจัดเรียงย่อหน้าในระดับการฝังนี้ ตัวอย่างเช่น หากระดับการฝังคือ 0, glyphFormat คือ %0. และประเภทสัญลักษณ์คือ DECIMAL สัญลักษณ์ที่แสดงผลจะแทนที่ตัวยึดตําแหน่ง %0 ในรูปแบบสัญลักษณ์ด้วยตัวเลขที่สอดคล้องกับลําดับของรายการในลิสต์

glyphSymbol

string

สัญลักษณ์แบบกำหนดเองที่ใช้โดยสัญลักษณ์หัวข้อเมื่อย่อหน้าในระดับการฝังนี้ไม่มีลําดับ

สัญลักษณ์แบบอักขระแทนที่ตัวยึดตําแหน่งใน glyphFormat เช่น หาก glyphSymbol คือวงกลมตันที่สอดคล้องกับจุดโค้ด Unicode U+25cf และ glyphFormat คือ %0 สัญลักษณ์ที่แสดงผลจะเป็นวงกลมตัน

BulletAlignment

ประเภทการจัดแนวของหัวข้อย่อย

Enum
BULLET_ALIGNMENT_UNSPECIFIED ไม่ได้ระบุการจัดแนวหัวข้อ
START ระบบจะจัดแนวสัญลักษณ์หัวข้อย่อยให้อยู่ตรงกับจุดเริ่มต้นของพื้นที่ที่กําหนดไว้สําหรับการแสดงผลสัญลักษณ์หัวข้อย่อย จัดชิดซ้ายสำหรับข้อความแบบ LTR และจัดชิดขวาสำหรับข้อความแบบอื่นๆ
CENTER ระบบจะจัดแนวหัวข้อให้อยู่ตรงกลางของพื้นที่ที่กำหนดไว้สำหรับการแสดงผลหัวข้อ
END หัวข้อจะจัดแนวกับส่วนท้ายของพื้นที่ที่กำหนดไว้สำหรับการแสดงผลหัวข้อ จัดชิดขวาสำหรับข้อความแบบ LTR และจัดชิดซ้ายสำหรับข้อความแบบอื่นๆ

GlyphType

ประเภทของสัญลักษณ์ที่ใช้กับหัวข้อย่อยเมื่อจัดเรียงย่อหน้าในระดับการฝังนี้

Enum
GLYPH_TYPE_UNSPECIFIED ไม่ได้ระบุประเภทสัญลักษณ์หรือระบบไม่รองรับ
NONE สตริงว่าง
DECIMAL ตัวเลข เช่น 1, 2 หรือ 3
ZERO_DECIMAL ตัวเลขที่มีเลขหลักเดียวและมี 0 นำหน้า เช่น 01, 02 หรือ 03 ตัวเลขที่มีมากกว่า 1 หลักจะไม่ขึ้นต้นด้วย 0
UPPER_ALPHA ตัวอักษรตัวพิมพ์ใหญ่ เช่น A, B หรือ C
ALPHA ตัวอักษรพิมพ์เล็ก เช่น a, b หรือ c
UPPER_ROMAN ตัวเลขโรมันตัวพิมพ์ใหญ่ เช่น I, II หรือ III
ROMAN ตัวเลขโรมันตัวพิมพ์เล็ก เช่น i, ii หรือ iii

SuggestedListProperties

การเปลี่ยนแปลงที่แนะนำสำหรับ ListProperties

การแสดง JSON
{
  "listProperties": {
    object (ListProperties)
  },
  "listPropertiesSuggestionState": {
    object (ListPropertiesSuggestionState)
  }
}
ช่อง
listProperties

object (ListProperties)

ListProperties ที่มีเฉพาะการเปลี่ยนแปลงที่ทำในคําแนะนํานี้ ซึ่งสามารถใช้ร่วมกับ listPropertiesSuggestionState เพื่อดูว่าฟิลด์ใดมีการเปลี่ยนแปลงและค่าใหม่ของฟิลด์นั้น

listPropertiesSuggestionState

object (ListPropertiesSuggestionState)

มาสก์ที่ระบุว่าช่องใดใน ListProperties พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้

ListPropertiesSuggestionState

มาสก์ที่ระบุว่าช่องใดใน ListProperties พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้ สำหรับช่องใดๆ ที่ตั้งค่าเป็น "จริง" จะมีค่าใหม่ที่แนะนำ

การแสดง JSON
{
  "nestingLevelsSuggestionStates": [
    {
      object (NestingLevelSuggestionState)
    }
  ]
}
ช่อง
nestingLevelsSuggestionStates[]

object (NestingLevelSuggestionState)

มาสก์ที่ระบุช่องใน NestingLevel ของ nestingLevels ที่เกี่ยวข้องซึ่งมีการเปลี่ยนแปลงในคำแนะนำนี้

ระบบจะแสดงสถานะคำแนะนำระดับการฝังตามลําดับจากน้อยไปมากของระดับการฝัง โดยแสดงระดับการฝังน้อยที่สุดก่อน

NestingLevelSuggestionState

มาสก์ที่ระบุว่าช่องใดใน NestingLevel พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้ สำหรับช่องใดๆ ที่ตั้งค่าเป็น "จริง" จะมีค่าใหม่ที่แนะนำ

การแสดง JSON
{
  "bulletAlignmentSuggested": boolean,
  "glyphTypeSuggested": boolean,
  "glyphFormatSuggested": boolean,
  "glyphSymbolSuggested": boolean,
  "indentFirstLineSuggested": boolean,
  "indentStartSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  },
  "startNumberSuggested": boolean
}
ช่อง
bulletAlignmentSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน bulletAlignment หรือไม่

glyphTypeSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน glyphType หรือไม่

glyphFormatSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน glyphFormat หรือไม่

glyphSymbolSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน glyphSymbol หรือไม่

indentFirstLineSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน indentFirstLine หรือไม่

indentStartSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน indentStart หรือไม่

textStyleSuggestionState

object (TextStyleSuggestionState)

มาสก์ที่ระบุช่องใน text style ที่มีการเปลี่ยนแปลงในคำแนะนำนี้

startNumberSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน startNumber หรือไม่

NamedRanges

ชุดNamedRangeทั้งหมดในเอกสารที่ใช้ชื่อเดียวกัน

การแสดง JSON
{
  "name": string,
  "namedRanges": [
    {
      object (NamedRange)
    }
  ]
}
ช่อง
name

string

ชื่อที่ named ranges ทั้งหมดใช้ร่วมกัน

namedRanges[]

object (NamedRange)

NamedRange ที่มีชื่อเดียวกัน

NamedRange

คอลเล็กชัน Range ที่มีรหัสช่วงที่มีชื่อเดียวกัน

ช่วงที่ระบุชื่อช่วยให้นักพัฒนาซอฟต์แวร์เชื่อมโยงส่วนของเอกสารกับป้ายกำกับที่ผู้ใช้กำหนดเองได้ เพื่อให้ระบบอ่านหรือแก้ไขเนื้อหาของส่วนนั้นๆ โดยใช้โปรแกรมในภายหลัง เอกสารอาจมีช่วงที่มีชื่อหลายรายการที่ใช้ชื่อเดียวกัน แต่ช่วงที่มีชื่อทุกช่วงจะมีรหัสที่ไม่ซ้ำกัน

ระบบจะสร้างช่วงที่มีชื่อด้วย Range เพียงตัวเดียว และโดยทั่วไปแล้วเนื้อหาที่แทรกภายในช่วงที่มีชื่อจะขยายช่วงนั้น อย่างไรก็ตาม การเปลี่ยนแปลงบางอย่างในเอกสารอาจทําให้ช่วงแบ่งออกเป็นหลายช่วง

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

การแสดง JSON
{
  "namedRangeId": string,
  "name": string,
  "ranges": [
    {
      object (Range)
    }
  ]
}
ช่อง
namedRangeId

string

รหัสของช่วงที่มีชื่อ

name

string

ชื่อของช่วงที่มีชื่อ

ranges[]

object (Range)

ช่วงที่อยู่ในช่วงที่ตั้งชื่อแล้วนี้

ช่วง

ระบุช่วงข้อความที่อยู่ติดกัน

การแสดง JSON
{
  "segmentId": string,
  "startIndex": integer,
  "endIndex": integer,
  "tabId": string
}
ช่อง
segmentId

string

รหัสของส่วนหัว ส่วนท้าย หรือเชิงอรรถที่มีช่วงนี้อยู่ รหัสกลุ่มว่างหมายถึงเนื้อหาของเอกสาร

startIndex

integer

ดัชนีเริ่มต้นแบบนับจาก 0 ของช่วงนี้ในหน่วยโค้ด UTF-16

ในการใช้งานปัจจุบันทั้งหมด คุณต้องระบุดัชนีเริ่มต้น ฟิลด์นี้เป็น Int32Value เพื่อรองรับกรณีการใช้งานในอนาคตที่มีช่วงแบบเปิด

endIndex

integer

ดัชนีสิ้นสุดแบบนับจาก 0 ของช่วงนี้แบบไม่รวมในหน่วยโค้ด UTF-16

ในการใช้งานปัจจุบันทั้งหมด คุณต้องระบุดัชนีสิ้นสุด ฟิลด์นี้เป็น Int32Value เพื่อรองรับกรณีการใช้งานในอนาคตที่มีช่วงแบบเปิด

tabId

string

แท็บที่มีช่วงนี้ หากไม่ระบุ ค่านี้จะมีผลกับแท็บแรก

ในเอกสารที่มีแท็บเดียว ให้ทำดังนี้

  • หากระบุ ต้องตรงกับรหัสของแท็บเดียว

  • หากไม่ระบุ คำขอจะมีผลกับแท็บเดียว

ในเอกสารที่มีหลายแท็บ ให้ทำดังนี้

  • หากระบุไว้ คำขอจะมีผลกับแท็บที่ระบุ

  • หากไม่ระบุ ค่าเริ่มต้นคือคำขอจะมีผลกับแท็บแรกในเอกสาร

InlineObject

วัตถุที่ปรากฏในบรรทัดเดียวกับข้อความ InlineObject มี EmbeddedObject เช่น รูปภาพ

การแสดง JSON
{
  "objectId": string,
  "inlineObjectProperties": {
    object (InlineObjectProperties)
  },
  "suggestedInlineObjectPropertiesChanges": {
    string: {
      object (SuggestedInlineObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
ช่อง
objectId

string

รหัสของออบเจ็กต์ในบรรทัดนี้ ใช้เพื่ออัปเดตพร็อพเพอร์ตี้ของออบเจ็กต์ได้

inlineObjectProperties

object (InlineObjectProperties)

พร็อพเพอร์ตี้ของออบเจ็กต์ในบรรทัดนี้

suggestedInlineObjectPropertiesChanges

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

การเปลี่ยนแปลงที่แนะนําในพร็อพเพอร์ตี้ออบเจ็กต์ในบรรทัด โดยคีย์ตามรหัสคําแนะนํา

suggestedInsertionId

string

รหัสการแทรกที่แนะนํา หากเป็นค่าว่าง แสดงว่านี่ไม่ใช่การแทรกที่แนะนำ

suggestedDeletionIds[]

string

รหัสการลบที่แนะนำ หากช่องนี้ว่าง แสดงว่าไม่มีคำแนะนำให้ลบเนื้อหานี้

InlineObjectProperties

คุณสมบัติของ InlineObject

การแสดง JSON
{
  "embeddedObject": {
    object (EmbeddedObject)
  }
}
ช่อง
embeddedObject

object (EmbeddedObject)

ออบเจ็กต์ที่ฝังไว้ของออบเจ็กต์ในบรรทัดนี้

EmbeddedObject

ออบเจ็กต์ที่ฝังในเอกสาร

การแสดง JSON
{
  "title": string,
  "description": string,
  "embeddedObjectBorder": {
    object (EmbeddedObjectBorder)
  },
  "size": {
    object (Size)
  },
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "linkedContentReference": {
    object (LinkedContentReference)
  },

  // Union field properties can be only one of the following:
  "embeddedDrawingProperties": {
    object (EmbeddedDrawingProperties)
  },
  "imageProperties": {
    object (ImageProperties)
  }
  // End of list of possible types for union field properties.
}
ช่อง
title

string

ชื่อของออบเจ็กต์ที่ฝัง ระบบจะรวม title และ description เข้าด้วยกันเพื่อแสดงข้อความแสดงแทน

description

string

คำอธิบายของออบเจ็กต์ที่ฝัง ระบบจะรวม title และ description เข้าด้วยกันเพื่อแสดงข้อความแสดงแทน

embeddedObjectBorder

object (EmbeddedObjectBorder)

เส้นขอบของวัตถุที่ฝัง

size

object (Size)

ขนาดที่มองเห็นได้ของรูปภาพหลังจากครอบตัด

marginTop

object (Dimension)

ระยะขอบด้านบนของออบเจ็กต์ที่ฝัง

marginBottom

object (Dimension)

ระยะขอบด้านล่างของวัตถุที่ฝัง

marginRight

object (Dimension)

ระยะขอบด้านขวาของออบเจ็กต์ที่ฝัง

marginLeft

object (Dimension)

ระยะขอบด้านซ้ายของออบเจ็กต์ที่ฝัง

linkedContentReference

object (LinkedContentReference)

การอ้างอิงเนื้อหาแหล่งที่มาภายนอกที่ลิงก์ เช่น มีข้อมูลอ้างอิงถึงแผนภูมิ Google ชีตต้นทางเมื่อออบเจ็กต์ที่ฝังเป็นแผนภูมิที่ลิงก์

หากไม่ได้ตั้งค่าไว้ แสดงว่าออบเจ็กต์ที่ฝังไม่ได้ลิงก์

ฟิลด์สหภาพ properties พร็อพเพอร์ตี้เฉพาะสำหรับออบเจ็กต์ที่ฝังแต่ละประเภท properties ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
embeddedDrawingProperties

object (EmbeddedDrawingProperties)

คุณสมบัติของภาพวาดที่ฝัง

imageProperties

object (ImageProperties)

พร็อพเพอร์ตี้ของรูปภาพ

EmbeddedDrawingProperties

ประเภทนี้ไม่มีช่อง

พร็อพเพอร์ตี้ของภาพวาดที่ฝังไว้และใช้เพื่อแยกความแตกต่างของประเภทออบเจ็กต์ ภาพวาดที่ฝังไว้คือภาพวาดที่สร้างและแก้ไขภายในเอกสาร โปรดทราบว่าระบบไม่รองรับรายละเอียดที่ละเอียดมาก

ImageProperties

พร็อพเพอร์ตี้ของรูปภาพ

การแสดง JSON
{
  "contentUri": string,
  "sourceUri": string,
  "brightness": number,
  "contrast": number,
  "transparency": number,
  "cropProperties": {
    object (CropProperties)
  },
  "angle": number
}
ช่อง
contentUri

string

URI ไปยังรูปภาพที่มีอายุการใช้งานเริ่มต้น 30 นาที URI นี้ติดแท็กด้วยบัญชีของผู้ขอ ทุกคนที่มี URI จะเข้าถึงรูปภาพในฐานะผู้ขอต้นฉบับได้ คุณอาจเสียสิทธิ์เข้าถึงรูปภาพหากการตั้งค่าการแชร์ของเอกสารมีการเปลี่ยนแปลง

sourceUri

string

URI ต้นทางคือ URI ที่ใช้แทรกรูปภาพ URI แหล่งที่มาสามารถเว้นว่างไว้ได้

brightness

number

เอฟเฟกต์ความสว่างของรูปภาพ ค่าควรอยู่ในช่วง [-1.0, 1.0] โดยที่ 0 หมายถึงไม่มีผล

contrast

number

เอฟเฟกต์คอนทราสต์ของรูปภาพ ค่าควรอยู่ในช่วง [-1.0, 1.0] โดยที่ 0 หมายถึงไม่มีผล

transparency

number

เอฟเฟกต์ความโปร่งใสของรูปภาพ ค่าควรอยู่ในช่วง [0.0, 1.0] โดยที่ 0 หมายถึงไม่มีผล และ 1 หมายถึงโปร่งใส

cropProperties

object (CropProperties)

คุณสมบัติการครอบตัดของรูปภาพ

angle

number

มุมการหมุนตามเข็มนาฬิกาของรูปภาพเป็นเรเดียน

CropProperties

พร็อพเพอร์ตี้ครอบตัดของรูปภาพ

สี่เหลี่ยมผืนผ้าครอบตัดจะแสดงโดยใช้การเลื่อนเชิงเศษส่วนจากขอบทั้ง 4 ด้านของเนื้อหาต้นฉบับ

  • หากออฟเซตอยู่ในช่วง (0, 1) ขอบของสี่เหลี่ยมผืนผ้าครอบตัดที่เกี่ยวข้องจะอยู่ในสี่เหลี่ยมผืนผ้าขอบเขตเดิมของรูปภาพ
  • หากออฟเซ็ตเป็นค่าลบหรือมากกว่า 1 ขอบของสี่เหลี่ยมผืนผ้าครอบตัดที่เกี่ยวข้องจะอยู่นอกสี่เหลี่ยมผืนผ้าขอบเขตเดิมของรูปภาพ
  • หากออฟเซตและมุมการหมุนทั้งหมดเป็น 0 ระบบจะไม่ครอบตัดรูปภาพ
การแสดง JSON
{
  "offsetLeft": number,
  "offsetRight": number,
  "offsetTop": number,
  "offsetBottom": number,
  "angle": number
}
ช่อง
offsetLeft

number

ส่วนออฟเซ็ตจะระบุระยะห่างของขอบด้านซ้ายของสี่เหลี่ยมผืนผ้าครอบตัดจากขอบด้านซ้ายของเนื้อหาต้นฉบับเป็นเศษส่วนของความกว้างของเนื้อหาต้นฉบับ

offsetRight

number

ส่วนออฟเซ็ตจะระบุระยะห่างของขอบด้านขวาของสี่เหลี่ยมผืนผ้าครอบตัดจากขอบด้านขวาของเนื้อหาต้นฉบับเป็นเศษส่วนของความกว้างของเนื้อหาต้นฉบับ

offsetTop

number

ส่วนออฟเซ็ตจะระบุระยะห่างของขอบด้านบนของสี่เหลี่ยมผืนผ้าครอบตัดจากขอบด้านบนของเนื้อหาต้นฉบับเป็นเศษส่วนของความสูงของเนื้อหาต้นฉบับ

offsetBottom

number

ส่วนออฟเซ็ตจะระบุระยะห่างของขอบด้านล่างของสี่เหลี่ยมผืนผ้าครอบตัดจากขอบด้านล่างของเนื้อหาต้นฉบับเป็นเศษส่วนของความสูงของเนื้อหาต้นฉบับ

angle

number

มุมการหมุนตามเข็มนาฬิกาของสี่เหลี่ยมผืนผ้าครอบตัดรอบจุดศูนย์กลางเป็นเรเดียน การหมุนจะมีผลหลังจากการเลื่อน

EmbeddedObjectBorder

เส้นขอบรอบ EmbeddedObject

การแสดง JSON
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle),
  "propertyState": enum (PropertyState)
}
ช่อง
color

object (OptionalColor)

สีของเส้นขอบ

width

object (Dimension)

ความกว้างของเส้นขอบ

dashStyle

enum (DashStyle)

รูปแบบเส้นประของเส้นขอบ

propertyState

enum (PropertyState)

สถานะของพร็อพเพอร์ตี้เส้นขอบ

PropertyState

สถานะที่เป็นไปได้ของที่พัก

Enum
RENDERED หากสถานะของพร็อพเพอร์ตี้คือ "แสดงผลแล้ว" แสดงว่าองค์ประกอบมีพร็อพเพอร์ตี้ที่เกี่ยวข้องเมื่อแสดงผลในเอกสาร นี่คือค่าเริ่มต้น
NOT_RENDERED หากสถานะของพร็อพเพอร์ตี้คือ NOT_RENDERED แสดงว่าองค์ประกอบไม่มีพร็อพเพอร์ตี้ที่เกี่ยวข้องเมื่อแสดงผลในเอกสาร

LinkedContentReference

การอ้างอิงเนื้อหาแหล่งที่มาภายนอกที่ลิงก์

การแสดง JSON
{

  // Union field reference can be only one of the following:
  "sheetsChartReference": {
    object (SheetsChartReference)
  }
  // End of list of possible types for union field reference.
}
ช่อง
ฟิลด์สหภาพ reference การอ้างอิงเฉพาะสำหรับประเภทเนื้อหาที่ลิงก์ reference ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
sheetsChartReference

object (SheetsChartReference)

การอ้างอิงถึงแผนภูมิที่ลิงก์

SheetsChartReference

การอ้างอิงถึงแผนภูมิที่ลิงก์ซึ่งฝังมาจาก Google ชีต

การแสดง JSON
{
  "spreadsheetId": string,
  "chartId": integer
}
ช่อง
spreadsheetId

string

รหัสของสเปรดชีต Google ชีตที่มีแผนภูมิต้นทาง

chartId

integer

รหัสของแผนภูมิที่เฉพาะเจาะจงในสเปรดชีต Google ชีตที่ฝังไว้

SuggestedInlineObjectProperties

การเปลี่ยนแปลงที่แนะนำสำหรับ InlineObjectProperties

การแสดง JSON
{
  "inlineObjectProperties": {
    object (InlineObjectProperties)
  },
  "inlineObjectPropertiesSuggestionState": {
    object (InlineObjectPropertiesSuggestionState)
  }
}
ช่อง
inlineObjectProperties

object (InlineObjectProperties)

InlineObjectProperties ที่มีเฉพาะการเปลี่ยนแปลงที่ทำในคําแนะนํานี้ ซึ่งสามารถใช้ร่วมกับ inlineObjectPropertiesSuggestionState เพื่อดูว่าฟิลด์ใดมีการเปลี่ยนแปลงและค่าใหม่ของฟิลด์นั้น

inlineObjectPropertiesSuggestionState

object (InlineObjectPropertiesSuggestionState)

มาสก์ที่ระบุว่าช่องใดใน InlineObjectProperties พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้

InlineObjectPropertiesSuggestionState

มาสก์ที่ระบุว่าช่องใดใน InlineObjectProperties พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้ สำหรับช่องใดก็ตามที่ตั้งค่าเป็น "จริง" จะมีค่าใหม่ที่แนะนำ

การแสดง JSON
{
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
ช่อง
embeddedObjectSuggestionState

object (EmbeddedObjectSuggestionState)

มาสก์ที่ระบุช่องใน embeddedObject ที่มีการเปลี่ยนแปลงในคำแนะนำนี้

EmbeddedObjectSuggestionState

มาสก์ที่ระบุว่าช่องใดใน EmbeddedObject พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้ สำหรับช่องใดก็ตามที่ตั้งค่าเป็น "จริง" จะมีค่าใหม่ที่แนะนำ

การแสดง JSON
{
  "embeddedDrawingPropertiesSuggestionState": {
    object (EmbeddedDrawingPropertiesSuggestionState)
  },
  "imagePropertiesSuggestionState": {
    object (ImagePropertiesSuggestionState)
  },
  "titleSuggested": boolean,
  "descriptionSuggested": boolean,
  "embeddedObjectBorderSuggestionState": {
    object (EmbeddedObjectBorderSuggestionState)
  },
  "sizeSuggestionState": {
    object (SizeSuggestionState)
  },
  "marginLeftSuggested": boolean,
  "marginRightSuggested": boolean,
  "marginTopSuggested": boolean,
  "marginBottomSuggested": boolean,
  "linkedContentReferenceSuggestionState": {
    object (LinkedContentReferenceSuggestionState)
  }
}
ช่อง
embeddedDrawingPropertiesSuggestionState

object (EmbeddedDrawingPropertiesSuggestionState)

มาสก์ที่ระบุช่องใน embeddedDrawingProperties ที่มีการเปลี่ยนแปลงในคำแนะนำนี้

imagePropertiesSuggestionState

object (ImagePropertiesSuggestionState)

มาสก์ที่ระบุช่องใน imageProperties ที่มีการเปลี่ยนแปลงในคำแนะนำนี้

titleSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน title หรือไม่

descriptionSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน description หรือไม่

embeddedObjectBorderSuggestionState

object (EmbeddedObjectBorderSuggestionState)

มาสก์ที่ระบุช่องใน embeddedObjectBorder ที่มีการเปลี่ยนแปลงในคำแนะนำนี้

sizeSuggestionState

object (SizeSuggestionState)

มาสก์ที่ระบุช่องใน size ที่มีการเปลี่ยนแปลงในคำแนะนำนี้

marginLeftSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน marginLeft หรือไม่

marginRightSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน marginRight หรือไม่

marginTopSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน marginTop หรือไม่

marginBottomSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน marginBottom หรือไม่

linkedContentReferenceSuggestionState

object (LinkedContentReferenceSuggestionState)

มาสก์ที่ระบุช่องใน linkedContentReference ที่มีการเปลี่ยนแปลงในคำแนะนำนี้

EmbeddedDrawingPropertiesSuggestionState

ประเภทนี้ไม่มีช่อง

มาสก์ที่ระบุว่าช่องใดใน EmbeddedDrawingProperties พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้ สำหรับช่องใดก็ตามที่ตั้งค่าเป็น "จริง" จะมีค่าใหม่ที่แนะนำ

ImagePropertiesSuggestionState

มาสก์ที่ระบุว่าช่องใดใน ImageProperties พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้ สำหรับช่องใดก็ตามที่ตั้งค่าเป็น "จริง" จะมีค่าใหม่ที่แนะนำ

การแสดง JSON
{
  "contentUriSuggested": boolean,
  "sourceUriSuggested": boolean,
  "brightnessSuggested": boolean,
  "contrastSuggested": boolean,
  "transparencySuggested": boolean,
  "cropPropertiesSuggestionState": {
    object (CropPropertiesSuggestionState)
  },
  "angleSuggested": boolean
}
ช่อง
contentUriSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน contentUri หรือไม่

sourceUriSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri] หรือไม่

brightnessSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน [brightness] [google.apps.docs.v1.EmbeddedObject.brightness] หรือไม่

contrastSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน [contrast] [google.apps.docs.v1.EmbeddedObject.contrast] หรือไม่

transparencySuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน [transparency] [google.apps.docs.v1.EmbeddedObject.transparency] หรือไม่

cropPropertiesSuggestionState

object (CropPropertiesSuggestionState)

มาสก์ที่ระบุช่องใน cropProperties ที่มีการเปลี่ยนแปลงในคำแนะนำนี้

angleSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำสำหรับ [angle] [google.apps.docs.v1.EmbeddedObject.angle] หรือไม่

CropPropertiesSuggestionState

มาสก์ที่ระบุว่าช่องใดใน CropProperties พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้ สำหรับช่องใดก็ตามที่ตั้งค่าเป็น "จริง" จะมีค่าใหม่ที่แนะนำ

การแสดง JSON
{
  "offsetLeftSuggested": boolean,
  "offsetRightSuggested": boolean,
  "offsetTopSuggested": boolean,
  "offsetBottomSuggested": boolean,
  "angleSuggested": boolean
}
ช่อง
offsetLeftSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน offsetLeft หรือไม่

offsetRightSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน offsetRight หรือไม่

offsetTopSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน offsetTop หรือไม่

offsetBottomSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน offsetBottom หรือไม่

angleSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน angle หรือไม่

EmbeddedObjectBorderSuggestionState

มาสก์ที่ระบุว่าช่องใดใน EmbeddedObjectBorder พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้ สำหรับช่องใดก็ตามที่ตั้งค่าเป็น "จริง" จะมีค่าใหม่ที่แนะนำ

การแสดง JSON
{
  "colorSuggested": boolean,
  "widthSuggested": boolean,
  "dashStyleSuggested": boolean,
  "propertyStateSuggested": boolean
}
ช่อง
colorSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน [color] [google.apps.docs.v1.EmbeddedBorderObject.color] หรือไม่

widthSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน [width] [google.apps.docs.v1.EmbeddedBorderObject.width] หรือไม่

dashStyleSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำสำหรับ [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style] หรือไม่

propertyStateSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน [propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state] หรือไม่

LinkedContentReferenceSuggestionState

มาสก์ที่ระบุว่าช่องใดใน LinkedContentReference พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้ สำหรับช่องใดก็ตามที่ตั้งค่าเป็น "จริง" จะมีค่าใหม่ที่แนะนำ

การแสดง JSON
{
  "sheetsChartReferenceSuggestionState": {
    object (SheetsChartReferenceSuggestionState)
  }
}
ช่อง
sheetsChartReferenceSuggestionState

object (SheetsChartReferenceSuggestionState)

มาสก์ที่ระบุช่องใน sheetsChartReference ที่มีการเปลี่ยนแปลงในคำแนะนำนี้

SheetsChartReferenceSuggestionState

มาสก์ที่ระบุว่าช่องใดใน SheetsChartReference พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้ สำหรับช่องใดๆ ที่ตั้งค่าเป็น "จริง" จะมีค่าใหม่ที่แนะนำ

การแสดง JSON
{
  "spreadsheetIdSuggested": boolean,
  "chartIdSuggested": boolean
}
ช่อง
spreadsheetIdSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน spreadsheetId หรือไม่

chartIdSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน chartId หรือไม่

PositionedObject

วัตถุที่เชื่อมโยงกับ Paragraph และวางตำแหน่งตามจุดเริ่มต้นของย่อหน้า PositionedObject มี EmbeddedObject เช่น รูปภาพ

การแสดง JSON
{
  "objectId": string,
  "positionedObjectProperties": {
    object (PositionedObjectProperties)
  },
  "suggestedPositionedObjectPropertiesChanges": {
    string: {
      object (SuggestedPositionedObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
ช่อง
objectId

string

รหัสของออบเจ็กต์ที่วางตำแหน่งนี้

positionedObjectProperties

object (PositionedObjectProperties)

พร็อพเพอร์ตี้ของออบเจ็กต์ที่วางตำแหน่งนี้

suggestedPositionedObjectPropertiesChanges

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

การเปลี่ยนแปลงที่แนะนําในพร็อพเพอร์ตี้ออบเจ็กต์ที่วางตําแหน่งไว้ โดยคีย์ตามรหัสคําแนะนํา

suggestedInsertionId

string

รหัสการแทรกที่แนะนํา หากเป็นค่าว่าง แสดงว่านี่ไม่ใช่การแทรกที่แนะนำ

suggestedDeletionIds[]

string

รหัสการลบที่แนะนำ หากช่องนี้ว่าง แสดงว่าไม่มีคำแนะนำให้ลบเนื้อหานี้

PositionedObjectProperties

พร็อพเพอร์ตี้ของ PositionedObject

การแสดง JSON
{
  "positioning": {
    object (PositionedObjectPositioning)
  },
  "embeddedObject": {
    object (EmbeddedObject)
  }
}
ช่อง
positioning

object (PositionedObjectPositioning)

การวางตำแหน่งของออบเจ็กต์ที่วางตำแหน่งนี้สัมพันธ์กับบรรทัดแรกของ Paragraph ที่อ้างอิงออบเจ็กต์ที่วางตำแหน่งนี้

embeddedObject

object (EmbeddedObject)

ออบเจ็กต์ที่ฝังไว้ของออบเจ็กต์ที่วางตำแหน่งนี้

PositionedObjectPositioning

ตำแหน่งของ PositionedObject วัตถุที่วางตำแหน่งจะวางตำแหน่งตามจุดเริ่มต้นของ Paragraph ที่ยึดไว้

การแสดง JSON
{
  "layout": enum (PositionedObjectLayout),
  "leftOffset": {
    object (Dimension)
  },
  "topOffset": {
    object (Dimension)
  }
}
ช่อง
layout

enum (PositionedObjectLayout)

เลย์เอาต์ของออบเจ็กต์ที่วางตำแหน่งนี้

leftOffset

object (Dimension)

การเลื่อนของขอบด้านซ้ายของออบเจ็กต์ที่วางตำแหน่งไว้ซึ่งสัมพันธ์กับจุดเริ่มต้นของ Paragraph ที่ยึดไว้ ตำแหน่งที่แน่นอนของวัตถุอาจขึ้นอยู่กับเนื้อหาอื่นๆ ในเอกสารและการจัดรูปแบบของเอกสาร

topOffset

object (Dimension)

การเลื่อนของขอบด้านบนของวัตถุที่วางตำแหน่งซึ่งสัมพันธ์กับจุดเริ่มต้นของParagraphที่ยึดไว้ ตำแหน่งที่แน่นอนของวัตถุอาจขึ้นอยู่กับเนื้อหาอื่นๆ ในเอกสารและการจัดรูปแบบของเอกสาร

PositionedObjectLayout

เลย์เอาต์ที่เป็นไปได้ของ [PositionedObject][google.aps.docs.v1.PositionedObject]

Enum
POSITIONED_OBJECT_LAYOUT_UNSPECIFIED ไม่ได้ระบุเลยว่าจะวางเลย์เอาต์แบบใด
WRAP_TEXT ข้อความจะตัดขึ้นบรรทัดใหม่รอบๆ วัตถุที่จัดตำแหน่งไว้
BREAK_LEFT แบ่งข้อความเพื่อให้วัตถุที่วางอยู่ทางด้านซ้ายและข้อความอยู่ทางด้านขวา
BREAK_RIGHT แบ่งข้อความเพื่อให้วัตถุที่วางอยู่ทางด้านขวาและข้อความอยู่ทางด้านซ้าย
BREAK_LEFT_RIGHT แบ่งข้อความโดยไม่มีข้อความอยู่ทางด้านซ้ายหรือขวาของออบเจ็กต์ที่จัดตำแหน่งไว้
IN_FRONT_OF_TEXT วัตถุที่วางอยู่อยู่ด้านหน้าข้อความ
BEHIND_TEXT วัตถุที่วางอยู่อยู่ด้านหลังข้อความ

SuggestedPositionedObjectProperties

การเปลี่ยนแปลงที่แนะนำสำหรับ PositionedObjectProperties

การแสดง JSON
{
  "positionedObjectProperties": {
    object (PositionedObjectProperties)
  },
  "positionedObjectPropertiesSuggestionState": {
    object (PositionedObjectPropertiesSuggestionState)
  }
}
ช่อง
positionedObjectProperties

object (PositionedObjectProperties)

PositionedObjectProperties ที่มีเฉพาะการเปลี่ยนแปลงที่ทำในคำแนะนำนี้ ซึ่งสามารถใช้ร่วมกับ positionedObjectPropertiesSuggestionState เพื่อดูว่าฟิลด์ใดมีการเปลี่ยนแปลงและค่าใหม่ของฟิลด์นั้น

positionedObjectPropertiesSuggestionState

object (PositionedObjectPropertiesSuggestionState)

มาสก์ที่ระบุว่าช่องใดใน PositionedObjectProperties พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้

PositionedObjectPropertiesSuggestionState

มาสก์ที่ระบุว่าช่องใดใน PositionedObjectProperties พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้ สำหรับช่องใดก็ตามที่ตั้งค่าเป็น "จริง" จะมีค่าใหม่ที่แนะนำ

การแสดง JSON
{
  "positioningSuggestionState": {
    object (PositionedObjectPositioningSuggestionState)
  },
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
ช่อง
positioningSuggestionState

object (PositionedObjectPositioningSuggestionState)

มาสก์ที่ระบุช่องใน positioning ที่มีการเปลี่ยนแปลงในคำแนะนำนี้

embeddedObjectSuggestionState

object (EmbeddedObjectSuggestionState)

มาสก์ที่ระบุช่องใน embeddedObject ที่มีการเปลี่ยนแปลงในคำแนะนำนี้

PositionedObjectPositioningSuggestionState

มาสก์ที่ระบุว่าช่องใดใน PositionedObjectPositioning พื้นฐานมีการเปลี่ยนแปลงในคําแนะนํานี้ สำหรับช่องใดก็ตามที่ตั้งค่าเป็น "จริง" จะมีค่าใหม่ที่แนะนำ

การแสดง JSON
{
  "layoutSuggested": boolean,
  "leftOffsetSuggested": boolean,
  "topOffsetSuggested": boolean
}
ช่อง
layoutSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน layout หรือไม่

leftOffsetSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน leftOffset หรือไม่

topOffsetSuggested

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำใน topOffset หรือไม่

SuggestionsViewMode

โหมดมุมมองคำแนะนำที่ใช้กับเอกสารซึ่งระบุวิธีแสดงการเปลี่ยนแปลงที่แนะนำ โดยจะมีตัวเลือกในการอ่านเอกสารโดยให้คำแนะนำทั้งหมดแสดงในบรรทัด ยอมรับ หรือปฏิเสธ

Enum
DEFAULT_FOR_CURRENT_ACCESS SuggestionsViewMode ที่ใช้กับเอกสารที่แสดงจะขึ้นอยู่กับระดับการเข้าถึงปัจจุบันของผู้ใช้ หากผู้ใช้มีสิทธิ์เข้าถึงแบบดูอย่างเดียว ระบบจะใช้ PREVIEW_WITHOUT_SUGGESTIONS ไม่เช่นนั้น ระบบจะใช้ SUGGESTIONS_INLINE โหมดนี้เป็นโหมดมุมมองคำแนะนำเริ่มต้น
SUGGESTIONS_INLINE

เอกสารที่แสดงผลจะมีคำแนะนำในบรรทัด การเปลี่ยนแปลงที่แนะนำจะแตกต่างจากเนื้อหาพื้นฐานในเอกสาร

คำขอดึงข้อมูลเอกสารโดยใช้โหมดนี้จะแสดงข้อผิดพลาด 403 หากผู้ใช้ไม่มีสิทธิ์ดูการเปลี่ยนแปลงที่แนะนำ

PREVIEW_SUGGESTIONS_ACCEPTED

เอกสารที่แสดงเป็นตัวอย่างที่ยอมรับการเปลี่ยนแปลงที่แนะนำทั้งหมด

คำขอดึงข้อมูลเอกสารโดยใช้โหมดนี้จะแสดงข้อผิดพลาด 403 หากผู้ใช้ไม่มีสิทธิ์ดูการเปลี่ยนแปลงที่แนะนำ

PREVIEW_WITHOUT_SUGGESTIONS เอกสารที่แสดงเป็นตัวอย่างที่มีการเปลี่ยนแปลงที่แนะนำทั้งหมดถูกปฏิเสธ หากมีคำแนะนำในเอกสาร

เมธอด

batchUpdate

ใช้การอัปเดตอย่างน้อย 1 รายการกับเอกสาร

create

สร้างเอกสารเปล่าโดยใช้ชื่อที่ระบุในคำขอ

get

รับเอกสารที่ระบุเวอร์ชันล่าสุด