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

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

出力専用。ドキュメント内のヘッダー（ヘッダー ID でキー設定）。

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

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

出力専用。ドキュメント内のフッター（フッター ID でキー設定）。

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

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

出力専用。ドキュメント内の脚注（脚注 ID でキーが設定されています）。

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

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

出力専用。ドキュメント内のインライン オブジェクト（オブジェクト ID をキーとする）。

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

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

出力専用。ドキュメント内の配置済みオブジェクト（オブジェクト ID をキーとする）。

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

本文の内容。

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

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

この構造要素の 0 ベースの開始インデックス（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

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

integer

この段落要素の終了インデックス（UTF-16 コード単位で、末尾を除く）。0 ベース。
共用体フィールド 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）。

ディメンション

指定された単位で、1 つの方向の振幅。

JSON 表現 
{
  "magnitude": number,
  "unit": enum (Unit)
}
フィールド
magnitude

number

大きさ。
unit

enum (Unit)

マグニチュードの単位。

ユニット

測定単位 を選択します。

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

WeightedFontFamily

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

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

string

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

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

integer

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

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

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

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

BaselineOffset

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

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

SuggestedTextStyle

TextStyle への変更の提案。

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

object (TextStyle)

この候補で行った変更のみを含む TextStyle。これは textStyleSuggestionState とともに使用して、変更されたフィールドとその新しい値を確認できます。
textStyleSuggestionState

object (TextStyleSuggestionState)

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

TextStyleSuggestionState

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

JSON 表現 
{
  "boldSuggested": boolean,
  "italicSuggested": boolean,
  "underlineSuggested": boolean,
  "strikethroughSuggested": boolean,
  "smallCapsSuggested": boolean,
  "backgroundColorSuggested": boolean,
  "foregroundColorSuggested": boolean,
  "fontSizeSuggested": boolean,
  "weightedFontFamilySuggested": boolean,
  "baselineOffsetSuggested": boolean,
  "linkSuggested": boolean
}
フィールド
boldSuggested

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

AutoText

テキスト内の位置を表す ParagraphElement。この位置は、時間の経過とともに変化するコンテンツ（ページ番号など）に動的に置き換えられます。

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

enum (Type)

この自動テキストのタイプ。
suggestedInsertionIds[]

string

推奨される挿入 ID。ネストされた推奨変更の場合、AutoText に複数の挿入 ID が設定されることがあります。空の場合、これは挿入の候補ではありません。
suggestedDeletionIds[]

string

削除候補の ID。空の場合、このコンテンツの削除は推奨されません。
textStyle

object (TextStyle)

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

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

候補のテキスト スタイルが、候補 ID でキー設定されたこの 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。たとえば、複数のユーザーが削除を提案した場合、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

段落の最後が 1 行になるか、1 行目になるかを指定します。設定されていない場合、値は親から継承されます。
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 第 5 版のパート 1「Office Open XML ファイル形式 - 基礎とマークアップ言語リファレンス」の 20.1.10.49 セクションで説明されている「ST_PresetLineDashVal」シンプル タイプに基づいています。

列挙型
DASH_STYLE_UNSPECIFIED 破線スタイルが指定されていません。
SOLID 実線。ECMA-376 ST_PresetLineDashVal 値「solid」に対応します。これがデフォルトのダッシュ スタイルです。
DOT 点線。ECMA-376 ST_PresetLineDashVal 値「dot」に対応します。
DASH 破線。ECMA-376 ST_PresetLineDashVal 値「dash」に対応します。

TabStop

段落内のタブストップ。

JSON 表現 
{
  "offset": {
    object (Dimension)
  },
  "alignment": enum (TabStopAlignment)
}
フィールド
offset

object (Dimension)

このタブストップと開始マージンの間のオフセット。
alignment

enum (TabStopAlignment)

このタブストップのアライメント。未設定の場合のデフォルト値は START です。

TabStopAlignment

タブストップのアライメント。

列挙型
TAB_STOP_ALIGNMENT_UNSPECIFIED タブストップ位置の配置が指定されていません。
START タブストップは行の先頭に揃えられます。これがデフォルトです。
CENTER タブストップは行の中央に揃えられます。
END タブストップは行の末尾に配置されます。

シェーディング

段落の網かけ。

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

object (OptionalColor)

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

SuggestedParagraphStyle

ParagraphStyle への変更の提案。

JSON 表現 
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}
フィールド
paragraphStyle

object (ParagraphStyle)

この候補で行った変更のみを含む ParagraphStyle。これは paragraphStyleSuggestionState とともに使用して、変更されたフィールドとその新しい値を確認できます。
paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

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

ParagraphStyleSuggestionState

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

JSON 表現 
{
  "headingIdSuggested": boolean,
  "namedStyleTypeSuggested": boolean,
  "alignmentSuggested": boolean,
  "lineSpacingSuggested": boolean,
  "directionSuggested": boolean,
  "spacingModeSuggested": boolean,
  "spaceAboveSuggested": boolean,
  "spaceBelowSuggested": boolean,
  "borderBetweenSuggested": boolean,
  "borderTopSuggested": boolean,
  "borderBottomSuggested": boolean,
  "borderLeftSuggested": boolean,
  "borderRightSuggested": boolean,
  "indentFirstLineSuggested": boolean,
  "indentStartSuggested": boolean,
  "indentEndSuggested": boolean,
  "keepLinesTogetherSuggested": boolean,
  "keepWithNextSuggested": boolean,
  "avoidWidowAndOrphanSuggested": boolean,
  "shadingSuggestionState": {
    object (ShadingSuggestionState)
  },
  "pageBreakBeforeSuggested": boolean
}
フィールド
headingIdSuggested

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

object (ShadingSuggestionState)

この候補で変更された shading のフィールドを示します。
pageBreakBeforeSuggested

boolean

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

ShadingSuggestionState

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

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

boolean

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

ブレット グラフ

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

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

string

この段落が属するリストの ID。
nestingLevel

integer

リスト内のこの段落のネストレベル。
textStyle

object (TextStyle)

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

SuggestedBullet

Bullet への変更の提案。

JSON 表現 
{
  "bullet": {
    object (Bullet)
  },
  "bulletSuggestionState": {
    object (BulletSuggestionState)
  }
}
フィールド
bullet

object (Bullet)

この候補で行った変更のみを含む Bullet。これは bulletSuggestionState とともに使用して、変更されたフィールドとその新しい値を確認できます。
bulletSuggestionState

object (BulletSuggestionState)

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

BulletSuggestionState

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

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

boolean

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

boolean

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

object (TextStyleSuggestionState)

この候補で変更された text style のフィールドを示します。

ObjectReferences

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

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

string

オブジェクト ID。

SectionBreak

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

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

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

string

推奨される挿入 ID。ネストされた推奨変更の場合、SectionBreak に複数の挿入 ID が設定されることがあります。空の場合、これは挿入の候補ではありません。
suggestedDeletionIds[]

string

削除候補の ID。空の場合、このコンテンツの削除は推奨されません。
sectionStyle

object (SectionStyle)

このセクション分割の後のセクションのスタイル。

SectionStyle

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

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

object (SectionColumnProperties)

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

空のセクションには、ドキュメント エディタのデフォルトのプロパティを含む列が 1 つあります。セクションを更新して、列を 3 つ以下にすることができます。

このプロパティを更新する場合は、具体的な値を設定する必要があります。このプロパティを設定解除すると、400 エラー（不正なリクエスト）が発生します。
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 の場合、この値はセクションの最初のページの footer に使用されます。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 の場合、この値はセクションの偶数ページの footer に使用されます。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

この行の終了インデックス（0 ベース、UTF-16 コード単位）。
tableCells[]

object (TableCell)

この行の各セルの内容とスタイル。

テーブルは長方形でない場合があるため、一部の行のセル数が同じテーブル内の他の行と異なる場合があります。
suggestedInsertionIds[]

string

推奨される挿入 ID。ネストされた推奨変更の場合、TableRow に複数の挿入 ID が設定されることがあります。空の場合、これは挿入の候補ではありません。
suggestedDeletionIds[]

string

削除候補の ID。空の場合、このコンテンツの削除は推奨されません。
tableRowStyle

object (TableRowStyle)

表の行のスタイル。
suggestedTableRowStyleChanges

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

推奨スタイルがこの行に変更され、候補 ID がキーになります。

TableCell

Table 内のセルの内容とスタイル。

JSON 表現 
{
  "startIndex": integer,
  "endIndex": integer,
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "suggestedTableCellStyleChanges": {
    string: {
      object (SuggestedTableCellStyle)
    },
    ...
  }
}
フィールド
startIndex

integer

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

integer

このセルの終了インデックス（0 ベース、UTF-16 コード単位）。
content[]

object (StructuralElement)

セルの内容。
tableCellStyle

object (TableCellStyle)

セルのスタイル。
suggestedInsertionIds[]

string

推奨される挿入 ID。ネストされた推奨変更の場合は、TableCell に複数の挿入 ID が設定されることがあります。空の場合、これは挿入の候補ではありません。
suggestedDeletionIds[]

string

削除候補の ID。空の場合、このコンテンツの削除は推奨されません。
suggestedTableCellStyleChanges

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

テーブル セルのスタイルに対する推奨される変更（候補 ID でキーが設定されています）。

TableCellStyle

TableCell のスタイル。

継承された表セルのスタイルは、このメッセージでは未設定のフィールドとして表されます。表セルのスタイルは、表のスタイルから継承できます。

JSON 表現 
{
  "rowSpan": integer,
  "columnSpan": integer,
  "backgroundColor": {
    object (OptionalColor)
  },
  "borderLeft": {
    object (TableCellBorder)
  },
  "borderRight": {
    object (TableCellBorder)
  },
  "borderTop": {
    object (TableCellBorder)
  },
  "borderBottom": {
    object (TableCellBorder)
  },
  "paddingLeft": {
    object (Dimension)
  },
  "paddingRight": {
    object (Dimension)
  },
  "paddingTop": {
    object (Dimension)
  },
  "paddingBottom": {
    object (Dimension)
  },
  "contentAlignment": enum (ContentAlignment)
}
フィールド
rowSpan

integer

セルの行範囲。

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

integer

セルの列スパンを指定します。

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

object (OptionalColor)

セルの背景色。
borderLeft

object (TableCellBorder)

セルの左枠線。
borderRight

object (TableCellBorder)

セルの右枠線。
borderTop

object (TableCellBorder)

セルの上部境界線。
borderBottom

object (TableCellBorder)

セルの下枠線。
paddingLeft

object (Dimension)

セルの左側のパディング。
paddingRight

object (Dimension)

セルの右側のパディング。
paddingTop

object (Dimension)

セルの上部パディング。
paddingBottom

object (Dimension)

セルの下部パディング。
contentAlignment

enum (ContentAlignment)

テーブルセル内のコンテンツの配置。デフォルトの配置は、ドキュメント エディタで新しく作成された表セルの配置と一致します。

TableCellBorder

テーブルセルの枠線。

表のセル境界を透明にすることはできません。テーブルのセル境界を非表示にするには、幅を 0 にします。

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

object (OptionalColor)

枠線の色。

この色は透明にできません。
width

object (Dimension)

枠線の幅。
dashStyle

enum (DashStyle)

枠線の破線スタイル。

ContentAlignment

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

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

列挙型
CONTENT_ALIGNMENT_UNSPECIFIED コンテンツの配置が指定されていない。コンテンツの配置は、親が存在する場合は親から継承されます。
CONTENT_ALIGNMENT_UNSUPPORTED サポートされていないコンテンツの配置。
TOP コンテンツをコンテンツ ホルダーの上部に揃える配置。ECMA-376 ST_TextAnchoringType の「t」に対応しています。
MIDDLE コンテンツ ホルダーの中央にコンテンツを配置する配置。ECMA-376 ST_TextAnchoringType の「ctr」に対応しています。
BOTTOM コンテンツ ホルダーの下部にコンテンツを配置する配置。ECMA-376 ST_TextAnchoringType の「b」に対応しています。

SuggestedTableCellStyle

TableCellStyle への変更の提案。

JSON 表現 
{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "tableCellStyleSuggestionState": {
    object (TableCellStyleSuggestionState)
  }
}
フィールド
tableCellStyle

object (TableCellStyle)

この候補で行った変更のみを含む TableCellStyle。これは tableCellStyleSuggestionState とともに使用して、変更されたフィールドとその新しい値を確認できます。
tableCellStyleSuggestionState

object (TableCellStyleSuggestionState)

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

TableCellStyleSuggestionState

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

JSON 表現 
{
  "rowSpanSuggested": boolean,
  "columnSpanSuggested": boolean,
  "backgroundColorSuggested": boolean,
  "borderLeftSuggested": boolean,
  "borderRightSuggested": boolean,
  "borderTopSuggested": boolean,
  "borderBottomSuggested": boolean,
  "paddingLeftSuggested": boolean,
  "paddingRightSuggested": boolean,
  "paddingTopSuggested": boolean,
  "paddingBottomSuggested": boolean,
  "contentAlignmentSuggested": boolean
}
フィールド
rowSpanSuggested

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

TableRowStyle

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

JSON 表現 
{
  "minRowHeight": {
    object (Dimension)
  },
  "tableHeader": boolean,
  "preventOverflow": boolean
}
フィールド
minRowHeight

object (Dimension)

行の最小高さ。行のセル内のすべてのコンテンツを表示するため、この値以上の高さで行がドキュメント エディタにレンダリングされます。
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 の値によって、偶数ページの footer に defaultFooterId を使用するか、この値を使用するかが決まります。設定しない場合、偶数ページの footer は表示されません。

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

A.

B.

C.

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

1.

2.

2.1.

2.2.

3.

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

object (Dimension)

このレベルのネストされた段落の 1 行目のインデントの量。
indentStart

object (Dimension)

このレベルのネストされた段落のインデントの量。段落のコンテンツの向きに基づいて、テキストの先頭に対応する側に適用されます。
textStyle

object (TextStyle)

このレベルのネストされた箇条書きのテキスト スタイル。
startNumber

integer

このネストレベルの最初のリストアイテムの数。

文字リストとローマ数字リストでは、値 0 は値 1 として扱われます。値が 0 と 1 の両方の場合、文字とローマ数字のリストはそれぞれ a と i から始まります。

順序付けられていないグリフを含むネストレベルの場合、この値は無視されます。
共用体フィールド glyph_kind。箇条書きで使用されるグリフの種類。これにより、glyph_format のプレースホルダに代わる箇条書き記号が定義されます。glyph_kind は次のいずれかになります。
glyphType

enum (GlyphType)

このレベルのネストされた段落が並べ替えられている場合に、箇条書きで使用されるグリフのタイプ。

グリフタイプは、このレベルのネストされた段落が並べ替えられるときに、glyphFormat 内のプレースホルダの置換に使用されるグリフのタイプを決定します。たとえば、ネストレベルが 0、glyphFormat が %0.、グリフタイプが DECIMAL の場合、レンダリングされたグリフでは、グリフ形式のプレースホルダ %0 が、リスト内のリストアイテムの順序に対応する数値に置き換えられます。
glyphSymbol

string

このレベルのネストされた段落が順序なしの場合に、箇条書きで使用されるカスタム グリフ記号。

グリフ記号は、glyphFormat 内のプレースホルダに置き換えられます。たとえば、glyphSymbol が Unicode U+25cf コードポイントに対応する実線の円で、glyphFormat が %0 の場合、レンダリングされるグリフは実線の円になります。

BulletAlignment

箇条書きの配置の種類。

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

GlyphType

このレベルのネストされた段落が並べ替えられている場合に、箇条書きで使用されるグリフのタイプ。

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

デフォルトの有効期間が 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

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

EmbeddedObjectBorder

EmbeddedObject の周囲の枠線。

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

object (OptionalColor)

枠線の色。
width

object (Dimension)

枠線の幅。
dashStyle

enum (DashStyle)

枠線の破線スタイル。
propertyState

enum (PropertyState)

境界プロパティのプロパティ状態。

PropertyState

宿泊施設の状態。

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

LinkedContentReference

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

JSON 表現 
{

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

[コントラスト] [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

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