Class CellImageBuilder
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
儲存格圖片建立器
CellImage
的建構工具。這個建構工具會建立將圖片新增至儲存格的圖片值。
屬性
屬性 | 類型 | 說明 |
valueType | ValueType | 儲存格圖片的值類型,即 ValueType.IMAGE 。 |
內容詳盡的說明文件
build()
建立將圖片新增至儲存格所需的圖片值類型。圖片值會根據新增至建構工具的圖片屬性 (例如來源網址) 建構。
回攻員
CellImage
:要新增至儲存格的圖片。
getAltTextDescription()
傳回此圖片的替代文字說明。
回攻員
String
:替代文字說明。
授權
使用這個方法的腳本需要具備下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getAltTextTitle()
傳回圖片的替代文字標題。
回攻員
String
:替代文字標題。
授權
使用這個方法的腳本需要具備下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getContentUrl()
傳回 Google 代管的圖片網址。這個網址會標記要求者的帳戶,因此任何擁有該網址的使用者都能以原始要求者的身分存取圖片。如果試算表的共用設定有所變更,您可能會失去圖片的存取權。傳回的網址會在短時間內失效。
const range = SpreadsheetApp.getActiveSpreadsheet().getRange("Sheet1!A1");
const value = range.getValue();
if (value.valueType == SpreadsheetApp.ValueType.IMAGE) {
console.log(value.getContentUrl());
}
回攻員
String
:圖片的 Google 代管網址。
setAltTextDescription(description)
設定圖片的替代文字說明。
參數
名稱 | 類型 | 說明 |
description | String | 圖片的新替代文字說明。 |
回攻員
CellImage
:這張圖片,用於鏈結。
授權
使用這個方法的腳本需要具備下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setAltTextTitle(title)
設定圖片的替代文字標題。
參數
名稱 | 類型 | 說明 |
title | String | 圖片的新替代文字標題。 |
回攻員
CellImage
:此圖片,用於鏈結。
授權
使用這個方法的腳本需要具備下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
toBuilder()
根據目前的圖片屬性建立單元格圖片建構工具。使用 setSourceUrl(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()
已淘汰。對於大多數新插入的圖片,系統無法提供來源網址。
取得圖片的來源網址。如果網址無法使用,就會傳回空白字串。對於大多數新插入的圖片,無論圖片插入方式為何,都無法取得來源網址。
回攻員
String
:圖片的來源網址 (如有);否則傳回空字串。
授權
使用這個方法的腳本需要具備下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-07-26 (世界標準時間)。
[null,null,["上次更新時間:2025-07-26 (世界標準時間)。"],[[["\u003cp\u003e\u003ccode\u003eCellImageBuilder\u003c/code\u003e facilitates the creation and manipulation of images within Google Sheets cells.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods for setting the image source, alt text, and retrieving a Google-hosted URL.\u003c/p\u003e\n"],["\u003cp\u003eYou can build a \u003ccode\u003eCellImage\u003c/code\u003e to insert into a cell using the \u003ccode\u003ebuild()\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003etoBuilder()\u003c/code\u003e method enables modification of existing cell images and insertion into new cells.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003egetUrl()\u003c/code\u003e method is deprecated as it often returns an empty string for newly inserted images.\u003c/p\u003e\n"]]],["The `CellImageBuilder` facilitates adding images to spreadsheet cells. It constructs image values with `build()`, which requires a source URL set via `setSourceUrl()`. Alt text can be managed using `setAltTextDescription()` and `setAltTextTitle()`, and information can be retrieved by using `getAltTextDescription()` ,`getAltTextTitle()` and `getContentUrl()`. `toBuilder()` creates a new builder from an existing image. The value type for cell images is `ValueType.IMAGE`. A deprecated method, `getUrl()`, was used to retrieve source URLs.\n"],null,["# Class CellImageBuilder\n\nCellImageBuilder\n\nBuilder for [CellImage](#). This builder creates the image value needed to add an\nimage to a cell. \n\n### Properties\n\n| Property | Type | Description |\n|---------------|------------------------------------------------------------|-----------------------------------------------------------------|\n| `value``Type` | [ValueType](/apps-script/reference/spreadsheet/value-type) | The value type of the cell image, which is `Value``Type.IMAGE`. |\n\n### Methods\n\n| Method | Return type | Brief description |\n|----------------------------------------------------------------------|------------------------------------------------------------|---------------------------------------------------------------------|\n| [build()](#build()) | [CellImage](/apps-script/reference/spreadsheet/cell-image) | Creates the image value type needed to add an image to a cell. |\n| [getAltTextDescription()](#getAltTextDescription()) | `String` | Returns the alt text description for this image. |\n| [getAltTextTitle()](#getAltTextTitle()) | `String` | Returns the alt text title for this image. |\n| [getContentUrl()](#getContentUrl()) | `String` | Returns a Google-hosted URL to the image. |\n| [setAltTextDescription(description)](#setAltTextDescription(String)) | [CellImage](/apps-script/reference/spreadsheet/cell-image) | Sets the alt-text description for this image. |\n| [setAltTextTitle(title)](#setAltTextTitle(String)) | [CellImage](/apps-script/reference/spreadsheet/cell-image) | Sets the alt text title for this image. |\n| [setSourceUrl(url)](#setSourceUrl(String)) | [CellImageBuilder](#) | Sets the image source URL. |\n| [toBuilder()](#toBuilder()) | [CellImageBuilder](#) | Creates a cell image builder based on the current image properties. |\n\n### Deprecated methods\n\n| Method | Return type | Brief description |\n|-----------------------|-------------|------------------------------|\n| [getUrl()](#getUrl()) | `String` | Gets the image's source URL. |\n\nDetailed documentation\n----------------------\n\n### `build()`\n\nCreates the image value type needed to add an image to a cell. The image value is built from\nthe image properties added to the builder, such as the source URL.\n\n#### Return\n\n\n[CellImage](/apps-script/reference/spreadsheet/cell-image) --- A representation of the image to add to a cell.\n\n*** ** * ** ***\n\n### `get``Alt``Text``Description()`\n\nReturns the alt text description for this image.\n\n#### Return\n\n\n`String` --- The alt text description.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`\n\n*** ** * ** ***\n\n### `get``Alt``Text``Title()`\n\nReturns the alt text title for this image.\n\n#### Return\n\n\n`String` --- The alt text title.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`\n\n*** ** * ** ***\n\n### `get``Content``Url()`\n\nReturns a Google-hosted URL to the image. This URL is tagged with the account of the requester,\nso anyone with the URL effectively accesses the image as the original requester. Access to the\nimage might be lost if the spreadsheet's sharing settings change. The returned URL expires\nafter a short period of time.\n\n```javascript\nconst range = SpreadsheetApp.getActiveSpreadsheet().getRange(\"Sheet1!A1\");\nconst value = range.getValue();\nif (value.valueType == SpreadsheetApp.ValueType.IMAGE) {\n console.log(value.getContentUrl());\n}\n```\n\n#### Return\n\n\n`String` --- The Google-hosted URL of the image.\n\n*** ** * ** ***\n\n### `set``Alt``Text``Description(description)`\n\nSets the alt-text description for this image.\n\n#### Parameters\n\n| Name | Type | Description |\n|---------------|----------|---------------------------------------------|\n| `description` | `String` | The new alt text description for the image. |\n\n#### Return\n\n\n[CellImage](/apps-script/reference/spreadsheet/cell-image) --- This image, for chaining.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`\n\n*** ** * ** ***\n\n### `set``Alt``Text``Title(title)`\n\nSets the alt text title for this image.\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|----------|---------------------------------------|\n| `title` | `String` | The new alt text title for the image. |\n\n#### Return\n\n\n[CellImage](/apps-script/reference/spreadsheet/cell-image) --- This image, for chaining.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`\n\n*** ** * ** ***\n\n### `set``Source``Url(url)`\n\nSets the image source URL.\n\n#### Parameters\n\n| Name | Type | Description |\n|-------|----------|------------------------|\n| `url` | `String` | The URL for the image. |\n\n#### Return\n\n\n[CellImageBuilder](#) --- This builder, for chaining.\n\n*** ** * ** ***\n\n### `to``Builder()`\n\nCreates a cell image builder based on the current image properties. Use [setSourceUrl(url)](#setSourceUrl(String)) to set the source URL of the new image. Then you can add it to a\ncell using [Range.setValue(value)](/apps-script/reference/spreadsheet/range#setValue(Object)) or [Range.setValues(values)](/apps-script/reference/spreadsheet/range#setValues(Object)).\n\n```javascript\nconst ss = SpreadsheetApp.getActiveSpreadsheet();\nconst range = ss.getRange(\"Sheet1!A1\");\nconst value = range.getValue();\nif (value.valueType == SpreadsheetApp.ValueType.IMAGE) {\n const newImage =\n value.toBuilder()\n .setSourceUrl(\n 'https://www.gstatic.com/images/branding/productlogos/apps_script/v10/web-64dp/logo_apps_script_color_1x_web_64dp.png',\n )\n .build();\n const newRange = ss.getRange(\"Sheet1!A2\");\n newRange.setValue(newImage);\n}\n```\n\n#### Return\n\n\n[CellImageBuilder](#) --- A builder that creates an image value type based on the given image properties.\n\nDeprecated methods\n------------------\n\n### `get``Url()`\n\n\n**Deprecated.** For most newly inserted images, the source URL is unavailable.\n\nGets the image's source URL. Returns an empty string if the URL is unavailable. For most newly\ninserted images, the source URL is unavailable regardless how the image is inserted.\n\n#### Return\n\n\n`String` --- The image's source URL if available; returns an empty string otherwise.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`"]]