getBlockByMarker
Recuperando un único objeto de bloque por su marcador
Blocks.getBlockByMarker(marker, langCode, offset, limit)
const value = await Blocks.getBlockByMarker('my-marker')
Esquema
marker:* string
El marcador del bloque
ejemplo: my-marker
langCode: string
Código de idioma
ejemplo: en_US
offset: number
Parámetro para la paginación. El valor predeterminado es 0
ejemplo: 0
limit: number
Parámetro para la paginación. El valor predeterminado es 30
ejemplo: 30
Este método devuelve un único objeto de bloque basado en el marcador.
Ejemplo de retorno:
{
"id": 3,
"localizeInfos": {
"title": "Bloque"
},
"version": 0,
"position": 1,
"identifier": "block",
"type": "common_block",
"templateIdentifier": null,
"isVisible": true,
"attributeValues": {}
}
Esquema
id: number
Identificador del objeto
ejemplo: 1764
localizeInfos: CommonLocalizeInfos
Nombre del bloque considerando la localización
ejemplo:
{
"en_US": {
"title": "Mi bloque"
}
}
customSettings: BlockCustomSettings
Configuraciones individuales para diferentes tipos de bloques
BlockCustomSettings
ejemplo:
{
"sliderDelay": 0,
"sliderDelayType": "",
"productConfig": {
"quantity": 2,
"sortType": "By_ID",
"sortOrder": "DESC",
"countElementsPerRow": 10
},
"similarProductRules": [
{
"property": "Descending",
"includes": "",
"keywords": "",
"strict": ""
}
],
"condition": {
"name": "title"
}
}
version: number
Número de versión del cambio del objeto
ejemplo: 10
identifier: string
Identificador textual para el campo de grabación
ejemplo: catalog
predeterminado: marker
position: number
Número de posición (para ordenar)
ejemplo: 192
productPageUrls: any
Array de partes únicas de la URL de la página (después del último "/") - categorías de las cuales se pueden obtener productos (opcional)
ejemplo:
[ "23-laminat-floorwood-maxima" ]
isVisible: boolean
Indicador de visibilidad (disponibilidad) del bloque
ejemplo: true
attributeValues: Record<string, string>
Array de valores de atributos del índice (tipo, valor, array de campos adicionales para el atributo)
ejemplo:
{
"en_US": {
"marker": {
"value": "",
"type": "string",
"position": 1,
"isProductPreview": false,
"isIcon": false,
"attributeFields": {
"marker": {
"type": "string",
"value": "test"
}
}
}
}
}
type: string
Tipo del bloque
ejemplo: forNewsPage
Enum: [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, forOrder, service ]
attributeSetId: number
Identificador del conjunto de atributos utilizado
ejemplo: 7
position: number
Número de posición (para ordenar)
ejemplo: 192
templateIdentifier: string
Marcador de plantilla utilizado por el bloque (puede ser nulo)
ejemplo: null