要素の演算

GoogleSlide API を使用すると、テキスト ボックス、画像、表、基本的な図形、線、埋め込み動画などの PageElement リソースを作成および編集できます。このページの例では、presentations.batchUpdate メソッドを使用した一般的なページ要素オペレーションの一部を示しています。

これらの例では、次の変数を使用します。

  • PRESENTATION_ID - プレゼンテーション ID を指定する場所を示します。この ID の値はプレゼンテーションの URL から取得できます。
  • PAGE_ID - ページ オブジェクト ID を指定する場所を示します。この値は、URL から、または API 読み取りリクエストを使用して取得できます。
  • PAGE_ELEMENT_ID - ページ要素オブジェクト ID を指定する場所を示します。作成する要素にこの ID を指定するか(いくつかの制限があります)、Slides API で自動的に ID を作成することもできます。要素 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 で指定されます。

また、このリクエストでは、スライドのグラフの LinkingModeLINKED に設定し、ソース スプレッドシートのグラフが更新された場合に、埋め込まれたグラフを更新できるようにします。

スプレッドシートからグラフをインポートするリクエスト プロトコルは次のとおりです。

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
      }
    }
  ]
}