getBlockByMarker

Récupération d'un objet bloc unique par son marqueur

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

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

Schéma

marker:* chaîne
Le marqueur du bloc
exemple : my-marker

langCode: chaîne
Code de langue
exemple : en_US

offset: nombre
Paramètre pour la pagination. Par défaut, c'est 0
exemple : 0

limit: nombre
Paramètre pour la pagination. Par défaut, c'est 30
exemple : 30

Cette méthode renvoie un objet bloc unique basé sur le marqueur.

Exemple de retour :

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

Schéma

id: nombre
Identifiant de l'objet
exemple : 1764

localizeInfos: CommonLocalizeInfos
Nom du bloc en tenant compte de la localisation
exemple :

{
  "en_US": {
    "title": "Mon bloc"
  }
}

customSettings: BlockCustomSettings
Paramètres individuels pour différents types de blocs
BlockCustomSettings exemple :

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

version: nombre
Numéro de version du changement d'objet
exemple : 10

identifier: chaîne
Identifiant textuel pour le champ d'enregistrement
exemple : catalog
par défaut : marker

position: nombre
Numéro de position (pour le tri)
exemple : 192

productPageUrls: any
Tableau de parties uniques de l'URL de la page (après le dernier "/") - catégories à partir desquelles des produits peuvent être sourcés (optionnel)
exemple :

[ "23-laminat-floorwood-maxima" ]

isVisible: booléen
Indicateur de visibilité (disponibilité) du bloc
exemple : true

attributeValues: Record<string, string>
Tableau des valeurs d'attribut de l'index (type, valeur, tableau de champs supplémentaires pour l'attribut)
exemple :

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

type: chaîne
Type du bloc
exemple : forNewsPage
Enum : [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, forOrder, service ]

attributeSetId: nombre
Identifiant pour l'ensemble d'attributs utilisé
exemple : 7

position: nombre
Numéro de position (pour le tri)
exemple : 192

templateIdentifier: chaîne
Marqueur de modèle utilisé par le bloc (peut être nul)
exemple : null

---