Requests

リクエスト

ドキュメントに適用される単一の更新。

JSON 表現 
{

  // 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.
}
フィールド
共用体フィールド request。適用するリクエスト。フィールドは 1 つだけ指定する必要があります。request は次のいずれかになります。
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)

ヘッダーを作成します。
createFootnote

object (CreateFootnoteRequest)

脚注を作成します。
replaceNamedRangeContent

object (ReplaceNamedRangeContentRequest)

名前付き範囲のコンテンツを置き換えます。
updateSectionStyle

object (UpdateSectionStyleRequest)

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

object (InsertSectionBreakRequest)

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

deleteHeader

object (DeleteHeaderRequest)

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

pinTableHeaderRows

object (PinTableHeaderRowsRequest)

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

replaceAllTextRequest

条件に一致するテキストのすべてのインスタンスを replace text に置き換えます。

JSON 表現 
{
  "replaceText": string,

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

string

一致したテキストを置き換えるテキスト。
共用体フィールド criteria。置き換えるテキストのマッチングに使用する条件。 criteria は次のいずれかになります。
containsText

object (SubstringMatchCriteria)

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

SubstringMatchCriteria

ドキュメント内の特定の文字列に一致する基準。

JSON 表現 
{
  "text": string,
  "matchCase": boolean
}
フィールド
text

string

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

matchCase

boolean

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

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

InsertTextRequest

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

JSON 表現 
{
  "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.
}
フィールド
text

string

挿入されるテキスト。

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

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

一部の制御文字（U+0000-U+0008、U+000C-U+001F）と Unicode Basic Multilingual Plane Private Use Area（U+E000-U+F8FF）の文字が、挿入されたテキストから削除されます。
共用体フィールド insertion_location。テキストが挿入される場所。insertion_location は次のいずれかになります。
location

object (Location)

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

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

object (EndOfSegmentLocation)

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

位置情報

ドキュメント内の特定の場所。

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

string

場所のヘッダー、フッター、または脚注の ID。セグメント ID が空であれば、ドキュメントの本文を示します。
index

integer

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

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

EndOfSegmentLocation

本文、ヘッダー、フッター、脚注の末尾。場所は、ドキュメント セグメントの最後の改行の直前にあります。

JSON 表現 
{
  "segmentId": string
}
フィールド
segmentId

string

場所のヘッダー、フッター、または脚注の ID。セグメント ID が空であれば、ドキュメントの本文を示します。

UpdateTextStyleRequest

テキストのスタイルを更新します。

JSON 表現 
{
  "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.
}
フィールド
textStyle

object (TextStyle)

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

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

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

string (FieldMask format)

更新するフィールド。

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

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

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

共用体フィールド insertion_location。テキスト スタイルを更新するために使用する範囲のタイプ。insertion_location は次のいずれかになります。
range

object (Range)

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

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

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

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

CreateParagraphBulletsRequest

指定された範囲と重複するすべての段落に箇条書きを作成します。

各段落のネストレベルは、各段落の先頭にある先頭のタブの数を算出して決定します。箇条書きと対応する段落との間の余分なスペースを避けるために、これらの先頭のタブはこのリクエストによって削除されます。これにより、テキストの一部のインデックスが変化する場合があります。

更新前の段落が、一致するプリセットのリストに含まれている場合、更新される段落がその前のリストに追加されます。

JSON 表現 
{
  "range": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}
フィールド
range

object (Range)

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

enum (BulletGlyphPreset)

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

BulletGlyphPreset

リスト用の箇条書きグリフのプリセット パターン。

これらのパターンでは、次のリスト項目が使用されます。

  • ARROW: Unicode U+2794 コードポイントに対応する矢印
  • ARROW3D: Unicode U+27a2 コードポイントに対応する 3D 網掛けの矢印
  • CHECKBOX: Unicode U+274f コードポイントに対応する中が空洞の正方形
  • CIRCLE: Unicode U+25cb コードポイントに対応する中抜きの円
  • DIAMOND: Unicode U+25c6 コードポイントに対応する実線のひし形
  • DIAMONDX: Unicode U+2756 コードポイントに対応する「x」の付いたひし形
  • HOLLOWDIAMOND: Unicode U+25c7 コードポイントに対応する中空のひし形
  • DISC: Unicode U+25cf コードポイントに対応する実線の円
  • SQUARE: Unicode U+25a0 コードポイントに対応する実線の正方形
  • STAR: Unicode U+2605 コードポイントに対応するスター
  • ALPHA : 'a'、'b'、'c' などの小文字。
  • UPPERALPHA : 「A」、「B」、「C」などの大文字。
  • DECIMAL: 「1」、「2」、「3」などの数字。
  • ZERODECIMAL : 先頭に 0 で始まる 0 桁の数字（「01」、「02」、「03」など）。複数の数字を持つ番号には、先頭にゼロは含まれません。
  • ROMAN : 小文字の数字（「i」、「ii」、「iii」など）。
  • UPPERROMAN: 'I'、'II'、'III' などの大文字のローマ数字。
  • LEFTTRIANGLE: Unicode U+25c4 コードポイントに対応する左向きの三角形
列挙型
BULLET_GLYPH_PRESET_UNSPECIFIED 箇条書きのグリフのプリセットが指定されていません。
BULLET_DISC_CIRCLE_SQUARE 最初の 3 つのリストのネストレベルを表す箇条書きリスト。DISC、CIRCLE、SQUARE の箇条書きグリフ。
BULLET_DIAMONDX_ARROW3D_SQUARE 最初の 3 つのリストのネストレベルを表す箇条書きリスト。DIAMONDX、ARROW3D、SQUARE の箇条書きグリフ。
BULLET_CHECKBOX すべてのリストのネストレベルを表す箇条書きのグリフを CHECKBOX で指定する箇条書き。
BULLET_ARROW_DIAMOND_DISC 最初の 3 つのリストのネストレベルを表す箇条書きリスト。ARROW、DIAMOND、DISC の箇条書きグリフ。
BULLET_STAR_CIRCLE_SQUARE 最初の 3 つのリストのネストレベルを表す箇条書きリスト。STAR、CIRCLE、SQUARE の箇条書きグリフ。
BULLET_ARROW3D_CIRCLE_SQUARE 最初の 3 つのリストのネストレベルを表す箇条書きリスト。ARROW3D、CIRCLE、SQUARE の箇条書きグリフ。
BULLET_LEFTTRIANGLE_DIAMOND_DISC 最初の 3 つのリストのネストレベルを表す箇条書きリスト。LEFTTRIANGLE、DIAMOND、DISC の箇条書きグリフ。
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE 最初の 3 つのリストのネストレベルを表す箇条書きリスト。DIAMONDX、HOLLOWDIAMOND、SQUARE の箇条書きグリフ。
BULLET_DIAMOND_CIRCLE_SQUARE 最初の 3 つのリストのネストレベルを表す箇条書きリスト。DIAMOND、CIRCLE、SQUARE の箇条書きグリフ。
NUMBERED_DECIMAL_ALPHA_ROMAN 最初の 3 つのリストのネストレベルにピリオド、その後にピリオドが付いた、DECIMAL、ALPHA、ROMAN の数値グリフを含む番号付きリスト。
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS 最初の 3 つのリストのネストレベルを表す数字のグリフ、DECIMAL、ALPHA、ROMAN、その後に丸括弧を続ける番号付きのリスト。
NUMBERED_DECIMAL_NESTED DECIMAL 数値のグリフをピリオドで区切った番号付きのリスト。各ネストレベルでは、以前のネストレベルのグリフがプレフィックスとして使用されます。例: '1.'、'1.1.'、'2.'、「2.2.」
NUMBERED_UPPERALPHA_ALPHA_ROMAN 最初の 3 つのリストのネストレベルにピリオド、その後にピリオドが付いた、UPPERALPHA、ALPHA、ROMAN の数値グリフを含む番号付きリスト。
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL 最初の 3 つのリストのネストレベルにピリオド、その後にピリオドが付いた、UPPERROMAN、UPPERALPHA、DECIMAL の数値グリフを含む番号付きリスト。
NUMBERED_ZERODECIMAL_ALPHA_ROMAN 最初の 3 つのリストのネストレベルにピリオド、その後にピリオドが付いた、ZERODECIMAL、ALPHA、ROMAN の数値グリフを含む番号付きリスト。

DeleteParagraphBulletsRequest

指定された範囲と重複するすべての段落から箇条書きを削除します。

各段落のネストレベルは、対応する段落の先頭にインデントを追加することで、視覚的に保持されます。

JSON 表現 
{
  "range": {
    object (Range)
  }
}
フィールド
range

object (Range)

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

CreateNamedRangeRequest

指定された範囲を参照する NamedRange を作成します。

JSON 表現 
{
  "name": string,
  "range": {
    object (Range)
  }
}
フィールド
name

string

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

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

object (Range)

名前を適用する範囲。

DeleteNamedRangeRequest

NamedRange を削除します。

JSON 表現 
{

  // 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.
}
フィールド
共用体フィールド named_range_reference。削除する範囲を指定する値。正確に 1 つ設定する必要があります。 named_range_reference は次のいずれかになります。
namedRangeId

string

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

string

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

UpdateParagraphStyleRequest

指定された範囲と重複するすべての段落のスタイルを更新します。

JSON 表現 
{
  "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.
}
フィールド
paragraphStyle

object (ParagraphStyle)

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

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

string (FieldMask format)

更新するフィールド。

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

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

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

共用体フィールド insertion_location。段落スタイルが更新されるために使用される範囲のタイプ。insertion_location は次のいずれかになります。
range

object (Range)

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

DeleteContentRangeRequest

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

JSON 表現 
{
  "range": {
    object (Range)
  }
}
フィールド
range

object (Range)

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

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

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

無効な削除リクエストの例としては、次のようなものが挙げられます。

InsertInlineImageRequest

指定された場所に画像を含む InlineObject を挿入します。

JSON 表現 
{
  "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.
}
フィールド
uri

string

画像の URI。

画像は挿入時に 1 回取得され、ドキュメント内にコピーが保存されます。画像は 50 MB 未満、25 メガピクセルを超えないようにし、PNG、JPEG、GIF のいずれかの形式にする必要があります。

指定する URI は、一般公開され、長さが 2 KB 以下でなければなりません。URI 自体は画像と一緒に保存され、ImageProperties.content_uri フィールドを介して公開されます。

objectSize

object (Size)

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

共用体フィールド insertion_location。画像を挿入する場所。 insertion_location は次のいずれかになります。
location

object (Location)

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

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

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

InsertTableRequest

指定した場所にテーブルを挿入します。

挿入されたテーブルの前に改行文字が挿入されます。

JSON 表現 
{
  "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.
}
フィールド
rows

integer

テーブル内の行数。
columns

integer

テーブル内の列数。
共用体フィールド insertion_location。テーブルが挿入されるロケーション。insertion_location は次のいずれかになります。
location

object (Location)

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

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

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

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

object (EndOfSegmentLocation)

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

脚注内にテーブルを挿入することはできません。

InsertTableRowRequest

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

JSON 表現 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean
}
フィールド
tableCellLocation

object (TableCellLocation)

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

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

boolean

参照セルの場所の下に新しい行を挿入するかどうかを指定します。

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

TableCellLocation

テーブル内の単一のセルの場所。

JSON 表現 
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndex": integer,
  "columnIndex": integer
}
フィールド
tableStartLocation

object (Location)

ドキュメント内のテーブル開始位置。
rowIndex

integer

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

integer

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

InsertTableColumnRequest

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

JSON 表現 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean
}
フィールド
tableCellLocation

object (TableCellLocation)

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

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

boolean

参照セルの場所の右側に新しい列を挿入するかどうかを指定します。

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

DeleteTableRowRequest

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

JSON 表現 
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
フィールド
tableCellLocation

object (TableCellLocation)

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

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

DeleteTableColumnRequest

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

JSON 表現 
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
フィールド
tableCellLocation

object (TableCellLocation)

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

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

InsertPageBreakRequest

指定された場所に改ページを挿入し、改行を挿入します。

JSON 表現 
{

  // 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.
}
フィールド
共用体フィールド insertion_location。改ページが挿入される場所。 insertion_location は次のいずれかになります。
location

object (Location)

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

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

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

object (EndOfSegmentLocation)

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

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

DeletePositionedObjectRequest

ドキュメントから PositionedObject を削除します。

JSON 表現 
{
  "objectId": string
}
フィールド
objectId

string

削除する配置されたオブジェクトの ID。

UpdateTableColumnPropertiesRequest

テーブル内の列の TableColumnProperties を更新します。

JSON 表現 
{
  "tableStartLocation": {
    object (Location)
  },
  "columnIndices": [
    integer
  ],
  "tableColumnProperties": {
    object (TableColumnProperties)
  },
  "fields": string
}
フィールド
tableStartLocation

object (Location)

ドキュメント内のテーブル開始位置。
columnIndices[]

integer

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

object (TableColumnProperties)

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

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

string (FieldMask format)

更新するフィールド。

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

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

UpdateTableCellStyleRequest

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

JSON 表現 
{
  "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.
}
フィールド
tableCellStyle

object (TableCellStyle)

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

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

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

  • borderRight
  • borderLeft
  • borderBottom
  • borderTop
fields

string (FieldMask format)

更新するフィールド。

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

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

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

共用体フィールド cells。更新されるセル。 cells は次のいずれかになります。
tableRange

object (TableRange)

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

object (Location)

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

TableRange

テーブル範囲は、テーブルのサブセットへの参照を表します。

テーブル範囲で指定されたセルが必ずしも長方形を形成するわけではないことにご注意ください。たとえば、最終行のすべてのセルがマージされた 3 行 × 3 列のテーブルがあるとします。テーブルは次のようになります。

 [   ][   ][   ]
 [   ][   ][   ]
 [             ]

テーブルセルの場所 =（tableStartLocation、行 = 0、列 = 0）、行スパン = 3、列スパン = 2 のテーブル範囲は、次のセルを指定します。

 [ x ][ x ][   ]
 [ x ][ x ][   ]
 [ x    x    x ]
JSON 表現 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}
フィールド
tableCellLocation

object (TableCellLocation)

表の範囲の先頭のセルの場所。
rowSpan

integer

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

integer

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

UpdateTableRowStyleRequest

テーブル内の行の TableRowStyle を更新します。

JSON 表現 
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndices": [
    integer
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "fields": string
}
フィールド
tableStartLocation

object (Location)

ドキュメント内のテーブル開始位置。
rowIndices[]

integer

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

object (TableRowStyle)

行に設定するスタイル。

fields

string (FieldMask format)

更新するフィールド。

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

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

ReplaceImageRequest

既存のイメージを新しいイメージに置き換えます。

画像を置換すると、ドキュメント エディタの動作を反映するため、既存の画像から一部の image effects が削除されます。

JSON 表現 
{
  "imageObjectId": string,
  "uri": string,
  "imageReplaceMethod": enum (ImageReplaceMethod)
}
フィールド
imageObjectId

string

置き換えられる既存の画像の ID。ID は取得リクエストのレスポンスから取得できます。
uri

string

新しい画像の URI。

画像は挿入時に 1 回取得され、ドキュメント内にコピーが保存されます。画像は 50 MB 未満、25 メガピクセルを超えないようにし、PNG、JPEG、GIF のいずれかの形式にする必要があります。

指定された URI の長さは 2 KB を超えられません。URI は画像と一緒に保存され、ImageProperties.source_uri フィールドを介して公開されます。

imageReplaceMethod

enum (ImageReplaceMethod)

置換メソッド。

ImageReplaceMethod

画像置換メソッド。

列挙型
IMAGE_REPLACE_METHOD_UNSPECIFIED 画像の指定方法が指定されていません。この値は使用しないでください。
CENTER_CROP 元の画像の境界に合うように、画像のスケーリングと中央揃えを行います。元の画像の境界に合うように、画像がトリミングされる場合があります。画像のレンダリング サイズは、元の画像と同じになります。

UpdateDocumentStyleRequest

DocumentStyle を更新します。

JSON 表現 
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "fields": string
}
フィールド
documentStyle

object (DocumentStyle)

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

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

string (FieldMask format)

更新するフィールド。

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

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

MergeTableCellsRequest

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

JSON 表現 
{
  "tableRange": {
    object (TableRange)
  }
}
フィールド
tableRange

object (TableRange)

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

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

範囲が非矩形の場合（範囲があらかじめ結合されているセルや、表が長方形でないセルなど）は、400 不正なリクエスト エラーが返されます。

UnmergeTableCellsRequest

Table 内のセルの結合を解除します。

JSON 表現 
{
  "tableRange": {
    object (TableRange)
  }
}
フィールド
tableRange

object (TableRange)

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

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

結合されたセルのいずれかにテキストがある場合、結合されていないセルで変換されたブロックの「head」セル内にテキストが残ります。「head」セルはコンテンツの方向が左から右の場合は左上のセル、そうでない場合は右上セルです。

CreateHeaderRequest

Header を作成します。新しいヘッダーは、SectionBreak の場所を指定した SectionStyle に適用されます。それ以外の場合は、DocumentStyle に適用されます。

指定されたタイプのヘッダーがすでに存在する場合は、400 不正なリクエスト エラーが返されます。

JSON 表現 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
フィールド
type

enum (HeaderFooterType)

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

object (Location)

このヘッダーが属するセクションの開始位置である SectionBreak の場所。「sectionBreakLocation」が設定されていない場合、またはドキュメント本文の最初のセクションの参照が参照されている場合、ヘッダーは DocumentStyle に適用されます。

HeaderFooterType

作成できるヘッダーとフッターのタイプ。

列挙型
DEFAULT デフォルトのヘッダーとフッター。

CreateFooterRequest

Footer を作成します。新しいフッターは、SectionBreak の場所に指定された場合は SectionStyle に適用され、それ以外の場合は DocumentStyle に適用されます。

指定されたタイプのフッターがすでに存在する場合は、400 不正なリクエスト エラーが返されます。

JSON 表現 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
フィールド
type

enum (HeaderFooterType)

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

object (Location)

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

CreateFootnoteRequest

Footnote セグメントを作成し、指定された場所に新しい FootnoteReference を挿入します。

新しい Footnote セグメントには、スペースの後に改行文字が続きます。

JSON 表現 
{

  // 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.
}
フィールド
共用体フィールド footnote_reference_location。脚注の参照を挿入する場所。 footnote_reference_location は次のいずれかになります。
location

object (Location)

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

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

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

object (EndOfSegmentLocation)

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

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

replaceNamedRangeContentRequest

指定された NamedRange または NamedRanges の内容を指定された置換コンテンツに置き換えます。

個々の NamedRange は、複数の不連続な ranges で構成される場合があります。この場合、最初の範囲のコンテンツのみが置き換えられます。他の範囲とその内容は削除されます。

範囲の置き換えや削除によってドキュメント構造が無効になった場合は、400 不正なリクエスト エラーが返されます。

JSON 表現 
{

  // 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.
}
フィールド
共用体フィールド replacement_content。指定された範囲の既存のコンテンツに置き換えるコンテンツ。 replacement_content は次のいずれかになります。
text

string

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

共用体フィールド named_range_reference。コンテンツが置き換えられる名前付き範囲への参照。 named_range_reference は次のいずれかになります。
namedRangeId

string

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

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

string

コンテンツを置き換える NamedRanges の名前。

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

UpdateSectionStyleRequest

SectionStyle を更新します。

JSON 表現 
{
  "range": {
    object (Range)
  },
  "sectionStyle": {
    object (SectionStyle)
  },
  "fields": string
}
フィールド
range

object (Range)

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

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

object (SectionStyle)

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

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

string (FieldMask format)

更新するフィールド。

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

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

InsertSectionBreakRequest

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

セクション区切りの前に改行文字が挿入されます。

JSON 表現 
{
  "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.
}
フィールド
sectionType

enum (SectionType)

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

共用体フィールド insertion_location。挿入位置が挿入される場所。insertion_location は次のいずれかになります。
location

object (Location)

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

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

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

object (EndOfSegmentLocation)

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

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

DeleteHeaderRequest

ドキュメントから Header を削除します。

JSON 表現 
{
  "headerId": string
}
フィールド
headerId

string

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

DeleteFooterRequest

ドキュメントから Footer を削除します。

JSON 表現 
{
  "footerId": string
}
フィールド
footerId

string

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

PinTableHeaderRowsRequest

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

JSON 表現 
{
  "tableStartLocation": {
    object (Location)
  },
  "pinnedHeaderRowsCount": integer
}
フィールド
tableStartLocation

object (Location)

ドキュメント内のテーブル開始位置。
pinnedHeaderRowsCount

integer

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