getTemplatePreviews

Получение всех объектов шаблонов.

Описание

Этот метод извлекает все объекты шаблонов из API. Он возвращает Promise, который разрешается в массив объектов шаблонов ITemplatesPreviewEntity.

TemplatePreviews.getTemplatePreviews(

langCode

);

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

Схема

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

Примеры

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

const response = await TemplatePreviews.getTemplatePreviews();

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

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

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

[
  {
    "id": 3,
    "title": "Предварительный просмотр шаблонов",
    "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
  }
]

Схема ответа

Схема: ITemplatesPreviewEntity[]

id: number
Уникальный идентификатор позиции.
пример: 3

title: string
Название предварительного просмотра шаблона.
пример: "Шаблон продукта".

proportions: object
Объект содержит информацию о пропорциях предварительного просмотра шаблона.
пример:

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

identifier: string
Текстовый идентификатор для поля записи.
пример: "preview-templates"

version: number
Номер версии объекта.
пример: 1

attributeValues: AttributeType
Значения атрибутов из индекса.
пример:

{}

position: number
Позиция объекта.
пример: 1

attributeSetIdentifier: string | null
Текстовый идентификатор, используемый для набора атрибутов.
пример: "attribute_set_1"

---