getBlockByMarker

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

Blocks.getBlockByMarker(marker, langCode, offset, limit)

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

Схема

marker:* строка
Маркер блока
пример: my-marker

langCode: строка
Код языка
пример: en_US

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

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

Этот метод возвращает один объект блока по маркеру.

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

{
  "id": 1764,
  "localizeInfos": {
    "en_US": {
      "title": "My block"
    }
  },
  "customSettings": {
    "sliderDelay": 0,
    "sliderDelayType": "",
    "productConfig": {
      "quantity": 2,
      "sortType": "By_ID",
      "sortOrder": "DESC",
      "countElementsPerRow": 10
    },
    "similarProductRules": [
      {
        "property": "Descending",
        "includes": "",
        "keywords": "",
        "strict": ""
      }
    ],
    "condition": {
      "name": "title"
    }
  },
  "version": 10,
  "identifier": "catalog",
  "position": 192,
  "productPageUrls": [
    "23-laminat-floorwood-maxima"
  ],
  "isVisible": true,
  "attributeValues": {
    "en_US": {
      "marker": {
        "value": "",
        "type": "string",
        "position": 1,
        "isProductPreview": false,
        "isIcon": false,
        "attributeFields": {
          "marker": {
            "type": "string",
            "value": "test"
          }
        }
      }
    }
  },
  "type": "forNewsPage",
  "templateIdentifier": null,
  "attributeSetIdentifier": "my-attributes-sets"
}

Схема

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

localizeInfos: CommonLocalizeInfos
название блока с учетом локализации
пример:

{
  "en_US": {
    "title": "My block"
  }
}

customSettings: BlockCustomSettings
индивидуальные настройки для различных типов блоков
BlockCustomSettings пример:

{
  "sliderDelay": 0,
  "sliderDelayType": "",
  "productConfig": {
    "quantity": 2,
    "sortType": "By_ID",
    "sortOrder": "DESC",
    "countElementsPerRow": 10
  },
  "similarProductRules": [
    {
      "property": "Descending",
      "includes": "",
      "keywords": "",
      "strict": ""
    }
  ],
  "condition": {
    "name": "title"
  }
}

version: число
номер версии изменения объекта
пример: 10

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

position: число
номер позиции (для сортировки)
пример: 192

productPageUrls: любой
массив уникальных частей URL страницы (после последнего "/") - категории, откуда могут быть взяты продукты (необязательно)
пример:

[ "23-laminat-floorwood-maxima" ]

isVisible: логическое
индикатор видимости (доступности) блока
пример: true

attributeValues: Record<string, string>
Массив значений атрибутов из индекса (тип, значение, массив дополнительных полей для атрибута)
пример:

{
  "en_US": {
    "marker": {
      "value": "",
      "type": "string",
      "position": 1,
      "isProductPreview": false,
      "isIcon": false,
      "attributeFields": {
        "marker": {
          "type": "string",
          "value": "test"
        }
      }
    }
  }
}

type: строка
тип блока
пример: forNewsPage
Перечисление: [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, forOrder, service ]

attributeSetId: число
идентификатор используемого набора атрибутов
пример: 7

position: число
номер позиции (для сортировки)
пример: 192

templateIdentifier: строка
Идентификатор шаблона, используемого блоком (может быть null)
пример: null