Class CellImageBuilder

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