getTemplatesPreviewByMarker

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

Описание

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

TemplatePreviews.getTemplatesPreviewByMarker(

marker*, langCode

);

Схема параметров

Схема

marker(обязательный): строка
Уникальный продуктовый маркер, используемый для идентификации шаблона. Если не предоставлен, может произойти поведение по умолчанию или ошибка
пример: "template_12345"

langCode: строка
Код языка. По умолчанию: "en_US"
пример: "en_US"

Примеры

Минимальный пример

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

Пример с атрибутами

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

Пример ответа

{
  "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": "Предварительные шаблоны",
  "position": 1
}

Схема ответа

Схема: ITemplatePreviewsEntity

---