Requests

リクエスト

ドキュメントに適用する 1 つの更新。

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,
  "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.
}
フィールド
replaceText

string

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

object (TabsCriteria)

省略可。置換を行うタブを指定する条件。

省略した場合、置換はすべてのタブに適用されます。

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

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

  • 省略した場合、置換は単数形のタブに適用されます。

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

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

  • 省略した場合は、すべてのタブに置換が適用されます。
共用体フィールド criteria。置換するテキストの照合に使用される条件。criteria は次のいずれかになります。
containsText

object (SubstringMatchCriteria)

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

SubstringMatchCriteria

ドキュメント内の特定のテキスト文字列に一致する条件。

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

string

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

boolean

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

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

TabsCriteria

リクエストが実行されるタブを指定する条件。

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

string

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

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 基本多言語プレーンの私用領域の文字（U+E000 ～ U+F8FF）が削除されます。

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

object (Location)

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

ロケーション

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

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

string

位置情報が含まれているヘッダー、フッター、または脚注の ID。空のセグメント ID は、ドキュメントの本文を表します。
index

integer

UTF-16 コード単位で表した、ゼロベースのインデックス。

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

string

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

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

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

  • 省略した場合、リクエストは単一のタブに適用されます。

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

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

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

EndOfSegmentLocation

本文、ヘッダー、フッター、脚注の末尾。ロケーションは、ドキュメント セグメントの最後の改行の直前です。

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

string

位置情報が含まれているヘッダー、フッター、または脚注の ID。空のセグメント ID は、ドキュメントの本文を表します。
tabId

string

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

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

  • 指定する場合は、単一のタブの 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 は暗黙的に指定されるため、指定する必要はありません。すべてのフィールドを一覧表示する場合は、1 つの "*" を省略表記として使用できます。

たとえば、テキスト スタイルを太字に更新するには、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 : 3D シェーディング付きの矢印。Unicode U+27a2 コードポイントに対応。
  • CHECKBOX : 空洞の正方形。Unicode U+274f コードポイントに対応します。
  • CIRCLE : 中空の円。Unicode U+25cb コードポイントに対応します。
  • DIAMOND : 塗りつぶされたダイヤモンド。Unicode U+25c6 コードポイントに対応します。
  • DIAMONDX : 「x」が付いたダイヤモンド。Unicode U+2756 コードポイントに対応します。
  • 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 : 1 桁の数字の前にゼロが付いた数値（「01」、「02」、「03」など）。2 桁以上の数値には先頭にゼロを付けません。
  • 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 の名前。名前は一意である必要はありません。

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

object (Range)

名前を適用する範囲。

DeleteNamedRangeRequest

NamedRange を削除します。

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

object (TabsCriteria)

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

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

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

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

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

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

  • 指定しない場合、範囲の削除はすべてのタブに適用されます。
共用体フィールド 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 は暗黙的に指定されるため、指定する必要はありません。すべてのフィールドを一覧表示する場合は、1 つの "*" を省略表記として使用できます。

たとえば、段落スタイルの配置プロパティを更新するには、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)

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

共用体フィールド 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

表内の 1 つのセルの位置。

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,
  "tabId": string
}
フィールド
objectId

string

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

string

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

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

  • 指定する場合は、単一のタブの 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 は暗黙的に指定されるため、指定する必要はありません。すべてのフィールドを一覧表示する場合は、1 つの "*" を省略表記として使用できます。

たとえば、列幅を更新するには、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 は暗黙的に指定されるため、指定する必要はありません。すべてのフィールドを一覧表示する場合は、1 つの "*" を省略表記として使用できます。

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

プロパティをデフォルト値にリセットするには、フィールド名をフィールド マスクに含めますが、フィールド自体は未設定のままにします。
共用体フィールド cells。更新されるセル。cells は次のいずれかになります。
tableRange

object (TableRange)

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

object (Location)

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

TableRange

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

テーブル範囲で指定されたセルが長方形になるとは限りません。たとえば、3 x 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 は暗黙的に指定されるため、指定する必要はありません。すべてのフィールドを一覧表示する場合は、1 つの "*" を省略表記として使用できます。

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

ReplaceImageRequest

既存の画像を新しい画像に置き換えます。

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

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

string

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

string

新しい画像の URI。

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

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

enum (ImageReplaceMethod)

交換方法。
tabId

string

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

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

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

  • 省略した場合、リクエストは単一のタブに適用されます。

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

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

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

ImageReplaceMethod

画像の置換方法。

列挙型
IMAGE_REPLACE_METHOD_UNSPECIFIED 画像の置換方法が指定されていません。この値は使用しないでください。
CENTER_CROP 元の画像の境界いっぱいに画像を拡大して中央に配置します。元の画像の境界に収まるように、画像が切り抜かれる場合があります。画像のレンダリング サイズは元の画像と同じになります。

UpdateDocumentStyleRequest

DocumentStyle を更新します。

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

object (DocumentStyle)

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

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

string (FieldMask format)

更新が必要なフィールド。

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

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

string

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

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

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

  • 省略した場合、リクエストは単一のタブに適用されます。

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

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

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

MergeTableCellsRequest

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

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

object (TableRange)

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

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

範囲が長方形でない場合（範囲がすでに結合されているセルにまたがっている場合や、テーブルが長方形でない場合など）、400 不正なリクエスト エラーが返されます。

UnmergeTableCellsRequest

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

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

object (TableRange)

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

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

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

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 の内容を、指定された置換コンテンツに置き換えます。

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

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

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

object (TabsCriteria)

省略可。置換を行うタブを指定する条件。省略した場合、置換はすべてのタブに適用されます。

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

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

  • 省略した場合、置換は単数形のタブに適用されます。

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

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

  • 省略した場合は、すべてのタブに置換が適用されます。
共用体フィールド 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 は暗黙的に指定されるため、指定する必要はありません。すべてのフィールドを一覧表示する場合は、1 つの "*" を省略表記として使用できます。

たとえば、左側の余白を更新するには、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,
  "tabId": string
}
フィールド
headerId

string

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

string

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

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

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

  • 省略した場合、リクエストは単一のタブに適用されます。

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

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

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

DeleteFooterRequest

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

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

string

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

string

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

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

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

  • 省略した場合、リクエストは単一のタブに適用されます。

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

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

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

PinTableHeaderRowsRequest

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

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

object (Location)

ドキュメント内でテーブルが開始される位置。
pinnedHeaderRowsCount

integer

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