getBlocksByPageUrl

Получение объектов для связанного блока по URL

Pages.getBlocksByPageUrl(url, langCode)

const value = await Pages.getFormsByPageUrl('shop');

Схема

url:* строка
URL страницы
пример: shop

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

Получите объекты PositionBlock для связанной формы по URL. Возвращает массив объектов PositionBlock.

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

[
  {
    "id": 2,
    "localizeInfos": {
      "title": "test"
    },
    "attributeSetIdentifier": "block",
    "version": 0,
    "position": 2,
    "identifier": "test_identifier",
    "type": "forTextBlock",
    "templateIdentifier": null,
    "isVisible": true,
    "isSync": false,
    "attributeValues": {},
    "countElementsPerRow": 0
  }
]

Схема

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

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

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

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

localizeInfos: Record<string, any>
json-описание основного объекта данных страницы с учетом языка "en_US" (например)
пример:

{
  "en_US": {
    "title": "Catalog",
    "plainContent": "Содержимое для каталога",
    "htmlContent": "<b>Содержимое для каталога</b>",
    "menuTitle": "Каталог"
  }
}

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

{
  "sliderDelay": 0,
  "sliderDelayType": "",
  "productQuantity": 4,
  "productSortType": "By_ID",
  "productSortOrder": "Descending",
  "productCountElementsPerRow": 10,
  "similarProductRules": [
    {
      "property": "Descending",
      "includes": "",
      "keywords": "",
      "strict": ""
    }
  ]
}

isSync: булево
индикатор индексации страницы (true или false)
пример: false

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

{
  "en_US": {
    "marker": {
      "value": "",
      "type": "string"
    }
  }
}

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

type: строка
Тип страницы
пример: forNewsPage
Enum: [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]

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