Saltar al contenido principal

getTemplatePreviews

Obtener todas las plantillas de vista previa.

Descripción​

Obtiene todas las plantillas de vista previa y se resuelve en un array de objetos ITemplatesPreviewEntity.

Las variantes están un nivel más abajo, en proportions.default: proportions.default.horizontal, proportions.default.vertical y proportions.default.square. El esquema de respuesta de abajo las muestra como proportions.horizontal, etc., siguiendo los tipos del SDK. La respuesta real también incluye weight en las variantes horizontal y vertical y un indicador default: true junto a ellas; los tipos del SDK no describen ninguno de los dos.

.getTemplatePreviews(

);

Esquema de parámetros​

Esquema

langCode: cadena
Código de idioma. Predeterminado: el langCode pasado a defineOneEntry ("en_US" si no se pasó ninguno).
ejemplo: "en_US"

Ejemplos​

Ejemplo mínimo​

const response = await TemplatePreviews.getTemplatePreviews();

Ejemplo con langCode​

const response = await TemplatePreviews.getTemplatePreviews('en_US');

Ejemplo de respuesta​

[
  {
    "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 respuesta​

Esquema: ITemplatesPreviewEntity[]

id: número
ID del objeto.
ejemplo: 3

title: string
Nombre de la plantilla de vista previa.
ejemplo: "Plantilla de Producto"

proportions: object
Proporciones de la vista previa: las variantes horizontal, vertical y cuadrada.
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.
ejemplo:

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

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

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

proportions.horizontal.alignmentType: string
Alineación de la imagen dentro de la vista previa, como middleMiddle o leftTop.
ejemplo: "center"

proportions.vertical: IProportion | null
Variante vertical de la vista previa, o null.
ejemplo:

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

proportions.square: ISquare
Variante cuadrada de la vista previa.
ejemplo:

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

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

proportions.square.alignmentType: string
Alineación de la imagen dentro de la vista previa cuadrada, como middleMiddle.
ejemplo: "center"

identifier: cadena
Identificador de texto (marcador) del objeto.
ejemplo: "preview-templates"

version: número
Número de versión del objeto; cambia con cada actualización.
ejemplo: 1

position: número
Posición del objeto, usada para ordenar.
ejemplo: 1

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