getBlockByMarker

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

Описание

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

Blocks.getBlockByMarker(

marker, langCode, offset, limit

);

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

Схема

marker(обязательный): string
Маркер блока
пример: "product_block"

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

offset: number
Параметр для пагинации. По умолчанию: 0
пример: 0

limit: number
Параметр для пагинации. По умолчанию: 30
пример: 30

Примеры

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

const response = await Blocks.getBlockByMarker('my-marker');

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

const response = await Blocks.getBlockByMarker('my-marker', 'en_US', 0, 30);

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

{
  "id": 3,
  "localizeInfos": {
    "title": "Блок"
  },
  "version": 0,
  "position": 1,
  "identifier": "block",
  "type": "common_block",
  "templateIdentifier": null,
  "isVisible": true,
  "attributeValues": {}
}

Схема ответа

Схема: IBlockEntity

attributeValues: AttributeType
Тип атрибутов, используемых в блоке.
пример:

{
  "block-text": {
    "type": "string",
    "value": "некоторый текст",
    "isIcon": false,
    "position": 0,
    "additionalFields": [],
    "isProductPreview": false
  }
}

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

localizeInfos: ILocalizeInfo
Информация о локализации для блока.
пример:

{
  "key": "value"
}

version: number
Версия сущности блока.
пример: 1

identifier: string
Уникальный строковый идентификатор для блока.
пример: "block1"

type: string
Тип блока, такой как 'product', 'error_page' и т.д.
пример: "product"

templateIdentifier: string | null
Идентификатор шаблона, используемого блоком, или null, если не применимо.
пример: "template1"

isVisible: boolean
Указывает, виден ли блок.
пример: true

countElementsPerRow: number
Количество элементов, отображаемых в строке в блоке, если применимо.
пример: 3

quantity: number
Количество элементов в блоке, если применимо.
пример: 5

similarProducts: IProductsResponse
Ответ, содержащий похожие продукты, связанные с блоком.
пример:

{
  "total": 10,
  "items": []
}

products: IProductsEntity[]
Массив сущностей продуктов, связанных с блоком.
пример:

[
  {
    "id": 1,
    "name": "Продукт 1"
  },
  {
    "id": 2,
    "name": "Продукт 2"
  }
]

---