REST Resource: documents

リソース: ドキュメント

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

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

string

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

string

ドキュメントのタイトル。
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))

出力のみ。ドキュメント内の名前付き範囲（名前がキーになっています）。
revisionId

string

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

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

enum (SuggestionsViewMode)

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

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

本文のコンテンツ。

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

構造要素

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 には影響しません。

オプションの色

完全に不透明または完全に透明な色。

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

object (Color)

設定すると、不透明な色として使用されます。設定しない場合、これは透明な色を表します。

色

無地。

JSON 表現 
{
  "rgbColor": {
    object (RgbColor)
  }
}
フィールド
rgbColor

object (RgbColor)

RGB カラー値。

RGB 値

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 値の組み合わせにより、継承を考慮したうえで、レンダリングのウェイトが決まります。

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

BaselineOffset

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

列挙型
BASELINE_OFFSET_UNSPECIFIED テキストのベースライン オフセットは親から継承されます。
NONE テキストが垂直方向にオフセットされていません。
SUPERSCRIPT テキストは垂直方向に上向きになります（上付き文字）。
SUBSCRIPT テキストは垂直方向に下方向にオフセットされます（下付き文字）。

推奨テキスト スタイル

TextStyle に対して推奨される変更。

JSON 表現 
{
  "textStyle": {
    object (TextStyle)
  },
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}
フィールド
textStyle

object (TextStyle)

この提案に加えられた変更のみを含む TextStyle。これを textStyleSuggestionState とともに使用すると、変更されたフィールドと新しい値を確認できます。
textStyleSuggestionState

object (TextStyleSuggestionState)

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

テキスト スタイル候補の状態

この提案で変更されたベース 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 への変更が提案されたかどうかを示します。

定型文

時間の経過とともに変化するコンテンツ（ページ番号など）で動的に置換される、テキスト内の部分を表す 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)

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

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

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

タイプ

自動テキストの種類。

列挙型
TYPE_UNSPECIFIED 未指定の自動テキスト タイプ。
PAGE_NUMBER 現在のページ番号を表す自動テキストを入力します。
PAGE_COUNT ドキュメント内の総ページ数を表す自動テキストを入力します。

改ページ

改ページを表す 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))

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

列区切り

列区切りを表す 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 に変更されます。

脚注参照

脚注参照を表す 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 に変更されます。

水平ルール

水平線を表す 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 にリンクされているメールアドレス。このフィールドは常に存在します。

リッチリンク プロパティ

RichLink に固有のプロパティ。

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

string

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

string

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

string

出力のみ。RichLink の MIME タイプ（存在する場合（Google ドライブ内のファイルなど））。

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 不正なリクエスト エラーが返されることがあります。

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

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

列挙型
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 コンテンツは右から左に流れます。

間隔モード

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

列挙型
SPACING_MODE_UNSPECIFIED 間隔モードは親から継承されます。
NEVER_COLLAPSE 段落の間隔は常にレンダリングされます。
COLLAPSE_LISTS リスト要素間の段落間隔はスキップされます。

段落の枠線

段落の周りの枠線。

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 4th edition エディションのパート 1「Office Open XML File Formats - Fundamentals and Markup Language Reference」のセクション 20.1.10.48 に記載されている「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)

この段落の網かけの背景色。

提案された ParagraphStyle

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)

この箇条書きに適用される段落固有のテキスト スタイル。

箇条書きの候補

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 のフィールドを示すマスク。

ObjectReference

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

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

string

オブジェクト ID。

セクション区切り

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

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

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

string

提案された挿入 ID。ネストされた変更の提案の場合は、SectionBreak に複数の挿入 ID を指定できます。空の場合、挿入は推奨されません。
suggestedDeletionIds[]

string

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

object (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

セクションの 1 ページ目でのみ使用されるヘッダーの 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)

列の末尾のパディング。

列区切りスタイル

列間を区切る列区切りのスタイル。

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

枠線の破線スタイル。

コンテンツの配置

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

ECMA-376 4th edition エディションのパート 1「Office Open XML File Formats - Fundamentals and Markup Language Reference」のセクション 20.1.10.59 にある「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' に対応します。

セルのスタイルの候補

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

行がページまたは列の境界を越えてはみ出さないかどうか。

推奨テーブル行スタイル

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 への変更が提案されたかどうかを示します。

テーブル スタイル

表に適用されるスタイル。

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

object (TableColumnProperties)

各列のプロパティ。

HTML と同様に、Google ドキュメントでは表には行が含まれ、行にはセルが含まれることに注意してください。したがって、行のプロパティは行の tableRowStyle で見つけることができます。

TableColumnProperties

テーブル内の列のプロパティ。

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

enum (WidthType)

列の幅の型。
width

object (Dimension)

列の幅。列の widthType が FIXED_WIDTH の場合に設定されます。

幅タイプ

列の幅の型。

列挙型
WIDTH_TYPE_UNSPECIFIED 列幅のタイプが指定されていません。
EVENLY_DISTRIBUTED

列幅は、均等に分散した他の列間で均等に分配されます。

列の幅は自動的に決定され、指定した幅のすべての列を考慮したうえで、テーブルの残りの幅が等しくなります。
FIXED_WIDTH 固定の列幅。[width][google.apps.docs.v1.TableColumnProperties.width] プロパティには列の幅を指定します。

目次

目次を表す 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。偶数ページのヘッダーに defaultHeaderId とこの値のどちらを使用するかは、useEvenPageHeaderFooter の値によって決まります。設定しない場合、偶数ページのヘッダーは存在しません。

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

string

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

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

オブジェクトの幅。

推奨ドキュメント スタイル

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 への変更が提案されたかどうかを示します。

名前付きスタイル

名前を付けたスタイル。ドキュメントの段落は、これらの名前付きスタイルから TextStyle と ParagraphStyle を継承できます。

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

object (NamedStyle)

名前を付けたスタイル。

可能性のある named style types ごとにエントリがあります。

名前付きスタイル

名前付きスタイル。ドキュメント内の段落の 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 は最もネスト レベルに対応します。ネスト レベルは昇順で返されます。ネストが最も小さいレベルが最初に返されます。

ネストレベル

特定のネストレベルでリスト箇条書きの外観を記述するプロパティを格納します。

JSON 表現 
{
  "bulletAlignment": enum (BulletAlignment),
  "glyphFormat": string,
  "indentFirstLine": {
    object (Dimension)
  },
  "indentStart": {
    object (Dimension)
  },
  "textStyle": {
    object (TextStyle)
  },
  "startNumber": integer,

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

enum (BulletAlignment)

箇条書きのレンダリング用に割り当てられるスペース内の箇条書きの配置。
glyphFormat

string

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

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

たとえば、グリフ形式 %0. は、レンダリングされたグリフによって、プレースホルダがレベル 0 のネストに対応するグリフに置き換えられ、その後に接尾辞としてピリオドが続くことを示します。したがって、グリフタイプが UPPER_ALPHA で、ネストレベル 0 のグリフ形式が %0. であるリストは、レンダリングされたグリフを含むリストになります。

A.

B.

C.

グリフ形式には、現在のネストレベルのプレースホルダと、親のネストレベルのプレースホルダを含めることができます。たとえば、リストのネスト レベル 0 のグリフ形式が %0. で、ネスト レベル 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 の場合、レンダリングされるグリフは実線の円になります。

箇条書き

箇条書きの配置の種類。

列挙型
BULLET_ALIGNMENT_UNSPECIFIED 箇条書きの配置が指定されていません。
START 箇条書きは、その表示用に割り当てられたスペースの先頭に合わせて配置されます。LTR テキストの場合は左揃え、それ以外の場合は右揃えになります。
CENTER 箇条書きは、その表示に使用されるスペースの中央に揃えられます。
END 箇条書きは、その表示用に割り当てられたスペースの端に揃えられます。LTR テキストは右揃え、それ以外の場合は左揃えになります。

グリフタイプ

このレベルのネストで段落が並べ替えられるときに、箇条書きで使用されるグリフの種類。

列挙型
GLYPH_TYPE_UNSPECIFIED グリフのタイプが指定されていないか、サポートされていません。
NONE 空の文字列。
DECIMAL 数値（1、2、3 など）。
ZERO_DECIMAL 1 桁の数字の前にゼロが付加された数字（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。

名前付き範囲

同じ名前付き範囲 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
}
フィールド
segmentId

string

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

integer

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

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

integer

この範囲のゼロから始まる終了インデックス。UTF-16 コードユニットで表します（その値を含まない）。

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

提案の表示モード

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

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

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

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

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

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

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)

このインライン オブジェクトの埋め込みオブジェクト。

埋め込みオブジェクト

ドキュメント内の埋め込みオブジェクト。

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

デフォルトの有効期間が 30 分の画像への URI。この 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

切り抜き枠の中心を中心とした時計回りの回転角度（ラジアン単位）。回転はオフセットの後に適用されます。

埋め込みオブジェクト ボーダー

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 表現 
{

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

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

スプレッドシートのグラフのリファレンス

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

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

boolean

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

boolean

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

object (CropPropertiesSuggestionState)

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

boolean

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

CropPropertiesSuggestionState

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

配置されたオブジェクト

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 への変更が提案されたかどうかを示します。

Methods

batchUpdate

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

create

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

get

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