- リソース: ドキュメント
- Tab
- TabProperties
- DocumentTab
- 本文
- StructuralElement
- Paragraph
- ParagraphElement
- TextRun
- TextStyle
- OptionalColor
- Color
- RgbColor
- ディメンション
- 単位
- WeightedFontFamily
- BaselineOffset
- リンク
- BookmarkLink
- HeadingLink
- SuggestedTextStyle
- TextStyleSuggestionState
- AutoText
- 型
- PageBreak
- ColumnBreak
- FootnoteReference
- HorizontalRule
- 方程式
- InlineObjectElement
- Person
- PersonProperties
- RichLink
- RichLinkProperties
- ParagraphStyle
- NamedStyleType
- アライメント
- ContentDirection
- SpacingMode
- ParagraphBorder
- DashStyle
- TabStop
- TabStopAlignment
- シェーディング
- SuggestedParagraphStyle
- ParagraphStyleSuggestionState
- ShadingSuggestionState
- Bullet
- SuggestedBullet
- BulletSuggestionState
- ObjectReferences
- SectionBreak
- SectionStyle
- SectionColumnProperties
- ColumnSeparatorStyle
- SectionType
- Table
- TableRow
- TableCell
- TableCellStyle
- TableCellBorder
- ContentAlignment
- SuggestedTableCellStyle
- TableCellStyleSuggestionState
- TableRowStyle
- SuggestedTableRowStyle
- TableRowStyleSuggestionState
- TableStyle
- TableColumnProperties
- WidthType
- TableOfContents
- ヘッダー
- Footer
- 脚注
- DocumentStyle
- 背景
- サイズ
- DocumentFormat
- DocumentMode
- SuggestedDocumentStyle
- DocumentStyleSuggestionState
- BackgroundSuggestionState
- SizeSuggestionState
- NamedStyles
- NamedStyle
- SuggestedNamedStyles
- NamedStylesSuggestionState
- NamedStyleSuggestionState
- リスト
- ListProperties
- NestingLevel
- BulletAlignment
- GlyphType
- SuggestedListProperties
- ListPropertiesSuggestionState
- NestingLevelSuggestionState
- NamedRanges
- NamedRange
- 範囲
- InlineObject
- InlineObjectProperties
- EmbeddedObject
- EmbeddedDrawingProperties
- ImageProperties
- CropProperties
- EmbeddedObjectBorder
- PropertyState
- LinkedContentReference
- SheetsChartReference
- SuggestedInlineObjectProperties
- InlineObjectPropertiesSuggestionState
- EmbeddedObjectSuggestionState
- EmbeddedDrawingPropertiesSuggestionState
- ImagePropertiesSuggestionState
- CropPropertiesSuggestionState
- EmbeddedObjectBorderSuggestionState
- LinkedContentReferenceSuggestionState
- SheetsChartReferenceSuggestionState
- PositionedObject
- PositionedObjectProperties
- PositionedObjectPositioning
- PositionedObjectLayout
- SuggestedPositionedObjectProperties
- PositionedObjectPropertiesSuggestionState
- PositionedObjectPositioningSuggestionState
- SuggestionsViewMode
- メソッド
リソース: ドキュメント
Google ドキュメントのドキュメント。
JSON 表現 |
---|
{ "documentId": string, "title": string, "tabs": [ { object ( |
フィールド | |
---|---|
documentId |
出力専用。ドキュメントの ID。 |
title |
ドキュメントのタイトル。 |
tabs[] |
ドキュメントの一部であるタブ。 タブには子タブ(別のタブ内にネストされたタブ)を含めることができます。子タブは |
revisionId |
出力専用。ドキュメントのリビジョン ID。更新リクエストで使用して、ドキュメントのどのリビジョンに更新を適用するか、そのリビジョン以降にドキュメントが編集された場合にリクエストがどのように動作するかを指定できます。ユーザーがドキュメントの編集権限を持っている場合にのみ入力されます。 リビジョン ID は連番ではなく、不透明な文字列です。リビジョン ID の形式は今後変更される可能性があります。返されたリビジョン ID は、返されてから 24 時間のみ有効であることが保証されており、ユーザー間で共有することはできません。呼び出し間でリビジョン ID が変更されていない場合、ドキュメントは変更されていません。逆に、同じドキュメントとユーザーで ID が変更された場合は、通常、ドキュメントが更新されたことを意味します。ただし、ID の変更は、ID 形式の変更などの内部要因による場合もあります。 |
suggestionsViewMode |
出力専用。ドキュメントに適用された提案ビューモード。 注: ドキュメントを編集する場合、変更は |
body |
出力専用。ドキュメントの本文。 以前のフィールド: 代わりに |
headers |
出力専用。ドキュメント内のヘッダー。ヘッダー ID でキー設定されます。 以前のフィールド: 代わりに |
footers |
出力専用。ドキュメントのフッター。フッター ID でキー設定されます。 以前のフィールド: 代わりに |
footnotes |
出力専用。ドキュメント内の脚注。脚注 ID をキーとして使用します。 以前のフィールド: 代わりに |
documentStyle |
出力専用。ドキュメントのスタイル。 以前のフィールド: 代わりに |
suggestedDocumentStyleChanges |
出力専用。提案 ID をキーとする、ドキュメントのスタイルの変更案。 以前のフィールド: 代わりに |
namedStyles |
出力専用。ドキュメントの名前付きスタイル。 以前のフィールド: 代わりに |
suggestedNamedStylesChanges |
出力専用。ドキュメントの命名済みスタイルに対する提案された変更。提案 ID をキーとして使用します。 以前のフィールド: 代わりに |
lists |
出力専用。ドキュメント内のリスト。リスト ID でキー設定されます。 以前のフィールド: 代わりに |
namedRanges |
出力専用。ドキュメント内の名前付き範囲。名前をキーとして使用します。 以前のフィールド: 代わりに |
inlineObjects |
出力専用。ドキュメント内のインライン オブジェクト。オブジェクト ID をキーとしています。 以前のフィールド: 代わりに |
positionedObjects |
出力専用。ドキュメント内の配置されたオブジェクト。オブジェクト ID をキーとしています。 以前のフィールド: 代わりに |
Tab
ドキュメント内のタブ。
JSON 表現 |
---|
{ "tabProperties": { object ( |
フィールド | |
---|---|
tabProperties |
タブのプロパティ(ID やタイトルなど)。 |
childTabs[] |
このタブ内にネストされた子タブ。 |
共用体フィールド content 。タブの内容。content は次のいずれかになります。 |
|
documentTab |
テキストや画像などのドキュメント コンテンツを含むタブ。 |
TabProperties
タブのプロパティ。
JSON 表現 |
---|
{ "tabId": string, "title": string, "parentTabId": string, "index": integer, "nestingLevel": integer } |
フィールド | |
---|---|
tabId |
出力専用。タブの ID。このフィールドは変更できません。 |
title |
ユーザーに表示されるタブの名前。 |
parentTabId |
省略可。親タブの ID。現在のタブがルートレベルのタブ(親がないタブ)の場合、空になります。 |
index |
親内のタブの 0 から始まるインデックス。 |
nestingLevel |
出力専用。ドキュメント内のタブの深さ。ルートレベルのタブは 0 から始まります。 |
DocumentTab
ドキュメントの内容が表示されたタブ。
JSON 表現 |
---|
{ "body": { object ( |
フィールド | |
---|---|
body |
ドキュメント タブのメインの本文。 |
headers |
ドキュメント タブのヘッダー。ヘッダー ID でキー設定されます。 |
footers |
ドキュメント タブのフッター。フッター ID でキー設定されます。 |
footnotes |
ドキュメント タブの脚注。脚注 ID でキー設定されています。 |
documentStyle |
ドキュメント タブのスタイル。 |
suggestedDocumentStyleChanges |
ドキュメント タブのスタイルの変更案。提案 ID をキーとしています。 |
namedStyles |
ドキュメント タブの名前付きスタイル。 |
suggestedNamedStylesChanges |
提案 ID をキーとする、ドキュメント タブの名前付きスタイルに対する提案された変更。 |
lists |
ドキュメント タブのリスト。リスト ID でキー設定されます。 |
namedRanges |
ドキュメント タブの名前付き範囲。名前でキー設定されます。 |
inlineObjects |
ドキュメント タブのインライン オブジェクト。オブジェクト ID をキーとします。 |
positionedObjects |
ドキュメント タブ内の配置されたオブジェクト。オブジェクト ID をキーとしています。 |
本文
ドキュメントの本文。
JSON 表現 |
---|
{
"content": [
{
object ( |
フィールド | |
---|---|
content[] |
本文の内容。 本文のコンテンツのインデックスは 0 から始まります。 |
StructuralElement
StructuralElement は、ドキュメントの構造を提供するコンテンツを表します。
JSON 表現 |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
フィールド | |
---|---|
startIndex |
この構造要素の 0 ベースの開始インデックス(UTF-16 コード単位)。 |
endIndex |
この構造要素の 0 から始まる終了インデックス(排他的、UTF-16 コード単位)。 |
共用体フィールド content 。構造要素の内容。content は次のいずれかになります。 |
|
paragraph |
段落タイプの構造要素。 |
sectionBreak |
構造要素のセクション区切りタイプ。 |
table |
構造要素のテーブルタイプ。 |
tableOfContents |
目次タイプの構造要素。 |
段落
段落を表す StructuralElement
。段落は、改行文字で終わるコンテンツの範囲です。
JSON 表現 |
---|
{ "elements": [ { object ( |
フィールド | |
---|---|
elements[] |
段落の内容を構成要素に分解したものです。 |
paragraphStyle |
この段落のスタイル。 |
suggestedParagraphStyleChanges |
この段落に適用する段落スタイルの候補の変更。候補 ID をキーとします。 |
bullet |
この段落の箇条書き。存在しない場合、段落はリストに属しません。 |
suggestedBulletChanges |
この段落の箇条書きに対する提案された変更。 |
positionedObjectIds[] |
この段落に固定されている配置オブジェクトの ID。 |
suggestedPositionedObjectIds |
この段落に添付することが推奨される位置指定オブジェクトの ID。提案 ID をキーとして使用します。 |
ParagraphElement
ParagraphElement は Paragraph
内のコンテンツを記述します。
JSON 表現 |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
フィールド | |
---|---|
startIndex |
この段落要素の 0 ベースの開始インデックス(UTF-16 コード単位)。 |
endIndex |
この段落要素の 0 ベースの終了インデックス(排他的、UTF-16 コード単位)。 |
共用体フィールド content 。段落要素の内容。content は次のいずれかになります。 |
|
textRun |
テキスト実行の段落要素。 |
autoText |
自動テキストの段落要素。 |
pageBreak |
改ページ段落要素。 |
columnBreak |
段組みの区切り段落要素。 |
footnoteReference |
脚注の出典の段落要素。 |
horizontalRule |
水平ルール段落要素。 |
equation |
数式段落要素。 |
inlineObjectElement |
インライン オブジェクトの段落要素。 |
person |
人物またはメールアドレスにリンクする段落要素。 |
richLink |
Google リソース(Google ドライブのファイル、YouTube 動画、カレンダーの予定など)にリンクする段落要素。 |
TextRun
すべて同じスタイル設定のテキストの実行を表す ParagraphElement
。
JSON 表現 |
---|
{ "content": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
フィールド | |
---|---|
content |
この実行のテキスト。 実行内のテキスト以外の要素は、Unicode 文字 U+E907 に置き換えられます。 |
suggestedInsertionIds[] |
提案された挿入 ID。 |
suggestedDeletionIds[] |
削除 ID の候補。空の場合、このコンテンツの削除候補はありません。 |
textStyle |
この実行のテキスト スタイル。 |
suggestedTextStyleChanges |
候補のテキスト スタイルがこの実行に変更されます。候補 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 ( |
フィールド | |
---|---|
bold |
テキストが太字でレンダリングされるかどうか。 |
italic |
テキストが斜体かどうか。 |
underline |
テキストに下線が引かれているかどうか。 |
strikethrough |
テキストに取り消し線が引かれているかどうか。 |
smallCaps |
テキストがスモール キャップであるかどうか。 |
backgroundColor |
テキストの背景色。設定されている場合、色は |
foregroundColor |
テキストの前景色。設定されている場合、色は |
fontSize |
テキストのフォントサイズ。 |
weightedFontFamily |
テキストのフォント ファミリーとレンダリングされた太さ。 更新リクエストで
|
baselineOffset |
テキストの通常の位置からの垂直オフセット。
|
link |
テキストのハイパーリンクの宛先。設定されていない場合、リンクはありません。リンクは親テキストから継承されません。 更新リクエストでリンクを変更すると、範囲のテキスト スタイルに次のような変更が加えられます。
|
OptionalColor
完全に不透明または完全に透明にできる色。
JSON 表現 |
---|
{
"color": {
object ( |
フィールド | |
---|---|
color |
設定されている場合、不透明な色として使用されます。設定されていない場合、これは透明な色を表します。 |
色
単色。
JSON 表現 |
---|
{
"rgbColor": {
object ( |
フィールド | |
---|---|
rgbColor |
RGB カラー値。 |
RgbColor
RGB カラー。
JSON 表現 |
---|
{ "red": number, "green": number, "blue": number } |
フィールド | |
---|---|
red |
色の赤成分(0.0 ~ 1.0)。 |
green |
色の緑のコンポーネント(0.0 ~ 1.0)。 |
blue |
色の青成分(0.0 ~ 1.0)。 |
ディメンション
指定された単位での単一方向の大きさ。
JSON 表現 |
---|
{
"magnitude": number,
"unit": enum ( |
フィールド | |
---|---|
magnitude |
大きさ。 |
unit |
マグニチュードの単位。 |
ユニット
測定単位 を選択します。
列挙型 | |
---|---|
UNIT_UNSPECIFIED |
単位は不明です。 |
PT |
ポイント(1/72 インチ)。 |
WeightedFontFamily
テキストのフォント ファミリーとウェイトを表します。
JSON 表現 |
---|
{ "fontFamily": string, "weight": integer } |
フィールド | |
---|---|
fontFamily |
テキストのフォント ファミリー。 フォント ファミリーには、ドキュメントの [フォント] メニューまたは Google Fonts の任意のフォントを使用できます。フォント名が認識されない場合、テキストは |
weight |
フォントの太さ。このフィールドには、 デフォルト値は フォントの太さは、レンダリングされたフォントの太さの 1 つのコンポーネントにすぎません。
|
BaselineOffset
テキストを通常の配置位置から垂直方向にオフセットする方法。
列挙型 | |
---|---|
BASELINE_OFFSET_UNSPECIFIED |
テキストのベースライン オフセットは親から継承されます。 |
NONE |
テキストは垂直方向にオフセットされません。 |
SUPERSCRIPT |
テキストが上方向に垂直にオフセットされます(上付き文字)。 |
SUBSCRIPT |
テキストが下方向に垂直にオフセットされます(下付き文字)。 |
リンク
ドキュメントの別の部分または外部 URL リソースへの参照。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド destination 。リンク先。destination は次のいずれかになります。 |
|
url |
外部 URL。 |
tabId |
このドキュメント内のタブの ID。 |
bookmark |
このドキュメント内のブックマーク。 タブが 1 つのみのドキュメントでは、 |
heading |
このドキュメント内の見出し。 タブが 1 つのみのドキュメントでは、 |
bookmarkId |
このドキュメント内のブックマークの ID。 以前のフィールド: 代わりに、 このフィールドが書き込みリクエストで使用されている場合、ブックマークはリクエストで指定されたタブ ID からのものと見なされます。リクエストでタブ ID が指定されていない場合、ドキュメントの最初のタブからのリクエストと見なされます。 |
headingId |
このドキュメント内の見出しの ID。 以前のフィールド: 代わりに、 このフィールドが書き込みリクエストで使用されている場合、見出しはリクエストで指定されたタブ ID から取得されたものと見なされます。リクエストでタブ ID が指定されていない場合、ドキュメントの最初のタブからのリクエストと見なされます。 |
BookmarkLink
このドキュメント内のブックマークへの参照。
JSON 表現 |
---|
{ "id": string, "tabId": string } |
フィールド | |
---|---|
id |
このドキュメント内のブックマークの ID。 |
tabId |
このブックマークを含むタブの ID。 |
HeadingLink
このドキュメント内の見出しへの参照。
JSON 表現 |
---|
{ "id": string, "tabId": string } |
フィールド | |
---|---|
id |
このドキュメント内の見出しの ID。 |
tabId |
この見出しを含むタブの ID。 |
SuggestedTextStyle
TextStyle
に対する提案された変更。
JSON 表現 |
---|
{ "textStyle": { object ( |
フィールド | |
---|---|
textStyle |
この提案で行われた変更のみを含む |
textStyleSuggestionState |
この提案でベース |
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 |
|
italicSuggested |
|
underlineSuggested |
|
strikethroughSuggested |
|
smallCapsSuggested |
|
backgroundColorSuggested |
|
foregroundColorSuggested |
|
fontSizeSuggested |
|
weightedFontFamilySuggested |
|
baselineOffsetSuggested |
|
linkSuggested |
|
AutoText
テキスト内のスポットを表す ParagraphElement
。このスポットは、ページ番号など、時間の経過とともに変化する可能性のあるコンテンツに動的に置き換えられます。
JSON 表現 |
---|
{ "type": enum ( |
フィールド | |
---|---|
type |
この自動テキストのタイプ。 |
suggestedInsertionIds[] |
提案された挿入 ID。 |
suggestedDeletionIds[] |
削除 ID の候補。空の場合、このコンテンツの削除候補はありません。 |
textStyle |
この AutoText のテキスト スタイル。 |
suggestedTextStyleChanges |
候補のテキスト スタイルが、候補 ID をキーとするこの自動テキストに変更されます。 |
タイプ
自動テキストの種類。
列挙型 | |
---|---|
TYPE_UNSPECIFIED |
未指定の自動テキスト タイプ。 |
PAGE_NUMBER |
現在のページ番号を表す自動テキストのタイプ。 |
PAGE_COUNT |
ドキュメントの総ページ数を表す自動テキストのタイプ。 |
PageBreak
改ページを表す ParagraphElement
。改ページを挿入すると、次のページの上部からテキストが開始されます。
JSON 表現 |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
フィールド | |
---|---|
suggestedInsertionIds[] |
提案された挿入 ID。 |
suggestedDeletionIds[] |
削除 ID の候補。空の場合、このコンテンツの削除候補はありません。 |
textStyle |
この PageBreak のテキスト スタイル。 テキスト コンテンツ(テキスト実行や脚注参照など)と同様に、改ページのテキスト スタイルは、コンテンツ レイアウトと、その横に挿入されたテキストのスタイル設定に影響を与える可能性があります。 |
suggestedTextStyleChanges |
提案されたテキスト スタイルがこの PageBreak に変更されます。提案 ID でキー設定されます。 |
ColumnBreak
列区切りを表す ParagraphElement
。段区切りを使用すると、後続のテキストが次の段の先頭から始まります。
JSON 表現 |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
フィールド | |
---|---|
suggestedInsertionIds[] |
提案された挿入 ID。 |
suggestedDeletionIds[] |
削除 ID の候補。空の場合、このコンテンツの削除候補はありません。 |
textStyle |
この ColumnBreak のテキスト スタイル。 テキスト コンテンツ(テキスト実行や脚注参照など)と同様に、段区切りのテキスト スタイルは、コンテンツ レイアウトと、その横に挿入されるテキストのスタイル設定に影響を与える可能性があります。 |
suggestedTextStyleChanges |
提案されたテキスト スタイルがこの ColumnBreak に変更され、提案 ID でキー設定されます。 |
FootnoteReference
脚注の参照を表す ParagraphElement
。脚注参照は、番号付きでレンダリングされるインライン コンテンツで、脚注を識別するために使用されます。
JSON 表現 |
---|
{ "footnoteId": string, "footnoteNumber": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
フィールド | |
---|---|
footnoteId |
この脚注参照のコンテンツを含む |
footnoteNumber |
この脚注のレンダリングされた番号。 |
suggestedInsertionIds[] |
提案された挿入 ID。 |
suggestedDeletionIds[] |
削除 ID の候補。空の場合、このコンテンツの削除候補はありません。 |
textStyle |
この FootnoteReference のテキスト スタイル。 |
suggestedTextStyleChanges |
提案されたテキスト スタイルが、提案 ID をキーとするこの FootnoteReference に変更されます。 |
HorizontalRule
水平線を表す ParagraphElement
。
JSON 表現 |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
フィールド | |
---|---|
suggestedInsertionIds[] |
提案された挿入 ID。 |
suggestedDeletionIds[] |
削除 ID の候補。空の場合、このコンテンツの削除候補はありません。 |
textStyle |
この HorizontalRule のテキスト スタイル。 テキスト コンテンツ(テキスト実行や脚注参照など)と同様に、水平ルールのテキスト スタイルは、コンテンツ レイアウトと、その横に挿入されたテキストのスタイル設定に影響を与える可能性があります。 |
suggestedTextStyleChanges |
提案されたテキスト スタイルが、提案 ID をキーとするこの HorizontalRule に変更されます。 |
計算式
方程式を表す ParagraphElement
。
JSON 表現 |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ] } |
フィールド | |
---|---|
suggestedInsertionIds[] |
提案された挿入 ID。 |
suggestedDeletionIds[] |
削除 ID の候補。空の場合、このコンテンツの削除候補はありません。 |
InlineObjectElement
JSON 表現 |
---|
{ "inlineObjectId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
フィールド | |
---|---|
inlineObjectId |
この要素に含まれる |
suggestedInsertionIds[] |
提案された挿入 ID。 |
suggestedDeletionIds[] |
削除 ID の候補。空の場合、このコンテンツの削除候補はありません。 |
textStyle |
この InlineObjectElement のテキスト スタイル。 テキスト コンテンツ(テキスト実行や脚注参照など)と同様に、インライン オブジェクト要素のテキスト スタイルは、コンテンツ レイアウトと、その横に挿入されるテキストのスタイル設定に影響を与える可能性があります。 |
suggestedTextStyleChanges |
提案されたテキスト スタイルが、提案 ID をキーとするこの InlineObject に変更されます。 |
人物
ドキュメント内で言及されているユーザーまたはメールアドレス。これらのメンションは、ユーザーの名前またはメールアドレスを含む単一の不変要素として機能します。
JSON 表現 |
---|
{ "personId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
フィールド | |
---|---|
personId |
出力専用。このリンクの一意の ID。 |
suggestedInsertionIds[] |
この人物リンクをドキュメントに挿入する候補の ID。 |
suggestedDeletionIds[] |
ドキュメントからこのユーザーリンクを削除する候補の ID。たとえば、複数のユーザーが |
textStyle |
この |
suggestedTextStyleChanges |
候補のテキスト スタイルが、候補 ID をキーとしてこの |
personProperties |
出力専用。この |
PersonProperties
リンクされた Person
に固有のプロパティ。
JSON 表現 |
---|
{ "name": string, "email": string } |
フィールド | |
---|---|
name |
リンク テキストにメールアドレスではなく名前が表示されている場合は、その名前。 |
email |
この |
RichLink
Google リソース(ドライブのファイル、YouTube 動画、カレンダーの予定など)へのリンク。
JSON 表現 |
---|
{ "richLinkId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
フィールド | |
---|---|
richLinkId |
出力専用。このリンクの ID。 |
suggestedInsertionIds[] |
このリンクをドキュメントに挿入する候補の ID。 |
suggestedDeletionIds[] |
ドキュメントからこのリンクを削除する候補の ID。たとえば、複数のユーザーが |
textStyle |
この |
suggestedTextStyleChanges |
候補のテキスト スタイルが、候補 ID をキーとしてこの |
richLinkProperties |
出力専用。この |
RichLinkProperties
RichLink
に固有のプロパティ。
JSON 表現 |
---|
{ "title": string, "uri": string, "mimeType": string } |
フィールド | |
---|---|
title |
出力専用。リンクに表示される |
uri |
出力専用。 |
mimeType |
|
ParagraphStyle
段落全体に適用されるスタイル。
継承された段落スタイルは、このメッセージでは設定されていないフィールドとして表されます。段落スタイルの親は、段落スタイルが定義されている場所によって異なります。
Paragraph
の ParagraphStyle は、段落の対応するnamed style type
から継承されます。named style
の ParagraphStyle は、normal text
という名前のスタイルから継承されます。normal text
という名前のスタイルの ParagraphStyle は、ドキュメント エディタのデフォルトの段落スタイルから継承されます。- テーブルに含まれる
Paragraph
要素の ParagraphStyle は、テーブル スタイルから段落スタイルを継承できます。
段落スタイルが親から継承されていない場合、フィールドの設定を解除すると、スタイルはドキュメント エディタのデフォルト値と一致する値に戻ります。
JSON 表現 |
---|
{ "headingId": string, "namedStyleType": enum ( |
フィールド | |
---|---|
headingId |
段落の見出し ID。空の場合、この段落は見出しではありません。 このプロパティは読み取り専用です。 |
namedStyleType |
段落の名前付きスタイル タイプ。 名前付きスタイルタイプの更新は ParagraphStyle 内の他のプロパティに影響するため、名前付きスタイルタイプは他のプロパティが更新される前に適用されます。 |
alignment |
この段落のテキストの配置。 |
lineSpacing |
行間のスペースの量。通常の行間のスペースを 100.0 とした場合の割合で表します。設定されていない場合、値は親から継承されます。 |
direction |
この段落のテキストの方向。設定されていない場合、段落の方向は継承されないため、値はデフォルトで |
spacingMode |
段落のスペーシング モード。 |
spaceAbove |
段落の上の余白の量。設定されていない場合、値は親から継承されます。 |
spaceBelow |
段落の下に追加するスペースの量。設定されていない場合、値は親から継承されます。 |
borderBetween |
この段落と次の段落、前の段落の間の境界線。設定されていない場合、値は親から継承されます。 隣接する段落の境界線とインデントのプロパティが同じ場合、境界線がレンダリングされます。 段落の境界線は部分的に更新できません。段落の境界線を変更する場合は、新しい境界線を完全に指定する必要があります。 |
borderTop |
この段落の上部の境界線。設定されていない場合、値は親から継承されます。 上の段落の境界線とインデントのプロパティが異なる場合、上部の境界線がレンダリングされます。 段落の境界線は部分的に更新できません。段落の境界線を変更する場合は、新しい境界線を完全に指定する必要があります。 |
borderBottom |
この段落の下の枠線。設定されていない場合、値は親から継承されます。 下の段落の境界線とインデントのプロパティが異なる場合、下部の境界線がレンダリングされます。 段落の境界線は部分的に更新できません。段落の境界線を変更する場合は、新しい境界線を完全に指定する必要があります。 |
borderLeft |
この段落の左側の枠線。設定されていない場合、値は親から継承されます。 段落の境界線は部分的に更新できません。段落の境界線を変更する場合は、新しい境界線を完全に指定する必要があります。 |
borderRight |
この段落の右側の枠線。設定されていない場合、値は親から継承されます。 段落の境界線は部分的に更新できません。段落の境界線を変更する場合は、新しい境界線を完全に指定する必要があります。 |
indentFirstLine |
段落の 1 行目のインデントの量。設定されていない場合、値は親から継承されます。 |
indentStart |
現在の段落の方向に基づいて、テキストの開始に対応する側の段落のインデント量。設定されていない場合、値は親から継承されます。 |
indentEnd |
現在の段落の方向に基づいて、テキストの末尾に対応する側の段落のインデント量。設定されていない場合、値は親から継承されます。 |
tabStops[] |
この段落のタブストップのリスト。タブストップのリストは継承されません。 このプロパティは読み取り専用です。 |
keepLinesTogether |
段落のすべての行を可能な限り同じページまたは列に配置するかどうかを指定します。設定されていない場合、値は親から継承されます。 |
keepWithNext |
この段落の少なくとも一部を、次の段落と同じページまたは列に配置するかどうかを指定します。設定されていない場合、値は親から継承されます。 |
avoidWidowAndOrphan |
段落の孤立語と孤立行を回避するかどうか。設定されていない場合、値は親から継承されます。 |
shading |
段落の網かけ。設定されていない場合、値は親から継承されます。 |
pageBreakBefore |
現在の段落を常にページの先頭から開始するかどうか。設定されていない場合、値は親から継承されます。
|
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 ( |
フィールド | |
---|---|
color |
枠線の色。 |
width |
枠線の幅。 |
padding |
枠線のパディング。 |
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 ( |
フィールド | |
---|---|
offset |
このタブストップと開始マージンの間のオフセット。 |
alignment |
このタブストップの配置。設定されていない場合、値はデフォルトで |
TabStopAlignment
タブストップの配置。
列挙型 | |
---|---|
TAB_STOP_ALIGNMENT_UNSPECIFIED |
タブストップの配置が指定されていません。 |
START |
タブストップは行の先頭に揃えられます。これがデフォルトです。 |
CENTER |
タブストップは行の中央に揃えられます。 |
END |
タブストップは行の末尾に配置されます。 |
シェーディング
段落の網かけ。
JSON 表現 |
---|
{
"backgroundColor": {
object ( |
フィールド | |
---|---|
backgroundColor |
この段落の網かけの背景色。 |
SuggestedParagraphStyle
ParagraphStyle
に対する提案された変更。
JSON 表現 |
---|
{ "paragraphStyle": { object ( |
フィールド | |
---|---|
paragraphStyle |
この提案で行われた変更のみを含む |
paragraphStyleSuggestionState |
この提案でベース |
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 ( |
フィールド | |
---|---|
headingIdSuggested |
|
namedStyleTypeSuggested |
|
alignmentSuggested |
|
lineSpacingSuggested |
|
directionSuggested |
|
spacingModeSuggested |
|
spaceAboveSuggested |
|
spaceBelowSuggested |
|
borderBetweenSuggested |
|
borderTopSuggested |
|
borderBottomSuggested |
|
borderLeftSuggested |
|
borderRightSuggested |
|
indentFirstLineSuggested |
|
indentStartSuggested |
|
indentEndSuggested |
|
keepLinesTogetherSuggested |
|
keepWithNextSuggested |
|
avoidWidowAndOrphanSuggested |
|
shadingSuggestionState |
この候補で |
pageBreakBeforeSuggested |
|
ShadingSuggestionState
この提案された変更でベース Shading
のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。
JSON 表現 |
---|
{ "backgroundColorSuggested": boolean } |
フィールド | |
---|---|
backgroundColorSuggested |
|
ブレット グラフ
段落の箇条書きを記述します。
JSON 表現 |
---|
{
"listId": string,
"nestingLevel": integer,
"textStyle": {
object ( |
フィールド | |
---|---|
listId |
この段落が属するリストの ID。 |
nestingLevel |
リスト内のこの段落のネストレベル。 |
textStyle |
この箇条書きに適用される段落固有のテキスト スタイル。 |
SuggestedBullet
Bullet
に対する提案された変更。
JSON 表現 |
---|
{ "bullet": { object ( |
フィールド | |
---|---|
bullet |
この提案で行われた変更のみを含む |
bulletSuggestionState |
この提案でベース |
BulletSuggestionState
この提案でベース Bullet
のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。
JSON 表現 |
---|
{
"listIdSuggested": boolean,
"nestingLevelSuggested": boolean,
"textStyleSuggestionState": {
object ( |
フィールド | |
---|---|
listIdSuggested |
|
nestingLevelSuggested |
|
textStyleSuggestionState |
この候補で |
ObjectReferences
オブジェクト ID のコレクション。
JSON 表現 |
---|
{ "objectIds": [ string ] } |
フィールド | |
---|---|
objectIds[] |
オブジェクト ID。 |
SectionBreak
セクション区切りを表す StructuralElement
。セクションは、同じ SectionStyle
を持つコンテンツの範囲です。セクション区切りは新しいセクションの開始を表し、セクション スタイルはセクション区切りの後のセクションに適用されます。
ドキュメントの本文は常にセクション区切りで始まります。
JSON 表現 |
---|
{
"suggestedInsertionIds": [
string
],
"suggestedDeletionIds": [
string
],
"sectionStyle": {
object ( |
フィールド | |
---|---|
suggestedInsertionIds[] |
提案された挿入 ID。 |
suggestedDeletionIds[] |
削除 ID の候補。空の場合、このコンテンツの削除候補はありません。 |
sectionStyle |
このセクション区切り後のセクションのスタイル。 |
SectionStyle
セクションに適用されるスタイル設定。
JSON 表現 |
---|
{ "columnProperties": [ { object ( |
フィールド | |
---|---|
columnProperties[] |
セクションの列のプロパティ。 空の場合、セクションにはドキュメント エディタのデフォルトのプロパティを持つ 1 つの列が含まれます。セクションは、3 列以下になるように更新できます。 このプロパティを更新する場合は、具体的な値を設定する必要があります。このプロパティの設定を解除すると、400 Bad Request エラーが発生します。 |
columnSeparatorStyle |
列の区切り線のスタイル。 このスタイルは、セクションに 1 つの列しかない場合でも設定できます。 このプロパティを更新する場合は、具体的な値を設定する必要があります。このプロパティの設定を解除すると、400 Bad Request エラーが発生します。 |
contentDirection |
このセクションのコンテンツの方向。設定されていない場合、値はデフォルトで このプロパティを更新する場合は、具体的な値を設定する必要があります。このプロパティの設定を解除すると、400 Bad Request エラーが発生します。 |
marginTop |
セクションの上部ページのマージン。設定されていない場合、値は DocumentStyle の [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が このプロパティを更新する場合は、具体的な値を設定する必要があります。このプロパティの設定を解除すると、400 Bad Request エラーが発生します。 |
marginBottom |
セクションの下部ページ余白。設定されていない場合、値は DocumentStyle の [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が このプロパティを更新する場合は、具体的な値を設定する必要があります。このプロパティの設定を解除すると、400 Bad Request エラーが発生します。 |
marginRight |
セクションの右側のページ余白。設定されていない場合、値は DocumentStyle の [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が このプロパティを更新する場合は、具体的な値を設定する必要があります。このプロパティの設定を解除すると、400 Bad Request エラーが発生します。 |
marginLeft |
セクションの左側のページ余白。設定されていない場合、値は DocumentStyle の [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が このプロパティを更新する場合は、具体的な値を設定する必要があります。このプロパティの設定を解除すると、400 Bad Request エラーが発生します。 |
marginHeader |
セクションのヘッダー マージン。設定されていない場合、値は DocumentStyle の [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が このプロパティを更新する場合は、具体的な値を設定する必要があります。このプロパティの設定を解除すると、400 Bad Request エラーが発生します。 |
marginFooter |
セクションのフッター マージン。設定されていない場合、値は DocumentStyle の [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が このプロパティを更新する場合は、具体的な値を設定する必要があります。このプロパティの設定を解除すると、400 Bad Request エラーが発生します。 |
sectionType |
出力専用。セクションのタイプ。 |
defaultHeaderId |
デフォルトのヘッダーの ID。設定しない場合、値は前の [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が このプロパティは読み取り専用です。 |
defaultFooterId |
デフォルトのフッターの ID。設定しない場合、値は前の [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が このプロパティは読み取り専用です。 |
firstPageHeaderId |
セクションの最初のページでのみ使用されるヘッダーの ID。 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が このプロパティは読み取り専用です。 |
firstPageFooterId |
セクションの最初のページでのみ使用されるフッターの ID。 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が このプロパティは読み取り専用です。 |
evenPageHeaderId |
偶数ページでのみ使用されるヘッダーの ID。DocumentStyle の [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が このプロパティは読み取り専用です。 |
evenPageFooterId |
偶数ページでのみ使用されるフッターの ID。DocumentStyle の [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が このプロパティは読み取り専用です。 |
useFirstPageHeaderFooter |
セクションの最初のページに最初のページのヘッダー / フッター ID を使用するかどうかを示します。設定しない場合、最初のセクションの DocumentStyle の [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が このプロパティを更新する場合は、具体的な値を設定する必要があります。このプロパティの設定を解除すると、400 Bad Request エラーが発生します。 |
pageNumberStart |
このセクションのページ数のカウントを開始するページ番号。設定されていない場合、ページ番号は前のセクションから続きます。最初の [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が このプロパティを更新する場合は、具体的な値を設定する必要があります。このプロパティの設定を解除すると、400 Bad Request エラーが発生します。 |
flipPageOrientation |
省略可。このセクションの DocumentStyle の [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が このプロパティを更新する場合は、具体的な値を設定する必要があります。このプロパティの設定を解除すると、400 Bad Request エラーが発生します。 |
SectionColumnProperties
セクションの列に適用されるプロパティ。
JSON 表現 |
---|
{ "width": { object ( |
フィールド | |
---|---|
width |
出力専用。列の幅。 |
paddingEnd |
列の末尾のパディング。 |
ColumnSeparatorStyle
列間の列区切り文字のスタイル。
列挙型 | |
---|---|
COLUMN_SEPARATOR_STYLE_UNSPECIFIED |
列区切り文字のスタイルが指定されていません。 |
NONE |
列間に列区切り線がない。 |
BETWEEN_EACH_COLUMN |
各列の間に列区切り線をレンダリングします。 |
SectionType
現在のセクションの開始位置が前のセクションに対してどのように配置されているかを表します。
列挙型 | |
---|---|
SECTION_TYPE_UNSPECIFIED |
セクション タイプが指定されていません。 |
CONTINUOUS |
セクションは、前のセクションの最後の段落の直後に開始されます。 |
NEXT_PAGE |
このセクションは次のページから始まります。 |
テーブル
テーブルを表す StructuralElement
。
JSON 表現 |
---|
{ "rows": integer, "columns": integer, "tableRows": [ { object ( |
フィールド | |
---|---|
rows |
テーブル内の行数。 |
columns |
テーブル内の列数。 テーブルは長方形でない場合があるため、一部の行のセル数が異なることがあります。 |
tableRows[] |
各行の内容とスタイル。 |
suggestedInsertionIds[] |
提案された挿入 ID。 |
suggestedDeletionIds[] |
削除 ID の候補。空の場合、このコンテンツの削除候補はありません。 |
tableStyle |
テーブルのスタイル。 |
TableRow
Table
の行のコンテンツとスタイル。
JSON 表現 |
---|
{ "startIndex": integer, "endIndex": integer, "tableCells": [ { object ( |
フィールド | |
---|---|
startIndex |
この行の 0 ベースの開始インデックス(UTF-16 コード単位)。 |
endIndex |
この行の 0 から始まる終了インデックス(UTF-16 コード単位、排他的)。 |
tableCells[] |
この行の各セルの内容とスタイル。 テーブルは長方形でない場合もあります。そのため、同じテーブル内の行でも、セル数が異なる場合があります。 |
suggestedInsertionIds[] |
提案された挿入 ID。 |
suggestedDeletionIds[] |
削除 ID の候補。空の場合、このコンテンツの削除候補はありません。 |
tableRowStyle |
テーブル行のスタイル。 |
suggestedTableRowStyleChanges |
この行に適用される提案されたスタイルの変更。提案 ID をキーとしています。 |
TableCell
Table
のセル内のコンテンツとスタイル。
JSON 表現 |
---|
{ "startIndex": integer, "endIndex": integer, "content": [ { object ( |
フィールド | |
---|---|
startIndex |
このセルの 0 ベースの開始インデックス(UTF-16 コード単位)。 |
endIndex |
このセルの 0 から始まる終了インデックス(UTF-16 コード単位、排他的)。 |
content[] |
セルの内容。 |
tableCellStyle |
セルのスタイル。 |
suggestedInsertionIds[] |
提案された挿入 ID。 |
suggestedDeletionIds[] |
削除 ID の候補。空の場合、このコンテンツの削除候補はありません。 |
suggestedTableCellStyleChanges |
提案 ID をキーとする、テーブル セルのスタイルに対する提案された変更。 |
TableCellStyle
TableCell
のスタイル。
継承された表のセルスタイルは、このメッセージで未設定のフィールドとして表されます。テーブル セルのスタイルは、テーブルのスタイルから継承できます。
JSON 表現 |
---|
{ "rowSpan": integer, "columnSpan": integer, "backgroundColor": { object ( |
フィールド | |
---|---|
rowSpan |
セルの行スパン。 このプロパティは読み取り専用です。 |
columnSpan |
セルの列スパン。 このプロパティは読み取り専用です。 |
backgroundColor |
セルの背景色。 |
borderLeft |
セルの左枠線。 |
borderRight |
セルの右枠線。 |
borderTop |
セルの上枠線。 |
borderBottom |
セルの下枠線。 |
paddingLeft |
セルの左側のパディング。 |
paddingRight |
セルの右側のパディング。 |
paddingTop |
セルの上部のパディング。 |
paddingBottom |
セルの下部のパディング。 |
contentAlignment |
テーブル セル内のコンテンツの配置。デフォルトの配置は、ドキュメント エディタで新しく作成された表のセルの配置と一致します。 |
TableCellBorder
テーブルセルの周囲の枠線。
表のセルの枠線を透明にすることはできません。テーブル セルの枠線を非表示にするには、幅を 0 にします。
JSON 表現 |
---|
{ "color": { object ( |
フィールド | |
---|---|
color |
枠線の色。 この色は透明にできません。 |
width |
枠線の幅。 |
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 |
この提案でベース |
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 |
|
columnSpanSuggested |
|
backgroundColorSuggested |
|
borderLeftSuggested |
|
borderRightSuggested |
|
borderTopSuggested |
|
borderBottomSuggested |
|
paddingLeftSuggested |
|
paddingRightSuggested |
|
paddingTopSuggested |
|
paddingBottomSuggested |
|
contentAlignmentSuggested |
|
TableRowStyle
テーブル行に適用されるスタイル。
JSON 表現 |
---|
{
"minRowHeight": {
object ( |
フィールド | |
---|---|
minRowHeight |
行の最小の高さ。行のセル内のすべてのコンテンツを表示するために、この値以上の高さでドキュメント エディタにレンダリングされます。 |
tableHeader |
行が表のヘッダーかどうか。 |
preventOverflow |
行がページまたは列の境界を越えてはみ出せないかどうか。 |
SuggestedTableRowStyle
TableRowStyle
に対する提案された変更。
JSON 表現 |
---|
{ "tableRowStyle": { object ( |
フィールド | |
---|---|
tableRowStyle |
この提案で行われた変更のみを含む |
tableRowStyleSuggestionState |
この提案でベース |
TableRowStyleSuggestionState
この提案でベース TableRowStyle
のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。
JSON 表現 |
---|
{ "minRowHeightSuggested": boolean } |
フィールド | |
---|---|
minRowHeightSuggested |
|
TableStyle
テーブルに適用されるスタイル。
JSON 表現 |
---|
{
"tableColumnProperties": [
{
object ( |
フィールド | |
---|---|
tableColumnProperties[] |
各列のプロパティ。 ドキュメントでは、HTML と同様に、表には行が含まれ、行にはセルが含まれます。そのため、行のプロパティは行の |
TableColumnProperties
テーブル内の列のプロパティ。
JSON 表現 |
---|
{ "widthType": enum ( |
フィールド | |
---|---|
widthType |
列の幅のタイプ。 |
width |
列の幅。列の |
WidthType
列の幅のタイプ。
列挙型 | |
---|---|
WIDTH_TYPE_UNSPECIFIED |
列幅のタイプが指定されていません。 |
EVENLY_DISTRIBUTED |
列の幅は、他の均等に分配された列間で均等に分配されます。 列の幅は自動的に決定され、幅が指定されたすべての列を考慮した後にテーブルに残る幅の均等な部分が割り当てられます。 |
FIXED_WIDTH |
固定列幅。[width][google.apps.docs.v1.TableColumnProperties.width プロパティには、列の幅が含まれています。 |
TableOfContents
目次を表す StructuralElement
。
JSON 表現 |
---|
{
"content": [
{
object ( |
フィールド | |
---|---|
content[] |
目次の内容。 |
suggestedInsertionIds[] |
提案された挿入 ID。 |
suggestedDeletionIds[] |
削除 ID の候補。空の場合、このコンテンツの削除候補はありません。 |
ヘッダー
ドキュメントのヘッダー。
JSON 表現 |
---|
{
"headerId": string,
"content": [
{
object ( |
フィールド | |
---|---|
headerId |
ヘッダーの ID。 |
content[] |
ヘッダーの内容。 ヘッダーのコンテンツのインデックスは 0 から始まります。 |
脚注
ドキュメントの脚注。
JSON 表現 |
---|
{
"footnoteId": string,
"content": [
{
object ( |
フィールド | |
---|---|
footnoteId |
脚注の ID。 |
content[] |
脚注の内容。 脚注のコンテンツのインデックスは 0 から始まります。 |
DocumentStyle
ドキュメントのスタイル。
JSON 表現 |
---|
{ "background": { object ( |
フィールド | |
---|---|
background |
ドキュメントの背景。ドキュメントの背景色を透明にすることはできません。 |
defaultHeaderId |
デフォルトのヘッダーの ID。設定されていない場合、デフォルトのヘッダーはありません。 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が このプロパティは読み取り専用です。 |
defaultFooterId |
デフォルトのフッターの ID。設定しない場合、デフォルトのフッターはありません。 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が このプロパティは読み取り専用です。 |
evenPageHeaderId |
偶数ページでのみ使用されるヘッダーの ID。 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が このプロパティは読み取り専用です。 |
evenPageFooterId |
偶数ページでのみ使用されるフッターの ID。 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が このプロパティは読み取り専用です。 |
firstPageHeaderId |
最初のページでのみ使用されるヘッダーの ID。設定されていない場合、最初のページの固有のヘッダーは存在しません。 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が このプロパティは読み取り専用です。 |
firstPageFooterId |
最初のページでのみ使用されるフッターの ID。設定されていない場合、最初のページの固有のフッターは存在しません。 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が このプロパティは読み取り専用です。 |
useFirstPageHeaderFooter |
最初のページのヘッダー / フッター ID を最初のページに使用するかどうかを示します。 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が |
useEvenPageHeaderFooter |
偶数ページに偶数ページのヘッダー / フッター ID を使用するかどうかを示します。 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が |
pageNumberStart |
ページ数のカウントを開始するページ番号。 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が |
marginTop |
ページの上の余白。 ドキュメント スタイルで上余白を更新すると、すべてのセクション スタイルで上余白がクリアされます。 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が |
marginBottom |
ページの下余白。 ドキュメント スタイルで下余白を更新すると、すべてのセクション スタイルの下余白がクリアされます。 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が |
marginRight |
右側のページ余白。 ドキュメント スタイルで右ページの余白を更新すると、すべてのセクション スタイルで右ページの余白がクリアされます。また、すべてのセクションで列のサイズが変更されることもあります。 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が |
marginLeft |
左側のページの余白。 ドキュメント スタイルで左側のページ余白を更新すると、すべてのセクション スタイルで左側のページ余白がクリアされます。また、すべてのセクションで列のサイズが変更されることもあります。 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が |
pageSize |
ドキュメント内のページのサイズ。 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が |
marginHeader |
ページの上部とヘッダーのコンテンツの間のスペースの量。 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が |
marginFooter |
ページの下部とフッターのコンテンツの間のスペースの量。 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が |
useCustomHeaderFooterMargins |
DocumentStyle [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が このプロパティは読み取り専用です。 |
flipPageOrientation |
省略可。 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] が |
documentFormat |
ドキュメント モード(ページ分けありとページ分けなし)など、ドキュメント レベルの形式設定を指定します。 |
背景
ドキュメントの背景を表します。
JSON 表現 |
---|
{
"color": {
object ( |
フィールド | |
---|---|
color |
背景色。 |
サイズ
幅と高さ。
JSON 表現 |
---|
{ "height": { object ( |
フィールド | |
---|---|
height |
オブジェクトの高さ。 |
width |
オブジェクトの幅。 |
DocumentFormat
ドキュメント レベルの形式設定を表します。
JSON 表現 |
---|
{
"documentMode": enum ( |
フィールド | |
---|---|
documentMode |
ドキュメントがページ分けあり形式かページ分けなし形式か。 |
DocumentMode
ドキュメントがページ分けあり形式かページ分けなし形式か。
列挙型 | |
---|---|
DOCUMENT_MODE_UNSPECIFIED |
ドキュメント モードが指定されていません。 |
PAGES |
ドキュメントにページがある。 |
PAGELESS |
ドキュメントはページ分けなしです。 |
SuggestedDocumentStyle
DocumentStyle
に対する提案された変更。
JSON 表現 |
---|
{ "documentStyle": { object ( |
フィールド | |
---|---|
documentStyle |
この提案で行われた変更のみを含む |
documentStyleSuggestionState |
この提案でベース |
DocumentStyleSuggestionState
この提案でベース DocumentStyle
のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。
JSON 表現 |
---|
{ "backgroundSuggestionState": { object ( |
フィールド | |
---|---|
backgroundSuggestionState |
この候補で |
defaultHeaderIdSuggested |
|
defaultFooterIdSuggested |
|
evenPageHeaderIdSuggested |
|
evenPageFooterIdSuggested |
|
firstPageHeaderIdSuggested |
|
firstPageFooterIdSuggested |
|
useFirstPageHeaderFooterSuggested |
|
useEvenPageHeaderFooterSuggested |
|
pageNumberStartSuggested |
|
marginTopSuggested |
|
marginBottomSuggested |
|
marginRightSuggested |
|
marginLeftSuggested |
|
pageSizeSuggestionState |
この候補で [size]([google.apps.docs.v1.DocumentStyle.size])のどのフィールドが変更されたかを示すマスク。 |
marginHeaderSuggested |
|
marginFooterSuggested |
|
useCustomHeaderFooterMarginsSuggested |
|
flipPageOrientationSuggested |
省略可。 |
BackgroundSuggestionState
この提案でベース Background
のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドごとに、Backgound
に新しい推奨値が設定されます。
JSON 表現 |
---|
{ "backgroundColorSuggested": boolean } |
フィールド | |
---|---|
backgroundColorSuggested |
この候補で現在の背景色が変更されたかどうかを示します。 |
SizeSuggestionState
この提案でベース Size
のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドごとに、Size
に新しい推奨値が設定されます。
JSON 表現 |
---|
{ "heightSuggested": boolean, "widthSuggested": boolean } |
フィールド | |
---|---|
heightSuggested |
|
widthSuggested |
|
NamedStyles
名前付きスタイル。ドキュメント内の段落は、これらの名前付きスタイルから TextStyle
と ParagraphStyle
を継承できます。
JSON 表現 |
---|
{
"styles": [
{
object ( |
フィールド | |
---|---|
styles[] |
名前付きスタイル。 可能な |
NamedStyle
名前付きスタイル。ドキュメント内の段落は、同じ名前付きスタイル タイプの場合、この名前付きスタイルから TextStyle
と ParagraphStyle
を継承できます。
JSON 表現 |
---|
{ "namedStyleType": enum ( |
フィールド | |
---|---|
namedStyleType |
この名前付きスタイルのタイプ。 |
textStyle |
この名前付きスタイルのテキスト スタイル。 |
paragraphStyle |
この名前付きスタイルの段落スタイル。 |
SuggestedNamedStyles
NamedStyles
に対する提案された変更。
JSON 表現 |
---|
{ "namedStyles": { object ( |
フィールド | |
---|---|
namedStyles |
この提案で行われた変更のみを含む |
namedStylesSuggestionState |
この提案でベース |
NamedStylesSuggestionState
NamedStyles
メッセージの提案状態。
JSON 表現 |
---|
{
"stylesSuggestionStates": [
{
object ( |
フィールド | |
---|---|
stylesSuggestionStates[] |
この候補で これらの名前付きスタイル候補の状態の順序は、 |
NamedStyleSuggestionState
NamedStyle
メッセージの提案状態。
JSON 表現 |
---|
{ "namedStyleType": enum ( |
フィールド | |
---|---|
namedStyleType |
この提案状態に対応する名前付きスタイル タイプ。 このフィールドは、NamedStyleSuggestionState を対応する |
textStyleSuggestionState |
この候補で |
paragraphStyleSuggestionState |
この候補で |
リスト
リストは、同じリストに属する段落のグループのリスト属性を表します。リストの一部である段落の bullet
には、リストの ID への参照が含まれています。
JSON 表現 |
---|
{ "listProperties": { object ( |
フィールド | |
---|---|
listProperties |
リストのプロパティ。 |
suggestedListPropertiesChanges |
リスト プロパティに対する提案された変更。提案 ID をキーとして使用します。 |
suggestedInsertionId |
提案された広告掲載 ID。空の場合、これは挿入候補ではありません。 |
suggestedDeletionIds[] |
削除 ID の候補。空の場合、このリストの削除候補はありません。 |
ListProperties
リストに関連付けられた段落に属する箇条書きのルック アンド フィールを記述する list
のプロパティ。
JSON 表現 |
---|
{
"nestingLevels": [
{
object ( |
フィールド | |
---|---|
nestingLevels[] |
関連付けられたレベルの箇条書きのプロパティを記述します。 リストのネストレベルは最大 9 レベルで、ネストレベル 0 が最上位のレベル、ネストレベル 8 が最もネストされたレベルに対応します。ネストレベルは昇順で返され、ネストが最も少ないものが最初に返されます。 |
NestingLevel
特定のネストレベルのリストの箇条書きの外観を記述するプロパティが含まれています。
JSON 表現 |
---|
{ "bulletAlignment": enum ( |
フィールド | |
---|---|
bulletAlignment |
箇条書きのレンダリング用に割り当てられたスペース内での箇条書きの配置。 |
glyphFormat |
このネストレベルの箇条書きで使用される形式文字列。 グリフ形式には 1 つ以上のプレースホルダが含まれており、これらのプレースホルダは たとえば、グリフ形式
グリフ形式には、現在のネストレベルのプレースホルダと親ネストレベルのプレースホルダを含めることができます。たとえば、リストのネストレベル 0 のグリフ形式を
順序付きのネストレベルの場合、特定の段落のグリフ形式のプレースホルダを置き換える文字列は、リスト内の段落の順序によって異なります。 |
indentFirstLine |
このネストレベルの段落の 1 行目のインデント量。 |
indentStart |
このネストレベルの段落のインデント量。段落のコンテンツの方向に基づいて、テキストの先頭に対応する側に適用されます。 |
textStyle |
このネストレベルの箇条書きのテキスト スタイル。 |
startNumber |
このネストレベルの最初のリストアイテムの番号。 文字付きリストとローマ数字付きリストでは、値 0 は値 1 として扱われます。値が 0 と 1 の場合、文字リストとローマ数字リストはそれぞれ この値は、順序なしグリフを含むネストレベルでは無視されます。 |
共用体フィールド glyph_kind 。箇条書きで使用されるグリフの種類。これは、glyph_format のプレースホルダを置き換える箇条書きのグリフを定義します。glyph_kind は次のいずれかになります。 |
|
glyphType |
このネストレベルの段落が順序付けされている場合に、箇条書きで使用されるグリフのタイプ。 グリフタイプは、このネストレベルの段落が順序付けされている場合に、 |
glyphSymbol |
このレベルのネストにある段落が順序なしの場合に、箇条書きで使用されるカスタム グリフ記号。 グリフ記号は |
BulletAlignment
箇条書きの配置のタイプ。
列挙型 | |
---|---|
BULLET_ALIGNMENT_UNSPECIFIED |
箇条書きの配置が指定されていません。 |
START |
箇条書きは、箇条書きのレンダリング用に割り当てられたスペースの先頭に揃えられます。LTR テキストの場合は左揃え、それ以外の場合は右揃え。 |
CENTER |
箇条書きは、箇条書きのレンダリング用に割り当てられたスペースの中央に配置されます。 |
END |
箇条書きは、箇条書きのレンダリング用に割り当てられたスペースの末尾に配置されます。LTR テキストの場合は右揃え、それ以外の場合は左揃え。 |
GlyphType
このレベルのネストにある段落が順序付けされている場合に、箇条書きで使用されるグリフのタイプ。
列挙型 | |
---|---|
GLYPH_TYPE_UNSPECIFIED |
グリフのタイプが指定されていないか、サポートされていません。 |
NONE |
空の文字列。 |
DECIMAL |
1 、2 、3 などの数値。 |
ZERO_DECIMAL |
1 桁の数字の前に 0 が付いた数字(01 、02 、03 など)。2 桁以上の数字の先頭にゼロは付きません。 |
UPPER_ALPHA |
A 、B 、C などの大文字。 |
ALPHA |
a 、b 、c などの小文字。 |
UPPER_ROMAN |
I 、II 、III などの大文字のローマ数字。 |
ROMAN |
i 、ii 、iii などの小文字のローマ数字。 |
SuggestedListProperties
ListProperties
への変更案。
JSON 表現 |
---|
{ "listProperties": { object ( |
フィールド | |
---|---|
listProperties |
この提案で行われた変更のみを含む |
listPropertiesSuggestionState |
この提案でベース |
ListPropertiesSuggestionState
この提案でベース ListProperties
のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。
JSON 表現 |
---|
{
"nestingLevelsSuggestionStates": [
{
object ( |
フィールド | |
---|---|
nestingLevelsSuggestionStates[] |
この候補で ネストレベルの提案状態は、ネストレベルの昇順で返されます。ネストが最も少ないものが最初に返されます。 |
NestingLevelSuggestionState
この提案でベース NestingLevel
のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。
JSON 表現 |
---|
{
"bulletAlignmentSuggested": boolean,
"glyphTypeSuggested": boolean,
"glyphFormatSuggested": boolean,
"glyphSymbolSuggested": boolean,
"indentFirstLineSuggested": boolean,
"indentStartSuggested": boolean,
"textStyleSuggestionState": {
object ( |
フィールド | |
---|---|
bulletAlignmentSuggested |
|
glyphTypeSuggested |
|
glyphFormatSuggested |
|
glyphSymbolSuggested |
|
indentFirstLineSuggested |
|
indentStartSuggested |
|
textStyleSuggestionState |
この候補で |
startNumberSuggested |
|
NamedRanges
指定された名前を共有するドキュメント内のすべての NamedRange
のコレクション。
JSON 表現 |
---|
{
"name": string,
"namedRanges": [
{
object ( |
フィールド | |
---|---|
name |
すべての |
namedRanges[] |
同じ名前を共有する |
NamedRange
同じ名前付き範囲 ID を持つ Range
のコレクション。
名前付き範囲を使用すると、ドキュメントの一部を任意のユーザー定義ラベルに関連付けることができ、後でそのコンテンツをプログラムで読み取ったり編集したりできます。ドキュメントには同じ名前の複数の名前付き範囲を含めることができますが、すべての名前付き範囲には一意の ID があります。
名前付き範囲は 1 つの Range
で作成され、名前付き範囲内に挿入されたコンテンツによって通常はその範囲が拡大されます。ただし、ドキュメントの変更によっては、範囲が複数の範囲に分割されることがあります。
名前付き範囲は非公開ではありません。ドキュメントにアクセスできるすべてのアプリケーションと共同編集者は、名前付き範囲を表示できます。
JSON 表現 |
---|
{
"namedRangeId": string,
"name": string,
"ranges": [
{
object ( |
フィールド | |
---|---|
namedRangeId |
名前付き範囲の ID。 |
name |
名前付き範囲の名前。 |
ranges[] |
この名前付き範囲に属する範囲。 |
範囲
テキストの連続した範囲を指定します。
JSON 表現 |
---|
{ "segmentId": string, "startIndex": integer, "endIndex": integer, "tabId": string } |
フィールド | |
---|---|
segmentId |
この範囲が含まれるヘッダー、フッター、脚注の ID。空のセグメント ID は、ドキュメントの本文を示します。 |
startIndex |
この範囲の 0 ベースの開始インデックス(UTF-16 コード単位)。 現在のすべての用途で、開始インデックスを指定する必要があります。このフィールドは、範囲が限定されない将来のユースケースに対応するために Int32Value です。 |
endIndex |
この範囲の 0 から始まる終了インデックス(UTF-16 コード単位)。 現在のすべての使用例では、終了インデックスを指定する必要があります。このフィールドは、範囲が限定されない将来のユースケースに対応するために Int32Value です。 |
tabId |
この範囲を含むタブ。省略した場合、リクエストは最初のタブに適用されます。 1 つのタブを含むドキュメントの場合:
複数のタブを含むドキュメントの場合:
|
InlineObject
テキストとインラインで表示されるオブジェクト。InlineObject には、画像などの EmbeddedObject
が含まれます。
JSON 表現 |
---|
{ "objectId": string, "inlineObjectProperties": { object ( |
フィールド | |
---|---|
objectId |
このインライン オブジェクトの ID。オブジェクトのプロパティの更新に使用できます。 |
inlineObjectProperties |
このインライン オブジェクトのプロパティ。 |
suggestedInlineObjectPropertiesChanges |
インライン オブジェクトのプロパティに対する提案された変更。提案 ID をキーとします。 |
suggestedInsertionId |
提案された広告掲載 ID。空の場合、これは挿入候補ではありません。 |
suggestedDeletionIds[] |
削除 ID の候補。空の場合、このコンテンツの削除候補はありません。 |
InlineObjectProperties
InlineObject
のプロパティ。
JSON 表現 |
---|
{
"embeddedObject": {
object ( |
フィールド | |
---|---|
embeddedObject |
このインライン オブジェクトの埋め込みオブジェクト。 |
EmbeddedObject
ドキュメント内の埋め込みオブジェクト。
JSON 表現 |
---|
{ "title": string, "description": string, "embeddedObjectBorder": { object ( |
フィールド | |
---|---|
title |
埋め込みオブジェクトのタイトル。 |
description |
埋め込みオブジェクトの説明。 |
embeddedObjectBorder |
埋め込みオブジェクトの枠線。 |
size |
切り抜き後の画像の表示サイズ。 |
marginTop |
埋め込みオブジェクトの上部余白。 |
marginBottom |
埋め込みオブジェクトの下部余白。 |
marginRight |
埋め込みオブジェクトの右側の余白。 |
marginLeft |
埋め込みオブジェクトの左マージン。 |
linkedContentReference |
外部のリンクされたソース コンテンツへの参照。たとえば、埋め込みオブジェクトがリンクされたグラフの場合、元の Google スプレッドシートのグラフへの参照が含まれます。 設定されていない場合、埋め込みオブジェクトはリンクされません。 |
共用体フィールド properties 。各埋め込みオブジェクト タイプに固有のプロパティ。properties は次のいずれかになります。 |
|
embeddedDrawingProperties |
埋め込み図形のプロパティ。 |
imageProperties |
画像のプロパティ。 |
EmbeddedDrawingProperties
この型にはフィールドがありません。
埋め込み図形のプロパティ。オブジェクト タイプを区別するために使用されます。埋め込み図形は、ドキュメント内で作成および編集された図形です。詳細な情報はサポートされていません。
ImageProperties
画像のプロパティ。
JSON 表現 |
---|
{
"contentUri": string,
"sourceUri": string,
"brightness": number,
"contrast": number,
"transparency": number,
"cropProperties": {
object ( |
フィールド | |
---|---|
contentUri |
画像の URI。デフォルトの有効期間は 30 分です。この URI には、リクエスト元のユーザーのアカウントがタグ付けされています。URI を持つユーザーは、元のリクエスト元として画像にアクセスできます。ドキュメントの共有設定が変更されると、画像にアクセスできなくなることがあります。 |
sourceUri |
ソース URI は、画像の挿入に使用される URI です。ソース URI は空にできます。 |
brightness |
画像の明るさ効果。値は [-1.0, 1.0] の範囲で指定します。0 は効果がないことを意味します。 |
contrast |
画像のコントラスト効果。値は [-1.0, 1.0] の範囲で指定します。0 は効果がないことを意味します。 |
transparency |
画像の透明度効果。値は [0.0, 1.0] の範囲で指定します。0 は効果なし、1 は透明を意味します。 |
cropProperties |
画像の切り抜きプロパティ。 |
angle |
画像の時計回りの回転角度(ラジアン単位)。 |
CropProperties
画像の切り抜きプロパティ。
切り抜き長方形は、元のコンテンツの 4 つの端からの分数オフセットを使用して表されます。
- オフセットが(0、1)の範囲内にある場合、切り抜き長方形の対応するエッジは、画像の元の境界長方形の内側に配置されます。
- オフセットが負の値または 1 より大きい場合、切り抜き長方形の対応するエッジは、画像の元の境界長方形の外側に配置されます。
- すべてのオフセットと回転角度が 0 の場合、画像は切り抜かれません。
JSON 表現 |
---|
{ "offsetLeft": number, "offsetRight": number, "offsetTop": number, "offsetBottom": number, "angle": number } |
フィールド | |
---|---|
offsetLeft |
オフセットは、切り抜き四角形の左端が元のコンテンツの左端から内側にどれだけ離れているかを、元のコンテンツの幅に対する割合で指定します。 |
offsetRight |
オフセットは、切り抜き四角形の右端が元のコンテンツの右端から内側にどれだけ離れているかを、元のコンテンツの幅の割合で指定します。 |
offsetTop |
オフセットは、切り抜き長方形の上端が元のコンテンツの上端から内側にどれだけ離れているかを、元のコンテンツの高さの割合で指定します。 |
offsetBottom |
オフセットは、切り抜き長方形の下端が元のコンテンツの下端から内側にどれだけ離れているかを、元のコンテンツの高さの割合で指定します。 |
angle |
切り抜き長方形の中心を中心とした時計回りの回転角度(ラジアン単位)。回転はオフセットの後に適用されます。 |
EmbeddedObjectBorder
EmbeddedObject
の周囲の枠線。
JSON 表現 |
---|
{ "color": { object ( |
フィールド | |
---|---|
color |
枠線の色。 |
width |
枠線の幅。 |
dashStyle |
枠線の破線スタイル。 |
propertyState |
境界プロパティのプロパティ状態。 |
PropertyState
プロパティが取り得る状態。
列挙型 | |
---|---|
RENDERED |
プロパティの状態が RENDERED の場合、ドキュメントでレンダリングされるときに、要素にそのプロパティが設定されます。これがデフォルト値です。 |
NOT_RENDERED |
プロパティの状態が NOT_RENDERED の場合、ドキュメントでレンダリングされるときに、要素にそのプロパティは含まれません。 |
LinkedContentReference
外部のリンクされたソース コンテンツへの参照。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド reference 。リンクされたコンテンツのタイプに固有の参照。reference は次のいずれかになります。 |
|
sheetsChartReference |
リンクされたグラフへの参照。 |
SheetsChartReference
Google スプレッドシートから埋め込まれたリンクされたグラフへの参照。
JSON 表現 |
---|
{ "spreadsheetId": string, "chartId": integer } |
フィールド | |
---|---|
spreadsheetId |
ソースグラフを含む Google スプレッドシートの ID。 |
chartId |
埋め込まれている Google スプレッドシートの特定のグラフの ID。 |
SuggestedInlineObjectProperties
InlineObjectProperties
への変更案。
JSON 表現 |
---|
{ "inlineObjectProperties": { object ( |
フィールド | |
---|---|
inlineObjectProperties |
この提案で行われた変更のみを含む |
inlineObjectPropertiesSuggestionState |
この提案でベース |
InlineObjectPropertiesSuggestionState
この提案でベース InlineObjectProperties
のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。
JSON 表現 |
---|
{
"embeddedObjectSuggestionState": {
object ( |
フィールド | |
---|---|
embeddedObjectSuggestionState |
この候補で |
EmbeddedObjectSuggestionState
この提案でベース EmbeddedObject
のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。
JSON 表現 |
---|
{ "embeddedDrawingPropertiesSuggestionState": { object ( |
フィールド | |
---|---|
embeddedDrawingPropertiesSuggestionState |
この候補で |
imagePropertiesSuggestionState |
この候補で |
titleSuggested |
|
descriptionSuggested |
|
embeddedObjectBorderSuggestionState |
この候補で |
sizeSuggestionState |
この候補で |
marginLeftSuggested |
|
marginRightSuggested |
|
marginTopSuggested |
|
marginBottomSuggested |
|
linkedContentReferenceSuggestionState |
この候補で |
EmbeddedDrawingPropertiesSuggestionState
この型にはフィールドがありません。
この提案でベース EmbeddedDrawingProperties
のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。
ImagePropertiesSuggestionState
この提案でベース ImageProperties
のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。
JSON 表現 |
---|
{
"contentUriSuggested": boolean,
"sourceUriSuggested": boolean,
"brightnessSuggested": boolean,
"contrastSuggested": boolean,
"transparencySuggested": boolean,
"cropPropertiesSuggestionState": {
object ( |
フィールド | |
---|---|
contentUriSuggested |
|
sourceUriSuggested |
[sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri] に変更の提案があったかどうかを示します。 |
brightnessSuggested |
[明るさ] [google.apps.docs.v1.EmbeddedObject.brightness] に変更が提案されたかどうかを示します。 |
contrastSuggested |
[コントラスト]([google.apps.docs.v1.EmbeddedObject.contrast])に対する変更の提案があったかどうかを示します。 |
transparencySuggested |
[透明度] [google.apps.docs.v1.EmbeddedObject.transparency] に変更が提案されたかどうかを示します。 |
cropPropertiesSuggestionState |
この候補で |
angleSuggested |
[angle] [google.apps.docs.v1.EmbeddedObject.angle] に変更の提案があったかどうかを示します。 |
CropPropertiesSuggestionState
この提案でベース CropProperties
のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。
JSON 表現 |
---|
{ "offsetLeftSuggested": boolean, "offsetRightSuggested": boolean, "offsetTopSuggested": boolean, "offsetBottomSuggested": boolean, "angleSuggested": boolean } |
フィールド | |
---|---|
offsetLeftSuggested |
|
offsetRightSuggested |
|
offsetTopSuggested |
|
offsetBottomSuggested |
|
angleSuggested |
|
EmbeddedObjectBorderSuggestionState
この提案でベース EmbeddedObjectBorder
のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。
JSON 表現 |
---|
{ "colorSuggested": boolean, "widthSuggested": boolean, "dashStyleSuggested": boolean, "propertyStateSuggested": boolean } |
フィールド | |
---|---|
colorSuggested |
[color]([google.apps.docs.v1.EmbeddedBorderObject.color])に対する変更の提案があったかどうかを示します。 |
widthSuggested |
[幅] [google.apps.docs.v1.EmbeddedBorderObject.width] に変更の提案があったかどうかを示します。 |
dashStyleSuggested |
[dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style] に変更が提案されたかどうかを示します。 |
propertyStateSuggested |
[propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state] に変更が提案されたかどうかを示します。 |
LinkedContentReferenceSuggestionState
この提案でベース LinkedContentReference
のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。
JSON 表現 |
---|
{
"sheetsChartReferenceSuggestionState": {
object ( |
フィールド | |
---|---|
sheetsChartReferenceSuggestionState |
この候補で |
SheetsChartReferenceSuggestionState
この提案でベース SheetsChartReference
のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。
JSON 表現 |
---|
{ "spreadsheetIdSuggested": boolean, "chartIdSuggested": boolean } |
フィールド | |
---|---|
spreadsheetIdSuggested |
|
chartIdSuggested |
|
PositionedObject
Paragraph
にテザーされ、段落の先頭を基準に配置されるオブジェクト。PositionedObject には、画像などの EmbeddedObject
が含まれます。
JSON 表現 |
---|
{ "objectId": string, "positionedObjectProperties": { object ( |
フィールド | |
---|---|
objectId |
この配置されたオブジェクトの ID。 |
positionedObjectProperties |
この配置されたオブジェクトのプロパティ。 |
suggestedPositionedObjectPropertiesChanges |
位置指定されたオブジェクトのプロパティに対する提案された変更。提案 ID でキー設定されます。 |
suggestedInsertionId |
提案された広告掲載 ID。空の場合、これは挿入候補ではありません。 |
suggestedDeletionIds[] |
削除 ID の候補。空の場合、このコンテンツの削除候補はありません。 |
PositionedObjectProperties
PositionedObject
のプロパティ。
JSON 表現 |
---|
{ "positioning": { object ( |
フィールド | |
---|---|
positioning |
この位置指定オブジェクトを参照する |
embeddedObject |
この配置されたオブジェクトの埋め込みオブジェクト。 |
PositionedObjectPositioning
PositionedObject
のポジショニング。配置されたオブジェクトは、テザリングされている Paragraph
の先頭を基準に配置されます。
JSON 表現 |
---|
{ "layout": enum ( |
フィールド | |
---|---|
layout |
この配置されたオブジェクトのレイアウト。 |
leftOffset |
位置指定されたオブジェクトの左端の、テザーされている |
topOffset |
配置されたオブジェクトの上端の、テザーされている |
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 |
この提案でベース |
PositionedObjectPropertiesSuggestionState
この提案でベース PositionedObjectProperties
のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。
JSON 表現 |
---|
{ "positioningSuggestionState": { object ( |
フィールド | |
---|---|
positioningSuggestionState |
この候補で |
embeddedObjectSuggestionState |
この候補で |
PositionedObjectPositioningSuggestionState
この提案でベース PositionedObjectPositioning
のどのフィールドが変更されたかを示すマスク。true に設定されたフィールドには、新しい推奨値があります。
JSON 表現 |
---|
{ "layoutSuggested": boolean, "leftOffsetSuggested": boolean, "topOffsetSuggested": boolean } |
フィールド | |
---|---|
layoutSuggested |
|
leftOffsetSuggested |
|
topOffsetSuggested |
|
SuggestionsViewMode
ドキュメントに適用される提案ビューモード。提案された変更がどのように表示されるかを示します。すべての提案をインラインで表示した状態、承認した状態、拒否した状態でドキュメントを閲覧するオプションが用意されています。
列挙型 | |
---|---|
DEFAULT_FOR_CURRENT_ACCESS |
返されるドキュメントに適用される SuggestionsViewMode は、ユーザーの現在のアクセスレベルによって異なります。ユーザーが閲覧権限のみを持っている場合は、PREVIEW_WITHOUT_SUGGESTIONS が適用されます。それ以外の場合は、SUGGESTIONS_INLINE が適用されます。これがデフォルトの候補表示モードです。 |
SUGGESTIONS_INLINE |
返されたドキュメントにはインラインで候補が表示されます。提案された変更は、ドキュメント内のベース コンテンツと区別されます。 このモードでドキュメントを取得するリクエストは、ユーザーに提案された変更を表示する権限がない場合、403 エラーを返します。 |
PREVIEW_SUGGESTIONS_ACCEPTED |
返されたドキュメントは、提案されたすべての変更が承認されたプレビューです。 このモードでドキュメントを取得するリクエストは、ユーザーに提案された変更を表示する権限がない場合、403 エラーを返します。 |
PREVIEW_WITHOUT_SUGGESTIONS |
ドキュメントに提案がある場合、返されるドキュメントは、提案されたすべての変更が拒否されたプレビューです。 |
メソッド |
|
---|---|
|
ドキュメントに 1 つ以上の更新を適用します。 |
|
リクエストで指定されたタイトルを使用して、空白のドキュメントを作成します。 |
|
指定されたドキュメントの最新バージョンを取得します。 |