Pular para o conteúdo principal

getTemplatesPreviewByMarker

Obtendo um objeto de template por marcador.

Este método recupera um único objeto de template com base em seu identificador textual (marcador) da API. Ele retorna uma Promise que resolve para um objeto TemplatePreviewsEntity.

TemplatePreviews.getTemplatesPreviewByMarker( marker, langCode );

Exemplo mínimo

const value = await TemplatePreviews.getTemplatePreviewByMarker('my-marker');

Exemplo com atributos

const value = await TemplatePreviews.getTemplatePreviewByMarker('my-marker', 'en_US');

Esquema de parâmetros

Esquema

marker(required): string
O marcador único do produto usado para identificar o template. Se não fornecido, um comportamento padrão ou erro pode ocorrer
exemplo: "template_12345"

langCode: string
Código do idioma. Padrão: "en_US"
exemplo: "en_US"

Exemplo de resposta

{
"id": 1,
"version": 0,
"identifier": "preview-templates",
"attributeValues": {
"marker": {
"value": "",
"type": "string",
"position": 1,
"isProductPreview": false,
"isIcon": false,
"attributeFields": {
"marker": {
"type": "string",
"value": "test"
}
}
}
},
"attributeSetIdentifier": "my-set",
"proportion": {
"vertical": {
"width": "2",
"height": "3",
"alignmentType": "leftTop",
"marker": "v"
},
"horizontal": {
"width": "234",
"height": "324",
"alignmentType": "middleBottom",
"marker": "h"
},
"square": {
"side": "3",
"alignmentType": "middleBottom",
"marker": "s"
}
},
"title": "Templates de Pré-visualização",
"position": 1
}

Esquema de resposta

Esquema: TemplatePreviewsEntity