Google Sheets API を使用すると、PageElement
リソース(テキスト ボックス、画像、表、基本的な図形、線、埋め込み動画など)を作成および編集できます。このページの例では、presentations.batchUpdate
メソッドを使用した一般的なページ要素のオペレーションを示しています。
これらの例では、次の変数を使用します。
- PRESENTATION_ID - プレゼンテーション ID を指定する場所を示します。この ID の値はプレゼンテーション URL から取得できます。
- PAGE_ID - ページ オブジェクト ID を指定する場所を示します。この値は、URL から、または API 読み取りリクエストを使用して取得できます。
- PAGE_ELEMENT_ID - ページ要素のオブジェクト ID を指定する場所を示します。この ID は、作成する要素に指定することも(一定の制限がある)、Slides API で自動的に作成することもできます。要素 ID は API 読み取りリクエストで取得できます。
これらの例では、言語に依存しない HTTP リクエストとして記載しています。Google API クライアント ライブラリを使用してさまざまな言語でバッチ アップデートを実装する方法については、次のガイドをご覧ください。
テキスト ボックスに箇条書きを追加する
次の presentations.batchUpdate
コードサンプルは、InsertTextRequest
メソッドを使用して、PAGE_ELEMENT_ID で指定された空のテキスト ボックスにテキストを挿入する方法を示しています。次にサンプルでは、CreateParagraphBulletsRequest
メソッドを使用して、すべてのテキスト ボックスのテキストを箇条書きリストに変換します。リスト内のアイテムは \n
文字で区切られ、インデントは \t
文字で制御されます。
プレゼンテーションを作成するためのリクエスト プロトコルは次のとおりです。
POST https://slides.googleapis.com/v1/presentations/PRESENTATION_ID:batchUpdate
{ "requests": [ { "insertText": { "objectId": PAGE_ELEMENT_ID, "text": "My List\n\tItem 1\n\t\tItem 2\n\t\t\tItem 3", "insertionIndex": 0 }, "createParagraphBullets": { "objectId": PAGE_ELEMENT_ID, "bulletPreset": "BULLET_ARROW_DIAMOND_DISC", "textRange": { "type": "ALL" } } } ] }
このリクエストによって、次のような箇条書きリストを作成できます。
スライドに図形を追加する
次の presentations.batchUpdate
コードサンプルは、CreateShapeRequest
メソッドを使用して、PAGE_ID で指定されたスライドに波形を追加する方法を示しています。このリクエストでは、シェイプの種類を指定してから、スライド内でシェイプの拡大縮小と配置を行います。次に、InsertTextRequest
メソッドを使用して、そのシェイプにテキストを追加します。このリクエストにより、行の ID が PAGE_ELEMENT_ID に設定されます。
スライドにシェイプを追加するためのリクエスト プロトコルは次のとおりです。
POST https://slides.googleapis.com/v1/presentations/PRESENTATION_ID:batchUpdate
{ "requests": [ { "createShape": { "objectId": PAGE_ELEMENT_ID, "elementProperties": { "pageObjectId": PAGE_ID, "size": { "width": { "magnitude": 3000000, "unit": "EMU" }, "height": { "magnitude": 3000000, "unit": "EMU" } }, "transform": { "scaleX": 0.6807, "scaleY": 0.4585, "translateX": 6583050, "translateY": 1673950, "unit": "EMU" } }, "shapeType": "WAVE" } }, { "insertText": { "objectId": PAGE_ELEMENT_ID, "text": "My Wave Shape", "insertionIndex": 0 } } ] }
スライドに動画を追加する
次の presentations.batchUpdate
コードサンプルは、CreateVideoRequest
メソッドを使用して、PAGE_ID で指定されたスライドに動画を埋め込む方法を示しています。このリクエストは、スライド内の動画のスケーリングと配置を行い、動画の ID を PAGE_ELEMENT_ID に設定します。ソース動画の一意の識別子は VIDEO_ID に設定されています。たとえば、https://www.youtube.com/watch?v=7U3axjORYZ0
の YouTube 動画の ID は 7U3axjORYZ0
です。
スライドに動画を追加するためのリクエスト プロトコルは次のとおりです。
POST https://slides.googleapis.com/v1/presentations/PRESENTATION_ID:batchUpdate
{ "requests": [ { "createVideo": { "objectId": PAGE_ELEMENT_ID, "elementProperties": { "pageObjectId": PAGE_ID, "size": { "width": { "magnitude": 12000, "unit": "EMU" }, "height": { "magnitude": 9000, "unit": "EMU" } }, "transform": { "scaleX": 381, "scaleY": 381, "translateX": 152400, "translateY": 152400, "unit": "EMU" } }, "source": "YOUTUBE", "id": VIDEO_ID } } ] }
要素をコピーして編集する
次の presentations.batchUpdate
コードサンプルは、DuplicateObjectRequest
メソッドを使用して、既存のシェイプ(PAGE_ELEMENT_ID で指定)を取得し、コピー(COPY_ELEMENT_ID で指定)を作成する方法を示しています。
後続のリクエストでは、複製されたオブジェクトに次の変更を行います。
- 背景色を
LIGHT2
テーマカラーに設定します。 - コピーを(元のシェイプの位置から)ページ下に移動します。
- テキスト フォントを 18 pt のジョージアに設定します。
- テキストが「My Shape Copy」になるように編集します。
このリクエストでは、フィールド マスクを使用して、変更されないシェイプのプロパティ(枠線のスタイルなど)を保持します。フィールド マスクを使用するとパフォーマンスも向上します。
スライドのコピーについて詳しくは、サンプルのスライドをコピーするをご覧ください。
要素をコピーして編集するためのリクエスト プロトコルは次のとおりです。
POST https://slides.googleapis.com/v1/presentations/PRESENTATION_ID:batchUpdate
{ "requests": [ { "duplicateObject": { "objectId": PAGE_ELEMENT_ID, "objectIds": { PAGE_ELEMENT_ID: COPY_ELEMENT_ID } } }, { "updateShapeProperties": { "objectId": COPY_ELEMENT_ID, "fields": "shapeBackgroundFill.solidFill.color", "shapeProperties": { "shapeBackgroundFill": { "solidFill": { "color": { "themeColor": "LIGHT2" } } } } } }, { "updatePageElementTransform": { "objectId": COPY_ELEMENT_ID, "applyMode": "RELATIVE", "transform": { "scaleX": 1, "scaleY": 1, "translateX": 0, "translateY": 1250000, "unit": "EMU" } } }, { "updateTextStyle": { "objectId": COPY_ELEMENT_ID, "fields": "fontFamily,fontSize", "textRange": { "type": "ALL" }, "style": { "fontFamily": "Georgia", "fontSize": { "magnitude": 18, "unit": "PT" } } } }, { "deleteText": { "objectId": COPY_ELEMENT_ID, "textRange": { "type": "ALL" } } }, { "insertText": { "objectId": COPY_ELEMENT_ID, "text": "My Shape Copy", "insertionIndex": 0 } } ] }
更新後のシェイプとそのコピーは、次のようになります。
画像または動画のアウトラインを編集する
次の presentations.batchUpdate
コードサンプルは、UpdateImagePropertiesRequest
メソッドを使用して、IMAGE_ELEMENT_ID で指定された画像のアウトライン表示を更新する方法を示しています。また、UpdateVideoPropertiesRequest
メソッドを使用して、VIDEO_ELEMENT_ID で指定された埋め込み動画のアウトライン表示を更新します。
このリクエストにより、オブジェクトに次の変更が行われます。
- 画像の枠線の色を、部分透明な
ACCENT5
テーマカラーに設定します。 - 動画の枠線の色を、透明な
ACCENT1
テーマの色に設定します。 - 両方の枠線の太さを 3 pt に設定します。
- 画像の枠線のスタイルを
SOLID
に設定します。 - 動画の枠線のスタイルを
DASH_DOT
に設定します。
UpdateImagePropertiesRequest
メソッドと UpdateVideoPropertiesRequest
メソッドは、画像と動画のアウトラインの外観のみを変更できます。他のすべてのプロパティは読み取り専用です。ここでのリクエストでは、フィールド マスクを使用して、将来の API の変更からコードを保護するために、アウトラインのみの変更を指定します。フィールド マスクを使用すると、パフォーマンスも向上します。
画像や動画のアウトラインを編集するためのリクエスト プロトコルは次のとおりです。
POST https://slides.googleapis.com/v1/presentations/PRESENTATION_ID:batchUpdate
{ "requests": [ { "updateImageProperties": { "objectId": IMAGE_ELEMENT_ID, "fields": "outline", "imageProperties": { "outline": { "dashStyle": "SOLID", "outlineFill": { "solidFill": { "alpha": 0.8, "color": { "themeColor": "ACCENT5" } } }, "weight": { "magnitude": 3, "unit": "PT" } } } } }, { "updateVideoProperties": { "objectId": VIDEO_ELEMENT_ID, "fields": "outline", "videoProperties": { "outline": { "dashStyle": "DASH_DOT", "outlineFill": { "solidFill": { "alpha": 0.8, "color": { "themeColor": "ACCENT1" } } }, "weight": { "magnitude": 3, "unit": "PT" } } } } } ] }
更新後の画像や動画は、次のように表示されます。
シェイプの枠線を編集する
次の presentations.batchUpdate
コードサンプルは、UpdateShapePropertiesRequest
メソッドを使用して既存のシェイプ(PAGE_ELEMENT_ID で指定)を取得し、そのアウトラインの外観を更新する方法を示しています。
このリクエストにより、オブジェクトに次の変更が行われます。
- 枠線の色を部分透明な
ACCENT5
テーマカラーに設定します。 - 枠線の太さを 3 pt に設定します。
- 枠線のスタイルを
LONG_DASH
に設定します。
このリクエストでは、フィールド マスクを使用して、変更されないシェイプのプロパティ(シェイプの塗りつぶしの色など)を保持します。フィールド マスクを使用するとパフォーマンスも向上します。
シェイプの枠線を編集するためのリクエスト プロトコルは次のとおりです。
POST https://slides.googleapis.com/v1/presentations/PRESENTATION_ID:batchUpdate
{ "requests": [ { "updateShapeProperties": { "objectId": PAGE_ELEMENT_ID, "fields": "outline", "shapeProperties": { "outline": { "dashStyle": "LONG_DASH", "outlineFill": { "solidFill": { "alpha": 0.6, "color": { "themeColor": "ACCENT5" } } }, "weight": { "magnitude": 3, "unit": "PT" } } } } } ] }
更新後のシェイプは次のようになります。
図形やテキスト ボックス内のテキストの書式を設定する
次の presentations.batchUpdate
コードサンプルは、UpdateTextStyleRequest
メソッドを使用して既存のシェイプ(PAGE_ELEMENT_ID で指定)を取得し、テキストの外観を更新する方法を示しています。
このリクエストにより、オブジェクトに次の変更が行われます。
- テキストの色を
ACCENT5
テーマの色に設定します。 - フォントを太字の斜体(18 pt の Corsiva 形式)に設定します。
- テキストに下線を引きます。
このリクエストでは、フィールド マスクを使用して、変更されないテキスト スタイルのプロパティ(背景色、リンク、ベースライン オフセットなど)を保持します。フィールド マスクを使用するとパフォーマンスも向上します。
シェイプまたはテキスト ボックス内のテキストの書式を設定するリクエスト プロトコルは次のとおりです。
POST https://slides.googleapis.com/v1/presentations/PRESENTATION_ID:batchUpdate
{ "requests": [ { "updateTextStyle": { "objectId": PAGE_ELEMENT_ID, "fields": "foregroundColor,bold,italic,fontFamily,fontSize,underline", "style": { "foregroundColor": { "opaqueColor": { "themeColor": "ACCENT5" } }, "bold": true, "italic": true, "underline": true, "fontFamily": "Corsiva", "fontSize": { "magnitude": 18, "unit": "PT" } }, "textRange": { "type": "ALL" } } } ] }
更新されたシェイプ テキストは次のようになります。
Google スプレッドシートからグラフをインポートする
次の presentations.batchUpdate
コードサンプルは、CreateSheetsChartRequest
メソッドを使用して、スプレッドシートからグラフをインポートし、PAGE_ID で指定されたスライドに配置する方法を示しています。
このリクエストには、スプレッドシート ID(SPREADSHEET_ID で指定)とスプレッドシート グラフ ID(SPREADSHEET_CHART_ID で指定)が必要です。スライド プレゼンテーション内のグラフ ID は PRESENTATION_CHART_ID で指定されます。
また、このリクエストではスライドのグラフの LinkingMode
が LINKED
に設定されるため、元のスプレッドシートのグラフが更新された場合に埋め込みグラフを更新できます。
スプレッドシートからグラフをインポートするリクエスト プロトコルは次のとおりです。
POST https://slides.googleapis.com/v1/presentations/PRESENTATION_ID:batchUpdate
{ "requests": [ { "createSheetsChart": { "objectId": PRESENTATION_CHART_ID, "spreadsheetId": SPREADSHEET_ID, "chartId": SPREADSHEET_CHART_ID, "linkingMode": "LINKED", "elementProperties": { "pageObjectId": PAGE_ID, "size": { "width": { "magnitude": 4000000, "unit": "EMU" }, "height": { "magnitude": 4000000, "unit": "EMU" } }, "transform": { "scaleX": 1, "scaleY": 1, "translateX": 100000, "translateY": 100000, "unit": "EMU" } } } ] }
スプレッドシートからグラフを更新する
次の presentations.batchUpdate
コードサンプルは、RefreshSheetsChartRequest
メソッドを使用して、プレゼンテーション内のリンクされたグラフを更新し、スプレッドシートのソース スプレッドシートにある最新バージョンのグラフに置き換える方法を示しています。このリクエストには、スライド プレゼンテーション内のグラフ ID(PRESENTATION_CHART_ID で指定)が必要です。
スプレッドシートからグラフを更新するためのリクエスト プロトコルは次のとおりです。
POST https://slides.googleapis.com/v1/presentations/PRESENTATION_ID:batchUpdate
{ "requests": [ { "refreshSheetsChart": { "objectId": PRESENTATION_CHART_ID } } ] }