Class CellImageBuilder

CellImageBuilder

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

プロパティ

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

Methods

メソッド戻り値の型概要
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 - 指定された画像プロパティに基づいて画像の値タイプを作成するビルダー。