ContentImageByKey
Descrição
Retorna uma tag <img> completa apontando para uma imagem armazenada no Content Builder, localizada pela sua external key. A tag gerada já inclui os atributos title, alt, border="0" e um atributo thid com o ID interno da imagem. É muito útil para montar e-mails dinâmicos onde as imagens podem variar por segmento ou campanha, com a segurança de um fallback caso a imagem principal não seja encontrada.
Sintaxe
ContentImageByKey(imageExternalKey, defaultImageExternalKey)
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| imageExternalKey | string | Sim | External key da imagem no Content Builder que você quer exibir. |
| defaultImageExternalKey | string | Sim | External key de uma imagem de fallback no Content Builder. Será usada se a imagem do primeiro parâmetro não for encontrada. |
Exemplo básico
Exibindo o banner principal de uma campanha da MegaStore, com um banner genérico como fallback:
%%=ContentImageByKey("banner-inverno-2024", "banner-padrao-megastore")=%%
Saída:
<img src="https://image.s11.sfmc-content.com/lib/fe3a.../banner-inverno-2024.jpg" alt="Promoção de Inverno MegaStore" title="Promoção de Inverno MegaStore" border="0" thid="12345678" />
Exemplo avançado
Em uma régua de relacionamento da Lojas Vitória, a imagem do e-mail muda conforme a categoria de interesse do cliente. A external key da imagem é montada dinamicamente com base em dados da Data Extension:
%%[
SET @categoria = Lookup("CategoriaCliente", "Categoria", "EmailAddress", EmailAddress)
IF Empty(@categoria) THEN
SET @categoria = "geral"
ENDIF
SET @chaveImagem = Concat("vitoria-destaque-", Lowercase(@categoria))
SET @chaveFallback = "vitoria-destaque-geral"
]%%
%%=ContentImageByKey(@chaveImagem, @chaveFallback)=%%
Saída (para um cliente com categoria "eletronicos"):
<img src="https://image.s11.sfmc-content.com/lib/fe3a.../vitoria-destaque-eletronicos.jpg" alt="Destaques Eletrônicos Lojas Vitória" title="Destaques Eletrônicos Lojas Vitória" border="0" thid="87654321" />
Saída (quando a categoria não existe ou a imagem não é encontrada):
<img src="https://image.s11.sfmc-content.com/lib/fe3a.../vitoria-destaque-geral.jpg" alt="Destaques Lojas Vitória" title="Destaques Lojas Vitória" border="0" thid="11223344" />
Observações
⚠️ Atenção: Essa função só funciona com conteúdo do tipo Image no Content Builder. Ela não funciona com conteúdo do tipo Image Block. Se você está tentando usar e nada aparece, verifique o tipo do asset no Content Builder.
- Se a imagem especificada no primeiro parâmetro não for encontrada, a função automaticamente retorna a tag
<img>apontando para a imagem do segundo parâmetro (fallback). Isso evita que o e-mail vá com imagem quebrada. - A tag
<img>retornada já vem comborder="0", o que é padrão para e-mail marketing e evita bordas indesejadas em clientes de e-mail antigos. - O atributo
thidincluído na tag contém um ID interno da imagem usado pelo Marketing Cloud.
💡 Dica: Ao montar external keys dinamicamente (como no exemplo avançado), use Lowercase para padronizar e evitar problemas de case sensitivity na hora da busca. Combine com Empty para garantir que você sempre terá uma chave válida antes de chamar a função.
Funções relacionadas
- ContentImageById - mesma ideia, mas localiza a imagem pelo ID numérico em vez da external key.
- ImageByKey - outra função para referenciar imagens por external key.
- ImageById - referencia imagens pelo ID numérico.
- Image - função base para trabalhar com imagens.
- ContentBlockByKey - para inserir blocos de conteúdo (não imagens) por external key.
- Concat - útil para montar external keys dinâmicas.
- Lowercase - para padronizar strings antes de usar como chave.
- Empty - para validar valores antes de montar a chave da imagem.