getTemplatesPreviewByMarker

Obteniendo un objeto de plantilla por marcador.

Descripción

Este método recupera un único objeto de plantilla basado en su identificador textual (marcador) de la API. Devuelve una Promesa que se resuelve en un objeto de vista previa de plantilla ITemplatePreviewsEntity.

TemplatePreviews.getTemplatesPreviewByMarker(

marker*, langCode

);

Esquema de parámetros

Esquema

marker(required): string
El marcador único del producto utilizado para identificar la plantilla. Si no se proporciona, puede ocurrir un comportamiento predeterminado o un error
ejemplo: "template_12345"

langCode: string
Código de idioma. Predeterminado: "en_US"
ejemplo: "en_US"

Ejemplos

Ejemplo mínimo

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

Ejemplo con atributos

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

Ejemplo de respuesta

{
  "id": 3,
  "title": "Vista previa de plantillas",
  "proportions": {
    "default": {
      "horizontal": {
        "width": 234,
        "height": 324,
        "alignmentType": "middleBottom"
      },
      "vertical": {
        "width": 2,
        "height": 3,
        "alignmentType": "leftTop"
      },
      "square": {
        "side": 3,
        "alignmentType": "leftTop"
      }
    }
  },
  "identifier": "preview-templates",
  "version": 0,
  "attributeValues": {},
  "position": 1,
  "isUsed": false
}

Esquema de respuesta

Esquema: ITemplatePreviewsEntity

id: number
El identificador único de la posición.
ejemplo: 3

title: string
El nombre de la vista previa de la plantilla.
ejemplo: "Plantilla de producto"

proportions: object
El objeto contiene información sobre las proporciones de la vista previa de la plantilla.
ejemplo:

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

proportions.horizontal: IProportion | null
Proporción horizontal de la vista previa de la plantilla.
ejemplo:

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

proportions.horizontal.width: string | number | null
Ancho de la vista previa de la plantilla.
ejemplo: 100

proportions.horizontal.height: string | number | null
Altura de la vista previa de la plantilla.
ejemplo: 200

proportions.horizontal.alignmentType: string
Tipo de alineación de la vista previa de la plantilla.
ejemplo: "center"

proportions.vertical: IProportion | null
Proporción vertical de la vista previa de la plantilla.
ejemplo:

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

proportions.vertical.width: string | number | null
Ancho de la vista previa de la plantilla.
ejemplo: 100

proportions.vertical.height: string | number | null
Altura de la vista previa de la plantilla.
ejemplo: 200

proportions.vertical.alignmentType: string
Tipo de alineación de la vista previa de la plantilla.
ejemplo: "center"

proportions.square: ISquare
Proporción cuadrada de la vista previa de la plantilla.
ejemplo:

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

proportions.square.side: number | string
Longitud del lado de la vista previa de la plantilla cuadrada, puede ser un número o una cadena.
ejemplo: 100

proportions.square.alignmentType: string
Tipo de alineación de la vista previa de la plantilla cuadrada.
ejemplo: "center"

identifier: string
El identificador textual para el campo del registro.
ejemplo: "preview-templates"

version: number
El número de versión del objeto.
ejemplo: 1

attributeValues: AttributeType
Valores de atributos del índice.
ejemplo:

position: number
La posición del objeto.
ejemplo: 1

isUsed: boolean
Indica si la vista previa de la plantilla está en uso.
ejemplo: true

attributeSetIdentifier: string | null
Identificador textual utilizado para un conjunto de atributos.
ejemplo: "attribute_set_1"

---