REST Resource: documents

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

เอกสารใน Google เอกสาร

การแสดง JSON 
{
  "documentId": string,
  "title": string,
  "tabs": [
    {
      object (Tab)
    }
  ],
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "commentsViewMode": enum (CommentsViewMode),
  "comments": [
    {
      object (CommentThread)
    }
  ],
  "suggestions": [
    {
      object (SuggestionThread)
    }
  ],
  "body": {
    object (Body)
  },
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "footers": {
    string: {
      object (Footer)
    },
    ...
  },
  "footnotes": {
    string: {
      object (Footnote)
    },
    ...
  },
  "documentStyle": {
    object (DocumentStyle)
  },
  "suggestedDocumentStyleChanges": {
    string: {
      object (SuggestedDocumentStyle)
    },
    ...
  },
  "namedStyles": {
    object (NamedStyles)
  },
  "suggestedNamedStylesChanges": {
    string: {
      object (SuggestedNamedStyles)
    },
    ...
  },
  "lists": {
    string: {
      object (List)
    },
    ...
  },
  "namedRanges": {
    string: {
      object (NamedRanges)
    },
    ...
  },
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
ช่อง
documentId

string

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

string

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

object (Tab)

เอาต์พุตเท่านั้น แท็บที่เป็นส่วนหนึ่งของเอกสาร

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

string

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

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

enum (SuggestionsViewMode)

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

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

enum (CommentsViewMode)

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

object (CommentThread)

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

object (SuggestionThread)

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

object (Body)

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

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

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

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

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

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

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

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

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

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

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

object (DocumentStyle)

เอาต์พุตเท่านั้น ลักษณะของเอกสาร

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

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

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

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

object (NamedStyles)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

แท็บ

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

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

  "documentTab": {
    object (DocumentTab)
  }
}
ช่อง
tabProperties

object (TabProperties)

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

object (Tab)

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

object (DocumentTab)

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

TabProperties

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

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

string

รหัสของแท็บที่เปลี่ยนแปลงไม่ได้
title

string

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

string

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

integer

ดัชนีฐาน 0 ของแท็บภายในองค์ประกอบหลัก
nestingLevel

integer

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

string

ไม่บังคับ ไอคอนอีโมจิที่แสดงพร้อมกับแท็บ ไอคอนอีโมจิที่ถูกต้องจะแสดงด้วยสตริง Unicode ที่ไม่ว่าง ชุดอักขระใดๆ ที่ไม่ได้แสดงอีโมจิเดียวจะถือว่าไม่ถูกต้อง

หากอีโมจิไม่ถูกต้อง ระบบจะแสดงข้อผิดพลาด 400 Bad Request

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

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)
    },
    ...
  },
  "commentAnchors": {
    string: {
      object (CommentAnchor)
    },
    ...
  }
}
ช่อง
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))

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

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

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

เนื้อความ

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

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

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

object (StructuralElement)

เนื้อหาของส่วนเนื้อหา

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

StructuralElement

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

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

  "paragraph": {
    object (Paragraph)
  },
  "sectionBreak": {
    object (SectionBreak)
  },
  "table": {
    object (Table)
  },
  "tableOfContents": {
    object (TableOfContents)
  }
}
ช่อง
startIndex

integer

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

integer

ดัชนีสิ้นสุดขององค์ประกอบโครงสร้างนี้โดยอิงตาม 0 ซึ่งไม่รวมอยู่ในหน่วยโค้ด UTF-16
เนื้อหาขององค์ประกอบโครงสร้าง ต่อไปนี้คือรายการฟิลด์ที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าฟิลด์อย่างน้อย 1 รายการในการตอบกลับ
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,

  "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)
  },
  "dateElement": {
    object (DateElement)
  }
}
ช่อง
startIndex

integer

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

integer

ดัชนีสิ้นสุดแบบอิงตาม 0 ขององค์ประกอบย่อหน้านี้ ซึ่งไม่รวมในหน่วยรหัส UTF-16
เนื้อหาขององค์ประกอบย่อหน้า ต่อไปนี้คือรายการฟิลด์ที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าฟิลด์อย่างน้อย 1 รายการในการตอบกลับ
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)

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

object (DateElement)

องค์ประกอบย่อหน้าที่แสดงถึงวันที่
สิ้นสุดฟิลด์ที่แยกกัน

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 ("normal")

น้ำหนักแบบอักษรเป็นเพียงองค์ประกอบเดียวของน้ำหนักแบบอักษรที่แสดง ค่า 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)

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

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

DateElement

อินสแตนซ์วันที่ที่กล่าวถึงในเอกสาร

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

string

เอาต์พุตเท่านั้น รหัสที่ไม่ซ้ำกันของวันที่นี้
suggestedInsertionIds[]

string

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

string

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

object (TextStyle)

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

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

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

object (DateElementProperties)

พร็อพเพอร์ตี้ของ DateElement นี้
suggestedDateElementPropertiesChanges

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

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

DateElementProperties

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

การแสดง JSON 
{
  "timestamp": string,
  "timeZoneId": string,
  "locale": string,
  "dateFormat": enum (DateFormat),
  "timeFormat": enum (TimeFormat),
  "displayText": string
}
ช่อง
timestamp

string (Timestamp format)

จุดเวลาที่จะแสดงในหน่วยวินาทีและนาโนวินาทีตั้งแต่ Unix Epoch ซึ่งก็คือวันที่ 1 มกราคม 1970 เวลาเที่ยงคืน UTC

การประทับเวลาควรอยู่ในรูปแบบ UTC หากตั้งค่า timeZoneId ระบบจะปรับการประทับเวลาตามเขตเวลา เช่น การประทับเวลา 18000 ที่มีรูปแบบวันที่เป็น DATE_FORMAT_ISO8601 และรูปแบบเวลาเป็น TIME_FORMAT_HOUR_MINUTE จะแสดงเป็น 1970-01-01 5:00 AM การประทับเวลา 18000 ที่มีรูปแบบวันที่เป็น DATE_FORMAT_ISO8601 รูปแบบเวลาเป็น TIME_FORMAT_HOUR_MINUTE และเขตเวลาที่ตั้งเป็น America/New_York จะเปลี่ยนเป็น 1970-01-01 12:00 AM แทน
timeZoneId

string

เขตเวลาของ DateElement ตามที่กำหนดโดยโปรเจ็กต์ Unicode Common Locale Data Repository (CLDR) เช่น America/New_York หากไม่ได้ตั้งค่าไว้ เขตเวลาเริ่มต้นจะเป็น etc/UTC
locale

string

รหัสภาษาของ DateElement เช่น en หากไม่ได้ตั้งค่าไว้ ภาษาเริ่มต้นจะเป็น en

จำกัดเฉพาะภาษาต่อไปนี้ af, am, ar, as, az, be, bg, bn, ca, cs, da, de, el, en, en-CA, en-GB, es, es-419, et, eu, fa, fi, fil, fr, fr-CA, gl, gu, hi, hr, hu, hy, id, is, it, iw, ja, ka, kk, km, kn, ko, lo, lt, lv, mk, ml, mn, mr, ms, ne, nl, no, or, pa, pl, pt-BR, pt-PT, ro, ru, si, sk, sl, sq, sr, sv, sw, ta, te, th, tr, uk, ur, uz, vi, zh-CN, zh-HK, zh-TW, zu, cy, my
dateFormat

enum (DateFormat)

กำหนดวิธีแสดงส่วนวันที่ของ DateElement ในเอกสาร

หากไม่ได้ตั้งค่า ค่าเริ่มต้นคือ DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED ซึ่งระบุว่าระบบจะจัดรูปแบบ DateElement เป็น MMM d, y ใน en หรือเทียบเท่ากับภาษาที่เฉพาะเจาะจง
timeFormat

enum (TimeFormat)

กำหนดวิธีแสดงส่วนเวลาของ DateElement ในเอกสาร

หากไม่ได้ตั้งค่า ค่าเริ่มต้นจะเป็น TIME_FORMAT_DISABLED ซึ่งหมายความว่าไม่ควรแสดงเวลา
displayText

string

เอาต์พุตเท่านั้น ระบุวิธีแสดง DateElement ในเอกสาร

DateFormat

รูปแบบวันที่ที่เป็นไปได้ของ DateElement

Enum
DATE_FORMAT_UNSPECIFIED ไม่ได้ระบุรูปแบบวันที่
DATE_FORMAT_CUSTOM เอาต์พุตเท่านั้น ระบบจะนำเข้ารูปแบบวันที่จากแหล่งที่มาภายนอก
DATE_FORMAT_MONTH_DAY_ABBREVIATED รูปแบบวันที่คือเดือนแบบย่อตามด้วยวัน เช่น "1 ม.ค."
DATE_FORMAT_MONTH_DAY_FULL รูปแบบวันที่คือเดือนตามด้วยวัน เช่น "01 มกราคม"
DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED รูปแบบวันที่คือเดือนแบบย่อ ตามด้วยวันและปี เช่น "1 ม.ค. 1970"
DATE_FORMAT_ISO8601 รูปแบบวันที่อยู่ในรูปแบบ ISO 8601 เช่น "1970-01-01"

TimeFormat

รูปแบบเวลาที่เป็นไปได้ของ DateElement

Enum
TIME_FORMAT_UNSPECIFIED ไม่ได้ระบุรูปแบบเวลา
TIME_FORMAT_DISABLED ระบุว่าวันที่ไม่มีเวลา
TIME_FORMAT_HOUR_MINUTE รูปแบบเวลาจะแสดงชั่วโมงและนาที เช่น "1 ม.ค. 1970 12:00 น."
TIME_FORMAT_HOUR_MINUTE_TIMEZONE รูปแบบเวลาจะแสดงชั่วโมง นาที และเขตเวลา เช่น "1 ม.ค. 1970 12:00 น. UTC"

SuggestedDateElementProperties

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

การแสดง JSON 
{
  "dateElementProperties": {
    object (DateElementProperties)
  },
  "dateElementPropertiesSuggestionState": {
    object (DateElementPropertiesSuggestionState)
  }
}
ช่อง
dateElementProperties

object (DateElementProperties)

DateElementProperties ซึ่งรวมเฉพาะการเปลี่ยนแปลงที่ทำในคำแนะนำนี้ คุณใช้พารามิเตอร์นี้ร่วมกับ dateElementPropertiesSuggestionState เพื่อดูว่าฟิลด์ใดมีการเปลี่ยนแปลงและมีค่าใหม่เป็นอะไร
dateElementPropertiesSuggestionState

object (DateElementPropertiesSuggestionState)

มาสก์ที่ระบุว่าฟิลด์ใดในฐาน DateElementProperties มีการเปลี่ยนแปลงในคำแนะนำนี้

DateElementPropertiesSuggestionState

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

การแสดง JSON 
{
  "timestampSuggested": boolean,
  "timeZoneIdSuggested": boolean,
  "localeSuggested": boolean,
  "dateFormatSuggested": boolean,
  "timeFormatSuggested": boolean
}
ช่อง
timestampSuggested

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

ParagraphStyle

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

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

  • ParagraphStyle ใน Paragraph จะรับค่ามาจาก named style type ที่เกี่ยวข้องของย่อหน้า
  • named styleใน normal text จะรับค่ามาจาก ParagraphStyle
  • ParagraphStyle ของnormal textรูปแบบที่มีชื่อจะรับค่ามาจากรูปแบบย่อหน้าเริ่มต้นในโปรแกรมแก้ไขเอกสาร
  • 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 Bad Request

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.49 ของ "รูปแบบไฟล์ Office Open XML - ข้อมูลพื้นฐานและการอ้างอิงภาษา Markup" ส่วนที่ 1 ของ ECMA-376 ฉบับที่ 5

Enum
DASH_STYLE_UNSPECIFIED รูปแบบเส้นประที่ไม่ได้ระบุ
SOLID เส้นทึบ สอดคล้องกับค่า ECMA-376 ST_PresetLineDashVal "solid" นี่คือรูปแบบเส้นประเริ่มต้น
DOT เส้นประ สอดคล้องกับค่า ECMA-376 ST_PresetLineDashVal 'dot'
DASH เส้นประ สอดคล้องกับค่า ECMA-376 ST_PresetLineDashVal "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 คำขอไม่ถูกต้อง
columnSeparatorStyle

enum (ColumnSeparatorStyle)

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

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

เมื่ออัปเดตพร็อพเพอร์ตี้นี้ คุณต้องตั้งค่าที่เฉพาะเจาะจง การยกเลิกการตั้งค่าพร็อพเพอร์ตี้นี้จะทำให้เกิดข้อผิดพลาด 400 คำขอไม่ถูกต้อง
contentDirection

enum (ContentDirection)

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

เมื่ออัปเดตพร็อพเพอร์ตี้นี้ คุณต้องตั้งค่าที่เฉพาะเจาะจง การยกเลิกการตั้งค่าพร็อพเพอร์ตี้นี้จะทำให้เกิดข้อผิดพลาด 400 คำขอไม่ถูกต้อง
marginTop

object (Dimension)

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

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้

เมื่ออัปเดตพร็อพเพอร์ตี้นี้ คุณต้องตั้งค่าที่เฉพาะเจาะจง การยกเลิกการตั้งค่าพร็อพเพอร์ตี้นี้จะทำให้เกิดข้อผิดพลาด 400 คำขอไม่ถูกต้อง
marginBottom

object (Dimension)

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

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้

เมื่ออัปเดตพร็อพเพอร์ตี้นี้ คุณต้องตั้งค่าที่เฉพาะเจาะจง การยกเลิกการตั้งค่าพร็อพเพอร์ตี้นี้จะทำให้เกิดข้อผิดพลาด 400 คำขอไม่ถูกต้อง
marginRight

object (Dimension)

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

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้

เมื่ออัปเดตพร็อพเพอร์ตี้นี้ คุณต้องตั้งค่าที่เฉพาะเจาะจง การยกเลิกการตั้งค่าพร็อพเพอร์ตี้นี้จะทำให้เกิดข้อผิดพลาด 400 คำขอไม่ถูกต้อง
marginLeft

object (Dimension)

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

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้

เมื่ออัปเดตพร็อพเพอร์ตี้นี้ คุณต้องตั้งค่าที่เฉพาะเจาะจง การยกเลิกการตั้งค่าพร็อพเพอร์ตี้นี้จะทำให้เกิดข้อผิดพลาด 400 คำขอไม่ถูกต้อง
marginHeader

object (Dimension)

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

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้

เมื่ออัปเดตพร็อพเพอร์ตี้นี้ คุณต้องตั้งค่าที่เฉพาะเจาะจง การยกเลิกการตั้งค่าพร็อพเพอร์ตี้นี้จะทำให้เกิดข้อผิดพลาด 400 คำขอไม่ถูกต้อง
sectionType

enum (SectionType)

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

string

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

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้

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

string

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

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้

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

string

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

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้

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

string

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

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้

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

string

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

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้

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

boolean

ระบุว่าจะใช้รหัสส่วนหัว / ส่วนท้ายของหน้าแรกสําหรับหน้าแรกของส่วนหรือไม่ หากไม่ได้ตั้งค่าไว้ ระบบจะรับค่าจาก useFirstPageHeaderFooter ของ DocumentStyle สำหรับส่วนแรก หากไม่ได้ตั้งค่าสำหรับภาคส่วนที่ตามมา ควรตีความว่าเป็นเท็จ

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้

เมื่ออัปเดตพร็อพเพอร์ตี้นี้ คุณต้องตั้งค่าที่เฉพาะเจาะจง การยกเลิกการตั้งค่าพร็อพเพอร์ตี้นี้จะทำให้เกิดข้อผิดพลาด 400 คำขอไม่ถูกต้อง
pageNumberStart

integer

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

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้

เมื่ออัปเดตพร็อพเพอร์ตี้นี้ คุณต้องตั้งค่าที่เฉพาะเจาะจง การยกเลิกการตั้งค่าพร็อพเพอร์ตี้นี้จะทำให้เกิดข้อผิดพลาด 400 คำขอไม่ถูกต้อง
flipPageOrientation

boolean

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

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้

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

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.60 ของ "Office Open XML File Formats - Fundamentals and Markup Language Reference" ส่วนที่ 1 ของ ECMA-376 ฉบับที่ 5

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,
  "documentFormat": {
    object (DocumentFormat)
  }
}
ช่อง
background

object (Background)

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

string

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

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้

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

string

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

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้

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

string

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

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้

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

string

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

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้

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

string

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

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้

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

boolean

ระบุว่าจะใช้รหัสส่วนหัว / ส่วนท้ายของหน้าแรกสําหรับหน้าแรกหรือไม่

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้
useEvenPageHeaderFooter

boolean

ระบุว่าจะใช้รหัสส่วนหัว / ส่วนท้ายของหน้าคู่กับหน้าคู่หรือไม่

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้
pageNumberStart

integer

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

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้
marginTop

object (Dimension)

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

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

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้
marginBottom

object (Dimension)

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

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

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้
marginRight

object (Dimension)

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

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

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้
marginLeft

object (Dimension)

ขอบหน้าด้านซ้าย

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

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้
pageSize

object (Size)

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

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้
marginHeader

object (Dimension)

ปริมาณพื้นที่ระหว่างด้านบนของหน้ากับเนื้อหาส่วนหัว

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้
flipPageOrientation

boolean

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

หาก [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] เป็น PAGELESS ระบบจะไม่แสดงพร็อพเพอร์ตี้นี้
documentFormat

object (DocumentFormat)

ระบุการตั้งค่ารูปแบบระดับเอกสาร เช่น โหมดเอกสาร (แบ่งหน้าเทียบกับไม่แบ่งหน้า)

ฉากหลัง

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

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

object (OptionalColor)

สีพื้นหลัง

ขนาด

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

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

object (Dimension)

ความสูงของออบเจ็กต์
width

object (Dimension)

ความกว้างของออบเจ็กต์

DocumentFormat

แสดงการตั้งค่ารูปแบบระดับเอกสาร

การแสดง JSON 
{
  "documentMode": enum (DocumentMode)
}
ช่อง
documentMode

enum (DocumentMode)

เอกสารแบ่งหน้าหรือไม่แบ่งหน้า

DocumentMode

เอกสารแบ่งหน้าหรือไม่แบ่งหน้า

Enum
DOCUMENT_MODE_UNSPECIFIED ไม่ได้ระบุโหมดเอกสาร
PAGES เอกสารมีหน้า
PAGELESS เอกสารไม่แบ่งหน้า

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 หรือไม่
evenPageFooterIdSuggested

boolean

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

boolean

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

boolean

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

boolean

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

boolean

ระบุว่ามีการเปลี่ยนแปลงที่แนะนำสำหรับ useEvenPageHeaderFooter หรือไม่
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,

  "glyphType": enum (GlyphType),
  "glyphSymbol": string
}
ช่อง
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.

สำหรับระดับการซ้อนที่เรียงตามลำดับ สตริงที่แทนที่ตัวยึดตำแหน่งในรูปแบบ Glyph สำหรับย่อหน้าหนึ่งๆ จะขึ้นอยู่กับลำดับของย่อหน้าภายในรายการ
indentFirstLine

object (Dimension)

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

object (Dimension)

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

object (TextStyle)

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

integer

หมายเลขของรายการแรกในระดับการซ้อนนี้

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

ระบบจะไม่สนใจค่านี้สำหรับระดับการซ้อนที่มีกลีฟที่ไม่ได้เรียงลำดับ
ประเภทสัญลักษณ์ที่ใช้กับหัวข้อย่อย ซึ่งกำหนดสัญลักษณ์หัวข้อย่อยที่จะแทนที่ตัวยึดตำแหน่งใน glyph_format ต่อไปนี้คือรายการฟิลด์ที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าฟิลด์อย่างน้อย 1 รายการในการตอบกลับ
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)
  },

  "embeddedDrawingProperties": {
    object (EmbeddedDrawingProperties)
  },
  "imageProperties": {
    object (ImageProperties)
  }
}
ช่อง
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 ชีตต้นฉบับเมื่อออบเจ็กต์ที่ฝังเป็นแผนภูมิที่ลิงก์

หากไม่ได้ตั้งค่า ระบบจะไม่ลิงก์ออบเจ็กต์ที่ฝัง
พร็อพเพอร์ตี้ที่เฉพาะเจาะจงสำหรับออบเจ็กต์ที่ฝังแต่ละประเภท ต่อไปนี้คือรายการฟิลด์ที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าฟิลด์อย่างน้อย 1 รายการในการตอบกลับ
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 หากสถานะของพร็อพเพอร์ตี้เป็น RENDERED แสดงว่าองค์ประกอบมีพร็อพเพอร์ตี้ที่เกี่ยวข้องเมื่อแสดงในเอกสาร นี่คือค่าเริ่มต้น
NOT_RENDERED หากสถานะของพร็อพเพอร์ตี้เป็น NOT_RENDERED แสดงว่าองค์ประกอบไม่มีพร็อพเพอร์ตี้ที่สอดคล้องกันเมื่อแสดงในเอกสาร

LinkedContentReference

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

การแสดง JSON 
{

  "sheetsChartReference": {
    object (SheetsChartReference)
  }
}
ช่อง
ข้อมูลอ้างอิงที่เฉพาะเจาะจงกับประเภทของเนื้อหาที่ลิงก์ ต่อไปนี้คือรายการฟิลด์ที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าฟิลด์อย่างน้อย 1 รายการในการตอบกลับ
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 หรือไม่

CommentAnchor

สถานที่อย่างน้อย 1 แห่งในเอกสารที่เชื่อมโยงกับ CommentThreads ที่มี anchorId เดียวกัน หมายเหตุ: Anchor หลายรายการอาจอ้างอิงถึงตำแหน่งเดียวกัน

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

string

รหัสของจุดยึดความคิดเห็น
ranges[]

object (Range)

ชุดของ Range ในเอกสารที่เชื่อมโยงกับ Anchor นี้

SuggestionsViewMode

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

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

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

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

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

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

CommentsViewMode

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

หากตั้งค่า commentsViewMode เป็นค่าใดก็ตาม คุณต้องตั้งค่า includeTabsContent เป็น true หรือใช้ FieldMask ที่อ้างอิงฟิลด์ Document.tabs (หรือฟิลด์ย่อยใดก็ได้)

ระบบจะส่งคืนความคิดเห็นได้ก็ต่อเมื่อส่งคืนคำแนะนำในบรรทัด หากตั้งค่า commentsViewMode เป็น COMMENTS_VIEW_MODE_INCLUDED หรือ COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS คุณจะตั้งค่า suggestionsViewMode เป็น PREVIEW_WITHOUT_SUGGESTIONS หรือ PREVIEW_SUGGESTIONS_ACCEPTED ได้เท่านั้น

Enum
COMMENTS_VIEW_MODE_UNSPECIFIED ไม่ได้ระบุ CommentsViewMode ระบบจะใช้คุณภาพระดับ COMMENTS_VIEW_MODE_OMITTED
COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS CommentsViewMode ที่ใช้กับเอกสารที่แสดงจะขึ้นอยู่กับระดับการเข้าถึงปัจจุบันของผู้ใช้ หากผู้ใช้มีสิทธิ์ดูอย่างเดียว ระบบจะใช้ COMMENTS_VIEW_MODE_OMITTED ไม่เช่นนั้น ระบบจะใช้ COMMENTS_VIEW_MODE_INCLUDED
COMMENTS_VIEW_MODE_OMITTED เอกสารที่ส่งคืนจะไม่มีความคิดเห็น
COMMENTS_VIEW_MODE_INCLUDED

เอกสารที่ส่งคืนจะมีข้อความความคิดเห็นรวมอยู่ด้วย

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

เมื่อตั้งค่าแล้ว ต้องตั้งค่า suggestionsViewMode เป็น SUGGESTIONS_INLINE ด้วย ไม่เช่นนั้นจะแสดงข้อผิดพลาด 400 คำขอไม่ถูกต้อง

CommentThread

แสดงถึงชุดความคิดเห็นเดียว

การแสดง JSON 
{
  "commentId": string,
  "anchorId": string,
  "headPost": {
    object (Post)
  },
  "replies": [
    {
      object (Post)
    }
  ],
  "status": enum (Status),

  "plainTextQuote": string
}
ช่อง
commentId

string

รหัสที่ไม่ซ้ำกันของชุดความคิดเห็น
anchorId

string

รหัสของ CommentAnchor ในเอกสารที่เชื่อมโยงกับเธรดนี้ เธรดความคิดเห็นหลายรายการอาจเชื่อมโยงกับ CommentAnchor เดียวกัน
headPost

object (Post)

โพสต์แรกในชุดข้อความ
replies[]

object (Post)

การตอบกลับโพสต์หลัก
status

enum (Status)

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

string

ข้อความที่ยกมาในเอกสารเมื่อสร้างความคิดเห็น โดยจัดรูปแบบเป็นข้อความธรรมดา
สิ้นสุดฟิลด์ที่แยกกัน

โพสต์

แสดงโพสต์เดียวในชุดข้อความความคิดเห็นหรือคำแนะนำ

การแสดง JSON 
{
  "postId": string,
  "content": string,
  "contentHtml": string,
  "author": {
    object (PostAuthor)
  },
  "createTime": string,
  "updateTime": string,
  "deleted": boolean,
  "fromImportedDocument": boolean,
  "fromCopiedDocument": boolean,
  "fromDocumentComparison": boolean,
  "assigneeEmail": string,

  "commentAction": enum (CommentActionType),
  "suggestionAction": enum (SuggestionActionType)
}
ช่อง
postId

string

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

string

เนื้อหาของโพสต์

ต้องไม่ว่างเปล่าหาก commentAction ไม่ใช่ RESOLVE หรือ REOPEN

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

ต้องยาวไม่เกิน 2048 หน่วยรหัส UTF-8
contentHtml

string

เอาต์พุตเท่านั้น เนื้อหาของโพสต์เป็น HTML
author

object (PostAuthor)

เอาต์พุตเท่านั้น ผู้ใช้ที่สร้างโพสต์
createTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่สร้างโพสต์
updateTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่อัปเดตโพสต์ครั้งล่าสุด
deleted

boolean

เอาต์พุตเท่านั้น มีการลบโพสต์หรือไม่ หากฟิลด์ true, content และ author จะว่างเปล่า
fromImportedDocument

boolean

เอาต์พุตเท่านั้น โพสต์มาจากเอกสารที่นำเข้าหรือไม่ ผู้โทรตั้งค่าฟิลด์นี้โดยตรงไม่ได้
fromCopiedDocument

boolean

เอาต์พุตเท่านั้น โพสต์มาจากเอกสารที่คัดลอกหรือไม่ ผู้โทรตั้งค่าฟิลด์นี้โดยตรงไม่ได้
fromDocumentComparison

boolean

เอาต์พุตเท่านั้น โพสต์มาจากการเปรียบเทียบเอกสารหรือไม่ ผู้โทรตั้งค่าฟิลด์นี้โดยตรงไม่ได้
assigneeEmail

string

ไม่บังคับ อีเมลของผู้ใช้ที่ได้รับมอบหมายให้เข้าร่วมเธรดใหม่เป็นส่วนหนึ่งของโพสต์นี้

แสดงข้อผิดพลาด 400 คำขอไม่ถูกต้องในกรณีต่อไปนี้

  • เธรดหลักคือ CommentThread ที่ headPost ไม่มีผู้รับมอบหมาย

  • เธรดหลักคือ SuggestionThread

  • commentAction ระบุเป็น RESOLVE หรือ REOPEN

  • assigneeEmail เกิน 2048 หน่วยรหัส UTF-8
การดำเนินการที่ทำเป็นส่วนหนึ่งของการสร้างโพสต์ ต่อไปนี้คือรายการฟิลด์ที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าฟิลด์อย่างน้อย 1 รายการในการตอบกลับ
commentAction

enum (CommentActionType)

ไม่บังคับ ประเภทการดำเนินการสำหรับโพสต์ความคิดเห็น
suggestionAction

enum (SuggestionActionType)

เอาต์พุตเท่านั้น ประเภทการดำเนินการสำหรับโพสต์คำแนะนำ
สิ้นสุดฟิลด์ที่แยกกัน

PostAuthor

แสดงถึงผู้ใช้ที่เขียนความคิดเห็นหรือโพสต์คำแนะนำ

การแสดง JSON 
{
  "displayName": string,
  "me": boolean,
  "anonymous": boolean,
  "user": string
}
ช่อง
displayName

string

ชื่อที่แสดงของผู้ใช้ อาจไม่มีหากผู้เขียนไม่ประสงค์จะออกนาม
me

boolean

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

boolean

ดูว่าผู้ใช้ไม่ระบุตัวตนหรือไม่
user

string

ชื่อทรัพยากรของผู้ใช้ที่เป็นผู้เขียนโพสต์ ซึ่งใช้เพื่อระบุผู้ใช้ใน Google People API ได้ด้วย รูปแบบ: users/{user} จะไม่แสดงหากฟิลด์นิรนามเป็น true หรือหากโพสต์มาจากเอกสารที่นำเข้า

CommentActionType

การดำเนินการที่ทำกับการตอบกลับชุดความคิดเห็นนี้

Enum
COMMENT_ACTION_TYPE_UNSPECIFIED ค่าเริ่มต้น ค่านี้ไม่ได้ใช้
NO_COMMENT_ACTION_CHANGE ไม่มีการเปลี่ยนแปลงการดำเนินการในโพสต์นี้
RESOLVE โพสต์นี้จะปิดชุดข้อความ
REOPEN โพสต์นี้จะเปิดชุดข้อความอีกครั้ง

SuggestionActionType

การดำเนินการที่ทำกับการตอบกลับชุดข้อความคำแนะนำนี้

Enum
SUGGESTION_ACTION_TYPE_UNSPECIFIED ค่าเริ่มต้น ค่านี้ไม่ได้ใช้
NO_SUGGESTION_ACTION_CHANGE ไม่มีการเปลี่ยนแปลงการดำเนินการในโพสต์นี้
ACCEPT โพสต์นี้ยอมรับคำแนะนำ
REJECT โพสต์นี้ปฏิเสธคำแนะนำ

สถานะ

ตัวเลือกสถานะของชุดข้อความความคิดเห็น

Enum
STATUS_UNSPECIFIED ค่าเริ่มต้น ค่านี้ไม่ได้ใช้
OPEN ชุดข้อความความคิดเห็นเปิดอยู่
RESOLVED ชุดความคิดเห็นได้รับการแก้ไขแล้ว

SuggestionThread

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

การแสดง JSON 
{
  "suggestionId": string,
  "headPost": {
    object (Post)
  },
  "replies": [
    {
      object (Post)
    }
  ],
  "status": enum (Status),
  "summaryText": string,
  "summaryHtml": string
}
ช่อง
suggestionId

string

รหัสที่ไม่ซ้ำกันของคำแนะนำ
headPost

object (Post)

โพสต์แรกในชุดข้อความ
replies[]

object (Post)

การตอบกลับโพสต์หลัก
status

enum (Status)

ชุดข้อความเปิด ยอมรับ หรือปฏิเสธ
summaryText

string

สรุปความแตกต่างที่แนะนำในเอกสารในรูปแบบข้อความธรรมดา อาจว่างเปล่า
summaryHtml

string

สรุปความแตกต่างที่แนะนำในเอกสารในรูปแบบ HTML อาจว่างเปล่า

สถานะ

ตัวเลือกสถานะของเธรดคำแนะนำ

Enum
STATUS_UNSPECIFIED ค่าเริ่มต้น ค่านี้ไม่ได้ใช้
OPEN ชุดข้อความคำแนะนำเปิดอยู่
ACCEPTED ยอมรับเธรดคำแนะนำแล้ว
REJECTED ชุดข้อความคำแนะนำถูกปฏิเสธ

เมธอด

batchUpdate

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

create

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

get

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