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 followingscopes:
[[["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\u003eCellImage\u003c/code\u003e allows you to add images to spreadsheet cells using \u003ccode\u003eSpreadsheetApp.newCellImage()\u003c/code\u003e and \u003ccode\u003eCellImageBuilder\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eYou can set an image to a cell using \u003ccode\u003eRange.setValue()\u003c/code\u003e or \u003ccode\u003eRange.setValues()\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eCellImage\u003c/code\u003e provides methods to access image properties like alt text, content URL, and source URL.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003etoBuilder()\u003c/code\u003e creates an image value type, necessary for placing images into cells.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eCellImage\u003c/code\u003e has a single property, \u003ccode\u003evalueType\u003c/code\u003e, which is always \u003ccode\u003eValueType.IMAGE\u003c/code\u003e.\u003c/p\u003e\n"]]],["To incorporate images into spreadsheet cells, create a new image value using `SpreadsheetApp.newCellImage()` and `CellImageBuilder`. Add the image to a cell via `Range.setValue()` or `Range.setValues()`. Key methods include: `getAltTextDescription()`, `getAltTextTitle()`, `getContentUrl()`, and `toBuilder()`. The method `getUrl()` is deprecated. `getContentUrl()` returns a Google-hosted URL to the image. `toBuilder()` creates a `CellImageBuilder` to modify image properties. `valueType` property is `ValueType.IMAGE`.\n"],null,["# Class CellImage\n\nCellImage\n\nRepresents an image value in a cell. To add an image to a cell, you must create a new image value\nfor the image using [SpreadsheetApp.newCellImage()](/apps-script/reference/spreadsheet/spreadsheet-app#newCellImage()) and [CellImageBuilder](/apps-script/reference/spreadsheet/cell-image-builder). Then you can use [Range.setValue(value)](/apps-script/reference/spreadsheet/range#setValue(Object)) or [Range.setValues(values)](/apps-script/reference/spreadsheet/range#setValues(Object)) to\nadd the image value to the 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| [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| [toBuilder()](#toBuilder()) | [CellImageBuilder](/apps-script/reference/spreadsheet/cell-image-builder) | 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### `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### `to``Builder()`\n\nCreates a cell image builder based on the current image properties. Use [CellImageBuilder.setSourceUrl(url)](/apps-script/reference/spreadsheet/cell-image-builder#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](/apps-script/reference/spreadsheet/cell-image-builder) --- 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`"]]
