Class CellImageBuilder

セル画像ビルダー

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

プロパティ

プロパティタイプ説明
valueTypeValueType画像の値の型を表す ValueType.IMAGE に設定されたフィールド。

メソッド

メソッド戻り値の型概要
build()CellImageセルに画像を追加するために必要な画像値の型を作成します。
getAltTextDescription()Stringこの画像の代替テキストの説明を返します。
getAltTextTitle()Stringこの画像の代替テキストのタイトルを返します。
getContentUrl()StringGoogle がホストする画像の URL を返します。
getUrl()String画像のソース URL を取得します。URL が使用できない場合は null を返します。
setAltTextDescription(description)CellImageこの画像の代替テキストの説明を設定します。
setAltTextTitle(title)CellImageこの画像の代替テキストのタイトルを設定します。
setSourceUrl(url)CellImageBuilder画像のソース URL を設定します。
toBuilder()CellImageBuilder画像を画像値型に変換してセルに配置できるようにするビルダーを作成します。

詳細なドキュメント

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 は、しばらくすると期限切れになります。

戻る

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

getUrl()

画像のソース URL を取得します。URL が使用できない場合は null を返します。API を使用して URL で画像が挿入された場合、このメソッドは画像の挿入時に指定された URL を返します。

戻る

String - 画像の URL（利用可能な場合）。画像が利用できない、またはソース URL がない場合は null を返します。

承認

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

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

setAltTextDescription(description)

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

パラメータ

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

戻る

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

承認

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

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

setAltTextTitle(title)

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

パラメータ

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

戻る

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

承認

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

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

setSourceUrl(url)

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

パラメータ

名前型説明
urlString画像の URL。

戻る

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

toBuilder()

画像を画像値型に変換してセルに配置できるようにするビルダーを作成します。画像をセルに配置する前に、画像値の型として作成する必要があります。その後、Range.setValue(value) または Range.setValues(values) を使用してセルに追加できます。

戻る

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