getTemplatePreviewByMarker

Obtendo um objeto de template por marcador.

Descrição

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 de pré-visualização de template ITemplatePreviewsEntity.

.getTemplatePreviewByMarker(

,

);

Esquema de parâmetros

Esquema

marker(obrigatório): 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"

Exemplos

Exemplo mínimo

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

Exemplo com atributos

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

Exemplo de resposta

{
  "id": 3,
  "title": "Preview Templates",
  "proportions": {
    "default": {
      "horizontal": {
        "width": 234,
        "height": 324,
        "alignmentType": "middleBottom",
        "weight": 234
      },
      "vertical": {
        "width": 2,
        "height": 3,
        "alignmentType": "leftTop",
        "weight": 2
      },
      "square": {
        "side": 360,
        "alignmentType": "middleMiddle"
      },
      "default": true
    }
  },
  "identifier": "preview-templates",
  "version": 1,
  "position": 1,
  "isUsed": true
}

Esquema de resposta

Esquema: ITemplatePreviewsEntity

id: number
O identificador único da posição.
exemplo: 3

title: string
O nome da pré-visualização do template.
exemplo: "Template de Produto"

proportions: object
O objeto contém informações sobre as proporções da pré-visualização do template.
exemplo:

{
  "default": {
    "horizontal": {
      "width": 234,
      "height": 324,
      "alignmentType": "middleBottom"
    },
    "vertical": {
      "width": 2,
      "height": 3,
      "alignmentType": "leftTop"
    },
    "square": {
      "side": 3,
      "alignmentType": "leftTop"
    }
  }
}

proportions.horizontal: IProportion | null
Proporção horizontal da pré-visualização do template.
exemplo:

{
  "width": 234,
  "height": 324,
  "alignmentType": "middleBottom"
}

proportions.horizontal.width: string | number | null
largura da pré-visualização do template.
exemplo: 100

proportions.horizontal.height: string | number | null
altura da pré-visualização do template.
exemplo: 200

proportions.horizontal.alignmentType: string
tipo de alinhamento da pré-visualização do template.
exemplo: "center"

proportions.vertical: IProportion | null
Proporção vertical da pré-visualização do template.
exemplo:

{
  "width": 2,
  "height": 3,
  "alignmentType": "leftTop"
}

proportions.square: ISquare
Proporção quadrada da pré-visualização do template.
exemplo:

{
  "side": 3,
  "alignmentType": "leftTop"
}

proportions.square.side: number | string
Comprimento do lado da pré-visualização do template quadrado, pode ser um número ou string.
exemplo: 100

proportions.square.alignmentType: string
Tipo de alinhamento da pré-visualização do template quadrado.
exemplo: "center"

identifier: string
O identificador textual para o campo do registro.
exemplo: "preview-templates"

version: number
O número da versão do objeto.
exemplo: 1

position: number
A posição do objeto.
exemplo: 1

isUsed: boolean
Indica se a pré-visualização do template está em uso.
exemplo: true

---