Creates the image value type needed to add an image to a cell. The image value is built from
the image properties added to the builder, such as the source URL.
Return
CellImage — A representation of the image to add to a cell.
getAltTextDescription()
Returns the alt text description for this image.
Return
String — The alt text description.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
Returns a Google-hosted URL to the image. This URL is tagged with the account of the requester,
so anyone with the URL effectively accesses the image as the original requester. Access to the
image might be lost if the spreadsheet's sharing settings change. The returned URL expires
after a short period of time.
CellImageBuilder — A builder that creates an image value type based on the given image properties.
Deprecated methods
getUrl()
Deprecated. For most newly inserted images, the source URL is unavailable.
Gets the image's source URL. Returns an empty string if the URL is unavailable. For most newly
inserted images, the source URL is unavailable regardless how the image is inserted.
Return
String — The image's source URL if available; returns an empty string otherwise.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-12-09 UTC."],[[["\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`"]]
