リクエスト
ドキュメントに適用する単一の更新。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド request 。適用する特定のリクエスト。フィールドは 1 つだけ必要です。request は次のいずれかになります。 |
|
replaceAllText
|
指定されたテキストのすべてのインスタンスを置き換えます。 |
insertText
|
指定した位置にテキストを挿入します。 |
updateTextStyle
|
指定された範囲のテキスト スタイルを更新します。 |
createParagraphBullets
|
段落の箇条書きを作成します。 |
deleteParagraphBullets
|
段落から箇条書きを削除します。 |
createNamedRange
|
名前付き範囲を作成します。 |
deleteNamedRange
|
名前付き範囲を削除します。 |
updateParagraphStyle
|
指定された範囲の段落スタイルを更新します。 |
deleteContentRange
|
ドキュメントからコンテンツを削除します。 |
insertInlineImage
|
指定した位置にインライン画像を挿入します。 |
insertTable
|
指定した位置にテーブルを挿入します。 |
insertTableRow
|
テーブルに空の行を挿入します。 |
insertTableColumn
|
テーブルに空の列を挿入します。 |
deleteTableRow
|
テーブルから行を削除します。 |
deleteTableColumn
|
テーブルから列を削除します。 |
insertPageBreak
|
指定した位置に改ページを挿入します。 |
deletePositionedObject
|
ドキュメントから位置指定されたオブジェクトを削除します。 |
updateTableColumnProperties
|
テーブル内の列のプロパティを更新します。 |
updateTableCellStyle
|
テーブル セルのスタイルを更新します。 |
updateTableRowStyle
|
テーブルの行スタイルを更新します。 |
replaceImage
|
ドキュメント内の画像を置き換えます。 |
updateDocumentStyle
|
ドキュメントのスタイルを更新します。 |
mergeTableCells
|
表内のセルを結合します。 |
unmergeTableCells
|
表内のセルを結合解除します。 |
createHeader
|
ヘッダーを作成します。 |
createFooter
|
フッターを作成します。 |
createFootnote
|
脚注を作成します。 |
replaceNamedRangeContent
|
名前付き範囲のコンテンツを置き換えます。 |
updateSectionStyle
|
指定された範囲のセクション スタイルを更新します。 |
insertSectionBreak
|
指定した位置にセクション区切りを挿入します。 |
deleteHeader
|
ドキュメントからヘッダーを削除します。 |
deleteFooter
|
ドキュメントからフッターを削除します。 |
pinTableHeaderRows
|
テーブル内の固定されたヘッダー行の数を更新します。 |
insertPerson
|
ユーザーのメンションを挿入します。 |
ReplaceAllTextRequest
条件に一致するテキストのすべてのインスタンスを replace text
に置き換えます。
JSON 表現 |
---|
{ "replaceText": string, "tabsCriteria": { object ( |
フィールド | |
---|---|
replaceText
|
一致したテキストを置き換えるテキスト。 |
tabsCriteria
|
省略可。置換が行われるタブを指定するために使用される条件。 省略した場合、置換はすべてのタブに適用されます。 1 つのタブを含むドキュメントの場合:
複数のタブを含むドキュメントの場合:
|
共用体フィールド criteria 。置換するテキストを照合するために使用される条件。criteria は次のいずれかになります。 |
|
containsText
|
この部分文字列に一致するテキストをドキュメント内で検索します。 |
SubstringMatchCriteria
ドキュメント内の特定のテキスト文字列に一致する条件。
JSON 表現 |
---|
{ "text": string, "matchCase": boolean, "searchByRegex": boolean } |
フィールド | |
---|---|
text
|
ドキュメント内で検索するテキスト。 |
matchCase
|
検索で大文字と小文字を区別するかどうかを示します。
|
searchByRegex
|
省略可。検索値を正規表現として扱う場合は true。パターン内のバックスラッシュはすべてエスケープする必要があります。
|
TabsCriteria
リクエストが実行されるタブを指定する条件。
JSON 表現 |
---|
{ "tabIds": [ string ] } |
フィールド | |
---|---|
tabIds[]
|
リクエストが実行されるタブ ID のリスト。 |
InsertTextRequest
指定した位置にテキストを挿入します。
JSON 表現 |
---|
{ "text": string, // Union field |
フィールド | |
---|---|
text
|
挿入するテキスト。
改行文字を挿入すると、そのインデックスに新しい 挿入されたテキストのスタイルは自動的に決定され、通常は隣接するテキストのスタイルが保持されます。ほとんどの場合、挿入されたテキストのテキスト スタイルは、挿入インデックスの直前のテキストと一致します。 挿入されたテキストから、一部の制御文字(U+0000 ~ U+0008、U+000C ~ U+001F)と Unicode 基本多言語面私用領域(U+E000 ~ U+F8FF)の文字が削除されます。 |
共用体フィールド insertion_location 。テキストが挿入される場所。
insertion_location は次のいずれかになります。 |
|
location
|
ドキュメントの特定のインデックスにテキストを挿入します。
テキストは既存の |
endOfSegmentLocation
|
ヘッダー、フッター、脚注、ドキュメント本文の末尾にテキストを挿入します。 |
Location
ドキュメント内の特定の場所。
JSON 表現 |
---|
{ "segmentId": string, "index": integer, "tabId": string } |
フィールド | |
---|---|
segmentId
|
位置情報があるヘッダー、フッター、脚注の ID。空のセグメント ID は、ドキュメントの本文を示します。 |
index
|
UTF-16 コード単位でのゼロベースのインデックス。
インデックスは、 |
tabId
|
場所が属するタブ。省略すると、リクエストは最初のタブに適用されます。 1 つのタブを含むドキュメントの場合:
複数のタブを含むドキュメントの場合:
|
EndOfSegmentLocation
本文、ヘッダー、フッター、脚注の末尾の位置。位置は、ドキュメント セグメントの最後の改行の直前です。
JSON 表現 |
---|
{ "segmentId": string, "tabId": string } |
フィールド | |
---|---|
segmentId
|
位置情報があるヘッダー、フッター、脚注の ID。空のセグメント ID は、ドキュメントの本文を示します。 |
tabId
|
場所が属するタブ。省略すると、リクエストは最初のタブに適用されます。 1 つのタブを含むドキュメントの場合:
複数のタブを含むドキュメントの場合:
|
UpdateTextStyleRequest
テキストのスタイル設定を更新します。
JSON 表現 |
---|
{ "textStyle": { object ( |
フィールド | |
---|---|
textStyle
|
テキストに設定するスタイル。 特定のスタイルの値が親の値と一致する場合、そのスタイルは継承に設定されます。
特定のテキスト スタイルの変更により、ドキュメント エディタの動作を反映するために他の変更が行われることがあります。詳細については、 |
fields
|
更新するフィールド。
少なくとも 1 つのフィールドを指定する必要があります。ルート
たとえば、テキストのスタイルを太字に更新するには、 プロパティをデフォルト値にリセットするには、フィールド名をフィールド マスクに含めますが、フィールド自体は設定しないままにします。 |
共用体フィールド insertion_location 。テキスト スタイルが更新される範囲のタイプ。insertion_location は次のいずれかになります。 |
|
range
|
スタイルを設定するテキストの範囲。 範囲は、隣接する改行を含むように拡張されることがあります。 範囲にリストに属する段落が完全に含まれている場合、段落の箇条書きも一致するテキスト スタイルで更新されます。 相対 UpdateTextStyleRequest 内に範囲を挿入することはできません。 |
CreateParagraphBulletsRequest
指定された範囲と重複するすべての段落に箇条書きを作成します。
各段落のネストレベルは、各段落の先頭にあるタブの数を数えることで決定されます。このリクエストでは、箇条書きと対応する段落の間の余分なスペースを避けるために、これらの先頭タブが削除されます。これにより、テキストの一部がインデックス化される可能性があります。
更新される段落の直前の段落が、一致するプリセットのリストにある場合、更新される段落はその直前のリストに追加されます。
JSON 表現 |
---|
{ "range": { object ( |
フィールド | |
---|---|
range
|
箇条書きのプリセットを適用する範囲。 |
bulletPreset
|
使用する箇条書きのグリフの種類。 |
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
: 1 桁の数字の前に 0 が付いた数字(「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
|
箇条書きを削除する範囲。 |
CreateNamedRangeRequest
指定された範囲を参照する NamedRange
を作成します。
JSON 表現 |
---|
{
"name": string,
"range": {
object ( |
フィールド | |
---|---|
name
|
NamedRange の名前。名前は一意である必要はありません。 名前は 1 文字以上 256 文字以下(UTF-16 コード単位)にする必要があります。 |
range
|
名前を適用する範囲。 |
DeleteNamedRangeRequest
NamedRange
を削除します。
JSON 表現 |
---|
{ "tabsCriteria": { object ( |
フィールド | |
---|---|
tabsCriteria
|
省略可。範囲の削除を行うタブを指定するために使用される条件。省略すると、範囲の削除はすべてのタブに適用されます。 1 つのタブを含むドキュメントの場合:
複数のタブを含むドキュメントの場合:
|
共用体フィールド named_range_reference 。削除する範囲を決定する値。必ず 1 つ設定する必要があります。named_range_reference は次のいずれかになります。 |
|
namedRangeId
|
削除する名前付き範囲の ID。 |
name
|
削除する範囲の名前。指定された名前のすべての名前付き範囲が削除されます。 |
UpdateParagraphStyleRequest
指定された範囲と重複するすべての段落のスタイルを更新します。
JSON 表現 |
---|
{ "paragraphStyle": { object ( |
フィールド | |
---|---|
paragraphStyle
|
段落に設定するスタイル。
一部の段落スタイルの変更は、ドキュメント エディタの動作を反映するために、他の変更を引き起こす可能性があります。詳細については、 |
fields
|
更新するフィールド。
少なくとも 1 つのフィールドを指定する必要があります。ルート
たとえば、段落スタイルの配置プロパティを更新するには、 プロパティをデフォルト値にリセットするには、フィールド名をフィールド マスクに含めますが、フィールド自体は設定しないままにします。 |
共用体フィールド insertion_location 。段落スタイルが更新される範囲のタイプ。insertion_location は次のいずれかになります。 |
|
range
|
スタイルを設定する段落と重複する範囲。 |
DeleteContentRangeRequest
ドキュメントからコンテンツを削除します。
JSON 表現 |
---|
{
"range": {
object ( |
フィールド | |
---|---|
range
|
削除するコンテンツの範囲。 段落の境界を越えてテキストを削除すると、2 つの段落が結合されるため、段落スタイル、リスト、配置されたオブジェクト、ブックマークが変更されることがあります。 特定の範囲を削除しようとすると、ドキュメント構造が無効になり、400 Bad Request エラーが返されることがあります。 無効な削除リクエストの例を次に示します。
|
InsertInlineImageRequest
指定された場所に画像を含む InlineObject
を挿入します。
JSON 表現 |
---|
{ "uri": string, "objectSize": { object ( |
フィールド | |
---|---|
uri
|
画像 URI。 画像は挿入時に 1 回取得され、ドキュメント内に表示するためにコピーが保存されます。画像のサイズは 50 MB 未満、25 メガピクセル以下で、PNG、JPEG、GIF のいずれかの形式である必要があります。
指定する URI は一般公開されており、長さが 2 kB 以下である必要があります。URI 自体は画像とともに保存され、 |
objectSize
|
ドキュメントに表示される画像のサイズ。このプロパティは省略可能です。ドキュメント内の画像の最終的なサイズは、次のルールに基づいて決定されます。* 幅と高さの両方が指定されていない場合、画像のデフォルトのサイズは解像度に基づいて計算されます。* 1 つのディメンションが指定されている場合、画像のアスペクト比を維持するために、もう 1 つのディメンションが計算されます。* 幅と高さの両方が指定されている場合、画像はアスペクト比を維持したまま、指定された寸法内に収まるように拡大縮小されます。 |
共用体フィールド insertion_location 。画像を挿入する場所。
insertion_location は次のいずれかになります。 |
|
location
|
ドキュメントの特定のインデックスに画像を挿入します。
画像は既存の インライン画像は、脚注や数式の中に挿入できません。 |
endOfSegmentLocation
|
ヘッダー、フッター、ドキュメント本文の末尾にテキストを挿入します。 インライン画像を脚注内に挿入することはできません。 |
InsertTableRequest
指定した位置にテーブルを挿入します。
挿入された表の前に改行文字が挿入されます。
JSON 表現 |
---|
{ "rows": integer, "columns": integer, // Union field |
フィールド | |
---|---|
rows
|
テーブル内の行数。 |
columns
|
テーブル内の列数。 |
共用体フィールド insertion_location 。表が挿入される場所。insertion_location は次のいずれかになります。 |
|
location
|
特定のモデル インデックスにテーブルを挿入します。 挿入されたテーブルの前に改行文字が挿入されるため、テーブルの開始インデックスは指定された位置インデックス + 1 になります。
テーブルは既存の 表を脚注や数式の中に挿入することはできません。 |
endOfSegmentLocation
|
指定されたヘッダー、フッター、またはドキュメント本文の末尾に表を挿入します。挿入された表の前に改行文字が挿入されます。 表を脚注内に挿入することはできません。 |
InsertTableRowRequest
テーブルに空の行を挿入します。
JSON 表現 |
---|
{
"tableCellLocation": {
object ( |
フィールド | |
---|---|
tableCellLocation
|
行が挿入される参照テーブルのセルの位置。 参照セルがある行の上(または下)に新しい行が挿入されます。参照セルが結合されたセルである場合は、結合されたセルの上(または下)に新しい行が挿入されます。 |
insertBelow
|
参照セルの位置の下に新しい行を挿入するかどうか。
|
TableCellLocation
テーブル内の単一のセルの位置。
JSON 表現 |
---|
{
"tableStartLocation": {
object ( |
フィールド | |
---|---|
tableStartLocation
|
ドキュメント内の表の開始位置。 |
rowIndex
|
ゼロから始まる行インデックス。たとえば、テーブルの 2 行目の行インデックスは 1 です。 |
columnIndex
|
ゼロから始まる列インデックス。たとえば、テーブルの 2 列目の列インデックスは 1 です。 |
InsertTableColumnRequest
テーブルに空の列を挿入します。
JSON 表現 |
---|
{
"tableCellLocation": {
object ( |
フィールド | |
---|---|
tableCellLocation
|
列の挿入元となる参照テーブルのセルの位置。 参照セルがある列の左(または右)に新しい列が挿入されます。参照セルが結合セルである場合は、結合セルの左(または右)に新しい列が挿入されます。 |
insertRight
|
参照セルの位置の右に新しい列を挿入するかどうか。
|
DeleteTableRowRequest
テーブルから行を削除します。
JSON 表現 |
---|
{
"tableCellLocation": {
object ( |
フィールド | |
---|---|
tableCellLocation
|
行が削除される参照テーブルのセルの位置。 このセルがまたがる行が削除されます。複数の行にまたがる結合セルである場合、セルがまたがるすべての行が削除されます。この削除後にテーブルに行が残っていない場合、テーブル全体が削除されます。 |
DeleteTableColumnRequest
テーブルから列を削除します。
JSON 表現 |
---|
{
"tableCellLocation": {
object ( |
フィールド | |
---|---|
tableCellLocation
|
列が削除される参照テーブルのセルの位置。 このセルがまたがる列が削除されます。複数の列にまたがる結合セルである場合、セルがまたがるすべての列が削除されます。この削除後にテーブルに列が残っていない場合、テーブル全体が削除されます。 |
InsertPageBreakRequest
指定した位置に改ページと改行を挿入します。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド insertion_location 。改ページが挿入される位置。insertion_location は次のいずれかになります。 |
|
location
|
ドキュメント内の特定のインデックスに改ページを挿入します。
改ページは、既存の
改ページを表、数式、脚注、ヘッダー、フッターの中に挿入することはできません。改ページは本文内でのみ挿入できるため、 |
endOfSegmentLocation
|
ドキュメント本文の末尾に改ページを挿入します。
脚注、ヘッダー、フッターの中に改ページを挿入することはできません。改ページは本文内でのみ挿入できるため、 |
DeletePositionedObjectRequest
ドキュメントから PositionedObject
を削除します。
JSON 表現 |
---|
{ "objectId": string, "tabId": string } |
フィールド | |
---|---|
objectId
|
削除する配置済みオブジェクトの ID。 |
tabId
|
削除する配置済みオブジェクトがあるタブ。省略すると、リクエストは最初のタブに適用されます。 1 つのタブを含むドキュメントの場合:
複数のタブを含むドキュメントの場合:
|
UpdateTableColumnPropertiesRequest
テーブル内の列の TableColumnProperties
を更新します。
JSON 表現 |
---|
{ "tableStartLocation": { object ( |
フィールド | |
---|---|
tableStartLocation
|
ドキュメント内の表の開始位置。 |
columnIndices[]
|
プロパティを更新するゼロベースの列インデックスのリスト。インデックスが指定されていない場合は、すべての列が更新されます。 |
tableColumnProperties
|
更新するテーブル列のプロパティ。
|
fields
|
更新するフィールド。
少なくとも 1 つのフィールドを指定する必要があります。ルート
たとえば、列の幅を更新するには、 |
UpdateTableCellStyleRequest
テーブル セルの範囲のスタイルを更新します。
JSON 表現 |
---|
{ "tableCellStyle": { object ( |
フィールド | |
---|---|
tableCellStyle
|
テーブルセルに設定するスタイル。 枠線を更新するときに、セルが隣接するセルと枠線を共有している場合、隣接するセルの対応する枠線プロパティも更新されます。結合されて非表示になっている境界線は更新されません。 同じリクエストで隣接するセルで共有される境界線を更新すると、境界線の更新が競合する可能性があるため、境界線の更新は次の順序で適用されます。
|
fields
|
更新するフィールド。
少なくとも 1 つのフィールドを指定する必要があります。ルート
たとえば、テーブル セルの背景色を更新するには、 プロパティをデフォルト値にリセットするには、フィールド名をフィールド マスクに含めますが、フィールド自体は設定しないままにします。 |
共用体フィールド cells 。更新されるセル。cells は次のいずれかになります。 |
|
tableRange
|
更新が適用されるテーブルのサブセットを表すテーブル範囲。 |
tableStartLocation
|
ドキュメント内の表の開始位置。指定すると、テーブル内のすべてのセルに更新が適用されます。 |
TableRange
テーブル範囲は、テーブルのサブセットへの参照を表します。
テーブル範囲で指定されたセルが必ずしも長方形を形成するとは限りません。たとえば、3 行 3 列の表があり、最後の行のすべてのセルが結合されているとします。テーブルは次のようになります。
[ ][ ][ ]
[ ][ ][ ]
[ ]
表のセル位置が(tableStartLocation、行 = 0、列 = 0)、行スパン = 3、列スパン = 2 の表範囲は、次のセルを指定します。
[ x ][ x ][ ]
[ x ][ x ][ ]
[ x x x ]
JSON 表現 |
---|
{
"tableCellLocation": {
object ( |
フィールド | |
---|---|
tableCellLocation
|
表範囲の開始位置のセル。 |
rowSpan
|
テーブル範囲の行スパン。 |
columnSpan
|
テーブル範囲の列スパン。 |
UpdateTableRowStyleRequest
テーブル内の行の TableRowStyle
を更新します。
JSON 表現 |
---|
{ "tableStartLocation": { object ( |
フィールド | |
---|---|
tableStartLocation
|
ドキュメント内の表の開始位置。 |
rowIndices[]
|
スタイルを更新するゼロベースの行インデックスのリスト。インデックスが指定されていない場合は、すべての行が更新されます。 |
tableRowStyle
|
行に設定するスタイル。 |
fields
|
更新するフィールド。
少なくとも 1 つのフィールドを指定する必要があります。ルート
たとえば、行の最小高を更新するには、 |
ReplaceImageRequest
既存の画像を新しい画像に置き換えます。
画像を置き換えると、ドキュメント エディタの動作を反映するために、既存の画像から一部の image effects
が削除されます。
JSON 表現 |
---|
{
"imageObjectId": string,
"uri": string,
"imageReplaceMethod": enum ( |
フィールド | |
---|---|
imageObjectId
|
置き換えられる既存のイメージの ID。ID は、GET リクエストのレスポンスから取得できます。 |
uri
|
新しい画像の URI。 画像は挿入時に 1 回取得され、ドキュメント内に表示するためにコピーが保存されます。画像は 50 MB 未満で、2,500 万ピクセルを超えない PNG、JPEG、GIF 形式である必要があります。
指定した URI の長さは 2 KB を超えることはできません。URI は画像とともに保存され、 |
imageReplaceMethod
|
置換メソッド。 |
tabId
|
置き換える画像があるタブ。省略すると、リクエストは最初のタブに適用されます。 1 つのタブを含むドキュメントの場合:
複数のタブを含むドキュメントの場合:
|
ImageReplaceMethod
画像置換メソッド。
列挙型 | |
---|---|
IMAGE_REPLACE_METHOD_UNSPECIFIED
|
画像置換方法が指定されていません。この値は使用しないでください。 |
CENTER_CROP
|
元の画像の境界に合わせて画像を拡大縮小し、中央に配置します。元の画像の境界内に収まるように、画像が切り抜かれることがあります。レンダリングされる画像のサイズは、元の画像と同じになります。 |
UpdateDocumentStyleRequest
DocumentStyle
を更新します。
JSON 表現 |
---|
{
"documentStyle": {
object ( |
フィールド | |
---|---|
documentStyle
|
ドキュメントに設定するスタイル。
ドキュメントのスタイルを変更すると、ドキュメント エディタの動作を反映するために、他の変更が加えられることがあります。詳細については、 |
fields
|
更新するフィールド。
少なくとも 1 つのフィールドを指定する必要があります。ルート
たとえば、背景を更新するには、 |
tabId
|
更新するスタイルを含むタブ。省略した場合、リクエストは最初のタブに適用されます。 1 つのタブを含むドキュメントの場合:
複数のタブを含むドキュメントの場合:
|
MergeTableCellsRequest
Table
のセルを結合します。
JSON 表現 |
---|
{
"tableRange": {
object ( |
フィールド | |
---|---|
tableRange
|
テーブルのどのセルを結合するかを指定するテーブル範囲。 結合されるセル内のテキストは連結され、範囲の「先頭」セルに保存されます。コンテンツの方向が左から右の場合は範囲の左上のセル、それ以外の場合は範囲の右上のセルです。 範囲が長方形でない場合(範囲がすでに結合されているセルをカバーしている場合や、表が長方形でない場合など)、400 不正なリクエスト エラーが返されます。 |
UnmergeTableCellsRequest
Table
内のセルの結合を解除します。
JSON 表現 |
---|
{
"tableRange": {
object ( |
フィールド | |
---|---|
tableRange
|
テーブルのどのセルを結合解除するかを指定するテーブル範囲。 この範囲内の結合されたセルはすべて結合が解除されます。すでに結合が解除されているセルは影響を受けません。範囲に結合されたセルがない場合、リクエストは何も行いません。 結合されたセルのいずれかにテキストが含まれている場合、そのテキストは、結合が解除されたセルのブロックの「先頭」セルに残ります。「ヘッド」セルは、コンテンツの方向が左から右の場合は左上のセル、それ以外の場合は右上のセルです。 |
CreateHeaderRequest
Header
を作成します。新しいヘッダーは、指定されている場合は SectionBreak
の場所にある SectionStyle
に適用されます。指定されていない場合は、DocumentStyle
に適用されます。
指定されたタイプのヘッダーがすでに存在する場合は、400 Bad Request エラーが返されます。
JSON 表現 |
---|
{ "type": enum ( |
フィールド | |
---|---|
type
|
作成するヘッダーのタイプ。 |
sectionBreakLocation
|
このヘッダーが属するセクションの先頭にある |
CreateFootnoteRequest
Footnote
セグメントを作成し、指定された位置に新しい FootnoteReference
を挿入します。
新しい Footnote
セグメントには、スペースと改行文字が含まれます。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド footnote_reference_location 。脚注参照を挿入する場所。footnote_reference_location は次のいずれかになります。 |
|
location
|
ドキュメントの特定のインデックスに脚注参照を挿入します。
脚注参照は、既存の
脚注参照を数式、ヘッダー、フッター、脚注の中に挿入することはできません。脚注参照は本文にのみ挿入できるため、 |
endOfSegmentLocation
|
ドキュメント本文の末尾に脚注参照を挿入します。
脚注参照をヘッダー、フッター、脚注の中に挿入することはできません。脚注参照は本文にのみ挿入できるため、 |
ReplaceNamedRangeContentRequest
指定された NamedRange
または NamedRanges
の内容を、指定された置換コンテンツに置き換えます。
個々の NamedRange
は、複数の不連続な ranges
で構成される場合があります。この場合、最初の範囲のコンテンツのみが置き換えられます。他の範囲とそのコンテンツは削除されます。
範囲の置換または削除によってドキュメント構造が無効になる場合は、400 Bad Request エラーが返されます。
JSON 表現 |
---|
{ "tabsCriteria": { object ( |
フィールド | |
---|---|
tabsCriteria
|
省略可。置換が行われるタブを指定するために使用される条件。省略した場合、置換はすべてのタブに適用されます。 1 つのタブを含むドキュメントの場合:
複数のタブを含むドキュメントの場合:
|
共用体フィールド replacement_content 。名前付き範囲の既存のコンテンツを置き換えるコンテンツ。replacement_content は次のいずれかになります。 |
|
text
|
指定した名前付き範囲のコンテンツを、指定したテキストに置き換えます。 |
共用体フィールド named_range_reference 。コンテンツが置き換えられる名前付き範囲への参照。named_range_reference は次のいずれかになります。 |
|
namedRangeId
|
コンテンツが置き換えられる名前付き範囲の ID。 指定された ID の名前付き範囲がない場合は、400 の不正なリクエスト エラーが返されます。 |
namedRangeName
|
コンテンツが置き換えられる
指定された名前の |
UpdateSectionStyleRequest
SectionStyle
を更新します。
JSON 表現 |
---|
{ "range": { object ( |
フィールド | |
---|---|
range
|
スタイルを設定するセクションと重複する範囲。
セクション区切りは本文内にのみ挿入できるため、 |
sectionStyle
|
セクションに設定するスタイル。
セクションのスタイルを変更すると、ドキュメント エディタの動作を反映するために、他の変更が加えられることがあります。詳細については、 |
fields
|
更新するフィールド。
少なくとも 1 つのフィールドを指定する必要があります。ルート
たとえば、左マージンを更新するには、 |
InsertSectionBreakRequest
指定した位置にセクション区切りを挿入します。
セクション区切りの前に改行文字が挿入されます。
JSON 表現 |
---|
{ "sectionType": enum ( |
フィールド | |
---|---|
sectionType
|
挿入するセクションのタイプ。 |
共用体フィールド insertion_location 。ブレークが挿入される場所。insertion_location は次のいずれかになります。 |
|
location
|
ドキュメントの特定のインデックスに改行とセクション区切りを挿入します。
セクション区切りは、既存の
セクション区切りを表、数式、脚注、ヘッダー、フッターの中に挿入することはできません。セクション区切りは本文内にのみ挿入できるため、 |
endOfSegmentLocation
|
ドキュメント本文の末尾に改行とセクション区切りを挿入します。
セクション区切りを脚注、ヘッダー、フッター内に挿入することはできません。セクション区切りは本文内にのみ挿入できるため、 |
DeleteHeaderRequest
ドキュメントから Header
を削除します。
JSON 表現 |
---|
{ "headerId": string, "tabId": string } |
フィールド | |
---|---|
headerId
|
削除するヘッダーの ID。このヘッダーが |
tabId
|
削除するヘッダーを含むタブ。省略すると、リクエストは最初のタブに適用されます。 1 つのタブを含むドキュメントの場合:
複数のタブを含むドキュメントの場合:
|
PinTableHeaderRowsRequest
テーブル内の固定されたテーブル ヘッダー行の数を更新します。
JSON 表現 |
---|
{
"tableStartLocation": {
object ( |
フィールド | |
---|---|
tableStartLocation
|
ドキュメント内の表の開始位置。 |
pinnedHeaderRowsCount
|
固定するテーブル行の数。0 はすべての行が固定されていないことを意味します。 |
InsertPersonRequest
ユーザーのメンションを挿入します。
JSON 表現 |
---|
{ "personProperties": { object ( |
フィールド | |
---|---|
personProperties
|
挿入する人物のメンションのプロパティ。 |
共用体フィールド insertion_location 。ユーザーのメンションが挿入される場所。insertion_location は次のいずれかになります。 |
|
location
|
ドキュメント内の特定のインデックスにユーザーメンションを挿入します。
ユーザーメンションは、既存の 数式内にユーザーメンションを挿入することはできません。 |
endOfSegmentLocation
|
ヘッダー、フッター、脚注、ドキュメント本文の末尾に人物メンションを挿入します。 |