Requests

{

  // Union field request can be only one of the following:
  "replaceAllText": {
    object (ReplaceAllTextRequest)
  },
  "insertText": {
    object (InsertTextRequest)
  },
  "updateTextStyle": {
    object (UpdateTextStyleRequest)
  },
  "createParagraphBullets": {
    object (CreateParagraphBulletsRequest)
  },
  "deleteParagraphBullets": {
    object (DeleteParagraphBulletsRequest)
  },
  "createNamedRange": {
    object (CreateNamedRangeRequest)
  },
  "deleteNamedRange": {
    object (DeleteNamedRangeRequest)
  },
  "updateParagraphStyle": {
    object (UpdateParagraphStyleRequest)
  },
  "deleteContentRange": {
    object (DeleteContentRangeRequest)
  },
  "insertInlineImage": {
    object (InsertInlineImageRequest)
  },
  "insertTable": {
    object (InsertTableRequest)
  },
  "insertTableRow": {
    object (InsertTableRowRequest)
  },
  "insertTableColumn": {
    object (InsertTableColumnRequest)
  },
  "deleteTableRow": {
    object (DeleteTableRowRequest)
  },
  "deleteTableColumn": {
    object (DeleteTableColumnRequest)
  },
  "insertPageBreak": {
    object (InsertPageBreakRequest)
  },
  "deletePositionedObject": {
    object (DeletePositionedObjectRequest)
  },
  "updateTableColumnProperties": {
    object (UpdateTableColumnPropertiesRequest)
  },
  "updateTableCellStyle": {
    object (UpdateTableCellStyleRequest)
  },
  "updateTableRowStyle": {
    object (UpdateTableRowStyleRequest)
  },
  "replaceImage": {
    object (ReplaceImageRequest)
  },
  "updateDocumentStyle": {
    object (UpdateDocumentStyleRequest)
  },
  "mergeTableCells": {
    object (MergeTableCellsRequest)
  },
  "unmergeTableCells": {
    object (UnmergeTableCellsRequest)
  },
  "createHeader": {
    object (CreateHeaderRequest)
  },
  "createFooter": {
    object (CreateFooterRequest)
  },
  "createFootnote": {
    object (CreateFootnoteRequest)
  },
  "replaceNamedRangeContent": {
    object (ReplaceNamedRangeContentRequest)
  },
  "updateSectionStyle": {
    object (UpdateSectionStyleRequest)
  },
  "insertSectionBreak": {
    object (InsertSectionBreakRequest)
  },
  "deleteHeader": {
    object (DeleteHeaderRequest)
  },
  "deleteFooter": {
    object (DeleteFooterRequest)
  },
  "pinTableHeaderRows": {
    object (PinTableHeaderRowsRequest)
  }
  // End of list of possible types for union field request.
}

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)

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

{
  "replaceText": string,
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // Union field criteria can be only one of the following:
  "containsText": {
    object (SubstringMatchCriteria)
  }
  // End of list of possible types for union field criteria.
}

string

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

object (TabsCriteria)

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

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

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

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

• 省略すると、1 つのタブに置換が適用されます。

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

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

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

object (SubstringMatchCriteria)

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

{
  "text": string,
  "matchCase": boolean
}

string

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

boolean

大文字と小文字を区別するかどうかを指定します。

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

{
  "tabIds": [
    string
  ]
}

string

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

{
  "text": string,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

string

挿入するテキスト。

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

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

挿入されたテキストからは、一部の制御文字（U+0000-U+0008、U+000C-U+001F）と Unicode Basic Multilingual Plane Private Use Area（U+E000-U+F8FF）の文字が取り除かれます。

object (Location)

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

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

object (EndOfSegmentLocation)

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

{
  "segmentId": string,
  "index": integer,
  "tabId": string
}

string

ビジネス情報を含むヘッダー、フッター、脚注の ID。セグメント ID が空の場合は、ドキュメントの本文を示します。

integer

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

インデックスは、 segmentId。

string

ビジネスがあるタブ。省略すると、リクエストは最初のタブに適用されます。

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

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

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

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

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

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

{
  "segmentId": string,
  "tabId": string
}

string

ビジネス情報を含むヘッダー、フッター、脚注の ID。セグメント ID が空の場合は、ドキュメントの本文を示します。

string

ビジネスがあるタブ。省略すると、リクエストは最初のタブに適用されます。

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

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

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

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

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

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

{
  "textStyle": {
    object (TextStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}

object (TextStyle)

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

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

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

string (FieldMask format)

更新対象のフィールド。

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

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

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

object (Range)

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

隣接する改行を含めるように範囲を拡張することもできます。

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

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

{
  "range": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}

object (Range)

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

enum (BulletGlyphPreset)

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

{
  "range": {
    object (Range)
  }
}

object (Range)

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

{
  "name": string,
  "range": {
    object (Range)
  }
}

string

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

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

object (Range)

名前を適用する範囲。

{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "name": string
  // End of list of possible types for union field named_range_reference.
}

object (TabsCriteria)

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

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

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

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

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

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

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

string

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

string

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

{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}

object (ParagraphStyle)

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

段落のスタイルを変更すると、ドキュメント エディタの動作を反映させるために、他の変更が行われる場合があります。詳しくは、 ParagraphStyle をご覧ください。

string (FieldMask format)

更新対象のフィールド。

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

たとえば、段落スタイルのアライメント プロパティを更新するには、 fields から "alignment"。

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

object (Range)

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

{
  "range": {
    object (Range)
  }
}

object (Range)

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

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

特定の範囲を削除しようとすると、無効なドキュメント構造が返されることがあり、その場合は 400 不正なリクエスト エラーが返されます。

無効な削除リクエストには次のようなものがあります。

• サロゲートペアの 1 つのコード単位を削除する。
• 最後の改行文字を削除すると、 Body, Header, Footer, Footnote, TableCell または TableOfContents。
• 先頭または末尾を削除すると、 Table, TableOfContents または Equation 要素全体を削除する必要はありません。
• 先頭にある改行文字を削除すると、 Table, TableOfContents または SectionBreak 要素を削除する必要はありません。
• テーブルの個々の行やセルを削除する。表のセル内のコンテンツは削除できます。

{
  "uri": string,
  "objectSize": {
    object (Size)
  },

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

string

イメージの URI。

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

指定する URI は一般公開されている必要があり、長さは 2 KB 以下である必要があります。URI 自体は画像と一緒に保存され、 ImageProperties.content_uri 表示されます。

object (Size)

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

object (Location)

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

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

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

object (EndOfSegmentLocation)

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

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

{
  "rows": integer,
  "columns": integer,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

integer

テーブル内の行数。

integer

テーブル内の列の数。

object (Location)

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

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

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

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

object (EndOfSegmentLocation)

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

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

{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean
}

object (TableCellLocation)

行の挿入元となる参照テーブルのセルの場所。

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

boolean

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

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

{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndex": integer,
  "columnIndex": integer
}

object (Location)

ドキュメント内の表の開始位置。

integer

ゼロベースの行インデックス。たとえば、テーブルの 2 番目の行の行インデックスは 1 です。

integer

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

{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean
}

object (TableCellLocation)

列の挿入元となる参照テーブルのセルの場所。

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

boolean

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

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

{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}

object (TableCellLocation)

行を削除する参照テーブルのセルの場所。

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

{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}

object (TableCellLocation)

列を削除する参照テーブルのセルの場所。

このセルにまたがる列が削除されます。複数の列にまたがる結合したセルの場合、そのセルがまたがっている列はすべて削除されます。この削除後もテーブルに列が残らなければ、テーブル全体が削除されます。

{

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

object (Location)

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

改ページは、既存の Paragraph。たとえば、テーブルの開始インデックス（テーブルとその前の段落の間）に挿入することはできません。

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

object (EndOfSegmentLocation)

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

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

{
  "objectId": string,
  "tabId": string
}

string

削除する位置決めオブジェクトの ID。

string

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

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

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

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

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

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

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

{
  "tableStartLocation": {
    object (Location)
  },
  "columnIndices": [
    integer
  ],
  "tableColumnProperties": {
    object (TableColumnProperties)
  },
  "fields": string
}

object (Location)

ドキュメント内の表の開始位置。

integer

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

object (TableColumnProperties)

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

値が tableColumnProperties#width 5 ポイント（5/72 インチ）未満の場合は、400 不正なリクエスト エラーが返されます。

string (FieldMask format)

更新対象のフィールド。

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

たとえば、列の幅を更新するには、 fields から "width"。

{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "fields": string,

  // Union field cells can be only one of the following:
  "tableRange": {
    object (TableRange)
  },
  "tableStartLocation": {
    object (Location)
  }
  // End of list of possible types for union field cells.
}

object (TableCellStyle)

表のセルに設定するスタイル。

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

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

• borderRight
• borderLeft
• borderBottom
• borderTop

string (FieldMask format)

更新対象のフィールド。

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

たとえば、表のセルの背景色を更新するには、 fields から "backgroundColor"。

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

object (TableRange)

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

object (Location)

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

{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}

object (TableCellLocation)

表の範囲を開始するセルの位置。

integer

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

integer

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

{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndices": [
    integer
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "fields": string
}

object (Location)

ドキュメント内の表の開始位置。

integer

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

object (TableRowStyle)

行に設定するスタイル。

string (FieldMask format)

更新対象のフィールド。

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

たとえば、行の最小の高さを更新するには、 fields から "minRowHeight"。

{
  "imageObjectId": string,
  "uri": string,
  "imageReplaceMethod": enum (ImageReplaceMethod),
  "tabId": string
}

string

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

string

新しい画像の URI。

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

指定する URI は長さが 2 KB を超えないようにしてください。URI は画像とともに保存され、 ImageProperties.source_uri 表示されます。

enum (ImageReplaceMethod)

置換メソッド。

string

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

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

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

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

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

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

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

{
  "documentStyle": {
    object (DocumentStyle)
  },
  "fields": string,
  "tabId": string
}

object (DocumentStyle)

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

特定のドキュメント スタイルを変更すると、ドキュメント エディタの動作を反映させるために、他の変更が行われる場合があります。詳しくは、 DocumentStyle をご覧ください。

string (FieldMask format)

更新対象のフィールド。

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

たとえば、背景を更新するには、 fields から "background"。

string

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

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

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

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

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

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

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

{
  "tableRange": {
    object (TableRange)
  }
}

object (TableRange)

結合する表のセルを指定する表の範囲。

結合されるセル内のテキストはすべて連結されて「ヘッド」に格納されますその範囲のセル。コンテンツの方向が左から右の場合は範囲の左上のセル、それ以外の場合は範囲の右上のセルになります。

範囲が長方形以外の場合（結合済みのセルや表が非長方形のセルが範囲に含まれる場合がある）、400 不正なリクエスト エラーが返されます。

{
  "tableRange": {
    object (TableRange)
  }
}

object (TableRange)

結合を解除する表のセルを指定する表の範囲。

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

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

{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}

enum (HeaderFooterType)

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

object (Location)

アプリケーションの SectionBreak これは、このヘッダーが属するセクションを開始します。「sectionBreakLocation」についてが設定されていない場合、またはドキュメント本文の最初のセクション区切りを参照している場合、ヘッダーは DocumentStyle

{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}

enum (HeaderFooterType)

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

object (Location)

アプリケーションの SectionBreak そのセクションの直前を SectionStyle 指定するようにします。このポリシーを未設定のままにした場合や、ドキュメントの最初のセクション区切りを参照している場合は、フッターがドキュメント スタイルに適用されます。

{

  // Union field footnote_reference_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field footnote_reference_location.
}

object (Location)

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

脚注参照は既存の Paragraph。たとえば、テーブルの開始インデックス（テーブルとその前の段落の間）に挿入することはできません。

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

object (EndOfSegmentLocation)

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

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

{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // Union field replacement_content can be only one of the following:
  "text": string
  // End of list of possible types for union field replacement_content.

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "namedRangeName": string
  // End of list of possible types for union field named_range_reference.
}

object (TabsCriteria)

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

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

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

• 省略すると、1 つのタブに置換が適用されます。

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

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

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

string

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

string

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

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

string

名前 NamedRanges そのコンテンツが置き換えられます

複数の named ranges 指定すると、それぞれの内容が置き換えられます。指定された名前の名前付き範囲がない場合、リクエストは何もしません。

{
  "range": {
    object (Range)
  },
  "sectionStyle": {
    object (SectionStyle)
  },
  "fields": string
}

object (Range)

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

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

object (SectionStyle)

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

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

string (FieldMask format)

更新対象のフィールド。

少なくとも 1 つのフィールドを指定する必要があります。ルート sectionStyle 指定しないでください。単一の "*" すべてのフィールドをリストするための省略形として使用できます。

たとえば、左余白を更新するには、 fields から "marginLeft"。

{
  "sectionType": enum (SectionType),

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

enum (SectionType)

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

object (Location)

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

セクション区切りは、既存の Paragraph。たとえば、テーブルの開始インデックス（テーブルとその前の段落の間）に挿入することはできません。

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

object (EndOfSegmentLocation)

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

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

{
  "headerId": string,
  "tabId": string
}

string

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

string

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

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

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

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

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

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

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

{
  "footerId": string,
  "tabId": string
}

string

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

string

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

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

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

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

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

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

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

{
  "tableStartLocation": {
    object (Location)
  },
  "pinnedHeaderRowsCount": integer
}

object (Location)

ドキュメント内の表の開始位置。

integer

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