Requests

object (ReplaceAllTextRequest)

指定されたテキストのすべてのインスタンスを置き換えます。

object (InsertTextRequest)

指定した位置にテキストを挿入します。

object (UpdateTextStyleRequest)

指定された範囲のテキスト スタイルを更新します。

object (CreateParagraphBulletsRequest)

段落の箇条書きを作成します。

object (DeleteParagraphBulletsRequest)

段落から箇条書きを削除します。

object (CreateNamedRangeRequest)

名前付き範囲を作成します。

object (DeleteNamedRangeRequest)

名前付き範囲を削除します。

object (UpdateParagraphStyleRequest)

指定された範囲の段落スタイルを更新します。

object (DeleteContentRangeRequest)

ドキュメントからコンテンツを削除します。

object (InsertInlineImageRequest)

指定した位置にインライン画像を挿入します。

object (InsertTableRequest)

指定した場所に表を挿入します。

object (InsertTableRowRequest)

テーブルに空の行を挿入します。

object (InsertTableColumnRequest)

テーブルに空の列を挿入します。

object (DeleteTableRowRequest)

テーブルから行を削除します。

object (DeleteTableColumnRequest)

テーブルから列を削除します。

object (InsertPageBreakRequest)

指定した位置に改ページを挿入します。

object (DeletePositionedObjectRequest)

ドキュメントから配置されたオブジェクトを削除します。

object (UpdateTableColumnPropertiesRequest)

テーブル内の列のプロパティを更新します。

object (UpdateTableCellStyleRequest)

表のセルのスタイルを更新します。

object (UpdateTableRowStyleRequest)

テーブル内の行のスタイルを更新します。

object (ReplaceImageRequest)

ドキュメント内の画像を置き換えます。

object (UpdateDocumentStyleRequest)

ドキュメントのスタイルを更新します。

object (MergeTableCellsRequest)

表内のセルを結合します。

object (UnmergeTableCellsRequest)

テーブル内のセルを結合解除します。

object (CreateHeaderRequest)

ヘッダーを作成します。

object (CreateFooterRequest)

フッターを作成します。

object (CreateFootnoteRequest)

脚注を作成します。

object (ReplaceNamedRangeContentRequest)

名前付き範囲の内容を置き換えます。

object (UpdateSectionStyleRequest)

指定された範囲のセクション スタイルを更新します。

object (InsertSectionBreakRequest)

指定した位置にセクション区切りを挿入します。

object (DeleteHeaderRequest)

ドキュメントからヘッダーを削除します。

object (DeleteFooterRequest)

ドキュメントからフッターを削除します。

object (PinTableHeaderRowsRequest)

テーブル内の固定されたヘッダー行の数を更新します。

object (AddDocumentTabRequest)

ドキュメント タブを追加します。

object (DeleteTabRequest)

ドキュメント タブを削除します。

object (UpdateDocumentTabPropertiesRequest)

ドキュメント タブのプロパティを更新します。

object (InsertPersonRequest)

ユーザーのメンションを挿入します。

object (UpdateNamedStyleRequest)

名前付きスタイルを更新します。

object (InsertRichLinkRequest)

リッチリンクを挿入します。

object (InsertDateRequest)

日付を挿入します。

object (InsertCommentRequest)

ドキュメントに CommentThread を挿入します。

object (AddCommentReplyRequest)

CommentThread または SuggestionThread に返信を追加します。

object (UpdateCommentPostRequest)

CommentThread または SuggestionThread の既存の投稿（ヘッド投稿または返信）を更新します。

object (DeleteCommentRequest)

CommentThread を削除します。

object (DeleteCommentReplyRequest)

CommentThread または SuggestionThread から返信 Post を削除します。

object (AcceptSuggestionRequest)

候補を承認します。

object (RejectSuggestionRequest)

候補を拒否します。

object (DeleteSuggestionRequest)

候補を削除します。

string

一致したテキストを置き換えるテキスト。

object (TabsCriteria)

省略可。置換が行われるタブを指定するために使用される条件。

省略すると、置換はすべてのタブに適用されます。

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

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

• 省略すると、置換は単一のタブに適用されます。

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

• 指定された場合、置換は指定されたタブに適用されます。

• 省略すると、置換はすべてのタブに適用されます。

object (SubstringMatchCriteria)

この部分文字列に一致するテキストをドキュメント内で検索します。

string

ドキュメント内で検索するテキスト。

boolean

検索で大文字と小文字を区別するかどうかを示します。

• True : 検索では大文字と小文字が区別されます。
• False : 検索では大文字と小文字が区別されません。

boolean

省略可。検索値を正規表現として扱う場合は true。パターン内のバックスラッシュはエスケープする必要があります。

• True : 検索テキストが正規表現として扱われます。
• False : 検索テキストは、照合用の部分文字列として扱われます。

string

リクエストが実行されるタブ ID のリスト。

string

挿入するテキスト。

改行文字を挿入すると、そのインデックスに新しい Paragraph が暗黙的に作成されます。新しい段落の段落スタイルは、現在の挿入インデックスの段落からコピーされます（リストや箇条書きを含む）。

挿入されたテキストのスタイルは自動的に決定され、通常は隣接するテキストのスタイルが保持されます。ほとんどの場合、挿入されたテキストのテキスト スタイルは、挿入インデックスの直前のテキストと一致します。

挿入されたテキストから、一部の制御文字（U+0000 ～ U+0008、U+000C ～ U+001F）と Unicode 基本多言語面の私用領域（U+E000 ～ U+F8FF）の文字が削除されます。

object (Location)

ドキュメントの特定のインデックスにテキストを挿入します。

テキストは既存の Paragraph の境界内に挿入する必要があります。たとえば、テキストをテーブルの開始インデックス（テーブルとその前の段落の間）に挿入することはできません。テキストは前の段落に挿入する必要があります。

object (EndOfSegmentLocation)

ヘッダー、フッター、脚注、ドキュメント本文の末尾にテキストを挿入します。

string

場所が属するヘッダー、フッター、脚注の ID。セグメント ID が空の場合、ドキュメントの本文を示します。

integer

UTF-16 コード単位の 0 ベースのインデックス。

インデックスは、segmentId で指定されたセグメントの先頭を基準としています。

string

場所が属するタブ。省略すると、リクエストは最初のタブに適用されます。

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

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

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

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

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

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

string

場所が属するヘッダー、フッター、脚注の ID。セグメント ID が空の場合、ドキュメントの本文を示します。

string

場所が属するタブ。省略すると、リクエストは最初のタブに適用されます。

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

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

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

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

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

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

object (TextStyle)

テキストに設定するスタイル。

特定のスタイルの値が親の値と一致する場合、そのスタイルは継承に設定されます。

特定のテキスト スタイルの変更により、ドキュメント エディタの動作を反映するために他の変更が行われることがあります。詳細については、TextStyle のドキュメントをご覧ください。

string (FieldMask format)

更新するフィールド。

少なくとも 1 つのフィールドを指定する必要があります。ルート textStyle は暗黙的に指定されるため、指定しないでください。単一の "*" は、すべてのフィールドを一覧表示する短縮形として使用できます。

たとえば、テキスト スタイルを太字に更新するには、fields を "bold" に設定します。

プロパティをデフォルト値にリセットするには、フィールド名をフィールド マスクに含めますが、フィールド自体は設定しないままにします。

object (Range)

スタイルを設定するテキストの範囲。

範囲は、隣接する改行を含むように拡張される場合があります。

範囲にリストに属する段落が完全に含まれている場合、段落の箇条書きも一致するテキスト スタイルで更新されます。

相対的な UpdateTextStyleRequest の内部に範囲を挿入することはできません。

object (Range)

箇条書きのプリセットを適用する範囲。

enum (BulletGlyphPreset)

使用する箇条書きのグリフの種類。

object (Range)

箇条書きを削除する範囲。

string

NamedRange の名前。名前は一意である必要はありません。

名前は 1 文字以上 256 文字以下にする必要があります（UTF-16 コード単位で測定）。

object (Range)

名前を適用する範囲。

object (TabsCriteria)

省略可。範囲の削除を行うタブを指定するために使用される条件。省略すると、範囲の削除はすべてのタブに適用されます。

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

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

• 省略すると、範囲の削除は単一のタブに適用されます。

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

• 指定した場合、範囲の削除は指定されたタブに適用されます。

• 指定しない場合、範囲の削除はすべてのタブに適用されます。

string

削除する名前付き範囲の ID。

string

削除する範囲の名前。指定された名前のすべての名前付き範囲が削除されます。

object (ParagraphStyle)

段落に設定するスタイル。

一部の段落スタイルの変更は、ドキュメント エディタの動作を反映するために、他の変更を引き起こす可能性があります。詳細については、ParagraphStyle のドキュメントをご覧ください。

string (FieldMask format)

更新するフィールド。

少なくとも 1 つのフィールドを指定する必要があります。ルート paragraphStyle は暗黙的に指定されるため、指定しないでください。単一の "*" は、すべてのフィールドを一覧表示する短縮形として使用できます。

たとえば、段落スタイルの配置プロパティを更新するには、fields を "alignment" に設定します。

プロパティをデフォルト値にリセットするには、フィールド名をフィールド マスクに含めますが、フィールド自体は設定しないままにします。

object (Range)

スタイル設定する段落と重複する範囲。

object (Range)

削除するコンテンツの範囲。

段落の境界をまたぐテキストを削除すると、2 つの段落が結合されるため、段落スタイル、リスト、配置されたオブジェクト、ブックマークが変更されることがあります。

特定の範囲を削除しようとすると、ドキュメント構造が無効になり、400 Bad Request エラーが返されることがあります。

無効な削除リクエストの例を次に示します。

• サロゲート ペアの 1 つのコード単位を削除します。
• Body、Header、Footer、Footnote、TableCell、TableOfContents の最後の改行文字を削除します。
• 要素全体を削除せずに、Table、TableOfContents、Equation の開始または終了を削除します。
• Table、TableOfContents、SectionBreak の前の改行文字を削除します。要素は削除しません。
• テーブルの個々の行またはセルを削除する。テーブル セル内のコンテンツの削除は許可されます。

string

画像 URI。

画像は挿入時に 1 回取得され、ドキュメント内に表示するためにコピーが保存されます。画像のサイズは 50 MB 未満、25 メガピクセル以下で、PNG、JPEG、GIF のいずれかの形式である必要があります。

指定された URI は一般公開されており、長さが 2 kB 以下である必要があります。URI 自体は画像とともに保存され、ImageProperties.content_uri フィールドを介して公開されます。

object (Size)

ドキュメントに表示される画像のサイズ。このプロパティは省略可能です。ドキュメント内の画像の最終的なサイズは、次のルールに基づいて決定されます。* 幅も高さも指定されていない場合、画像のデフォルトのサイズは解像度に基づいて計算されます。* 1 つのディメンションが指定されている場合、画像のアスペクト比を維持するように他のディメンションが計算されます。* 幅と高さの両方が指定されている場合、画像はアスペクト比を維持したまま、指定されたサイズに収まるように拡大縮小されます。

object (Location)

ドキュメントの特定のインデックスに画像を挿入します。

画像は既存の Paragraph の境界内に挿入する必要があります。たとえば、表の開始インデックス（表とその前の段落の間）に挿入することはできません。

インライン画像は、脚注や数式の中に挿入できません。

object (EndOfSegmentLocation)

ヘッダー、フッター、ドキュメント本文の末尾にテキストを挿入します。

インライン画像を脚注内に挿入することはできません。

integer

テーブル内の行数。

integer

テーブル内の列数。

object (Location)

特定のモデル インデックスにテーブルを挿入します。

挿入されたテーブルの前に改行文字が挿入されるため、テーブルの開始インデックスは指定された位置インデックス + 1 になります。

テーブルは既存の Paragraph の境界内に挿入する必要があります。たとえば、テーブルの開始インデックス（既存のテーブルとその前の段落の間）に挿入することはできません。

表を脚注や数式の中に挿入することはできません。

object (EndOfSegmentLocation)

指定されたヘッダー、フッター、またはドキュメント本文の末尾に表を挿入します。挿入された表の前に改行文字が挿入されます。

表を脚注内に挿入することはできません。

object (TableCellLocation)

行が挿入される基準テーブルのセルの位置。

参照セルがある行の上（または下）に新しい行が挿入されます。参照セルが結合されたセルである場合は、結合されたセルの上（または下）に新しい行が挿入されます。

boolean

参照セルの位置の下に新しい行を挿入するかどうか。

• True : セルの下に挿入します。
• False : セルの上に挿入します。

object (Location)

ドキュメント内でテーブルが始まる位置。

integer

ゼロから始まる行インデックス。たとえば、テーブルの 2 行目の行インデックスは 1 です。

integer

ゼロから始まる列インデックス。たとえば、テーブルの 2 番目の列の列インデックスは 1 です。

object (TableCellLocation)

列が挿入される参照テーブルのセルの位置。

参照セルがある列の左（または右）に新しい列が挿入されます。参照セルが結合セルである場合は、結合セルの左（または右）に新しい列が挿入されます。

boolean

参照セルの位置の右に新しい列を挿入するかどうか。

• True : 右に挿入します。
• False : 左に挿入します。

object (TableCellLocation)

行が削除される参照テーブルのセルの位置。

このセルがまたがる行は削除されます。複数の行にまたがる結合セルである場合は、そのセルがまたがるすべての行が削除されます。この削除後にテーブルに行が残っていない場合、テーブル全体が削除されます。

object (TableCellLocation)

列が削除される参照テーブルのセルの位置。

このセルがまたがる列が削除されます。これが複数の列にまたがる結合セルである場合、セルがまたがるすべての列が削除されます。この削除後にテーブルに列が残っていない場合、テーブル全体が削除されます。

object (Location)

ドキュメントの特定のインデックスに改ページを挿入します。

改ページは、既存の Paragraph の境界内に挿入する必要があります。たとえば、表の開始インデックス（表とその前の段落の間）に挿入することはできません。

改ページは、表、数式、脚注、ヘッダー、フッターの中に挿入することはできません。改ページは本文内にのみ挿入できるため、segment ID フィールドは空にする必要があります。

object (EndOfSegmentLocation)

ドキュメント本文の末尾に改ページを挿入します。

脚注、ヘッダー、フッターの中に改ページを挿入することはできません。改ページは本文内にのみ挿入できるため、segment ID フィールドは空にする必要があります。

string

削除する配置済みオブジェクトの ID。

string

削除する配置済みオブジェクトがあるタブ。省略すると、リクエストは最初のタブに適用されます。

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

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

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

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

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

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

object (Location)

ドキュメント内でテーブルが始まる位置。

integer

プロパティを更新するゼロベースの列インデックスのリスト。インデックスが指定されていない場合、すべての列が更新されます。

object (TableColumnProperties)

更新するテーブル列のプロパティ。

tableColumnProperties#width の値が 5 ポイント（5/72 インチ）未満の場合、400 Bad Request エラーが返されます。

string (FieldMask format)

更新するフィールド。

少なくとも 1 つのフィールドを指定する必要があります。ルート tableColumnProperties は暗黙的に指定されるため、指定しないでください。単一の "*" は、すべてのフィールドを一覧表示する短縮形として使用できます。

たとえば、列の幅を更新するには、fields を "width" に設定します。

object (TableCellStyle)

テーブルのセルに設定するスタイル。

枠線を更新するときに、セルが隣接するセルと枠線を共有している場合、隣接するセルの対応する枠線プロパティも更新されます。結合されて非表示になっている境界線は更新されません。

同じリクエストで隣接するセルで共有される境界線を更新すると、境界線の更新が競合する可能性があるため、境界線の更新は次の順序で適用されます。

• borderRight
• borderLeft
• borderBottom
• borderTop

string (FieldMask format)

更新するフィールド。

少なくとも 1 つのフィールドを指定する必要があります。ルート tableCellStyle は暗黙的に指定されるため、指定しないでください。単一の "*" は、すべてのフィールドを一覧表示する短縮形として使用できます。

たとえば、テーブル セルの背景色を更新するには、fields を "backgroundColor" に設定します。

プロパティをデフォルト値にリセットするには、フィールド名をフィールド マスクに含めますが、フィールド自体は設定しないままにします。

object (TableRange)

更新が適用されるテーブルのサブセットを表すテーブル範囲。

object (Location)

ドキュメント内のテーブルの開始位置。指定すると、更新はテーブル内のすべてのセルに適用されます。

object (TableCellLocation)

表範囲の開始位置のセル。

integer

テーブル範囲の行スパン。

integer

テーブル範囲の列スパン。

object (Location)

ドキュメント内でテーブルが始まる位置。

integer

スタイルを更新するゼロベースの行インデックスのリスト。インデックスが指定されていない場合は、すべての行が更新されます。

object (TableRowStyle)

行に設定するスタイル。

string (FieldMask format)

更新するフィールド。

少なくとも 1 つのフィールドを指定する必要があります。ルート tableRowStyle は暗黙的に指定されるため、指定しないでください。単一の "*" は、すべてのフィールドを一覧表示する短縮形として使用できます。

たとえば、行の最小高を更新するには、fields を "minRowHeight" に設定します。

string

置き換えられる既存のイメージの ID。ID は、GET リクエストのレスポンスから取得できます。

string

新しい画像の URI。

画像は挿入時に 1 回取得され、ドキュメント内に表示するためにコピーが保存されます。画像は 50 MB 未満、25 メガピクセル以下で、PNG、JPEG、GIF のいずれかの形式である必要があります。

指定された URI の長さは 2 KB を超えることはできません。URI は画像とともに保存され、ImageProperties.source_uri フィールドを通じて公開されます。

enum (ImageReplaceMethod)

置換メソッド。

string

置き換える画像があるタブ。省略すると、リクエストは最初のタブに適用されます。

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

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

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

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

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

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

object (DocumentStyle)

ドキュメントに設定するスタイル。

ドキュメントのスタイルを変更すると、ドキュメント エディタの動作を反映するために、他の変更が加えられることがあります。詳細については、DocumentStyle のドキュメントをご覧ください。

string (FieldMask format)

更新するフィールド。

少なくとも 1 つのフィールドを指定する必要があります。ルート documentStyle は暗黙的に指定されるため、指定しないでください。単一の "*" は、すべてのフィールドを一覧表示する短縮形として使用できます。

たとえば、背景を更新するには、fields を "background" に設定します。

string

更新するスタイルを含むタブ。省略した場合、リクエストは最初のタブに適用されます。

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

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

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

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

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

• 指定しない場合、リクエストはドキュメントの最初のタブに適用されます。

object (TableRange)

テーブルのどのセルを結合するかを指定するテーブル範囲。

結合されるセル内のテキストは連結され、範囲の「先頭」セルに保存されます。コンテンツの方向が左から右の場合は範囲の左上のセル、それ以外の場合は範囲の右上のセルです。

範囲が長方形でない場合（範囲がすでに結合されているセルをカバーしている場合や、テーブルが長方形でない場合に発生することがあります）、400 不正なリクエスト エラーが返されます。

object (TableRange)

テーブルのどのセルを結合解除するかを指定するテーブル範囲。

この範囲内のすべての結合セルが結合解除されます。すでに結合解除されているセルは影響を受けません。範囲に結合されたセルがない場合、リクエストは何も行いません。

結合されたセルにテキストが含まれている場合、そのテキストは、結合が解除されたセルのブロックの「先頭」セルに残ります。「ヘッド」セルは、コンテンツの方向が左から右の場合は左上のセル、それ以外の場合は右上のセルです。

enum (HeaderFooterType)

作成するヘッダーのタイプ。

object (Location)

このヘッダーが属するセクションの先頭にある SectionBreak の位置。`sectionBreakLocation` が設定されていない場合、またはドキュメント本文の最初のセクション区切りを参照している場合、ヘッダーは DocumentStyle に適用されます。

enum (HeaderFooterType)

作成するフッターのタイプ。

object (Location)

このフッターが属するセクションの SectionStyle の直前の SectionBreak の位置。これが設定されていない場合、またはドキュメントの最初のセクション区切りを参照している場合、フッターはドキュメント スタイルに適用されます。

object (Location)

ドキュメントの特定のインデックスに脚注参照を挿入します。

脚注参照は、既存の Paragraph の境界内に挿入する必要があります。たとえば、表の開始インデックス（表とその前の段落の間）に挿入することはできません。

脚注参照は、数式、ヘッダー、フッター、脚注の中に挿入できません。脚注参照は本文にのみ挿入できるため、segment ID フィールドは空である必要があります。

object (EndOfSegmentLocation)

ドキュメント本文の末尾に脚注参照を挿入します。

脚注参照をヘッダー、フッター、脚注の中に挿入することはできません。脚注参照は本文にのみ挿入できるため、segment ID フィールドは空である必要があります。

object (TabsCriteria)

省略可。置換が行われるタブを指定するために使用される条件。省略すると、置換はすべてのタブに適用されます。

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

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

• 省略すると、置換は単一のタブに適用されます。

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

• 指定された場合、置換は指定されたタブに適用されます。

• 省略すると、置換はすべてのタブに適用されます。

string

指定した名前付き範囲のコンテンツを、指定したテキストに置き換えます。

string

コンテンツが置き換えられる名前付き範囲の ID。

指定された ID の名前付き範囲がない場合は、400 不正なリクエスト エラーが返されます。

string

コンテンツが置き換えられる NamedRanges の名前。

指定された名前の named ranges が複数ある場合は、それぞれの内容が置き換えられます。指定された名前の範囲名が存在しない場合、リクエストは no-op になります。

object (Range)

スタイル設定するセクションと重複する範囲。

セクション区切りは本文内にのみ挿入できるため、segment ID フィールドは空にする必要があります。

object (SectionStyle)

セクションに設定するスタイル。

特定のセクション スタイルの変更により、ドキュメント エディタの動作を反映するために他の変更が行われることがあります。詳細については、SectionStyle のドキュメントをご覧ください。

string (FieldMask format)

更新するフィールド。

少なくとも 1 つのフィールドを指定する必要があります。ルート sectionStyle は暗黙的に指定されるため、指定してはなりません。単一の "*" は、すべてのフィールドを一覧表示する短縮形として使用できます。

たとえば、左余白を更新するには、fields を "marginLeft" に設定します。

enum (SectionType)

挿入するセクションのタイプ。

object (Location)

ドキュメントの特定のインデックスに改行とセクション区切りを挿入します。

セクション区切りは、既存の Paragraph の境界内に挿入する必要があります。たとえば、表の開始インデックス（表とその前の段落の間）に挿入することはできません。

セクション区切りは、表、数式、脚注、ヘッダー、フッターの中に挿入できません。セクション区切りは本文内にのみ挿入できるため、segment ID フィールドは空にする必要があります。

object (EndOfSegmentLocation)

ドキュメント本文の末尾に改行とセクション区切りを挿入します。

セクション区切りを脚注、ヘッダー、フッターの中に挿入することはできません。セクション区切りは本文内にのみ挿入できるため、segment ID フィールドは空にする必要があります。

string

削除するヘッダーの ID。このヘッダーが DocumentStyle で定義されている場合、このヘッダーへの参照が削除され、ドキュメントの最初のセクションにそのタイプのヘッダーがなくなります。このヘッダーが SectionStyle で定義されている場合、このヘッダーへの参照は削除され、この型のヘッダーは前のセクションから継続されます。

string

削除するヘッダーを含むタブ。省略すると、リクエストは最初のタブに適用されます。

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

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

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

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

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

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

string

削除するフッターの ID。このフッターが DocumentStyle で定義されている場合、このフッターへの参照が削除され、ドキュメントの最初のセクションにそのタイプのフッターがなくなります。このフッターが SectionStyle で定義されている場合、このフッターへの参照は削除され、そのタイプのフッターは前のセクションから継続されます。

string

削除するフッターを含むタブ。省略すると、リクエストは最初のタブに適用されます。

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

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

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

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

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

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

object (Location)

ドキュメント内でテーブルが始まる位置。

integer

固定するテーブル行の数。0 はすべての行が固定されていないことを意味します。

object (TabProperties)

追加するタブのプロパティ。すべてのプロパティは省略可能です。

string

削除するタブの ID。

object (TabProperties)

更新するタブのプロパティ。

string (FieldMask format)

更新するフィールド。

少なくとも 1 つのフィールドを指定する必要があります。ルート tabProperties は暗黙的に指定されるため、指定しないでください。単一の "*" は、すべてのフィールドを一覧表示する短縮形として使用できます。

object (PersonProperties)

挿入する人物メンションのプロパティ。

object (Location)

ドキュメントの特定のインデックスにユーザーメンションを挿入します。

ユーザーメンションは、既存の Paragraph の境界内に挿入する必要があります。たとえば、表の開始インデックス（表とその前の段落の間）に挿入することはできません。

数式内にユーザーメンションを挿入することはできません。

object (EndOfSegmentLocation)

ヘッダー、フッター、脚注、またはドキュメント本文の末尾にユーザーメンションを挿入します。

object (NamedStyle)

更新するドキュメント スタイル。

string (FieldMask format)

更新する NamedStyle フィールド。

少なくとも namedStyleType を指定する必要があります。ルート namedStyle は暗黙的に指定されるため、指定しないでください。単一の "*" は、すべてのフィールドを一覧表示する短縮形として使用できます。

たとえば、テキストのスタイルを太字に更新するには、fields を "textStyle" と "textStyle.bold" を含むように設定します。段落スタイルの配置プロパティを更新するには、fields を設定して "paragraphStyle" と "paragraphStyle.alignment" を含めます。

プロパティをデフォルト値にリセットするには、フィールド マスクにフィールド名を含めますが、フィールド自体は設定しないままにします。空の TextStyle または ParagraphStyle で "textStyle" または "paragraphStyle" を指定すると、ネストされたすべてのフィールドがリセットされます。

string

更新するドキュメント タブ。デフォルトでは、更新は最初のタブに適用されます。

object (RichLinkProperties)

挿入するリッチリンクのプロパティ。

object (Location)

ドキュメント内の特定のインデックスにリッチリンクを挿入します。

リッチリンクは、既存の Paragraph の境界内に挿入する必要があります。たとえば、表の開始インデックス（表とその前の段落の間）に挿入することはできません。

リッチリンクを数式内に挿入することはできません。

object (EndOfSegmentLocation)

ヘッダー、フッター、脚注、またはドキュメント本文の末尾にリッチリンクを挿入します。

object (DateElementProperties)

挿入する日付のプロパティ。

object (Location)

ドキュメントの特定のインデックスに日付を挿入します。

日付は既存の Paragraph の境界内に挿入する必要があります。たとえば、テーブルの開始インデックス（既存のテーブルとその前の段落の間）に挿入することはできません。

object (EndOfSegmentLocation)

指定されたヘッダー、フッター、またはドキュメント本文の末尾に日付を挿入します。

string

コメントのテキスト（書式なしテキスト）。

このテキスト コンテンツは、ドキュメント エディタで作成されたコメントと同様に処理されます。書式設定や通知などについても同様の動作をします。

このフィールドは空にできず、2, 048 UTF-8 コード単位を超えてはなりません。

string

省略可。コメントの割り当て先のメールアドレス。

割り当てられていないコメントの場合は空欄のままにします。

2,048 UTF-8 コード単位を超えてはなりません。

object (Range)

このコメントに関連付けられているドキュメント内の Range。

object (Post)

返信を表す Post。

string

返信を追加する CommentThread の ID。

string

返信を追加する SuggestionThread の ID。

string

更新される投稿の ID。

string

コメントの新しいテキスト（書式なしテキスト）。

このテキスト コンテンツは、ドキュメント エディタで作成されたコメントと同様に処理されます。書式設定や通知などについても同様の動作をします。

このフィールドは空にできず、2, 048 UTF-8 コード単位を超えてはなりません。

string

投稿が属する CommentThread の ID。

string

投稿が属する SuggestionThread の ID。

string

削除される CommentThread の ID。

string

削除される返信 Post の ID。

string

投稿が属する CommentThread の ID。

string

投稿が属する SuggestionThread の ID。

string

候補の ID。

string

候補の ID。

string

候補の ID。