REST Resource: documents

リソース: ドキュメント

Google ドキュメントのドキュメント。

JSON 表現 
{
  "documentId": string,
  "title": string,
  "tabs": [
    {
      object (Tab)
    }
  ],
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "body": {
    object (Body)
  },
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "footers": {
    string: {
      object (Footer)
    },
    ...
  },
  "footnotes": {
    string: {
      object (Footnote)
    },
    ...
  },
  "documentStyle": {
    object (DocumentStyle)
  },
  "suggestedDocumentStyleChanges": {
    string: {
      object (SuggestedDocumentStyle)
    },
    ...
  },
  "namedStyles": {
    object (NamedStyles)
  },
  "suggestedNamedStylesChanges": {
    string: {
      object (SuggestedNamedStyles)
    },
    ...
  },
  "lists": {
    string: {
      object (List)
    },
    ...
  },
  "namedRanges": {
    string: {
      object (NamedRanges)
    },
    ...
  },
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
フィールド
documentId

string

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

string

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

object (Tab)

ドキュメント内にあるタブ。

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

string

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

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

enum (SuggestionsViewMode)

出力専用。ドキュメントに適用された候補表示モード。

注: ドキュメントを編集する場合、変更は SUGGESTIONS_INLINE を含むドキュメントに基づいて行う必要があります。
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)
    }
  ],

  // Union field content can be only one of the following:
  "documentTab": {
    object (DocumentTab)
  }
  // End of list of possible types for union field content.
}
フィールド
tabProperties

object (TabProperties)

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

object (Tab)

このタブ内にネストされた子タブ。
共用体フィールド content。タブのコンテンツ。content は次のいずれかになります。
documentTab

object (DocumentTab)

テキストや画像などのドキュメントのコンテンツが表示されるタブ。

TabProperties

タブのプロパティ。

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

string

出力専用。タブの ID。このフィールドは変更できません。
title

string

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

string

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

integer

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

integer

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

DocumentTab

ドキュメントのコンテンツを表示するタブ。

JSON 表現 
{
  "body": {
    object (Body)
  },
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "footers": {
    string: {
      object (Footer)
    },
    ...
  },
  "footnotes": {
    string: {
      object (Footnote)
    },
    ...
  },
  "documentStyle": {
    object (DocumentStyle)
  },
  "suggestedDocumentStyleChanges": {
    string: {
      object (SuggestedDocumentStyle)
    },
    ...
  },
  "namedStyles": {
    object (NamedStyles)
  },
  "suggestedNamedStylesChanges": {
    string: {
      object (SuggestedNamedStyles)
    },
    ...
  },
  "lists": {
    string: {
      object (List)
    },
    ...
  },
  "namedRanges": {
    string: {
      object (NamedRanges)
    },
    ...
  },
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
フィールド
body

object (Body)

[ドキュメント] タブの本文。
headers

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

ヘッダー 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 をキーとしています。

本文

ドキュメントの本文。

通常、本文には headers、footers、footnotes を除くすべてのドキュメント コンテンツが含まれます。

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

object (StructuralElement)

本文の内容。

本文のコンテンツのインデックスはゼロから始まります。

StructuralElement

StructuralElement は、ドキュメントに構造を提供するコンテンツを記述します。

JSON 表現 
{
  "startIndex": integer,
  "endIndex": integer,

  // Union field content can be only one of the following:
  "paragraph": {
    object (Paragraph)
  },
  "sectionBreak": {
    object (SectionBreak)
  },
  "table": {
    object (Table)
  },
  "tableOfContents": {
    object (TableOfContents)
  }
  // End of list of possible types for union field content.
}
フィールド
startIndex

integer

この構造要素のゼロベースの開始インデックス（UTF-16 コード単位）。
endIndex

integer

この構造要素のゼロベースの終了インデックス（UTF-16 コードユニットを除く）。
共用体フィールド content。構造要素のコンテンツ。content は次のいずれかになります。
paragraph

object (Paragraph)

段落型構造要素。
sectionBreak

object (SectionBreak)

構造要素のセクション区切りのタイプ。
table

object (Table)

構造要素のテーブルタイプ。
tableOfContents

object (TableOfContents)

構造要素の目次タイプ。

段落

段落を表す StructuralElement。段落とは、改行文字で終わるコンテンツの範囲です。

JSON 表現 
{
  "elements": [
    {
      object (ParagraphElement)
    }
  ],
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "suggestedParagraphStyleChanges": {
    string: {
      object (SuggestedParagraphStyle)
    },
    ...
  },
  "bullet": {
    object (Bullet)
  },
  "suggestedBulletChanges": {
    string: {
      object (SuggestedBullet)
    },
    ...
  },
  "positionedObjectIds": [
    string
  ],
  "suggestedPositionedObjectIds": {
    string: {
      object (ObjectReferences)
    },
    ...
  }
}
フィールド
elements[]

object (ParagraphElement)

段落の構成要素に分解された内容。
paragraphStyle

object (ParagraphStyle)

この段落のスタイル。
suggestedParagraphStyleChanges

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

候補の段落スタイルは、候補 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,

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

integer

この段落要素のゼロベースの開始インデックス（UTF-16 コード単位）。
endIndex

integer

この段落要素のゼロベース終了インデックス（UTF-16 コードユニットを除く）。
共用体フィールド content。段落要素のコンテンツ。content は次のいずれかになります。
textRun

object (TextRun)

テキスト実行の段落要素。
autoText

object (AutoText)

自動テキストの段落要素です。
pageBreak

object (PageBreak)

改ページ段落要素。
columnBreak

object (ColumnBreak)

列区切りの段落要素です。
footnoteReference

object (FootnoteReference)

脚注参照の段落要素。
horizontalRule

object (HorizontalRule)

水平ルールの段落要素です。
equation

object (Equation)

計算式の段落要素。
inlineObjectElement

object (InlineObjectElement)

インライン オブジェクトの段落要素。
person

object (Person)

個人またはメールアドレスにリンクする段落要素。

TextRun

すべて同じスタイル設定のテキストの実行を表す ParagraphElement。

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

string

この実行のテキスト。

実行に含まれる非テキスト要素は、Unicode 文字 U+E907 に置き換えられます。
suggestedInsertionIds[]

string

提案された挿入 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)

大きさの単位。

単位

Units of measurement.

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

この改ページのテキスト スタイル。

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

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

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

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))

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

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。たとえば、複数のユーザーが削除を提案した場合、Person には複数の削除 ID が存在することがあります。空の場合、このユーザーリンクの削除は提案されません。
textStyle

object (TextStyle)

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

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

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

object (PersonProperties)

出力専用。この Person のプロパティ。このフィールドは常に存在します。

PersonProperties

リンクされた Person に固有のプロパティ。

JSON 表現 
{
  "name": string,
  "email": string
}
フィールド
name

string

出力専用。メールアドレスではなくリンクテキストに表示される場合は、その人の名前。
email

string

出力専用。この Person にリンクされているメールアドレス。このフィールドは常に存在します。

RichLinkProperties

RichLink に固有のプロパティ。

JSON 表現 
{
  "title": string,
  "uri": string,
  "mimeType": string
}
フィールド
title

string

出力専用。リンクに表示される RichLink のタイトル。このタイトルは、リンクの挿入時または最終更新時のリンクされたリソースのタイトルと一致します。このフィールドは常に存在します。
uri

string

出力専用。RichLink への URI。これは常に存在します。
mimeType

string

出力専用。RichLink の MIME タイプ（ドライブ内にある場合など）。

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

線間のスペースの量を、normal に対するパーセンテージで表したものです。normal は 100.0 と表されます。設定しない場合、値は親から継承されます。
direction

enum (ContentDirection)

この段落のテキスト方向。設定しない場合、段落の方向は継承されないため、値はデフォルトで LEFT_TO_RIGHT になります。
spacingMode

enum (SpacingMode)

段落の間隔モード。
spaceAbove

object (Dimension)

段落上部の余分なスペースの量。設定しない場合、値は親から継承されます。
spaceBelow

object (Dimension)

段落の下の余分なスペースの量。設定しない場合、値は親から継承されます。
borderBetween

object (ParagraphBorder)

この段落と次の段落、前の段落の枠線。設定しない場合、値は親から継承されます。

隣接する段落に同じ枠線とインデントのプロパティがある場合、中枠線はレンダリングされます。

段落の枠線を部分的に更新することはできません。段落の枠線を変更する場合は、新しい枠線全体を指定する必要があります。
borderTop

object (ParagraphBorder)

この段落の上部の枠線。設定しない場合、値は親から継承されます。

上の段落の枠線とインデントのプロパティが異なる場合は、上の枠線がレンダリングされます。

段落の枠線を部分的に更新することはできません。段落の枠線を変更する場合は、新しい枠線全体を指定する必要があります。
borderBottom

object (ParagraphBorder)

この段落の下部にある枠線。設定しない場合、値は親から継承されます。

下の段落の枠線とインデントのプロパティが異なる場合は、下の枠線がレンダリングされます。

段落の枠線を部分的に更新することはできません。段落の枠線を変更する場合は、新しい枠線全体を指定する必要があります。
borderLeft

object (ParagraphBorder)

この段落の左の枠線。設定しない場合、値は親から継承されます。

段落の枠線を部分的に更新することはできません。段落の枠線を変更する場合は、新しい枠線全体を指定する必要があります。
borderRight

object (ParagraphBorder)

この段落の右側の枠線。設定しない場合、値は親から継承されます。

段落の枠線を部分的に更新することはできません。段落の枠線を変更する場合は、新しい枠線全体を指定する必要があります。
indentFirstLine

object (Dimension)

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

object (Dimension)

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

object (Dimension)

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

object (TabStop)

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

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

boolean

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

boolean

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

boolean

段落で死別や孤児を避けるかどうかを指定します。設定しない場合、値は親から継承されます。
shading

object (Shading)

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

boolean

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

サポートされていない地域（Table、Header、Footer、Footnote など）で段落の pageBreakBefore を更新しようとすると、無効なドキュメントの状態が発生し、400 不正なリクエスト エラーが返されることがあります。

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

線形ジオメトリをレンダリングできる破線の種類。これらの値は、「ST_PresetLineDashVal」「Office Open XML File Formats - Fundamentals and Markup Language Reference」（ECMA-376 第 4 版パート 1）のセクション 20.1.10.48 で説明されている単純な型です。

列挙型
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 不正なリクエスト エラーが発生します。
columnSeparatorStyle

enum (ColumnSeparatorStyle)

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

セクション内に列が 1 つの場合でも、このスタイルを設定できます。

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

enum (ContentDirection)

このセクションの内容の方向性。設定しない場合、値はデフォルトで LEFT_TO_RIGHT になります。

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

object (Dimension)

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

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

object (Dimension)

セクションの下側の余白。設定しない場合、値はデフォルトで DocumentStyle の marginBottom になります。

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

object (Dimension)

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

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

object (Dimension)

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

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

object (Dimension)

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

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

enum (SectionType)

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

string

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

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

string

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

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

string

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

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

string

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

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

string

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

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

boolean

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

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

integer

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

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

boolean

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

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

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

この行のゼロベースの開始インデックス（UTF-16 コード単位）。
endIndex

integer

この行のゼロベースの終了インデックス（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

このセルの開始インデックス（ゼロベース）。UTF-16 コードユニットで指定します。
endIndex

integer

このセルのゼロベースの終了インデックス（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

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

「ST_TextAnchoringType」の値のサブセットから取得されます「Office Open XML File Formats - Fundamentals and Markup Language Reference」（ECMA-376 第 4 版パート 1）のセクション 20.1.10.59 のシンプル型。

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

行の最小の高さ。行はドキュメント エディタでこの値以上の高さで表示されます。これは、行のセル内のすべてのコンテンツを表示するためです。
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
}
フィールド
background

object (Background)

ドキュメントの背景。ドキュメントの背景色を透明にすることはできません。
defaultHeaderId

string

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

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

string

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

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

string

偶数ページのみに使用されるフッターの ID。useEvenPageHeaderFooter の値により、偶数ページのフッターに defaultFooterId とこの値のどちらを使用するかが決まります。設定しない場合、偶数ページのフッターは表示されません。

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

string

最初のページでのみ使用されるヘッダーの ID。設定しない場合、最初のページの一意のヘッダーは存在しません。useFirstPageHeaderFooter の値により、最初のページのヘッダーに defaultHeaderId とこの値のどちらを使用するかが決まります。設定しない場合、最初のページのヘッダーは作成されません。

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

string

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

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

boolean

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

boolean

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

integer

ページ数のカウントを開始するページ番号。
marginTop

object (Dimension)

上部ページの余白。

ドキュメント スタイルで上部余白を更新すると、すべてのセクション スタイルの上部余白が消去されます。
marginBottom

object (Dimension)

下部のページの余白。

ドキュメント スタイルの下部ページの余白を更新すると、すべてのセクション スタイルの下部ページの余白が消去されます。
marginRight

object (Dimension)

右側のページ余白。

ドキュメント スタイルの右側のページ余白を更新すると、すべてのセクション スタイルの右側のページ余白が消去されます。また、すべてのセクションで列のサイズが変更される原因となる場合もあります。
marginLeft

object (Dimension)

左側のページ余白。

ドキュメント スタイルの左側のページ余白を更新すると、すべてのセクション スタイルの左側のページ余白が消去されます。また、すべてのセクションで列のサイズが変更される原因となる場合もあります。
pageSize

object (Size)

ドキュメント内のページのサイズ。
marginHeader

object (Dimension)

ページの上部とヘッダーの内容の間のスペース。
flipPageOrientation

boolean

省略可。pageSize のサイズを反転するかどうかを指定します。反転すると、ページの向きを縦向きと横向きで変更できます。

背景

ドキュメントの背景を表します。

JSON 表現 
{
  "color": {
    object (OptionalColor)
  }
}
フィールド
color

object (OptionalColor)

背景色。

サイズ

幅と高さ。

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

object (Dimension)

オブジェクトの高さ。
width

object (Dimension)

オブジェクトの幅。

SuggestedDocumentStyle

DocumentStyle に対して推奨される変更です。

JSON 表現 
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "documentStyleSuggestionState": {
    object (DocumentStyleSuggestionState)
  }
}
フィールド
documentStyle

object (DocumentStyle)

この提案で行われた変更のみを含む DocumentStyle。documentStyleSuggestionState と一緒に使用すると、変更されたフィールドとその新しい値を確認できます。
documentStyleSuggestionState

object (DocumentStyleSuggestionState)

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

DocumentStyleSuggestionState

この提案で変更されたベース DocumentStyle のフィールドを示すマスク。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 フィールドを示すマスク。

リスト

List は、すべて同じリストに属する段落のグループに対するリスト属性を表します。リストを構成する段落の 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,

  // Union field glyph_kind can be only one of the following:
  "glyphType": enum (GlyphType),
  "glyphSymbol": string
  // End of list of possible types for union field glyph_kind.
}
フィールド
bulletAlignment

enum (BulletAlignment)

弾丸のレンダリングのために割り当てられたスペース内での箇条書きの配置です。
glyphFormat

string

このネスト レベルで箇条書きで使用される書式文字列。

グリフ形式には 1 つ以上のプレースホルダが含まれ、これらのプレースホルダは、glyphType または glyphSymbol に応じて適切な値に置き換えられます。プレースホルダは、パターン %[nestingLevel] に従います。また、プレースホルダに接頭辞と接尾辞を含めることができます。したがって、グリフ形式はパターン <prefix>%[nestingLevel]<suffix> に従います。接頭辞と接尾辞は省略可能で、任意の文字列を使用できます。

たとえば、グリフ形式 %0. は、レンダリングされたグリフで、プレースホルダが、ネスト レベル 0 の対応するグリフに置き換え、その後に接尾辞としてピリオドが続くことを示します。そのため、ネストレベル 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_kind。箇条書きに使用されるグリフの種類です。glyph_format 内のプレースホルダを置き換える箇条書きのグリフを定義します。glyph_kind は次のいずれかになります。
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 桁の数字の前にゼロが付いた数値（01、02、03 など）。2 桁以上の数字には先頭に 0 は付きません。
UPPER_ALPHA 大文字（A、B、C など）。
ALPHA 小文字（a、b、c など）。
UPPER_ROMAN ローマ数字（I、II、III など）。
ROMAN 小文字のローマ数字（i、ii、iii など）。

SuggestedListProperties

ListProperties に推奨される変更です。

JSON 表現 
{
  "listProperties": {
    object (ListProperties)
  },
  "listPropertiesSuggestionState": {
    object (ListPropertiesSuggestionState)
  }
}
フィールド
listProperties

object (ListProperties)

この提案で行われた変更のみを含む ListProperties。listPropertiesSuggestionState と一緒に使用すると、変更されたフィールドとその新しい値を確認できます。
listPropertiesSuggestionState

object (ListPropertiesSuggestionState)

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

ListPropertiesSuggestionState

この提案で変更されたベース ListProperties のフィールドを示すマスク。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

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

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

integer

この範囲のゼロベースの終了インデックス（UTF-16 コード単位を除く）。

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

string

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

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

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

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

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

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

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

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)
  },

  // Union field properties can be only one of the following:
  "embeddedDrawingProperties": {
    object (EmbeddedDrawingProperties)
  },
  "imageProperties": {
    object (ImageProperties)
  }
  // End of list of possible types for union field properties.
}
フィールド
title

string

埋め込みオブジェクトのタイトル。代替テキストは、title と description を組み合わせて表示されます。
description

string

埋め込みオブジェクトの説明。代替テキストは、title と description を組み合わせて表示されます。
embeddedObjectBorder

object (EmbeddedObjectBorder)

埋め込みオブジェクトの枠線
size

object (Size)

切り抜き後の画像の表示サイズ。
marginTop

object (Dimension)

埋め込みオブジェクトの上余白
marginBottom

object (Dimension)

埋め込みオブジェクトの下余白
marginRight

object (Dimension)

埋め込みオブジェクトの右余白
marginLeft

object (Dimension)

埋め込みオブジェクトの左余白。
linkedContentReference

object (LinkedContentReference)

リンクされている外部ソース コンテンツへの参照。たとえば、埋め込みオブジェクトがリンクされたグラフの場合、このファイルには、参照元の Google スプレッドシート グラフへの参照が含まれます。

未設定の場合、埋め込みオブジェクトはリンクされません。
共用体フィールド properties。各埋め込みオブジェクト タイプに固有のプロパティ。properties は次のいずれかになります。
embeddedDrawingProperties

object (EmbeddedDrawingProperties)

埋め込み図形描画のプロパティ。
imageProperties

object (ImageProperties)

画像のプロパティ。

EmbeddedDrawingProperties

この型にはフィールドがありません。

埋め込み図形描画のプロパティ。オブジェクト タイプの区別に使用されます。埋め込み図形描画とは、ドキュメント内で作成、編集される図形描画です。詳細な情報はサポートされないことにご注意ください。

ImageProperties

画像のプロパティ。

JSON 表現 
{
  "contentUri": string,
  "sourceUri": string,
  "brightness": number,
  "contrast": number,
  "transparency": number,
  "cropProperties": {
    object (CropProperties)
  },
  "angle": number
}
フィールド
contentUri

string

イメージの URI。デフォルトの有効期間は 30 分です。この URI には、リクエスト元のアカウントでタグが付けられます。URI を知っているユーザーは誰でも、元のリクエスト元として実質的に画像にアクセスできます。ドキュメントの共有設定を変更すると、画像にアクセスできなくなる可能性があります。
sourceUri

string

ソース URI は、画像の挿入に使用される URI です。ソース URI は空にできます。
brightness

number

画像の明るさの効果。値は [-1.0, 1.0] の範囲内で指定する必要があります。0 は影響がないことを意味します。
contrast

number

画像のコントラスト効果。値は [-1.0, 1.0] の範囲内で指定する必要があります。0 は影響がないことを意味します。
transparency

number

画像の透明度効果。値は [0.0, 1.0] の範囲で指定します。0 は効果なし、1 は透明を意味します。
cropProperties

object (CropProperties)

画像の切り抜きプロパティ。
angle

number

画像の時計回りの回転角度（ラジアン単位）。

CropProperties

画像の切り抜きプロパティ。

切り抜き長方形は、元のコンテンツの 4 つの端からの小数オフセットを使用して表現されます。

  • オフセットが (0, 1) の範囲内の場合、切り抜く長方形の対応する端は、画像の元の境界長方形の内側に配置されます。
  • オフセットが負の値または 1 より大きい場合、切り抜く長方形の対応する端は画像の元の境界長方形の外側になります。
  • すべてのオフセットと回転角度が 0 の場合、画像は切り抜かれません。
JSON 表現 
{
  "offsetLeft": number,
  "offsetRight": number,
  "offsetTop": number,
  "offsetBottom": number,
  "angle": number
}
フィールド
offsetLeft

number

offset では、切り抜く長方形の左端が元のコンテンツの左端からどれくらい内側にあるかを、元のコンテンツの幅に対する比率で指定します。
offsetRight

number

オフセットは、切り抜く長方形の右端から元のコンテンツの右端から内側までの距離を、元のコンテンツの幅に対する比率で指定します。
offsetTop

number

offset では、切り抜く長方形の上端が元のコンテンツの上端からどのくらい内側にあるかを、元のコンテンツの高さに対する比率で指定します。
offsetBottom

number

offset では、切り抜く長方形の下端が元のコンテンツの下端からどのくらい内側にあるかを、元のコンテンツの高さに対する比率で指定します。
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)

region プロパティのプロパティ状態。

PropertyState

プロパティの状態。

列挙型
RENDERED プロパティの状態が RENDERED の場合、要素にはドキュメントでレンダリングされた時点で対応するプロパティがあります。これがデフォルト値です。
NOT_RENDERED プロパティの状態が NOT_RENDERED の場合、ドキュメントでレンダリングされた要素には、対応するプロパティがありません。

LinkedContentReference

リンクされている外部ソース コンテンツへの参照。

JSON 表現 
{

  // Union field reference can be only one of the following:
  "sheetsChartReference": {
    object (SheetsChartReference)
  }
  // End of list of possible types for union field reference.
}
フィールド
共用体フィールド reference。リンクされたコンテンツの種類に固有の参照。reference は次のいずれかになります。
sheetsChartReference

object (SheetsChartReference)

リンクされたグラフへの参照。

SheetsChartReference

Google スプレッドシートから埋め込まれたリンクされたグラフへの参照。

JSON 表現 
{
  "spreadsheetId": string,
  "chartId": integer
}
フィールド
spreadsheetId

string

ソースグラフを含む Google スプレッドシートの 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

[contrast] への変更の提案があるかどうかを示します。 [google.apps.docs.v1.EmbeddedObject.contrast]。
transparencySuggested

boolean

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

object (CropPropertiesSuggestionState)

この提案で変更された cropProperties フィールドを示すマスク。
angleSuggested

boolean

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

CropPropertiesSuggestionState

この提案で変更されたベース CropProperties のフィールドを示すマスク。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

[width] の変更の提案があったかどうかを示します。 [google.apps.docs.v1.EmbeddedBorderObject.width]
dashStyleSuggested

boolean

[dashStyle] に対して推奨される変更があったかどうかを示します。 [google.apps.docs.v1.EmbeddedBorderObject.dash_style]。
propertyStateSuggested

boolean

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

LinkedContentReferenceSuggestionState

この提案で変更されたベース LinkedContentReference のフィールドを示すマスク。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 に変更が提案されたかどうかを示します。

SuggestionsViewMode

ドキュメントに適用される提案表示モード。提案される変更がどのように表示されるかを示します。ドキュメントを読む際に、すべての候補をインラインで表示するか、承認または拒否したオプションを使用できます。

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

返されたドキュメントにはインラインの提案があります。提案された変更は、ドキュメント内の基本コンテンツと区別されます。

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

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

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

メソッド

batchUpdate

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

create

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

get

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