getTemplatesPreviewById

Получение одного объекта шаблона по id

TemplatePreviews.getTemplatesPreviewById(id, langCode)

const value = await TemplatePreviews.getTemplatePreviewById(1764)

Схема

id:* число
Маркер продукта
пример: 1764

langCode: строка
Необязательный параметр кода языка
пример: en_US

Этот метод извлекает один объект шаблона на основе его идентификатора (id) из API. Он возвращает Promise, который разрешается в объект TemplatePreviewsEntity.

Пример возвращаемого значения:

  {
  "id": 1,
  "version": 0,
  "identifier": "preview-templates",
  "attributeValues": {
    "en_US": {
      "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": "Шаблоны предварительного просмотра",
  "position": 1
}

Схема

id: число
идентификатор объекта
пример: 1764

version число
номер версии объекта модификации
пример: 10

identifier: строка
текстовый идентификатор для поля в записи
пример: catalog

proportion ITemplateProportionType
параметры пропорции шаблона
пример:

{
  "horizontal": {
    "height": 200,
    "weight": 10,
    "marker": "horizontal",
    "title": "Горизонтальный",
    "alignmentType": "left"
  },
  "vertical": {
    "height": 10,
    "weight": 200,
    "marker": "vertical",
    "title": "Вертикальный",
    "alignmentType": "left"
  },
  "square": {
    "marker": "square",
    "title": "Квадрат",
    "slide": 3,
    "alignmentType": "center"
  }
}

title: строка
название шаблона
пример: шаблон страницы

position объект
номер позиции
пример: 0

positionId: число
идентификатор объекта позиции
пример: 12