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 に設定されている場合、Document.tabs.documentTab.documentStyle はすべてのタブの実際のドキュメント コンテンツを公開します。false または未設定の場合、このフィールドにはドキュメントの最初のタブに関する情報が含まれます。
suggestedDocumentStyleChanges

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

出力専用。ドキュメントのスタイルに対する提案された変更（提案 ID でキーが設定されています）。

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

object (NamedStyles)

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

従来フィールド: 代わりに Document.tabs.documentTab.namedStyles を使用してください。includeTabsContent パラメータが true に設定されている場合、Document.tabs.documentTab.namedStyles はすべてのタブの実際のドキュメント コンテンツを公開します。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 に設定されている場合、Document.tabs.documentTab.lists はすべてのタブの実際のドキュメント コンテンツを公開します。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 でキー設定されたこの AutoText に変更されます。

タイプ

自動テキストの種類。

列挙型
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。複数のユーザーが削除を提案した場合など、1 つの 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

線間のスペースの量（標準の割合）。標準は 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 不正なリクエスト エラーが返される可能性があります。

NamedStyleType

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

列挙型
NAMED_STYLE_TYPE_UNSPECIFIED 名前付きスタイルのタイプが指定されていません。
NORMAL_TEXT 標準テキスト。
TITLE タイトル。
SUBTITLE 字幕。
HEADING_1 見出し 1.
HEADING_2 見出し 2。
HEADING_3 見出し 3.
HEADING_4 見出し 4.
HEADING_5 見出し 5.
HEADING_6 見出し 6.

配置

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

列挙型
ALIGNMENT_UNSPECIFIED 段落のアライメントは親から継承されます。
START 段落は行の先頭に揃えられます。LTR テキストの場合は左揃え、それ以外の場合は右揃え。
CENTER 段落は中央に配置されます。
END 段落は行の末尾に揃えられます。LTR テキストの場合は右揃え、それ以外の場合は左揃え。
JUSTIFIED 段落が両端揃えになっています。

ContentDirection

コンテンツを流入できるルート。

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

SpacingMode

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

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

ParagraphBorder

段落の枠線。

JSON 表現 
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "padding": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}
フィールド
color

object (OptionalColor)

枠線の色。
width

object (Dimension)

枠線の幅。
padding

object (Dimension)

枠線のパディング。
dashStyle

enum (DashStyle)

枠線の破線スタイル。

DashStyle

線形ジオメトリをレンダリングできるダッシュの種類。これらの値は、ECMA-376 第 4 版のパート 1「Office Open XML ファイル形式 - 基礎とマークアップ言語リファレンス」の 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)

この段落のシャドウの背景色。

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

このセルの 0 ベースの開始インデックス（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

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

ECMA-376 第 4 版のパート 1「Office Open XML ファイル形式 - 基礎とマークアップ言語リファレンス」の 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' に対応します。

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 とフッター 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 の対応するグリフに置き換え、末尾にピリオドを追加することを示します。したがって、グリフタイプが 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 の場合、レンダリングされるグリフは実線の円になります。

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 桁以上の数値には先頭にゼロを付けません。
UPPER_ALPHA 大文字（A、B、C など）。
ALPHA 小文字（a、b、c など）。
UPPER_ROMAN ローマ数字（I、II、III など）。
ROMAN 小文字のローマ数字（i、ii、iii など）。

SuggestedListProperties

ListProperties への変更案。

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

object (ListProperties)

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

object (ListPropertiesSuggestionState)

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

ListPropertiesSuggestionState

この候補でベースの ListProperties のどのフィールドが変更されたかを示します。true に設定されたフィールドには、新しい推奨値が表示されます。

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

object (NestingLevelSuggestionState)

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

ネスト レベルの候補の状態は、ネスト レベルの昇順で返され、最もネストされていないものが最初に返されます。

NestingLevelSuggestionState

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

JSON 表現 
{
  "bulletAlignmentSuggested": boolean,
  "glyphTypeSuggested": boolean,
  "glyphFormatSuggested": boolean,
  "glyphSymbolSuggested": boolean,
  "indentFirstLineSuggested": boolean,
  "indentStartSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  },
  "startNumberSuggested": boolean
}
フィールド
bulletAlignmentSuggested

boolean

bulletAlignment に変更が提案されたかどうかを示します。
glyphTypeSuggested

boolean

glyphType への変更が提案されたかどうかを示します。
glyphFormatSuggested

boolean

glyphFormat への変更が提案されたかどうかを示します。
glyphSymbolSuggested

boolean

glyphSymbol への変更が提案されたかどうかを示します。
indentFirstLineSuggested

boolean

indentFirstLine に変更が提案されたかどうかを示します。
indentStartSuggested

boolean

indentStart に変更が提案されているかどうかを示します。
textStyleSuggestionState

object (TextStyleSuggestionState)

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

boolean

startNumber への変更が提案されたかどうかを示します。

NamedRanges

指定された名前を共有するドキュメント内のすべての NamedRange のコレクション。

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

string

すべての named ranges が共有する名前。
namedRanges[]

object (NamedRange)

同じ名前を共有する NamedRange。

NamedRange

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

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

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

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

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

string

名前付き範囲の ID。
name

string

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

object (Range)

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

範囲

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

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

string

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

integer

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

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

integer

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

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

string

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

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

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

  • 省略した場合、リクエストは単一のタブに適用されます。

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

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

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

InlineObject

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

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

string

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

object (InlineObjectProperties)

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

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

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

string

提案された挿入 ID。空の場合、挿入は推奨されません。
suggestedDeletionIds[]

string

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

InlineObjectProperties

InlineObject のプロパティ。

JSON 表現 
{
  "embeddedObject": {
    object (EmbeddedObject)
  }
}
フィールド
embeddedObject

object (EmbeddedObject)

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

EmbeddedObject

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

JSON 表現 
{
  "title": string,
  "description": string,
  "embeddedObjectBorder": {
    object (EmbeddedObjectBorder)
  },
  "size": {
    object (Size)
  },
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "linkedContentReference": {
    object (LinkedContentReference)
  },

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

number

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

number

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

number

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

number

オフセットは、切り抜き長方形の下端が元のコンテンツの下端からどの程度内側にあるかを、元のコンテンツの高さの比率で指定します。
angle

number

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

EmbeddedObjectBorder

EmbeddedObject の周囲の枠線。

JSON 表現 
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle),
  "propertyState": enum (PropertyState)
}
フィールド
color

object (OptionalColor)

枠線の色。
width

object (Dimension)

枠線の幅。
dashStyle

enum (DashStyle)

枠線の破線スタイル。
propertyState

enum (PropertyState)

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

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