Requests

リクエスト

プレゼンテーションに適用する 1 種類の更新。

JSON 表現
{

  // Union field kind can be only one of the following:
  "createSlide": {
    object (CreateSlideRequest)
  },
  "createShape": {
    object (CreateShapeRequest)
  },
  "createTable": {
    object (CreateTableRequest)
  },
  "insertText": {
    object (InsertTextRequest)
  },
  "insertTableRows": {
    object (InsertTableRowsRequest)
  },
  "insertTableColumns": {
    object (InsertTableColumnsRequest)
  },
  "deleteTableRow": {
    object (DeleteTableRowRequest)
  },
  "deleteTableColumn": {
    object (DeleteTableColumnRequest)
  },
  "replaceAllText": {
    object (ReplaceAllTextRequest)
  },
  "deleteObject": {
    object (DeleteObjectRequest)
  },
  "updatePageElementTransform": {
    object (UpdatePageElementTransformRequest)
  },
  "updateSlidesPosition": {
    object (UpdateSlidesPositionRequest)
  },
  "deleteText": {
    object (DeleteTextRequest)
  },
  "createImage": {
    object (CreateImageRequest)
  },
  "createVideo": {
    object (CreateVideoRequest)
  },
  "createSheetsChart": {
    object (CreateSheetsChartRequest)
  },
  "createLine": {
    object (CreateLineRequest)
  },
  "refreshSheetsChart": {
    object (RefreshSheetsChartRequest)
  },
  "updateShapeProperties": {
    object (UpdateShapePropertiesRequest)
  },
  "updateImageProperties": {
    object (UpdateImagePropertiesRequest)
  },
  "updateVideoProperties": {
    object (UpdateVideoPropertiesRequest)
  },
  "updatePageProperties": {
    object (UpdatePagePropertiesRequest)
  },
  "updateTableCellProperties": {
    object (UpdateTableCellPropertiesRequest)
  },
  "updateLineProperties": {
    object (UpdateLinePropertiesRequest)
  },
  "createParagraphBullets": {
    object (CreateParagraphBulletsRequest)
  },
  "replaceAllShapesWithImage": {
    object (ReplaceAllShapesWithImageRequest)
  },
  "duplicateObject": {
    object (DuplicateObjectRequest)
  },
  "updateTextStyle": {
    object (UpdateTextStyleRequest)
  },
  "replaceAllShapesWithSheetsChart": {
    object (ReplaceAllShapesWithSheetsChartRequest)
  },
  "deleteParagraphBullets": {
    object (DeleteParagraphBulletsRequest)
  },
  "updateParagraphStyle": {
    object (UpdateParagraphStyleRequest)
  },
  "updateTableBorderProperties": {
    object (UpdateTableBorderPropertiesRequest)
  },
  "updateTableColumnProperties": {
    object (UpdateTableColumnPropertiesRequest)
  },
  "updateTableRowProperties": {
    object (UpdateTableRowPropertiesRequest)
  },
  "mergeTableCells": {
    object (MergeTableCellsRequest)
  },
  "unmergeTableCells": {
    object (UnmergeTableCellsRequest)
  },
  "groupObjects": {
    object (GroupObjectsRequest)
  },
  "ungroupObjects": {
    object (UngroupObjectsRequest)
  },
  "updatePageElementAltText": {
    object (UpdatePageElementAltTextRequest)
  },
  "replaceImage": {
    object (ReplaceImageRequest)
  },
  "updateSlideProperties": {
    object (UpdateSlidePropertiesRequest)
  },
  "updatePageElementsZOrder": {
    object (UpdatePageElementsZOrderRequest)
  },
  "updateLineCategory": {
    object (UpdateLineCategoryRequest)
  },
  "rerouteLine": {
    object (RerouteLineRequest)
  }
  // End of list of possible types for union field kind.
}
フィールド
共用体フィールド kind。更新の種類。1 つのフィールドのみを指定する必要があります。kind は次のいずれかになります。
createSlide

object (CreateSlideRequest)

新しいスライドを作成します。

createShape

object (CreateShapeRequest)

新しいシェイプを作成します。

createTable

object (CreateTableRequest)

新しいテーブルを作成します。

insertText

object (InsertTextRequest)

シェイプまたは表のセルにテキストを挿入します。

insertTableRows

object (InsertTableRowsRequest)

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

insertTableColumns

object (InsertTableColumnsRequest)

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

deleteTableRow

object (DeleteTableRowRequest)

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

deleteTableColumn

object (DeleteTableColumnRequest)

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

replaceAllText

object (ReplaceAllTextRequest)

指定したテキストのすべてのインスタンスを置き換えます。

deleteObject

object (DeleteObjectRequest)

プレゼンテーションからページまたはページ要素を削除します。

updatePageElementTransform

object (UpdatePageElementTransformRequest)

ページ要素の変換を更新します。

updateSlidesPosition

object (UpdateSlidesPositionRequest)

プレゼンテーション内のスライドセットの位置を更新します。

deleteText

object (DeleteTextRequest)

図形または表のセルからテキストを削除します。

createImage

object (CreateImageRequest)

イメージを作成します。

createVideo

object (CreateVideoRequest)

動画を作成します。

createSheetsChart

object (CreateSheetsChartRequest)

埋め込みの Google スプレッドシートのグラフを作成します。

createLine

object (CreateLineRequest)

線を作成します。

refreshSheetsChart

object (RefreshSheetsChartRequest)

Google スプレッドシートのグラフを更新します。

updateShapeProperties

object (UpdateShapePropertiesRequest)

Shape のプロパティを更新します。

updateImageProperties

object (UpdateImagePropertiesRequest)

Image のプロパティを更新します。

updateVideoProperties

object (UpdateVideoPropertiesRequest)

Video のプロパティを更新します。

updatePageProperties

object (UpdatePagePropertiesRequest)

Page のプロパティを更新します。

updateTableCellProperties

object (UpdateTableCellPropertiesRequest)

TableCell のプロパティを更新します。

updateLineProperties

object (UpdateLinePropertiesRequest)

Line のプロパティを更新します。

createParagraphBullets

object (CreateParagraphBulletsRequest)

段落に箇条書きを作成します。

replaceAllShapesWithImage

object (ReplaceAllShapesWithImageRequest)

特定の条件に一致するすべての図形を画像に置き換えます。

duplicateObject

object (DuplicateObjectRequest)

スライドまたはページ要素を複製します。

updateTextStyle

object (UpdateTextStyleRequest)

Shape または Table 内のテキストのスタイルを更新します。

replaceAllShapesWithSheetsChart

object (ReplaceAllShapesWithSheetsChartRequest)

特定の条件に一致するすべての図形を Google スプレッドシートのグラフに置き換えます。

deleteParagraphBullets

object (DeleteParagraphBulletsRequest)

段落から箇条書きを削除します。

updateParagraphStyle

object (UpdateParagraphStyleRequest)

Shape または Table 内の段落のスタイルを更新します。

updateTableBorderProperties

object (UpdateTableBorderPropertiesRequest)

Table のテーブル境界のプロパティを更新します。

updateTableColumnProperties

object (UpdateTableColumnPropertiesRequest)

Table 列のプロパティを更新します。

updateTableRowProperties

object (UpdateTableRowPropertiesRequest)

Table 行のプロパティを更新します。

mergeTableCells

object (MergeTableCellsRequest)

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

unmergeTableCells

object (UnmergeTableCellsRequest)

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

groupObjects

object (GroupObjectsRequest)

ページ要素などのオブジェクトをグループ化します。

ungroupObjects

object (UngroupObjectsRequest)

オブジェクトのグループ化を解除します(groups など)。

updatePageElementAltText

object (UpdatePageElementAltTextRequest)

page element の代替テキストのタイトルまたは説明を更新します。

replaceImage

object (ReplaceImageRequest)

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

updateSlideProperties

object (UpdateSlidePropertiesRequest)

スライドのプロパティを更新します。

updatePageElementsZOrder

object (UpdatePageElementsZOrderRequest)

page elements の Z オーダーを更新します。

updateLineCategory

object (UpdateLineCategoryRequest)

line のカテゴリを更新します。

rerouteLine

object (RerouteLineRequest)

line を再ルーティングして、接続されたページ要素の最も近い 2 つの接続サイトで接続されるようにします。

CreateSlideRequest

スライドを作成します。

JSON 表現
{
  "objectId": string,
  "insertionIndex": integer,
  "slideLayoutReference": {
    object (LayoutReference)
  },
  "placeholderIdMappings": [
    {
      object (LayoutPlaceholderIdMapping)
    }
  ]
}
フィールド
objectId

string

ユーザー指定のオブジェクト ID。

ID を指定する場合は、プレゼンテーション内のすべてのページとページ要素で一意である必要があります。ID の先頭は英数字またはアンダースコア(正規表現 [a-zA-Z0-9_] に一致)にする必要があります。残りの文字には、ハイフンやコロン(正規表現 [a-zA-Z0-9_-:] に一致)を含めることができます。ID の長さは 5 ~ 50 文字にする必要があります。

ID を指定しない場合、一意の ID が生成されます。

insertionIndex

integer

スライドを挿入する場所を示す 0 ベースのインデックス(省略可)。

インデックスを指定しない場合、スライドは最後に作成されます。

slideLayoutReference

object (LayoutReference)

現在のマスターに基づいて挿入するスライドのレイアウト参照。次のいずれかです。

  • 前のスライド インデックスのマスター。
  • 挿入インデックスが 0 の場合、最初のスライドのマスター。
  • スライドがない場合、プレゼンテーションの最初のマスター。

現在のマスターに LayoutReference が見つからない場合、400 不正なリクエスト エラーが返されます。

レイアウト参照を指定しない場合、スライドは事前定義された BLANK レイアウトを使用します。

placeholderIdMappings[]

object (LayoutPlaceholderIdMapping)

レイアウトの placeholder から、指定されたレイアウトからスライド上に作成されたプレースホルダへのオブジェクト ID マッピングのリスト(省略可)。slideLayoutReference が指定されている場合にのみ使用できます。

LayoutReference

スライド レイアウトのリファレンス。これは次のいずれかを指す場合があります。

  • 事前定義されたレイアウト
  • プレゼンテーションのレイアウトの 1 つ。
JSON 表現
{

  // Union field kind can be only one of the following:
  "predefinedLayout": enum (PredefinedLayout),
  "layoutId": string
  // End of list of possible types for union field kind.
}
フィールド
共用体フィールド kind。LayoutReference の種類。kind は次のいずれかになります。
predefinedLayout

enum (PredefinedLayout)

事前定義されたレイアウト。

layoutId

string

レイアウト ID: プレゼンテーション内のいずれかのレイアウトのオブジェクト ID。

PredefinedLayout

事前定義されたレイアウト タイプ。これらはプレゼンテーションでよく見られるレイアウトです。ただし、これらのレイアウトが現在のマスターに存在する保証はありません。削除されている場合や、使用されているテーマの一部ではない場合があります。また、各レイアウトのプレースホルダが変更されている場合があります。

列挙型
PREDEFINED_LAYOUT_UNSPECIFIED レイアウトが指定されていません。
BLANK プレースホルダのない空のレイアウト。
CAPTION_ONLY 下部にキャプションがあるレイアウト。
TITLE タイトルとサブタイトルを含むレイアウト。
TITLE_AND_BODY タイトルと本文を含むレイアウト。
TITLE_AND_TWO_COLUMNS タイトルと 2 列のレイアウト。
TITLE_ONLY タイトルのみのレイアウト。
SECTION_HEADER セクション タイトル付きのレイアウト。
SECTION_TITLE_AND_DESCRIPTION 片側にタイトルとサブタイトル、もう片側に説明があるレイアウト。
ONE_COLUMN_TEXT 1 つのタイトルと 1 つの本文が 1 つの列に配置されたレイアウト。
MAIN_POINT 主なポイントを記載したレイアウト。
BIG_NUMBER 大きな数字の見出しが付いたレイアウト。

LayoutPlaceholderIdMapping

指定されたレイアウトからスライド上に作成されるプレースホルダのユーザー指定 ID マッピング。

JSON 表現
{
  "objectId": string,

  // Union field kind can be only one of the following:
  "layoutPlaceholder": {
    object (Placeholder)
  },
  "layoutPlaceholderObjectId": string
  // End of list of possible types for union field kind.
}
フィールド
objectId

string

スライド上に作成する、上記で指定したプレースホルダのユーザー指定のオブジェクト ID。

ID を指定する場合は、プレゼンテーション内のすべてのページとページ要素で一意である必要があります。ID の先頭は英数字またはアンダースコア(正規表現 [a-zA-Z0-9_] に一致)にする必要があります。残りの文字には、それらの文字に加えてハイフンまたはコロン(正規表現 [a-zA-Z0-9_-:] に一致)を含めることができます。ID の長さは 5 文字以上 50 文字以下にする必要があります。

ID を指定しない場合、一意の ID が生成されます。

共用体フィールド kind。レイアウト上のプレースホルダを識別する種類。 kind は次のいずれかになります。
layoutPlaceholder

object (Placeholder)

スライドに適用されるレイアウト上のプレースホルダ。typeindex のみが必要です。たとえば、事前定義された TITLE_AND_BODY レイアウトには通常、インデックス 0 の TITLE プレースホルダとインデックス 0 の BODY プレースホルダがあります。

layoutPlaceholderObjectId

string

スライドに適用されるレイアウト上のプレースホルダのオブジェクト ID。

CreateShapeRequest

新しいシェイプを作成します。

JSON 表現
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },
  "shapeType": enum (Type)
}
フィールド
objectId

string

ユーザー指定のオブジェクト ID。

ID を指定する場合は、プレゼンテーション内のすべてのページとページ要素で一意である必要があります。ID の先頭は英数字またはアンダースコア(正規表現 [a-zA-Z0-9_] に一致)にする必要があります。残りの文字には、それらの文字に加えてハイフンまたはコロン(正規表現 [a-zA-Z0-9_-:] に一致)を含めることができます。ID の長さは 5 文字以上 50 文字以下にする必要があります。空白の場合は、一意の識別子が生成されます。

elementProperties

object (PageElementProperties)

シェイプの要素プロパティ。

shapeType

enum (Type)

シェイプのタイプ。

PageElementProperties

ページ要素の一般的なプロパティ。

注: PageElement を最初に作成すると、API によって sizetransform の両方の値が変更される場合がありますが、視覚的なサイズは変更されません。

JSON 表現
{
  "pageObjectId": string,
  "size": {
    object (Size)
  },
  "transform": {
    object (AffineTransform)
  }
}
フィールド
pageObjectId

string

要素が配置されているページのオブジェクト ID。

size

object (Size)

要素のサイズ。

transform

object (AffineTransform)

要素の変換。

CreateTableRequest

新しいテーブルを作成します。

JSON 表現
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },
  "rows": integer,
  "columns": integer
}
フィールド
objectId

string

ユーザー指定のオブジェクト ID。

ID を指定する場合は、プレゼンテーション内のすべてのページとページ要素で一意である必要があります。ID の先頭は英数字またはアンダースコア(正規表現 [a-zA-Z0-9_] に一致)にする必要があります。残りの文字には、それらの文字に加えてハイフンまたはコロン(正規表現 [a-zA-Z0-9_-:] に一致)を含めることができます。ID の長さは 5 文字以上 50 文字以下にする必要があります。

ID を指定しない場合、一意の ID が生成されます。

elementProperties

object (PageElementProperties)

表の要素プロパティ。

テーブルは、指定されたサイズで作成されます(最小サイズが適用されます)。サイズを指定しない場合、テーブルのサイズは自動的に設定されます。

テーブル変換のスケールは 1 で、シアー コンポーネントは使用できません。変換が指定されていない場合、テーブルはページの中央に配置されます。

rows

integer

テーブル内の行数。

columns

integer

テーブル内の列数。

InsertTextRequest

シェイプまたは表セルにテキストを挿入します。

JSON 表現
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "text": string,
  "insertionIndex": integer
}
フィールド
objectId

string

テキストを挿入する図形または表のオブジェクト ID。

cellLocation

object (TableCellLocation)

テキストをテーブルセルに挿入する場合は、テーブルセルの位置(省略可)。objectId が指定されている場合は、テーブルを参照する必要があります。

text

string

挿入するテキスト。

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

挿入されたテキストのテキスト スタイルは自動的に決定されます。通常は、隣接するテキストのスタイルが保持されます。ほとんどの場合、テキストは挿入インデックスに存在する TextRun に追加されます。

挿入されたテキストから、一部の制御文字(U+0000 ~ U+0008、U+000C ~ U+001F)と Unicode 基本多言語プレーンの私用領域の文字(U+E000 ~ U+F8FF)が削除されます。

insertionIndex

integer

テキストが挿入されるインデックス(TextElement インデックスに基づく Unicode コード単位)。

インデックスはゼロベースで、文字列の先頭から計算されます。インデックスは、Unicode グラフ記号クラスタ内に挿入されないように調整される場合があります。このような場合は、テキストがグラフーム クラスタの直後に挿入されます。

InsertTableRowsRequest

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

JSON 表現
{
  "tableObjectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean,
  "number": integer
}
フィールド
tableObjectId

string

行を挿入するテーブル。

cellLocation

object (TableCellLocation)

行を挿入する参照テーブルのセル位置。

参照セルが配置されている行の上に(または下に)新しい行が挿入されます。参照セルが結合セルの場合は、結合セルの上に(または下に)新しい行が挿入されます。

insertBelow

boolean

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

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

integer

挿入する行数。リクエストあたり最大 20 件。

InsertTableColumnsRequest

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

テーブル内の他の列は、新しい列に合わせてサイズが変更されます。

JSON 表現
{
  "tableObjectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean,
  "number": integer
}
フィールド
tableObjectId

string

列を挿入するテーブル。

cellLocation

object (TableCellLocation)

列を挿入する参照テーブルのセル位置。

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

insertRight

boolean

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

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

integer

挿入する列の数。リクエストあたり最大 20 件。

DeleteTableRowRequest

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

JSON 表現
{
  "tableObjectId": string,
  "cellLocation": {
    object (TableCellLocation)
  }
}
フィールド
tableObjectId

string

行を削除するテーブル。

cellLocation

object (TableCellLocation)

行を削除する参照テーブルのセル位置。

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

DeleteTableColumnRequest

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

JSON 表現
{
  "tableObjectId": string,
  "cellLocation": {
    object (TableCellLocation)
  }
}
フィールド
tableObjectId

string

列を削除するテーブル。

cellLocation

object (TableCellLocation)

列を削除する参照テーブルのセル位置。

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

ReplaceAllTextRequest

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

JSON 表現
{
  "replaceText": string,
  "pageObjectIds": [
    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

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

pageObjectIds[]

string

空でない場合、一致は指定されたページのページ要素のみに制限されます。

notes master のページ オブジェクト ID が指定されている場合、またはそのオブジェクト ID のページがプレゼンテーションに存在しない場合、400 エラー(不正なリクエスト)を返します。

共用体フィールド criteria。置換するテキストの照合に使用される条件。criteria は次のいずれかになります。
containsText

object (SubstringMatchCriteria)

このサブ文字列に一致するシェイプ内のテキストを検索します。

SubstringMatchCriteria

シェイプまたは表内の特定のテキスト文字列に一致する条件。

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

string

シェイプまたは表内で検索するテキスト。

matchCase

boolean

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

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

boolean

省略可。検索値を正規表現として扱う必要がある場合は true。パターンのバックスラッシュはエスケープする必要があります。

  • True : 検索テキストは正規表現として扱われます。
  • False : 検索テキストは、一致するサブ文字列として扱われます。

DeleteObjectRequest

プレゼンテーションからオブジェクト(pages または