Class CellImageBuilder

セル画像ビルダー

CellImage のビルダー。このビルダーは、セルに画像を追加するために必要な画像値を作成します。

プロパティ

プロパティ	タイプ	説明
valueType	ValueType	セル画像の値の型（ValueType.IMAGE）。

メソッド

メソッド	戻り値の型	概要
build()	CellImage	セルに画像を追加するために必要な画像値の型を作成します。
getAltTextDescription()	String	この画像の代替テキストの説明を返します。
getAltTextTitle()	String	この画像の代替テキストのタイトルを返します。
getContentUrl()	String	Google がホストする画像の URL を返します。
setAltTextDescription(description)	CellImage	この画像の代替テキストの説明を設定します。
setAltTextTitle(title)	CellImage	この画像の代替テキストのタイトルを設定します。
setSourceUrl(url)	CellImageBuilder	画像のソース URL を設定します。
toBuilder()	CellImageBuilder	現在の画像プロパティに基づいてセル画像ビルダーを作成します。

サポート終了のメソッド

メソッド	戻り値の型	概要
getUrl()	String	画像のソース URL を取得します。

詳細なドキュメント

build()

セルに画像を追加するために必要な画像値の型を作成します。画像値は、ビルダーに追加された画像プロパティ（ソース URL など）から構築されます。

戻る

CellImage - セルに追加する画像を表します。

---

getAltTextDescription()

この画像の代替テキストの説明を返します。

戻る

String - 代替テキストの説明。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getAltTextTitle()

この画像の代替テキストのタイトルを返します。

戻る

String - 代替テキストのタイトル。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getContentUrl()

画像の Google ホスト URL を返します。この URL にはリクエスト元のアカウントのタグが付けられているため、URL を知っているユーザーは、元のリクエスト元として画像にアクセスできます。スプレッドシートの共有設定が変更されると、画像にアクセスできなくなる可能性があります。返された URL は、しばらくすると期限切れになります。

const range = SpreadsheetApp.getActiveSpreadsheet().getRange("Sheet1!A1");
const value = range.getValue();
if (value.valueType == SpreadsheetApp.ValueType.IMAGE) {
  console.log(value.getContentUrl());
}

戻る

String - Google がホストする画像の URL。

---

setAltTextDescription(description)

この画像の代替テキストの説明を設定します。

パラメータ

名前	型	説明
description	String	画像の新しい代替テキストの説明。

戻る

CellImage - チェーン用のこの画像。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setAltTextTitle(title)

この画像の代替テキストのタイトルを設定します。

パラメータ

名前	型	説明
title	String	画像の新しい代替テキストのタイトル。

戻る

CellImage - チェーン用のこの画像。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setSourceUrl(url)

画像のソース URL を設定します。

パラメータ

名前	型	説明
url	String	画像の URL。

戻る

CellImageBuilder - チェーン用のこのビルダー。

---

toBuilder()

現在の画像プロパティに基づいてセル画像ビルダーを作成します。setSourceUrl(url) を使用して、新しい画像のソース URL を設定します。その後、Range.setValue(value) または Range.setValues(values) を使用してセルに追加できます。

const ss = SpreadsheetApp.getActiveSpreadsheet();
const range = ss.getRange("Sheet1!A1");
const value = range.getValue();
if (value.valueType == SpreadsheetApp.ValueType.IMAGE) {
  const newImage =
      value.toBuilder()
          .setSourceUrl(
              'https://www.gstatic.com/images/branding/productlogos/apps_script/v10/web-64dp/logo_apps_script_color_1x_web_64dp.png',
              )
          .build();
  const newRange = ss.getRange("Sheet1!A2");
  newRange.setValue(newImage);
}

戻る

CellImageBuilder - 指定された画像プロパティに基づいて画像値の型を作成するビルダー。

サポート終了のメソッド

getUrl()

非推奨。新しく挿入された画像のほとんどで、ソース URL は使用できません。

画像のソース URL を取得します。URL が使用できない場合は空の文字列を返します。新しく挿入された画像のほとんどは、画像の挿入方法に関係なく、ソース URL を使用できません。

戻る

String - 画像のソース URL（利用可能な場合）。利用できない場合は空の文字列を返します。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets