Class CellImageBuilder
Page Summary
CellImageBuilder is used to create the image value needed to add an image to a cell.
The value type for a CellImage is
ValueType.IMAGE.Key methods include
build()to create the image value,setSourceUrl()to set the image source, and methods to get and set alt text (getAltTextDescription,setAltTextDescription,getAltTextTitle,setAltTextTitle).The
getContentUrl()method returns a temporary Google-hosted URL for the image.The
getUrl()method is deprecated and will often return an empty string.
Builder forCell. This builder creates the image value needed to add animage to a cell.
Properties
| Property | Type | Description |
|---|---|---|
value | Value | The value type of the cell image, which isValue. |
Methods
| Method | Return type | Brief description |
|---|---|---|
build() | Cell | Creates the image value type needed to add an image to a cell. |
get | String | Returns the alt text description for this image. |
get | String | Returns the alt text title for this image. |
get | String | Returns a Google-hosted URL to the image. |
set | Cell | Sets the alt-text description for this image. |
set | Cell | Sets the alt text title for this image. |
set | Cell | Sets the image source URL. |
to | Cell | Creates a cell image builder based on the current image properties. |
Deprecated methods
| Method | Return type | Brief description |
|---|---|---|
| String | Gets the image's source URL. |
Detailed documentation
build()
Creates the image value type needed to add an image to a cell. The image value is built fromthe image properties added to the builder, such as the source URL.
Return
Cell — 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 followingscopes:
https://www.googleapis.com/auth/spreadsheets.currentonlyhttps://www.googleapis.com/auth/spreadsheets
getAltTextTitle()
Returns the alt text title for this image.
Return
String — The alt text title.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/spreadsheets.currentonlyhttps://www.googleapis.com/auth/spreadsheets
getContentUrl()
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 theimage might be lost if the spreadsheet's sharing settings change. The returned URL expiresafter a short period of time.
constrange=SpreadsheetApp.getActiveSpreadsheet().getRange("Sheet1!A1");constvalue=range.getValue();if(value.valueType==SpreadsheetApp.ValueType.IMAGE){console.log(value.getContentUrl());}
Return
String — The Google-hosted URL of the image.
setAltTextDescription(description)
Sets the alt-text description for this image.
Parameters
| Name | Type | Description |
|---|---|---|
description | String | The new alt text description for the image. |
Return
Cell — This image, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/spreadsheets.currentonlyhttps://www.googleapis.com/auth/spreadsheets
setAltTextTitle(title)
Sets the alt text title for this image.
Parameters
| Name | Type | Description |
|---|---|---|
title | String | The new alt text title for the image. |
Return
Cell — This image, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/spreadsheets.currentonlyhttps://www.googleapis.com/auth/spreadsheets
setSourceUrl(url)
Sets the image source URL.
Parameters
| Name | Type | Description |
|---|---|---|
url | String | The URL for the image. |
Return
Cell — This builder, for chaining.
toBuilder()
Creates a cell image builder based on the current image properties. Useset to set the source URL of the new image. Then you can add it to acell usingRange.setValue(value) orRange.setValues(values).
constss=SpreadsheetApp.getActiveSpreadsheet();constrange=ss.getRange("Sheet1!A1");constvalue=range.getValue();if(value.valueType==SpreadsheetApp.ValueType.IMAGE){constnewImage=value.toBuilder().setSourceUrl('https://www.gstatic.com/images/branding/productlogos/apps_script/v10/web-64dp/logo_apps_script_color_1x_web_64dp.png',).build();constnewRange=ss.getRange("Sheet1!A2");newRange.setValue(newImage);}
Return
Cell — A builder that creates an image value type based on the given image properties.
Deprecated methods
getUrl()
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 newlyinserted 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:
https://www.googleapis.com/auth/spreadsheets.currentonlyhttps://www.googleapis.com/auth/spreadsheets
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-11 UTC.