リクエスト
ドキュメントに適用する 1 つの更新。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド request 。適用する具体的なリクエスト。1 つのフィールドのみを指定する必要があります。request は次のいずれかになります。 |
|
replace
|
指定したテキストのすべてのインスタンスを置き換えます。 |
insert
|
指定した位置にテキストを挿入します。 |
update
|
指定した範囲のテキスト スタイルを更新します。 |
create
|
段落の箇条書きを作成します。 |
delete
|
段落から箇条書きを削除します。 |
create
|
名前付き範囲を作成します。 |
delete
|
名前付き範囲を削除します。 |
update
|
指定された範囲の段落スタイルを更新します。 |
delete
|
ドキュメントからコンテンツを削除します。 |
insert
|
指定した位置にインライン画像を挿入します。 |
insert
|
指定した位置に表を挿入します。 |
insert
|
テーブルに空の行を挿入します。 |
insert
|
空の列をテーブルに挿入します。 |
delete
|
テーブルから行を削除します。 |
delete
|
テーブルから列を削除します。 |
insert
|
指定された場所に改ページを挿入します。 |
delete
|
配置されたオブジェクトをドキュメントから削除します。 |
update
|
テーブル内の列のプロパティを更新します。 |
update
|
表のセルのスタイルを更新します。 |
update
|
テーブル内の行スタイルを更新します。 |
replace
|
ドキュメント内の画像を置き換えます。 |
update
|
ドキュメントのスタイルを更新します。 |
merge
|
表内のセルを結合します。 |
unmerge
|
表内のセルの結合を解除します。 |
create
|
ヘッダーを作成します。 |
create
|
フッターを作成します。 |
create
|
脚注を作成します。 |
replace
|
名前付き範囲内のコンテンツを置き換えます。 |
update
|
指定した範囲のセクション スタイルを更新します。 |
insert
|
指定した位置にセクション ブレークを挿入します。 |
delete
|
ドキュメントからヘッダーを削除します。 |
delete
|
ドキュメントからフッターを削除します。 |
pin
|
テーブル内の固定された見出し行の数を更新します。 |
ReplaceAllTextRequest
条件に一致するテキストをすべて replace text
に置き換えます。
JSON 表現 |
---|
{ "replaceText": string, "tabsCriteria": { object ( |
フィールド | |
---|---|
replace
|
一致したテキストに置き換えるテキスト。 |
tabs
|
省略可。置換を行うタブを指定する条件。 省略した場合、置換はすべてのタブに適用されます。 1 つのタブを含むドキュメントの場合:
複数のタブを含むドキュメントの場合:
|
共用体フィールド criteria 。置換するテキストの照合に使用される条件。
criteria は次のいずれかになります。 |
|
contains
|
このサブ文字列に一致するドキュメント内のテキストを検索します。 |
SubstringMatchCriteria
ドキュメント内の特定のテキスト文字列に一致する条件。
JSON 表現 |
---|
{ "text": string, "matchCase": boolean } |
フィールド | |
---|---|
text
|
ドキュメント内で検索するテキスト。 |
match
|
検索で大文字と小文字を区別するかどうかを示します。
|
TabsCriteria
リクエストが実行されるタブを指定する条件。
JSON 表現 |
---|
{ "tabIds": [ string ] } |
フィールド | |
---|---|
tab
|
リクエストが実行されるタブ ID のリスト。 |
InsertTextRequest
指定した位置にテキストを挿入します。
JSON 表現 |
---|
{ "text": string, // Union field |
フィールド | |
---|---|
text
|
挿入するテキスト。
改行文字を挿入すると、そのインデックスに新しい 挿入されたテキストのテキスト スタイルは自動的に決定され、一般的には隣接するテキストのスタイルが保持されます。ほとんどの場合、挿入されたテキストのテキスト スタイルは、挿入インデックスの直前のテキストと一致します。 挿入されたテキストからは、一部の制御文字(U+0000-U+0008、U+000C-U+001F)と Unicode Basic Multilingual Plane Private Use Area(U+E000-U+F8FF)の文字が削除されます。 |
共用体フィールド insertion_location 。テキストが挿入される場所。insertion_location は次のいずれかになります。 |
|
location
|
ドキュメント内の特定のインデックスにテキストを挿入します。
テキストは既存の |
end
|
ヘッダー、フッター、脚注、ドキュメント本文の末尾にテキストを挿入します。 |
ロケーション
ドキュメント内の特定の場所。
JSON 表現 |
---|
{ "segmentId": string, "index": integer, "tabId": string } |
フィールド | |
---|---|
segment
|
位置情報が含まれているヘッダー、フッター、または脚注の ID。空のセグメント ID は、ドキュメントの本文を表します。 |
index
|
UTF-16 コード単位で表した、ゼロベースのインデックス。
インデックスは、 |
tab
|
場所が含まれているタブ。省略すると、リクエストは最初のタブに適用されます。 1 つのタブを含むドキュメントの場合:
複数のタブを含むドキュメントの場合:
|
EndOfSegmentLocation
本文、ヘッダー、フッター、脚注の末尾。場所は、ドキュメント セグメントの最後の改行の直前です。
JSON 表現 |
---|
{ "segmentId": string, "tabId": string } |
フィールド | |
---|---|
segment
|
ビジネス情報を含むヘッダー、フッター、脚注の ID。空のセグメント ID は、ドキュメントの本文を表します。 |
tab
|
場所が含まれているタブ。省略すると、リクエストは最初のタブに適用されます。 1 つのタブを含むドキュメントの場合:
複数のタブを含むドキュメントの場合:
|
UpdateTextStyleRequest
テキストのスタイルを更新します。
JSON 表現 |
---|
{ "textStyle": { object ( |
フィールド | |
---|---|
text
|
テキストに設定するスタイル。 特定のスタイルの値が親の値と一致する場合、そのスタイルは継承するように設定されます。
特定のテキスト スタイルを変更すると、ドキュメント エディタの動作を反映するために他の変更が加えられることがあります。詳細については、 |
fields
|
更新が必要なフィールド。
少なくとも 1 つのフィールドを指定する必要があります。ルート
たとえば、テキスト スタイルを太字に更新するには、 プロパティをデフォルト値にリセットするには、フィールド名をフィールド マスクに含めますが、フィールド自体は未設定のままにします。 |
共用体フィールド insertion_location 。テキスト スタイルが更新される範囲のタイプ。insertion_location は次のいずれかになります。 |
|
range
|
スタイル設定するテキストの範囲。 範囲は、隣接する改行を含むように拡張される場合があります。 範囲にリストに属する段落が完全に含まれている場合は、段落の箇条書きも一致するテキスト スタイルで更新されます。 相対的な UpdateTextStyleRequest 内に範囲を挿入することはできません。 |
CreateParagraphBulletsRequest
指定した範囲と重複するすべての段落の箇条書きを作成します。
各段落のネストレベルは、各段落の前に配置されているタブの数によって決まります。箇条書きと対応する段落の間に余分なスペースが空かないように、このリクエストによって先頭のタブが削除されます。これにより、テキストの部分のインデックスが変わる可能性があります。
更新される段落の直前の段落が、一致するプリセットを含むリストにある場合、更新される段落はその前のリストに追加されます。
JSON 表現 |
---|
{ "range": { object ( |
フィールド | |
---|---|
range
|
箇条書きのプリセットを適用する範囲。 |
bullet
|
使用する箇条書き記号の種類。 |
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
|
箇条書きを削除する範囲。 |
CreateNamedRangeRequest
指定された範囲を参照する NamedRange
を作成します。
JSON 表現 |
---|
{
"name": string,
"range": {
object ( |
フィールド | |
---|---|
name
|
NamedRange の名前。名前は一意である必要はありません。 名前は 1 文字以上 256 文字以下(UTF-16 コード単位)にする必要があります。 |
range
|
名前を適用する範囲。 |
DeleteNamedRangeRequest
NamedRange
を削除します。
JSON 表現 |
---|
{ "tabsCriteria": { object ( |
フィールド | |
---|---|
tabs
|
省略可。範囲を削除するタブを指定するために使用する条件。省略した場合、範囲の削除はすべてのタブに適用されます。 1 つのタブを含むドキュメントの場合:
複数のタブを含むドキュメントの場合:
|
共用体フィールド named_range_reference 。削除する範囲を決定する値。必ず 1 つ設定する必要があります。
named_range_reference は次のいずれかになります。 |
|
named
|
削除する名前付き範囲の ID。 |
name
|
削除する範囲の名前。指定された名前のすべての名前付き範囲が削除されます。 |
UpdateParagraphStyleRequest
指定された範囲と重複するすべての段落のスタイルを更新します。
JSON 表現 |
---|
{ "paragraphStyle": { object ( |
フィールド | |
---|---|
paragraph
|
段落に設定するスタイル。
一部の段落スタイルを変更すると、ドキュメント エディタの動作を反映するために他の変更が加えられることがあります。詳細については、 |
fields
|
更新対象のフィールド。
少なくとも 1 つのフィールドを指定する必要があります。ルート
たとえば、段落スタイルの配置プロパティを更新するには、 プロパティをデフォルト値にリセットするには、フィールド名をフィールド マスクに含めますが、フィールド自体は未設定のままにします。 |
共用体フィールド insertion_location 。段落スタイルが更新される範囲のタイプ。insertion_location は次のいずれかになります。 |
|
range
|
スタイル設定する段落が重複する範囲。 |
DeleteContentRangeRequest
ドキュメントからコンテンツを削除します。
JSON 表現 |
---|
{
"range": {
object ( |
フィールド | |
---|---|
range
|
削除するコンテンツの範囲。 段落境界を超えるテキストを削除すると、2 つの段落が統合されるため、段落スタイル、リスト、配置されたオブジェクト、ブックマークが変更される可能性があります。 特定の範囲を削除しようとすると、ドキュメント構造が無効になることがあります。その場合は、400 エラーが返されます。 無効な削除リクエストの例:
|
InsertInlineImageRequest
指定された場所に画像を含む InlineObject
を挿入します。
JSON 表現 |
---|
{ "uri": string, "objectSize": { object ( |
フィールド | |
---|---|
uri
|
画像の URI。 画像は挿入時に 1 回取得され、ドキュメント内に表示するためのコピーが保存されます。画像は、サイズが 50 MB 未満、25 メガピクセル以下で、PNG、JPEG、GIF 形式のいずれかである必要があります。
指定する URI は一般公開されており、長さが 2 KB 以下である必要があります。URI 自体は画像とともに保存され、 |
object
|
ドキュメント内で画像を表示するサイズ。このプロパティは省略可能で、ドキュメント内の画像の最終的なサイズは次のルールによって決まります。* 幅と高さのどちらも指定されていない場合、画像のデフォルトのサイズは解像度に基づいて計算されます。* 1 つのディメンションが指定されている場合は、画像のアスペクト比を維持するために、もう一方のディメンションが計算されます。* 幅と高さの両方を指定すると、画像は指定されたサイズ内に収まるように縮小され、アスペクト比は維持されます。 |
共用体フィールド insertion_location 。画像が挿入される場所。insertion_location は次のいずれかになります。 |
|
location
|
ドキュメント内の特定のインデックスに画像を挿入します。
画像は、既存の 脚注や数式内にインライン画像を挿入することはできません。 |
end
|
ヘッダー、フッター、ドキュメント本文の末尾にテキストを挿入します。 インライン画像を脚注内に挿入することはできません。 |
InsertTableRequest
指定した位置に表を挿入します。
挿入された表の前に改行文字が挿入されます。
JSON 表現 |
---|
{ "rows": integer, "columns": integer, // Union field |
フィールド | |
---|---|
rows
|
テーブル内の行数。 |
columns
|
テーブル内の列数。 |
共用体フィールド insertion_location 。表を挿入する場所。
insertion_location は次のいずれかになります。 |
|
location
|
特定のモデル インデックスにテーブルを挿入します。 挿入されたテーブルの前に改行文字が挿入されるため、テーブルの開始インデックスは指定された位置のインデックス + 1 になります。
テーブルは、既存の 表を脚注や数式内に挿入することはできません。 |
end
|
指定したヘッダー、フッター、ドキュメント本文の末尾に表を挿入します。挿入された表の前に改行文字が挿入されます。 脚注内に表を挿入することはできません。 |
InsertTableRowRequest
空の行をテーブルに挿入します。
JSON 表現 |
---|
{
"tableCellLocation": {
object ( |
フィールド | |
---|---|
table
|
行の挿入元となる参照テーブルのセルの場所。 参照セルがある行の上に(または下に)新しい行が挿入されます。参照セルが結合セルの場合は、結合セルの上に(または下に)新しい行が挿入されます。 |
insert
|
参照セルの位置の下に新しい行を挿入するかどうか。
|
TableCellLocation
表内の 1 つのセルの位置。
JSON 表現 |
---|
{
"tableStartLocation": {
object ( |
フィールド | |
---|---|
table
|
ドキュメント内のテーブルの開始位置。 |
row
|
ゼロベースの行インデックス。たとえば、テーブルの 2 行目は行番号 1 です。 |
column
|
ゼロから始まる列インデックス。たとえば、テーブルの 2 番目の列の列インデックスは 1 です。 |
InsertTableColumnRequest
空の列をテーブルに挿入します。
JSON 表現 |
---|
{
"tableCellLocation": {
object ( |
フィールド | |
---|---|
table
|
列を挿入する参照テーブルのセル位置。 参照セルがある列の左側(または右側)に新しい列が挿入されます。参照セルが結合セルの場合は、結合セルの左側(または右側)に新しい列が挿入されます。 |
insert
|
参照セルの位置の右側に新しい列を挿入するかどうか。
|
DeleteTableRowRequest
テーブルから行を削除します。
JSON 表現 |
---|
{
"tableCellLocation": {
object ( |
フィールド | |
---|---|
table
|
行を削除する参照テーブルのセル位置。 このセルがまたがっている行は削除されます。複数の行にまたがる結合セルの場合は、そのセルがまたがっているすべての行が削除されます。この削除後にテーブルに行が残っていない場合、テーブル全体が削除されます。 |
DeleteTableColumnRequest
テーブルから列を削除します。
JSON 表現 |
---|
{
"tableCellLocation": {
object ( |
フィールド | |
---|---|
table
|
列を削除する参照テーブルのセル位置。 このセルがまたがっている列は削除されます。複数の列にまたがる結合セルの場合は、そのセルがまたがっているすべての列が削除されます。この削除後にテーブルに列が残っていない場合、テーブル全体が削除されます。 |
InsertPageBreakRequest
指定した位置に改ページと改行を挿入します。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド insertion_location 。改ページを挿入する位置。
insertion_location は次のいずれかになります。 |
|
location
|
ドキュメント内の特定のインデックスにページ区切りを挿入します。
ページ分割は、既存の
表、数式、脚注、ヘッダー、フッター内には改ページを挿入できません。ページ分割は本文内にのみ挿入できるため、 |
end
|
ドキュメント本文の末尾にページ区切りを挿入します。
脚注、ヘッダー、フッター内にページ区切りを挿入することはできません。改ページは本文内にのみ挿入できるため、 |
DeletePositionedObjectRequest
ドキュメントから PositionedObject
を削除します。
JSON 表現 |
---|
{ "objectId": string, "tabId": string } |
フィールド | |
---|---|
object
|
削除する位置決めオブジェクトの ID。 |
tab
|
削除するオブジェクトが配置されているタブ。省略すると、リクエストは最初のタブに適用されます。 1 つのタブを含むドキュメントの場合:
複数のタブを含むドキュメントの場合:
|
UpdateTableColumnPropertiesRequest
テーブル内の列の TableColumnProperties
を更新します。
JSON 表現 |
---|
{ "tableStartLocation": { object ( |
フィールド | |
---|---|
table
|
ドキュメント内でテーブルが開始される位置。 |
column
|
プロパティを更新するゼロベースの列番号のリスト。インデックスが指定されていない場合、すべての列が更新されます。 |
table
|
更新するテーブル列のプロパティ。
|
fields
|
更新対象のフィールド。
少なくとも 1 つのフィールドを指定する必要があります。ルート
たとえば、列の幅を更新するには、 |
UpdateTableCellStyleRequest
表内のセルの範囲のスタイルを更新します。
JSON 表現 |
---|
{ "tableCellStyle": { object ( |
フィールド | |
---|---|
table
|
テーブルセルに設定するスタイル。 境界を更新するときに、セルが隣接するセルと境界を共有している場合、隣接するセルの対応する境界プロパティも更新されます。結合されて非表示になった枠線は更新されません。 同じリクエストで隣接するセルで共有されている境界を更新すると、境界の更新が競合する可能性があるため、境界の更新は次の順序で適用されます。
|
fields
|
更新対象のフィールド。
少なくとも 1 つのフィールドを指定する必要があります。ルート
たとえば、テーブルセルの背景色を更新するには、 プロパティをデフォルト値にリセットするには、フィールド名をフィールド マスクに含めますが、フィールド自体は未設定のままにします。 |
共用体フィールド cells 。更新されるセル。cells は次のいずれかになります。 |
|
table
|
更新が適用されるテーブルのサブセットを表すテーブル範囲。 |
table
|
ドキュメント内でテーブルが開始される位置。指定すると、更新がテーブル内のすべてのセルに適用されます。 |
TableRange
テーブル範囲は、テーブルのサブセットへの参照を表します。
テーブル範囲で指定されたセルが長方形になるとは限りません。たとえば、3 x 3 の表で、最後の行のすべてのセルが結合されているとします。テーブルは次のようになります。
[ ][ ][ ]
[ ][ ][ ]
[ ]
表セルの位置 =(tableStartLocation、行 = 0、列 = 0)、行の範囲 = 3、列の範囲 = 2 の表範囲は、次のセルを指定します。
[ x ][ x ][ ]
[ x ][ x ][ ]
[ x x x ]
JSON 表現 |
---|
{
"tableCellLocation": {
object ( |
フィールド | |
---|---|
table
|
表範囲の開始位置のセルの位置。 |
row
|
テーブル範囲の行範囲。 |
column
|
テーブル範囲の列範囲。 |
UpdateTableRowStyleRequest
テーブル内の行の TableRowStyle
を更新します。
JSON 表現 |
---|
{ "tableStartLocation": { object ( |
フィールド | |
---|---|
table
|
ドキュメント内でテーブルが開始される位置。 |
row
|
スタイルを更新するゼロベースの行番号のリスト。インデックスを指定しないと、すべての行が更新されます。 |
table
|
行に設定するスタイル。 |
fields
|
更新が必要なフィールド。
少なくとも 1 つのフィールドを指定する必要があります。ルート
たとえば、最小行の高さを更新するには、 |
ReplaceImageRequest
既存のイメージを新しいイメージに置き換えます。
画像を置き換えると、ドキュメント エディタの動作を反映するために、既存の画像から一部の image effects
が削除されます。
JSON 表現 |
---|
{
"imageObjectId": string,
"uri": string,
"imageReplaceMethod": enum ( |
フィールド | |
---|---|
image
|
置き換えられる既存のイメージの ID。ID は、GET リクエストのレスポンスから取得できます。 |
uri
|
新しい画像の URI。 画像は挿入時に一度取得され、ドキュメント内に表示するためにコピーが保存されます。画像は 50 MB 未満で、25 メガピクセルを超えてはならず、PNG、JPEG、GIF 形式である必要があります。
指定された URI の長さは 2 KB を超えてはなりません。URI は画像とともに保存され、 |
image
|
置換メソッド。 |
tab
|
置き換える画像が含まれているタブ。省略すると、リクエストは最初のタブに適用されます。 1 つのタブを含むドキュメントの場合:
複数のタブを含むドキュメントの場合:
|
ImageReplaceMethod
画像の置換方法。
列挙型 | |
---|---|
IMAGE_REPLACE_METHOD_UNSPECIFIED
|
画像の置換メソッドが指定されていません。この値は使用しないでください。 |
CENTER_CROP
|
元の画像の境界いっぱいになるように、画像を拡大縮小および中央揃えします。元の画像の境界に収まるように、画像が切り抜かれる場合があります。画像のレンダリング サイズは元の画像と同じになります。 |
UpdateDocumentStyleRequest
DocumentStyle
を更新します。
JSON 表現 |
---|
{
"documentStyle": {
object ( |
フィールド | |
---|---|
document
|
ドキュメントに設定するスタイル。
ドキュメントのスタイルを変更すると、ドキュメント エディタの動作を反映するために他の変更が加えられることがあります。詳細については、 |
fields
|
更新が必要なフィールド。
少なくとも 1 つのフィールドを指定する必要があります。ルート
たとえば、背景を更新するには、 |
tab
|
更新するスタイルを含むタブ。省略した場合、リクエストは最初のタブに適用されます。 1 つのタブを含むドキュメントの場合:
複数のタブを含むドキュメントの場合:
|
MergeTableCellsRequest
Table
内のセルを結合します。
JSON 表現 |
---|
{
"tableRange": {
object ( |
フィールド | |
---|---|
table
|
結合するテーブルのセルを指定するテーブル範囲。 結合されるセル内のテキストは連結され、範囲の「先頭」セルに格納されます。コンテンツの方向が左から右の場合は範囲の左上のセル、それ以外の場合は範囲の右上のセルになります。 範囲が長方形以外の場合(結合済みのセルや表が非長方形のセルを含む場合があります)、400 不正なリクエスト エラーが返されます。 |
UnmergeTableCellsRequest
Table
内のセルの結合を解除します。
JSON 表現 |
---|
{
"tableRange": {
object ( |
フィールド | |
---|---|
table
|
結合を解除するテーブルのセルを指定するテーブル範囲。 この範囲の結合したすべてのセルの結合が解除されます。すでに結合が解除されているセルには影響しません。範囲に結合セルがない場合、リクエストは何も実行しません。 結合されたセルにテキストが含まれている場合、そのテキストは、結合されていないセルのブロックの「ヘッド」セルに残ります。コンテンツの方向が左から右の場合、「ヘッド」セルは左上のセルになり、それ以外の場合は右上のセルになります。 |
CreateHeaderRequest
Header
を作成します。新しいヘッダーは、指定された場合、SectionBreak
の場所にある SectionStyle
に適用されます。それ以外の場合は、DocumentStyle
に適用されます。
指定されたタイプのヘッダーがすでに存在する場合は、400 エラー(不正なリクエスト)が返されます。
JSON 表現 |
---|
{ "type": enum ( |
フィールド | |
---|---|
type
|
作成するヘッダーのタイプ。 |
section
|
このヘッダーが属するセクションの先頭にある |
CreateFootnoteRequest
Footnote
セグメントを作成し、指定された場所に新しい FootnoteReference
を挿入します。
新しい Footnote
セグメントには、スペースの後に改行文字が含まれます。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド footnote_reference_location 。脚注参照を挿入する場所。
footnote_reference_location は次のいずれかになります。 |
|
location
|
ドキュメント内の特定のインデックスに脚注の参照を挿入します。
脚注の参照は、既存の
脚注参照は、式、ヘッダー、フッター、脚注内に挿入することはできません。脚注参照は本文にのみ挿入できるため、 |
end
|
ドキュメント本文の末尾に脚注の参照を挿入します。
ヘッダー、フッター、脚注の中に脚注の参照を挿入することはできません。脚注の参照は本文にのみ挿入できるため、 |
ReplaceNamedRangeContentRequest
指定された NamedRange
または NamedRanges
の内容を、指定された置換コンテンツに置き換えます。
1 つの NamedRange
は、複数の連続しない ranges
で構成されている場合があります。この場合、最初の範囲内のコンテンツのみが置き換えられます。他の範囲とその内容は削除されます。
範囲の置換または削除によってドキュメント構造が無効になる場合は、400 エラー(不正なリクエスト)が返されます。
JSON 表現 |
---|
{ "tabsCriteria": { object ( |
フィールド | |
---|---|
tabs
|
省略可。置換を行うタブを指定する条件。省略すると、すべてのタブに置換が適用されます。 1 つのタブを含むドキュメントの場合:
複数のタブを含むドキュメントの場合:
|
共用体フィールド replacement_content 。名前付き範囲の既存の内容を置き換えるコンテンツ。replacement_content は次のいずれかになります。 |
|
text
|
指定した名前付き範囲の内容を、指定したテキストに置き換えます。 |
共用体フィールド named_range_reference 。内容が置き換えられる名前付き範囲への参照。named_range_reference は次のいずれかになります。 |
|
named
|
内容が置き換えられる名前付き範囲の ID。 指定された ID の範囲が存在しない場合、400 エラー(不正なリクエスト)が返されます。 |
named
|
コンテンツが置き換えられる
指定された名前の |
UpdateSectionStyleRequest
SectionStyle
を更新します。
JSON 表現 |
---|
{ "range": { object ( |
フィールド | |
---|---|
range
|
スタイル設定するセクションと重複する範囲。
セクション ブレークは本文内にのみ挿入できるため、 |
section
|
セクションで設定するスタイル。
セクションのスタイルを変更すると、ドキュメント エディタの動作を反映させるために、他の変更が行われる場合があります。詳しくは、 |
fields
|
更新が必要なフィールド。
少なくとも 1 つのフィールドを指定する必要があります。ルート
たとえば、左側の余白を更新するには、 |
InsertSectionBreakRequest
指定した位置にセクション ブレークを挿入します。
セクション ブレークの前に改行文字が挿入されます。
JSON 表現 |
---|
{ "sectionType": enum ( |
フィールド | |
---|---|
section
|
挿入するセクションのタイプ。 |
共用体フィールド insertion_location 。挿入点を挿入する位置。
insertion_location は次のいずれかになります。 |
|
location
|
ドキュメント内の特定のインデックスに改行とセクション ブレークを挿入します。
セクション ブレークは、既存の
表、式、脚注、ヘッダー、フッター内にはセクション ブレークを挿入できません。セクション区切りは本文内にのみ挿入できるため、 |
end
|
ドキュメント本文の末尾に改行とセクション区切りを挿入します。
脚注、ヘッダー、フッター内に改ページを挿入することはできません。セクション区切りは本文内にのみ挿入できるため、 |
DeleteHeaderRequest
ドキュメントから Header
を削除します。
JSON 表現 |
---|
{ "headerId": string, "tabId": string } |
フィールド | |
---|---|
header
|
削除するヘッダーの ID。このヘッダーが |
tab
|
削除するヘッダーを含むタブ。省略すると、リクエストは最初のタブに適用されます。 1 つのタブを含むドキュメントの場合:
複数のタブを含むドキュメントの場合:
|
PinTableHeaderRowsRequest
テーブル内の固定されたテーブル見出し行の数を更新します。
JSON 表現 |
---|
{
"tableStartLocation": {
object ( |
フィールド | |
---|---|
table
|
ドキュメント内でテーブルが開始される位置。 |
pinned
|
固定するテーブル行の数。0 は、すべての行が固定されていないことを意味します。 |