REST Resource: documents

リソース: Document

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

出力専用。ドキュメントの ID。
title

string

ドキュメントのタイトル。
tabs[]

object (Tab)

出力専用。ドキュメントの一部であるタブ。

タブには子タブ（別のタブ内にネストされたタブ）を含めることができます。子タブは Tab.childTabs フィールドで表されます。
revisionId

string

出力専用。ドキュメントのリビジョン ID。更新リクエストで使用して、ドキュメントのどのリビジョンに更新を適用するかを指定できます。また、そのリビジョン以降にドキュメントが編集された場合にリクエストがどのように動作するかを指定できます。ユーザーがドキュメントの編集権限を持っている場合にのみ入力されます。

リビジョン ID は連番ではなく、不透明な文字列です。リビジョン ID の形式は今後変更される可能性があります。返されたリビジョン ID は、返されてから 24 時間のみ有効であることが保証されており、ユーザー間で共有することはできません。呼び出し間でリビジョン ID が変更されていない場合、ドキュメントは変更されていません。逆に、同じドキュメントとユーザーで ID が変更された場合は、通常、ドキュメントが更新されたことを意味します。ただし、ID の変更は、ID 形式の変更などの内部要因による場合もあります。
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))

出力専用。ドキュメント内のヘッダー。ヘッダー ID でキー設定されます。

以前のフィールド: 代わりに Document.tabs.documentTab.headers を使用します。includeTabsContent パラメータが true に設定されている場合、すべてのタブの実際のドキュメント コンテンツが公開されます。false または未設定の場合、このフィールドにはドキュメントの最初のタブに関する情報が含まれます。
footers

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

出力専用。ドキュメントのフッター。フッター ID でキー設定されます。

以前のフィールド: 代わりに Document.tabs.documentTab.footers を使用します。includeTabsContent パラメータが true に設定されている場合、すべてのタブの実際のドキュメント コンテンツが公開されます。false または未設定の場合、このフィールドにはドキュメントの最初のタブに関する情報が含まれます。
footnotes

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

出力専用。ドキュメント内の脚注。脚注 ID をキーとして使用します。

以前のフィールド: 代わりに Document.tabs.documentTab.footnotes を使用します。includeTabsContent パラメータが true に設定されている場合、すべてのタブの実際のドキュメント コンテンツが公開されます。false または未設定の場合、このフィールドにはドキュメントの最初のタブに関する情報が含まれます。
documentStyle

object (DocumentStyle)

出力専用。ドキュメントのスタイル。

以前のフィールド: 代わりに Document.tabs.documentTab.documentStyle を使用します。includeTabsContent パラメータが true に設定されている場合、すべてのタブの実際のドキュメント コンテンツが公開されます。false または未設定の場合、このフィールドにはドキュメントの最初のタブに関する情報が含まれます。
suggestedDocumentStyleChanges

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

出力専用。提案 ID をキーとする、ドキュメントのスタイルの変更案。

以前のフィールド: 代わりに Document.tabs.documentTab.suggestedDocumentStyleChanges を使用します。includeTabsContent パラメータが true に設定されている場合、すべてのタブの実際のドキュメント コンテンツが公開されます。false または未設定の場合、このフィールドにはドキュメントの最初のタブに関する情報が含まれます。
namedStyles

object (NamedStyles)

出力専用。ドキュメントの名前付きスタイル。

以前のフィールド: 代わりに Document.tabs.documentTab.namedStyles を使用します。includeTabsContent パラメータが true に設定されている場合、すべてのタブの実際のドキュメント コンテンツが公開されます。false または未設定の場合、このフィールドにはドキュメントの最初のタブに関する情報が含まれます。
suggestedNamedStylesChanges

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

出力専用。提案 ID をキーとする、ドキュメントの命名済みスタイルに対する提案された変更。

以前のフィールド: 代わりに Document.tabs.documentTab.suggestedNamedStylesChanges を使用します。includeTabsContent パラメータが true に設定されている場合、すべてのタブの実際のドキュメント コンテンツが公開されます。false または未設定の場合、このフィールドにはドキュメントの最初のタブに関する情報が含まれます。
lists

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

出力専用。ドキュメント内のリスト。リスト ID をキーとして使用します。

以前のフィールド: 代わりに 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))

出力専用。ドキュメント内のインライン オブジェクト。オブジェクト ID をキーとして使用します。

以前のフィールド: 代わりに Document.tabs.documentTab.inlineObjects を使用します。includeTabsContent パラメータが true に設定されている場合、すべてのタブの実際のドキュメント コンテンツが公開されます。false または未設定の場合、このフィールドにはドキュメントの最初のタブに関する情報が含まれます。
positionedObjects

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

出力専用。ドキュメント内の配置されたオブジェクト。オブジェクト ID をキーとして使用します。

以前のフィールド: 代わりに Document.tabs.documentTab.positionedObjects を使用します。includeTabsContent パラメータが true に設定されている場合、すべてのタブの実際のドキュメント コンテンツが公開されます。false または未設定の場合、このフィールドにはドキュメントの最初のタブに関する情報が含まれます。

Tab

ドキュメント内のタブ。

JSON 表現 
{
  "tabProperties": {
    object (TabProperties)
  },
  "childTabs": [
    {
      object (Tab)
    }
  ],

  "documentTab": {
    object (DocumentTab)
  }
}
フィールド
tabProperties

object (TabProperties)

タブのプロパティ（ID やタイトルなど）。
childTabs[]

object (Tab)

このタブ内にネストされた子タブ。
タブの内容。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
documentTab

object (DocumentTab)

テキストや画像などのドキュメント コンテンツを含むタブ。
相互に排他的なフィールドの終わり。

TabProperties

タブのプロパティ。

JSON 表現 
{
  "tabId": string,
  "title": string,
  "parentTabId": string,
  "index": integer,
  "nestingLevel": integer,
  "iconEmoji": string
}
フィールド
tabId

string

タブのイミュータブル ID。
title

string

ユーザーに表示されるタブの名前。
parentTabId

string

省略可。親タブの ID。現在のタブがルートレベルのタブ（親がないタブ）の場合、空になります。
index

integer

親内のタブのゼロベースのインデックス。
nestingLevel

integer

出力専用。ドキュメント内のタブの深さ。ルートレベルのタブは 0 から始まります。
iconEmoji

string

省略可。タブに表示される絵文字アイコン。有効な絵文字アイコンは、空でない Unicode 文字列で表されます。1 つの絵文字を表さない文字セットは無効です。

絵文字が無効な場合は、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))

ドキュメント タブのヘッダー。ヘッダー ID でキー設定されます。
footers

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

ドキュメント タブのフッター。フッター ID でキー設定されます。
footnotes

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

ドキュメント タブの脚注。脚注 ID でキー設定されます。
documentStyle

object (DocumentStyle)

ドキュメント タブのスタイル。
suggestedDocumentStyleChanges

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

ドキュメント タブのスタイルの変更案。提案 ID をキーとしています。
namedStyles

object (NamedStyles)

ドキュメント タブの名前付きスタイル。
suggestedNamedStylesChanges

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

提案されたドキュメント タブのスタイル名に対する変更。提案 ID でキー設定されます。
lists

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

ドキュメント タブのリスト。リスト ID をキーとして使用します。
namedRanges

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

ドキュメント タブの名前付き範囲。名前でキー設定されます。
inlineObjects

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

ドキュメント タブのインライン オブジェクト。オブジェクト ID をキーとして使用します。
positionedObjects

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

ドキュメント タブ内の配置されたオブジェクト。オブジェクト ID をキーとして使用します。
commentAnchors

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

ドキュメント タブのコメント アンカー。アンカー ID でキー設定されます。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))

提案された段落スタイルが、提案 ID をキーとしてこの段落に変更されます。
bullet

object (Bullet)

この段落の箇条書き。存在しない場合、段落はリストに属しません。
suggestedBulletChanges

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

この段落の箇条書きに対する提案された変更。
positionedObjectIds[]

string

この段落に固定されている配置済みオブジェクトの ID。
suggestedPositionedObjectIds

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

この段落に添付することが推奨される位置指定オブジェクトの ID。提案 ID をキーとして指定します。

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

提案された挿入 ID。TextRun がネストされた提案された変更である場合、複数の挿入 ID を持つことがあります。空の場合、これは挿入候補ではありません。
suggestedDeletionIds[]

string

削除候補の ID。空の場合、このコンテンツの削除候補はありません。
textStyle

object (TextStyle)

この実行のテキスト スタイル。
suggestedTextStyleChanges

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

提案されたテキスト スタイルがこの実行に変更され、提案 ID でキー設定されます。

TextStyle

テキストに適用できるスタイル設定を表します。

継承されたテキスト スタイルは、このメッセージでは未設定のフィールドとして表されます。テキスト スタイルの親は、テキスト スタイルが定義されている場所によって異なります。

  • Paragraph のテキストの TextStyle は、段落の対応する named style type から継承されます。
  • named style の TextStyle は normal text という名前のスタイルから継承されます。
  • normal text という名前のスタイルの TextStyle は、ドキュメント エディタのデフォルトのテキスト スタイルから継承されます。
  • テーブルに含まれる Paragraph 要素の TextStyle は、テーブル スタイルからテキスト スタイルを継承する場合があります。

テキスト スタイルが親から継承されていない場合、フィールドの設定を解除すると、スタイルはドキュメント エディタのデフォルト値と一致する値に戻ります。

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)

テキストの背景色。設定されている場合、色は color フィールドに応じて RGB カラーまたは透明になります。
foregroundColor

object (OptionalColor)

テキストの前景色。設定されている場合、色は color フィールドに応じて RGB カラーまたは透明になります。
fontSize

object (Dimension)

テキストのフォントサイズ。
weightedFontFamily

object (WeightedFontFamily)

テキストのフォント ファミリーとレンダリングされた太さ。

更新リクエストで weightedFontFamily と bold の両方の値が指定されている場合、最初に weightedFontFamily が適用され、次に bold が適用されます。

weightedFontFamily#weight が設定されていない場合、デフォルトは 400 です。

weightedFontFamily が設定されている場合、weightedFontFamily#fontFamily も空でない値で設定する必要があります。それ以外の場合は、400 不正なリクエスト エラーが返されます。
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)

大きさの単位。

単位

測定単位 を選択します。

列挙型
UNIT_UNSPECIFIED 単位は不明です。
PT ポイント。1/72 インチ。

WeightedFontFamily

テキストのフォント ファミリーと太さを表します。

JSON 表現 
{
  "fontFamily": string,
  "weight": integer
}
フィールド
fontFamily

string

テキストのフォント ファミリー。

フォント ファミリーには、ドキュメントの [フォント] メニューまたは Google Fonts の任意のフォントを指定できます。フォント名が認識されない場合、テキストは Arial でレンダリングされます。
weight

integer

フォントの太さ。このフィールドには、100～900 の範囲で 100 の倍数となる任意の値を指定できます。この範囲は、CSS 2.1 仕様のセクション 15.6 で説明されている数値に対応しており、数値以外の値は許可されません。

デフォルト値は 400（「normal」）です。

フォントの太さは、レンダリングされたフォントの太さの 1 つのコンポーネントにすぎません。weight とテキスト スタイルの解決された bold 値の組み合わせによって、継承を考慮したレンダリングされる太さが決まります。

  • テキストが太字で、重みが 400 より小さい場合、レンダリングされる重みは 400 になります。
  • テキストが太字で、重みが 400 以上 700 未満の場合、レンダリングされる重みは 700 になります。
  • 重みが 700 以上の場合、レンダリングされる重みは重みと同じになります。
  • テキストが太字でない場合、レンダリングされた重みは重みと同じになります。

BaselineOffset

テキストを通常の位置から垂直方向にオフセットする方法。

列挙型
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 のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。

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

提案された挿入 ID。AutoText がネストされた提案された変更である場合、複数の挿入 ID を持つことがあります。空の場合、これは挿入候補ではありません。
suggestedDeletionIds[]

string

削除候補の ID。空の場合、このコンテンツの削除候補はありません。
textStyle

object (TextStyle)

この自動テキストのテキスト スタイル。
suggestedTextStyleChanges

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

候補のテキスト スタイルが、候補 ID をキーとするこの自動テキストに変更されます。

タイプ

自動テキストの種類。

列挙型
TYPE_UNSPECIFIED 自動テキストのタイプが指定されていません。
PAGE_NUMBER 現在のページ番号を表す自動テキストのタイプ。
PAGE_COUNT ドキュメントの総ページ数を表す自動テキストの型。

PageBreak

改ページを表す ParagraphElement。改ページを挿入すると、次のページの先頭からテキストが始まります。

JSON 表現 
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
フィールド
suggestedInsertionIds[]

string

提案された挿入 ID。PageBreak がネストされた提案された変更である場合、複数の挿入 ID を持つことがあります。空の場合、これは挿入候補ではありません。
suggestedDeletionIds[]

string

削除候補の ID。空の場合、このコンテンツの削除候補はありません。
textStyle

object (TextStyle)

この PageBreak のテキスト スタイル。

テキスト コンテンツ（テキスト実行や脚注参照など）と同様に、改ページのテキスト スタイルは、コンテンツのレイアウトと、その横に挿入されたテキストのスタイル設定に影響する可能性があります。
suggestedTextStyleChanges

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

提案されたテキスト スタイルがこの PageBreak に変更され、提案 ID でキー設定されます。

ColumnBreak

列区切りを表す ParagraphElement。列区切りを使用すると、後続のテキストが次の列の上部から開始されます。

JSON 表現 
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
フィールド
suggestedInsertionIds[]

string

提案された挿入 ID。ColumnBreak がネストされた提案された変更である場合、複数の挿入 ID を持つことがあります。空の場合、これは挿入候補ではありません。
suggestedDeletionIds[]

string

削除候補の ID。空の場合、このコンテンツの削除候補はありません。
textStyle

object (TextStyle)

この ColumnBreak のテキスト スタイル。

テキスト コンテンツ（テキスト実行や脚注参照など）と同様に、段区切りのテキスト スタイルは、コンテンツ レイアウトと、その横に挿入されたテキストのスタイル設定に影響を与える可能性があります。
suggestedTextStyleChanges

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

候補のテキスト スタイルがこの ColumnBreak に変更され、候補 ID でキー設定されます。

FootnoteReference

脚注参照を表す ParagraphElement。脚注参照は、番号付きでレンダリングされるインライン コンテンツで、脚注を識別するために使用されます。

JSON 表現 
{
  "footnoteId": string,
  "footnoteNumber": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
フィールド
footnoteId

string

この脚注参照の内容を含む footnote の ID。
footnoteNumber

string

この脚注のレンダリングされた番号。
suggestedInsertionIds[]

string

提案された挿入 ID。FootnoteReference がネストされた提案された変更である場合、複数の挿入 ID を持つことがあります。空の場合、これは挿入候補ではありません。
suggestedDeletionIds[]

string

削除候補の ID。空の場合、このコンテンツの削除候補はありません。
textStyle

object (TextStyle)

この FootnoteReference のテキスト スタイル。
suggestedTextStyleChanges

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

提案されたテキスト スタイルが、提案 ID をキーとするこの FootnoteReference に変更されます。

HorizontalRule

水平線を表す ParagraphElement。

JSON 表現 
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
フィールド
suggestedInsertionIds[]

string

提案された挿入 ID。HorizontalRule がネストされた提案された変更である場合、複数の挿入 ID を持つことがあります。空の場合、これは挿入候補ではありません。
suggestedDeletionIds[]

string

削除候補の ID。空の場合、このコンテンツの削除候補はありません。
textStyle

object (TextStyle)

この HorizontalRule のテキスト スタイル。

テキスト ランや脚注参照などのテキスト コンテンツと同様に、水平ルールのテキスト スタイルは、コンテンツ レイアウトだけでなく、その横に挿入されたテキストのスタイルにも影響します。
suggestedTextStyleChanges

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

提案されたテキスト スタイルが、提案 ID をキーとするこの HorizontalRule に変更されます。

計算式

方程式を表す ParagraphElement。

JSON 表現 
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}
フィールド
suggestedInsertionIds[]

string

提案された挿入 ID。Equation がネストされた提案された変更である場合、複数の挿入 ID を持つことがあります。空の場合、これは挿入候補ではありません。
suggestedDeletionIds[]

string

削除候補の ID。空の場合、このコンテンツの削除候補はありません。

InlineObjectElement

InlineObject を含む ParagraphElement。

JSON 表現 
{
  "inlineObjectId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
フィールド
inlineObjectId

string

この要素に含まれる InlineObject の ID。
suggestedInsertionIds[]

string

提案された挿入 ID。InlineObjectElement がネストされた提案された変更である場合、複数の挿入 ID を持つことがあります。空の場合、これは挿入候補ではありません。
suggestedDeletionIds[]

string

削除候補の ID。空の場合、このコンテンツの削除候補はありません。
textStyle

object (TextStyle)

この InlineObjectElement のテキスト スタイル。

テキスト コンテンツ（テキスト実行や脚注参照など）と同様に、インライン オブジェクト要素のテキスト スタイルは、コンテンツ レイアウトと、その横に挿入されたテキストのスタイル設定に影響を与える可能性があります。
suggestedTextStyleChanges

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

提案されたテキスト スタイルが、提案 ID をキーとするこの InlineObject に変更されます。

人物

ドキュメント内で言及されている人物またはメールアドレス。これらのメンションは、ユーザーの名前またはメールアドレスを含む単一の不変要素として動作します。

JSON 表現 
{
  "personId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  },
  "personProperties": {
    object (PersonProperties)
  }
}
フィールド
personId

string

出力専用。このリンクの一意の ID。
suggestedInsertionIds[]

string

この人物リンクをドキュメントに挿入する候補の ID。Person は、ネストされた提案された変更（別のユーザーによる提案内の提案など）の場合、複数の挿入 ID を持つことがあります。空の場合、この人物リンクは挿入候補ではありません。
suggestedDeletionIds[]

string

このユーザーのリンクをドキュメントから削除する候補の ID。たとえば、複数のユーザーが削除を提案した場合、1 つの Person に複数の削除 ID が含まれることがあります。空の場合、この人物リンクは削除候補として表示されません。
textStyle

object (TextStyle)

この Person のテキスト スタイル。
suggestedTextStyleChanges

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

候補のテキスト スタイルがこの Person に変更され、候補 ID でキー設定されます。
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

RichLink の URI。これは常に存在します。
mimeType

string

RichLink の MIME タイプ（存在する場合。たとえば、ドライブ内のファイルの場合）。

DateElement

ドキュメントに記載されている日付インスタンス。

JSON 表現 
{
  "dateId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  },
  "dateElementProperties": {
    object (DateElementProperties)
  },
  "suggestedDateElementPropertiesChanges": {
    string: {
      object (SuggestedDateElementProperties)
    },
    ...
  }
}
フィールド
dateId

string

出力専用。この日付の一意の ID。
suggestedInsertionIds[]

string

この日付をドキュメントに挿入する候補の ID。DateElement がネストされた候補の変更（別のユーザーによる候補内の候補など）である場合、複数の挿入 ID を持つことがあります。空の場合、この日付は挿入候補ではありません。
suggestedDeletionIds[]

string

ドキュメントからこの日付を削除する候補の ID。たとえば、複数のユーザーが削除を提案した場合、DateElement に複数の削除 ID が含まれることがあります。空の場合、この日付は削除の候補として表示されません。
textStyle

object (TextStyle)

この DateElement のテキスト スタイル。
suggestedTextStyleChanges

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

提案されたテキスト スタイルは、提案 ID をキーとしてこの DateElement に変更されます。
dateElementProperties

object (DateElementProperties)

この DateElement のプロパティ。
suggestedDateElementPropertiesChanges

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

日付要素のプロパティに対する提案された変更。提案 ID をキーとして使用します。

DateElementProperties

DateElement のプロパティ。

JSON 表現 
{
  "timestamp": string,
  "timeZoneId": string,
  "locale": string,
  "dateFormat": enum (DateFormat),
  "timeFormat": enum (TimeFormat),
  "displayText": string
}
フィールド
timestamp

string (Timestamp format)

表す時点。Unix エポック（1970 年 1 月 1 日午前 0 時（UTC））からの秒数とナノ秒数。

タイムスタンプは UTC で指定する必要があります。timeZoneId が設定されている場合、タイムスタンプはタイムゾーンに従って調整されます。たとえば、日付形式が DATE_FORMAT_ISO8601、時間形式が TIME_FORMAT_HOUR_MINUTE のタイムスタンプ 18000 は、1970-01-01 5:00 AM と表示されます。日付形式が DATE_FORMAT_ISO8601、時刻形式が TIME_FORMAT_HOUR_MINUTE、タイムゾーンが America/New_York に設定されている 18000 のタイムスタンプは、1970-01-01 12:00 AM になります。
timeZoneId

string

Unicode 共通地域データ リポジトリ（CLDR）プロジェクトで定義されている DateElement のタイムゾーン。（例: 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 が en の MMM d, y、またはロケール固有の同等の形式でフォーマットされることを示します。
timeFormat

enum (TimeFormat)

DateElement の時間部分をドキュメントに表示する方法を決定します。

設定されていない場合、デフォルト値は TIME_FORMAT_DISABLED になり、時刻が表示されないことを示します。
displayText

string

出力専用。DateElement がドキュメントにどのように表示されるかを示します。

DateFormat

DateElement の日付形式。

列挙型
DATE_FORMAT_UNSPECIFIED 日付形式が指定されていません。
DATE_FORMAT_CUSTOM 出力専用。日付形式は外部ソースからインポートされます。
DATE_FORMAT_MONTH_DAY_ABBREVIATED 日付の形式は、月の略称の後に日を続けたものです。例: 「1 月 1 日」。
DATE_FORMAT_MONTH_DAY_FULL 日付の形式は、月の後に日が続きます。例: 「January 01」。
DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED 日付の形式は、月の略称、日、年の順です。例: 「1970 年 1 月 1 日」。
DATE_FORMAT_ISO8601 日付の形式は ISO 8601 形式です。例: 「1970-01-01」。

TimeFormat

DateElement の時間形式。

列挙型
TIME_FORMAT_UNSPECIFIED 時間形式が指定されていません。
TIME_FORMAT_DISABLED 日付に時刻がないことを示します。
TIME_FORMAT_HOUR_MINUTE 時刻形式には時間と分が表示されます。例: 「1970 年 1 月 1 日午後 12 時」。
TIME_FORMAT_HOUR_MINUTE_TIMEZONE 時刻形式には、時間、分、タイムゾーンが表示されます。例: 「1970 年 1 月 1 日 12:00 PM UTC」。

SuggestedDateElementProperties

DateElementProperties に対する変更提案。

JSON 表現 
{
  "dateElementProperties": {
    object (DateElementProperties)
  },
  "dateElementPropertiesSuggestionState": {
    object (DateElementPropertiesSuggestionState)
  }
}
フィールド
dateElementProperties

object (DateElementProperties)

DateElementProperties。この提案で行われた変更のみが含まれます。これは dateElementPropertiesSuggestionState とともに使用して、どのフィールドが変更されたか、その新しい値を確認できます。
dateElementPropertiesSuggestionState

object (DateElementPropertiesSuggestionState)

この提案でベース DateElementProperties のどのフィールドが変更されたかを示すマスク。

DateElementPropertiesSuggestionState

この提案でベース DateElementProperties のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。

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

段落全体に適用されるスタイル。

継承された段落スタイルは、このメッセージでは未設定のフィールドとして表されます。段落スタイルの親は、段落スタイルが定義されている場所によって異なります。

  • Paragraph の ParagraphStyle は、段落の対応する named style type から継承されます。
  • named style の ParagraphStyle は、normal text という名前のスタイルから継承されます。
  • normal text という名前のスタイルの ParagraphStyle は、ドキュメント エディタのデフォルトの段落スタイルから継承されます。
  • テーブルに含まれる Paragraph 要素の ParagraphStyle は、テーブル スタイルから段落スタイルを継承する場合があります。

段落スタイルが親から継承されていない場合、フィールドの設定を解除すると、スタイルはドキュメント エディタのデフォルト値と一致する値に戻ります。

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

段落の見出し ID。空の場合、この段落は見出しではありません。

このプロパティは読み取り専用です。
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)

段落の 1 行目のインデントの量。設定されていない場合、値は親から継承されます。
indentStart

object (Dimension)

現在の段落の方向に基づいて、テキストの開始に対応する側の段落のインデント量。設定されていない場合、値は親から継承されます。
indentEnd

object (Dimension)

現在の段落の方向に基づいて、テキストの末尾に対応する側の段落のインデント量。設定されていない場合、値は親から継承されます。
tabStops[]

object (TabStop)

この段落のタブストップのリスト。タブストップのリストは継承されません。

このプロパティは読み取り専用です。
keepLinesTogether

boolean

段落のすべての行を可能な限り同じページまたは列に配置するかどうか。設定されていない場合、値は親から継承されます。
keepWithNext

boolean

この段落の少なくとも一部を、次の段落と同じページまたは列に配置するかどうかを指定します。設定されていない場合、値は親から継承されます。
avoidWidowAndOrphan

boolean

段落で孤立語と孤立行を避けるかどうか。設定されていない場合、値は親から継承されます。
shading

object (Shading)

段落の網かけ。設定されていない場合、値は親から継承されます。
pageBreakBefore

boolean

現在の段落を常にページの先頭から開始するかどうか。設定されていない場合、値は親から継承されます。

Table、Header、Footer、Footnote などのサポートされていないリージョンの段落の pageBreakBefore を更新しようとすると、無効なドキュメント状態になり、400 Bad Request エラーが返されることがあります。

NamedStyleType

名前付きスタイルのタイプ。

列挙型
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。

配置

段落のテキスト配置の種類。

列挙型
ALIGNMENT_UNSPECIFIED 段落の配置は親から継承されます。
START 段落が行の先頭に揃えられます。LTR テキストの場合は左揃え、それ以外の場合は右揃え。
CENTER 段落が中央に配置されます。
END 段落が行の末尾に揃えられます。LTR テキストの場合は右揃え、それ以外の場合は左揃え。
JUSTIFIED 段落が均等割り付けされている。

ContentDirection

経路のコンテンツが流れ込むことができます。

列挙型
CONTENT_DIRECTION_UNSPECIFIED コンテンツの方向が指定されていません。
LEFT_TO_RIGHT コンテンツは左から右に流れます。
RIGHT_TO_LEFT コンテンツは右から左に流れます。

SpacingMode

段落間隔のさまざまなモード。

列挙型
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

線形ジオメトリをレンダリングできるダッシュの種類。これらの値は、ECMA-376 第 5 版の第 1 部「Office Open XML File Formats - Fundamentals and Markup Language Reference」のセクション 20.1.10.49 で説明されている「ST_PresetLineDashVal」単純型に基づいています。

列挙型
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

タブストップの配置。

列挙型
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 のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。

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 のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。

JSON 表現 
{
  "backgroundColorSuggested": boolean
}
フィールド
backgroundColorSuggested

boolean

Shading に変更の提案があったかどうかを示します。

ブレット

段落の箇条書きを記述します。

JSON 表現 
{
  "listId": string,
  "nestingLevel": integer,
  "textStyle": {
    object (TextStyle)
  }
}
フィールド
listId

string

この段落が属するリストの ID。
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 のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。

JSON 表現 
{
  "listIdSuggested": boolean,
  "nestingLevelSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}
フィールド
listIdSuggested

boolean

listId に変更の提案があったかどうかを示します。
nestingLevelSuggested

boolean

nestingLevel に変更の提案があったかどうかを示します。
textStyleSuggestionState

object (TextStyleSuggestionState)

この候補で text style のどのフィールドが変更されたかを示すマスク。

ObjectReferences

オブジェクト ID のコレクション。

JSON 表現 
{
  "objectIds": [
    string
  ]
}
フィールド
objectIds[]

string

オブジェクト ID。

SectionBreak

セクション区切りを表す StructuralElement。セクションは、同じ SectionStyle を持つコンテンツの範囲です。セクション区切りは新しいセクションの開始を表し、セクション スタイルはセクション区切りの後のセクションに適用されます。

ドキュメントの本文は常にセクション区切りで始まります。

JSON 表現 
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "sectionStyle": {
    object (SectionStyle)
  }
}
フィールド
suggestedInsertionIds[]

string

提案された挿入 ID。SectionBreak がネストされた提案された変更である場合、複数の挿入 ID を持つことがあります。空の場合、これは挿入候補ではありません。
suggestedDeletionIds[]

string

削除候補の ID。空の場合、このコンテンツの削除候補はありません。
sectionStyle

object (SectionStyle)

このセクション区切り後のセクションのスタイル。

SectionStyle

セクションに適用されるスタイル。

JSON 表現 
{
  "columnProperties": [
    {
      object (SectionColumnProperties)
    }
  ],
  "columnSeparatorStyle": enum (ColumnSeparatorStyle),
  "contentDirection": enum (ContentDirection),
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "marginHeader": {
    object (Dimension)
  },
  "marginFooter": {
    object (Dimension)
  },
  "sectionType": enum (SectionType),
  "defaultHeaderId": string,
  "defaultFooterId": string,
  "firstPageHeaderId": string,
  "firstPageFooterId": string,
  "evenPageHeaderId": string,
  "evenPageFooterId": string,
  "useFirstPageHeaderFooter": boolean,
  "pageNumberStart": integer,
  "flipPageOrientation": boolean
}
フィールド
columnProperties[]

object (SectionColumnProperties)

セクションの列のプロパティ。

空の場合、セクションにはドキュメント エディタのデフォルトのプロパティを持つ 1 つの列が含まれます。セクションは、3 列以下になるように更新できます。

このプロパティを更新する場合は、具体的な値を設定する必要があります。このプロパティの設定を解除すると、400 Bad Request エラーが発生します。
columnSeparatorStyle

enum (ColumnSeparatorStyle)

列の区切り線のスタイル。

このスタイルは、セクションに 1 つの列しかない場合でも設定できます。

このプロパティを更新する場合は、具体的な値を設定する必要があります。このプロパティの設定を解除すると、400 Bad Request エラーが発生します。
contentDirection

enum (ContentDirection)

このセクションのコンテンツの方向。未設定の場合、値はデフォルトで LEFT_TO_RIGHT になります。

このプロパティを更新する場合は、具体的な値を設定する必要があります。このプロパティの設定を解除すると、400 Bad Request エラーが発生します。
marginTop

object (Dimension)

セクションの上部ページ余白。設定されていない場合、値は DocumentStyle の marginTop にデフォルト設定されます。

[DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が PAGELESS の場合、このプロパティはレンダリングされません。

このプロパティを更新する場合は、具体的な値を設定する必要があります。このプロパティの設定を解除すると、400 Bad Request エラーが発生します。
marginBottom

object (Dimension)

セクションの下のページ余白。設定されていない場合、値は DocumentStyle の marginBottom にデフォルト設定されます。

[DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が PAGELESS の場合、このプロパティはレンダリングされません。

このプロパティを更新する場合は、具体的な値を設定する必要があります。このプロパティの設定を解除すると、400 Bad Request エラーが発生します。
marginRight

object (Dimension)

セクションの右ページ余白。設定されていない場合、値は DocumentStyle の marginRight にデフォルト設定されます。右余白を更新すると、このセクションの列のサイズが変更されます。マージンは列の幅に影響するため、列のプロパティの前に適用されます。

[DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が PAGELESS の場合、このプロパティはレンダリングされません。

このプロパティを更新する場合は、具体的な値を設定する必要があります。このプロパティの設定を解除すると、400 Bad Request エラーが発生します。
marginLeft

object (Dimension)

セクションの左側のページ余白。設定されていない場合、値は DocumentStyle の marginLeft にデフォルト設定されます。左余白を更新すると、このセクションの列のサイズが変更されます。マージンは列の幅に影響するため、列のプロパティの前に適用されます。

[DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が PAGELESS の場合、このプロパティはレンダリングされません。

このプロパティを更新する場合は、具体的な値を設定する必要があります。このプロパティの設定を解除すると、400 Bad Request エラーが発生します。
marginHeader

object (Dimension)

セクションのヘッダー マージン。設定されていない場合、値は DocumentStyle の marginHeader にデフォルト設定されます。更新された場合、DocumentStyle の useCustomHeaderFooterMargins が true に設定されます。DocumentStyle の useCustomHeaderFooterMargins の値は、このセクションでヘッダーの余白が尊重されているかどうかを示します。

[DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が PAGELESS の場合、このプロパティはレンダリングされません。

このプロパティを更新する場合は、具体的な値を設定する必要があります。このプロパティの設定を解除すると、400 Bad Request エラーが発生します。
sectionType

enum (SectionType)

出力専用。セクションのタイプ。
defaultHeaderId

string

デフォルト ヘッダーの ID。設定しない場合、値は前の SectionBreak's SectionStyle から継承されます。最初の SectionBreak で値が設定されていない場合、DocumentStyle の defaultHeaderId から継承されます。

[DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が PAGELESS の場合、このプロパティはレンダリングされません。

このプロパティは読み取り専用です。
firstPageHeaderId

string

セクションの最初のページでのみ使用されるヘッダーの ID。useFirstPageHeaderFooter が true の場合、この値はセクションの最初のページのヘッダーに使用されます。false の場合、セクションの最初のページのヘッダーは defaultHeaderId を使用します。設定しない場合、値は前の SectionBreak's SectionStyle から継承されます。最初の SectionBreak で値が設定されていない場合、DocumentStyle の firstPageHeaderId から継承されます。

[DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が PAGELESS の場合、このプロパティはレンダリングされません。

このプロパティは読み取り専用です。
firstPageFooterId

string

セクションの最初のページでのみ使用されるフッターの ID。useFirstPageHeaderFooter が true の場合、この値はセクションの最初のページのフッターに使用されます。false の場合、セクションの最初のページのフッターは defaultFooterId を使用します。設定しない場合、値は前の SectionBreak's SectionStyle から継承されます。最初の SectionBreak で値が設定されていない場合、DocumentStyle の firstPageFooterId から継承されます。

[DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が PAGELESS の場合、このプロパティはレンダリングされません。

このプロパティは読み取り専用です。
evenPageHeaderId

string

偶数ページでのみ使用されるヘッダーの ID。DocumentStyle の useEvenPageHeaderFooter の値が true の場合、この値はセクションの偶数ページのヘッダーに使用されます。false の場合、偶数ページのヘッダーには defaultHeaderId が使用されます。設定しない場合、値は前の SectionBreak's SectionStyle から継承されます。最初の SectionBreak で値が設定されていない場合、DocumentStyle の evenPageHeaderId から継承されます。

[DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が PAGELESS の場合、このプロパティはレンダリングされません。

このプロパティは読み取り専用です。
evenPageFooterId

string

偶数ページでのみ使用されるフッターの ID。DocumentStyle の useEvenPageHeaderFooter の値が true の場合、この値はセクションの偶数ページのフッターに使用されます。false の場合、偶数ページのフッターは defaultFooterId を使用します。設定しない場合、値は前の SectionBreak's SectionStyle から継承されます。最初の SectionBreak で値が設定されていない場合、DocumentStyle の evenPageFooterId から継承されます。

[DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が PAGELESS の場合、このプロパティはレンダリングされません。

このプロパティは読み取り専用です。
useFirstPageHeaderFooter

boolean

セクションの最初のページに最初のページのヘッダー / フッター ID を使用するかどうかを示します。設定されていない場合、最初のセクションの DocumentStyle の useFirstPageHeaderFooter から継承されます。後続のセクターで値が設定されていない場合は、false と解釈する必要があります。

[DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が PAGELESS の場合、このプロパティはレンダリングされません。

このプロパティを更新する場合は、具体的な値を設定する必要があります。このプロパティの設定を解除すると、400 Bad Request エラーが発生します。
pageNumberStart

integer

このセクションのページ数のカウントを開始するページ番号。設定されていない場合、ページ番号は前のセクションから続きます。最初の SectionBreak で値が設定されていない場合は、DocumentStyle の pageNumberStart を参照してください。

[DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が PAGELESS の場合、このプロパティはレンダリングされません。

このプロパティを更新する場合は、具体的な値を設定する必要があります。このプロパティの設定を解除すると、400 Bad Request エラーが発生します。
flipPageOrientation

boolean

省略可。このセクションの DocumentStyle の pageSize のディメンションを反転するかどうかを示します。これにより、ページの向きを縦向きと横向きの間で変更できます。設定されていない場合、値は DocumentStyle の flipPageOrientation から継承されます。

[DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が PAGELESS の場合、このプロパティはレンダリングされません。

このプロパティを更新する場合は、具体的な値を設定する必要があります。このプロパティの設定を解除すると、400 Bad Request エラーが発生します。

SectionColumnProperties

セクションの列に適用されるプロパティ。

JSON 表現 
{
  "width": {
    object (Dimension)
  },
  "paddingEnd": {
    object (Dimension)
  }
}
フィールド
width

object (Dimension)

出力専用。列の幅。
paddingEnd

object (Dimension)

列の末尾のパディング。

ColumnSeparatorStyle

列間の列区切り文字のスタイル。

列挙型
COLUMN_SEPARATOR_STYLE_UNSPECIFIED 列区切り文字のスタイルが指定されていません。
NONE 列間に列区切り線がない。
BETWEEN_EACH_COLUMN 各列の間に列区切り線を表示します。

SectionType

現在のセクションの開始位置が前のセクションに対してどのように配置されているかを表します。

列挙型
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

挿入候補の ID。Table がネストされた提案された変更である場合、複数の挿入 ID を持つことがあります。空の場合、これは挿入候補ではありません。
suggestedDeletionIds[]

string

削除候補の ID。空の場合、このコンテンツの削除候補はありません。
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

挿入候補の ID。TableRow がネストされた提案された変更である場合、複数の挿入 ID を持つことがあります。空の場合、これは挿入候補ではありません。
suggestedDeletionIds[]

string

削除候補の ID。空の場合、このコンテンツの削除候補はありません。
tableRowStyle

object (TableRowStyle)

テーブル行のスタイル。
suggestedTableRowStyleChanges

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

この行に提案されたスタイルの変更。提案 ID でキー設定されます。

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

提案された挿入 ID。TableCell がネストされた提案された変更である場合、複数の挿入 ID を持つことがあります。空の場合、これは挿入候補ではありません。
suggestedDeletionIds[]

string

削除候補の ID。空の場合、このコンテンツの削除候補はありません。
suggestedTableCellStyleChanges

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

提案されたテーブル セル スタイルの変更。提案 ID をキーとしています。

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

コンテンツの配置の種類。

ECMA-376 第 5 版の第 1 部「Office Open XML ファイル形式 - 基本とマークアップ言語リファレンス」のセクション 20.1.10.60 にある「ST_TextAnchoringType」単純型の値のサブセットから派生。

列挙型
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 のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。

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)

行の最小高さ。行のすべてのコンテンツを表示するため、行は Docs エディタでこの値以上の高さでレンダリングされます。
tableHeader

boolean

行がテーブル ヘッダーかどうか。
preventOverflow

boolean

行がページまたは列の境界を越えてオーバーフローできないかどうか。

SuggestedTableRowStyle

TableRowStyle に対する変更提案。

JSON 表現 
{
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "tableRowStyleSuggestionState": {
    object (TableRowStyleSuggestionState)
  }
}
フィールド
tableRowStyle

object (TableRowStyle)

この提案で行われた変更のみを含む TableRowStyle。これは tableRowStyleSuggestionState とともに使用して、どのフィールドが変更されたか、その新しい値を確認できます。
tableRowStyleSuggestionState

object (TableRowStyleSuggestionState)

この提案でベース TableRowStyle のどのフィールドが変更されたかを示すマスク。

TableRowStyleSuggestionState

この提案でベース TableRowStyle のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。

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

列の幅のタイプ。

列挙型
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

挿入候補の ID。TableOfContents がネストされた提案された変更である場合、複数の挿入 ID を持つことがあります。空の場合、これは挿入候補ではありません。
suggestedDeletionIds[]

string

削除候補の ID。空の場合、このコンテンツの削除候補はありません。

脚注

ドキュメントの脚注。

JSON 表現 
{
  "footnoteId": string,
  "content": [
    {
      object (StructuralElement)
    }
  ]
}
フィールド
footnoteId

string

脚注の ID。
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

デフォルト ヘッダーの ID。設定しない場合、デフォルトのヘッダーはありません。

[DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が PAGELESS の場合、このプロパティはレンダリングされません。

このプロパティは読み取り専用です。
evenPageHeaderId

string

偶数ページでのみ使用されるヘッダーの ID。useEvenPageHeaderFooter の値によって、偶数ページのヘッダーに defaultHeaderId を使用するか、この値を使用するかが決まります。設定されていない場合、偶数ページのヘッダーはありません。

[DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が PAGELESS の場合、このプロパティはレンダリングされません。

このプロパティは読み取り専用です。
evenPageFooterId

string

偶数ページでのみ使用されるフッターの ID。useEvenPageHeaderFooter の値によって、偶数ページのフッターに defaultFooterId を使用するか、この値を使用するかが決まります。設定されていない場合、偶数ページのフッターはありません。

[DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が PAGELESS の場合、このプロパティはレンダリングされません。

このプロパティは読み取り専用です。
firstPageHeaderId

string

最初のページでのみ使用されるヘッダーの ID。設定されていない場合、最初のページの固有のヘッダーは存在しません。useFirstPageHeaderFooter の値によって、最初のページのヘッダーに defaultHeaderId を使用するか、この値を使用するかが決まります。設定しない場合、1 ページ目のヘッダーはありません。

[DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が PAGELESS の場合、このプロパティはレンダリングされません。

このプロパティは読み取り専用です。
firstPageFooterId

string

最初のページでのみ使用されるフッターの ID。設定されていない場合、最初のページの固有のフッターは存在しません。useFirstPageHeaderFooter の値によって、最初のページのフッターに defaultFooterId を使用するか、この値を使用するかが決まります。設定しない場合、最初のページのフッターは表示されません。

[DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が PAGELESS の場合、このプロパティはレンダリングされません。

このプロパティは読み取り専用です。
useFirstPageHeaderFooter

boolean

最初のページのヘッダー / フッター ID を最初のページに使用するかどうかを示します。

[DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が PAGELESS の場合、このプロパティはレンダリングされません。
useEvenPageHeaderFooter

boolean

偶数ページのヘッダー / フッター ID を偶数ページに使用するかどうかを示します。

[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

ドキュメントがページ分けあり形式かページ分けなし形式か。

列挙型
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 のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。

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 のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドごとに、Backgound に新しい推奨値が設定されます。

JSON 表現 
{
  "backgroundColorSuggested": boolean
}
フィールド
backgroundColorSuggested

boolean

現在の背景色がこの候補で変更されたかどうかを示します。

SizeSuggestionState

この提案でベース Size のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドごとに、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)

この候補で styles の対応する NamedStyle のどのフィールドが変更されたかを示すマスク。

これらの名前付きスタイル候補の状態の順序は、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 には、リストの ID への参照が含まれます。

JSON 表現 
{
  "listProperties": {
    object (ListProperties)
  },
  "suggestedListPropertiesChanges": {
    string: {
      object (SuggestedListProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
フィールド
listProperties

object (ListProperties)

リストのプロパティ。
suggestedListPropertiesChanges

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

提案 ID をキーとする、リスト プロパティに対する提案された変更。
suggestedInsertionId

string

挿入候補の ID。空の場合、これは挿入候補ではありません。
suggestedDeletionIds[]

string

削除候補の ID。空の場合、このリストの削除候補はありません。

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 の対応するグリフに置き換え、接尾辞としてピリオドを追加することを示します。したがって、ネストレベル 0 でグリフタイプ UPPER_ALPHA とグリフ形式 %0. のリストは、レンダリングされたグリフのリストになります。

A.

B.

C.

グリフ形式には、現在のネストレベルのプレースホルダと親ネストレベルのプレースホルダを含めることができます。たとえば、リストのネストレベル 0 のグリフ形式を %0. に、ネストレベル 1 のグリフ形式を %0.%1. に設定できます。両方のネストレベルに DECIMAL グリフ型があると仮定すると、レンダリングされたグリフを含むリストが生成されます。

1.

2.

2.1.

2.2.

3.

順序付きのネストレベルの場合、特定の段落のグリフ形式のプレースホルダを置き換える文字列は、リスト内の段落の順序によって異なります。
indentFirstLine

object (Dimension)

このネストレベルの段落の 1 行目のインデント量。
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

箇条書きの配置の種類。

列挙型
BULLET_ALIGNMENT_UNSPECIFIED 箇条書きの配置が指定されていません。
START 箇条書きは、箇条書きのレンダリング用に割り当てられたスペースの先頭に揃えられます。LTR テキストの場合は左揃え、それ以外の場合は右揃え。
CENTER 箇条書きは、箇条書きのレンダリング用に割り当てられたスペースの中央に配置されます。
END 箇条書きは、箇条書きのレンダリング用に割り当てられたスペースの末尾に配置されます。LTR テキストの場合は右揃え、それ以外の場合は左揃え。

GlyphType

このレベルのネストにある段落が順序付けされている場合に、箇条書きで使用されるグリフの種類。

列挙型
GLYPH_TYPE_UNSPECIFIED グリフのタイプが指定されていないか、サポートされていません。
NONE 空の文字列。
DECIMAL 1、2、3 などの数値。
ZERO_DECIMAL 1 桁の数字の前に 0 が付いた数字（01、02、03 など）。2 桁以上の数字にはゼロは付きません。
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 のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。

JSON 表現 
{
  "nestingLevelsSuggestionStates": [
    {
      object (NestingLevelSuggestionState)
    }
  ]
}
フィールド
nestingLevelsSuggestionStates[]

object (NestingLevelSuggestionState)

この候補で nestingLevels の対応する NestingLevel のどのフィールドが変更されたかを示すマスク。

ネストレベルの提案状態は、ネストレベルの昇順で返されます。ネストレベルが最も低いものが最初に返されます。

NestingLevelSuggestionState

この提案でベース NestingLevel のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。

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

同じ名前付き範囲 ID を持つ Range のコレクション。

名前付き範囲を使用すると、ドキュメントの一部を任意のユーザー定義ラベルに関連付けることができるため、後でその内容をプログラムで読み取ったり編集したりできます。ドキュメントには同じ名前の複数の名前付き範囲を含めることができますが、すべての名前付き範囲には一意の ID があります。

名前付き範囲は 1 つの Range で作成され、名前付き範囲内に挿入されたコンテンツによって通常はその範囲が拡大されます。ただし、ドキュメントの変更によっては、範囲が複数の範囲に分割されることがあります。

名前付き範囲は非公開ではありません。ドキュメントにアクセスできるすべてのアプリケーションと共同編集者は、名前付き範囲を表示できます。

JSON 表現 
{
  "namedRangeId": string,
  "name": string,
  "ranges": [
    {
      object (Range)
    }
  ]
}
フィールド
namedRangeId

string

名前付き範囲の ID。
name

string

名前付き範囲の名前。
ranges[]

object (Range)

この名前付き範囲に属する範囲。

範囲

連続したテキストの範囲を指定します。

JSON 表現 
{
  "segmentId": string,
  "startIndex": integer,
  "endIndex": integer,
  "tabId": string
}
フィールド
segmentId

string

この範囲が含まれているヘッダー、フッター、脚注の ID。空のセグメント ID は、ドキュメントの本文を示します。
startIndex

integer

この範囲の 0 ベースの開始インデックス（UTF-16 コード単位）。

現在のすべての用途で、開始インデックスを指定する必要があります。このフィールドは、範囲が限定されない将来のユースケースに対応するために Int32Value です。
endIndex

integer

この範囲の 0 ベースの終了インデックス（UTF-16 コードユニット）。このインデックスは範囲に含まれません。

現在のすべての用途で、終了インデックスを指定する必要があります。このフィールドは、範囲が限定されない将来のユースケースに対応するために Int32Value です。
tabId

string

この範囲を含むタブ。省略した場合、リクエストは最初のタブに適用されます。

1 つのタブを含むドキュメントの場合:

  • 指定する場合は、単一タブの ID と一致する必要があります。

  • 省略すると、リクエストは単一のタブに適用されます。

複数のタブを含むドキュメントの場合:

  • 指定されている場合、リクエストは指定されたタブに適用されます。

  • 省略した場合、リクエストはドキュメントの最初のタブに適用されます。

InlineObject

テキストとともにインラインで表示されるオブジェクト。InlineObject には、画像などの EmbeddedObject が含まれます。

JSON 表現 
{
  "objectId": string,
  "inlineObjectProperties": {
    object (InlineObjectProperties)
  },
  "suggestedInlineObjectPropertiesChanges": {
    string: {
      object (SuggestedInlineObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
フィールド
objectId

string

このインライン オブジェクトの ID。オブジェクトのプロパティの更新に使用できます。
inlineObjectProperties

object (InlineObjectProperties)

このインライン オブジェクトのプロパティ。
suggestedInlineObjectPropertiesChanges

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

インライン オブジェクトのプロパティに対する推奨される変更。候補 ID をキーとして使用します。
suggestedInsertionId

string

挿入候補の ID。空の場合、これは挿入候補ではありません。
suggestedDeletionIds[]

string

削除候補の ID。空の場合、このコンテンツの削除候補はありません。

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

プロパティが取り得る状態。

列挙型
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 スプレッドシートの ID。
chartId

integer

埋め込まれた Google スプレッドシート内の特定のグラフの ID。

SuggestedInlineObjectProperties

InlineObjectProperties に対する変更案。

JSON 表現 
{
  "inlineObjectProperties": {
    object (InlineObjectProperties)
  },
  "inlineObjectPropertiesSuggestionState": {
    object (InlineObjectPropertiesSuggestionState)
  }
}
フィールド
inlineObjectProperties

object (InlineObjectProperties)

この提案で行われた変更のみを含む InlineObjectProperties。これは inlineObjectPropertiesSuggestionState とともに使用して、どのフィールドが変更されたか、その新しい値を確認できます。
inlineObjectPropertiesSuggestionState

object (InlineObjectPropertiesSuggestionState)

この提案でベース InlineObjectProperties のどのフィールドが変更されたかを示すマスク。

InlineObjectPropertiesSuggestionState

この提案でベース InlineObjectProperties のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。

JSON 表現 
{
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
フィールド
embeddedObjectSuggestionState

object (EmbeddedObjectSuggestionState)

この候補で embeddedObject のどのフィールドが変更されたかを示すマスク。

EmbeddedObjectSuggestionState

この提案でベース EmbeddedObject のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。

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 のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。

ImagePropertiesSuggestionState

この提案でベース ImageProperties のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。

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

[明るさ] [google.apps.docs.v1.EmbeddedObject.brightness] に変更が提案されたかどうかを示します。
contrastSuggested

boolean

[コントラスト]（[google.apps.docs.v1.EmbeddedObject.contrast]）に対する変更の提案があったかどうかを示します。
transparencySuggested

boolean

[透明度] [google.apps.docs.v1.EmbeddedObject.transparency] に変更が提案されたかどうかを示します。
cropPropertiesSuggestionState

object (CropPropertiesSuggestionState)

この候補で cropProperties のどのフィールドが変更されたかを示すマスク。
angleSuggested

boolean

[angle]（[google.apps.docs.v1.EmbeddedObject.angle]）に対する変更の提案があったかどうかを示します。

CropPropertiesSuggestionState

この提案でベース CropProperties のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。

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 のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。

JSON 表現 
{
  "colorSuggested": boolean,
  "widthSuggested": boolean,
  "dashStyleSuggested": boolean,
  "propertyStateSuggested": boolean
}
フィールド
colorSuggested

boolean

[color]（[google.apps.docs.v1.EmbeddedBorderObject.color]）に推奨される変更があったかどうかを示します。
widthSuggested

boolean

[幅] [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 のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。

JSON 表現 
{
  "sheetsChartReferenceSuggestionState": {
    object (SheetsChartReferenceSuggestionState)
  }
}
フィールド
sheetsChartReferenceSuggestionState

object (SheetsChartReferenceSuggestionState)

この候補で sheetsChartReference のどのフィールドが変更されたかを示すマスク。

SheetsChartReferenceSuggestionState

この提案でベース SheetsChartReference のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。

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

この配置されたオブジェクトの ID。
positionedObjectProperties

object (PositionedObjectProperties)

この配置されたオブジェクトのプロパティ。
suggestedPositionedObjectPropertiesChanges

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

位置指定されたオブジェクトのプロパティに対する提案された変更。提案 ID をキーとして使用します。
suggestedInsertionId

string

挿入候補の ID。空の場合、これは挿入候補ではありません。
suggestedDeletionIds[]

string

削除候補の ID。空の場合、このコンテンツの削除候補はありません。

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] の可能なレイアウト。

列挙型
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 のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。

JSON 表現 
{
  "positioningSuggestionState": {
    object (PositionedObjectPositioningSuggestionState)
  },
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
フィールド
positioningSuggestionState

object (PositionedObjectPositioningSuggestionState)

この候補で positioning のどのフィールドが変更されたかを示すマスク。
embeddedObjectSuggestionState

object (EmbeddedObjectSuggestionState)

この候補で embeddedObject のどのフィールドが変更されたかを示すマスク。

PositionedObjectPositioningSuggestionState

この提案でベース PositionedObjectPositioning のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。

JSON 表現 
{
  "layoutSuggested": boolean,
  "leftOffsetSuggested": boolean,
  "topOffsetSuggested": boolean
}
フィールド
layoutSuggested

boolean

layout の変更案があったかどうかを示します。
leftOffsetSuggested

boolean

leftOffset の変更案があったかどうかを示します。
topOffsetSuggested

boolean

topOffset の変更案があったかどうかを示します。

CommentAnchor

同じ anchorId で CommentThreads に関連付けられているドキュメント内の 1 つ以上の場所。注: 複数のアンカーが同じ位置を参照する場合があります。

JSON 表現 
{
  "anchorId": string,
  "ranges": [
    {
      object (Range)
    }
  ]
}
フィールド
anchorId

string

コメント アンカーの ID。
ranges[]

object (Range)

このアンカーに関連付けられているドキュメント内の Range のコレクション。

SuggestionsViewMode

ドキュメントに適用される提案ビューモード。提案された変更がどのように表示されるかを示します。すべての提案をインラインで表示するか、承認済みまたは不承認の提案のみを表示してドキュメントを読むためのオプションが用意されています。

列挙型
DEFAULT_FOR_CURRENT_ACCESS 返されるドキュメントに適用される SuggestionsViewMode は、ユーザーの現在のアクセスレベルによって異なります。ユーザーが閲覧権限のみを持っている場合は、PREVIEW_WITHOUT_SUGGESTIONS が適用されます。それ以外の場合は、SUGGESTIONS_INLINE が適用されます。これがデフォルトの候補ビューモードです。
SUGGESTIONS_INLINE

返されたドキュメントには、インラインで候補が表示されます。提案された変更は、ドキュメント内のベース コンテンツと区別されます。

このモードでドキュメントを取得するリクエストは、ユーザーに提案された変更を表示する権限がない場合、403 エラーを返します。
PREVIEW_SUGGESTIONS_ACCEPTED

返されたドキュメントは、提案されたすべての変更が承認されたプレビューです。

このモードでドキュメントを取得するリクエストは、ユーザーに提案された変更を表示する権限がない場合、403 エラーを返します。
PREVIEW_WITHOUT_SUGGESTIONS 返されるドキュメントは、ドキュメントに提案がある場合は、提案された変更がすべて拒否されたプレビューです。

CommentsViewMode

ドキュメントに適用されているコメント表示モード。コメントが含まれているかどうかを示します。コメントやコメント アンカーの有無にかかわらず、ドキュメントを読めるオプションが用意されています。

commentsViewMode を任意の値に設定する場合は、includeTabsContent を true に設定するか、Document.tabs フィールド（またはサブフィールド）を参照するフィールド マスクを使用する必要があります。

コメントは、候補がインラインで返された場合にのみ返されます。commentsViewMode を COMMENTS_VIEW_MODE_INCLUDED または COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS に設定した場合、suggestionsViewMode は PREVIEW_WITHOUT_SUGGESTIONS または PREVIEW_SUGGESTIONS_ACCEPTED にのみ設定できます。

列挙型
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

コメント スレッドの一意の ID。
anchorId

string

このスレッドが関連付けられているドキュメント内の CommentAnchor の ID。複数のコメント スレッドを同じ 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

出力専用。投稿の一意の ID。
content

string

投稿の内容。

commentAction が RESOLVE または REOPEN でない場合は、空でない必要があります。

このテキスト コンテンツは、ドキュメント エディタで作成されたコメントと同様に処理されます。書式設定や通知などについても同様の動作になります。

2,048 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 不正なリクエスト エラーを返します。

  • 親スレッドは、headPost に割り当てがない CommentThread です。

  • 親スレッドは SuggestionThread です。

  • commentAction が RESOLVE または REOPEN として指定されています。

  • assigneeEmail が 2,048 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

コメント スレッドに対するこの返信で行われたアクション。

列挙型
COMMENT_ACTION_TYPE_UNSPECIFIED デフォルト値。この値は使用されません。
NO_COMMENT_ACTION_CHANGE この記事では、対応の変更はありません。
RESOLVE この投稿でスレッドは解決しました。
REOPEN この投稿により、スレッドが再度開きます。

SuggestionActionType

提案スレッドに対するこの返信で行われたアクション。

列挙型
SUGGESTION_ACTION_TYPE_UNSPECIFIED デフォルト値。この値は使用されません。
NO_SUGGESTION_ACTION_CHANGE この記事では、対応の変更はありません。
ACCEPT この投稿では提案が承認されています。
REJECT この投稿は提案を拒否します。

ステータス

コメント スレッドのステータス オプション。

列挙型
STATUS_UNSPECIFIED デフォルト値。この値は使用されません。
OPEN コメント スレッドが開いています。
RESOLVED コメント スレッドが解決されました。

SuggestionThread

単一の提案スレッドを表します。提案スレッドは、提案モードでドキュメントへの変更を保存した結果として作成されるもので、直接作成することはできません。

JSON 表現 
{
  "suggestionId": string,
  "headPost": {
    object (Post)
  },
  "replies": [
    {
      object (Post)
    }
  ],
  "status": enum (Status),
  "summaryText": string,
  "summaryHtml": string
}
フィールド
suggestionId

string

提案の一意の ID。
headPost

object (Post)

スレッドの最初の投稿。
replies[]

object (Post)

ヘッド投稿への返信。
status

enum (Status)

スレッドがオープン、承認済み、拒否済みのいずれであるか。
summaryText

string

ドキュメント内の提案された変更点の概要（書式なしテキスト）。空の場合もあります。
summaryHtml

string

ドキュメントで提案された相違点の概要（HTML 形式）。空の場合もあります。

ステータス

提案スレッドのステータス オプション。

列挙型
STATUS_UNSPECIFIED デフォルト値。この値は使用されません。
OPEN 候補のスレッドが開いています。
ACCEPTED 提案スレッドが承認されました。
REJECTED 提案スレッドが拒否されます。

メソッド

batchUpdate

 ドキュメントに 1 つ以上の更新を適用します。

create

 リクエストで指定されたタイトルを使用して、空白のドキュメントを作成します。

get

 指定されたドキュメントの最新バージョンを取得します。