Class CellImage
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Propriedades
Propriedade | Tipo | Descrição |
valueType | ValueType | O tipo de valor da imagem da célula, que é ValueType.IMAGE . |
Métodos obsoletos
Método | Tipo de retorno | Breve descrição |
getUrl()
| String | Consegue o URL de origem da imagem. |
Documentação detalhada
getAltTextDescription()
Retorna a descrição do texto alternativo para essa imagem.
Retornar
String
: a descrição do texto alternativo.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getAltTextTitle()
Retorna o título do texto alternativo para essa imagem.
Retornar
String
: o título do texto alternativo.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getContentUrl()
Retorna um URL hospedado pelo Google para a imagem. Esse URL é marcado com a conta do solicitante.
Assim, qualquer pessoa com o URL acessa a imagem como o solicitante original. O acesso à
imagem pode ser perdido se as configurações de compartilhamento da planilha mudarem. O URL retornado expira
após um curto período.
const range = SpreadsheetApp.getActiveSpreadsheet().getRange("Sheet1!A1");
const value = range.getValue();
if (value.valueType == SpreadsheetApp.ValueType.IMAGE) {
console.log(value.getContentUrl());
}
Retornar
String
: o URL da imagem hospedado pelo Google.
toBuilder()
Cria um builder de imagens de célula com base nas propriedades de imagem atuais. Use CellImageBuilder.setSourceUrl(url)
para definir o URL de origem da nova imagem. Em seguida, adicione-o a uma
célula usando Range.setValue(value)
ou 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);
}
Retornar
CellImageBuilder
: um builder que cria um tipo de valor de imagem com base nas propriedades de imagem fornecidas.
Métodos obsoletos
getUrl()
Obsoleto. Para a maioria das imagens recém-inseridas, o URL da origem não está disponível.
Consegue o URL de origem da imagem. Retorna uma string vazia se o URL estiver indisponível. Para a maioria das imagens
novamente inseridas, o URL da origem fica indisponível, independentemente de como a imagem é inserida.
Retornar
String
: o URL de origem da imagem, se disponível. Caso contrário, retorna uma string vazia.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-26 UTC.
[null,null,["Última atualização 2025-07-26 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`"]]