getBlockByMarker

Obtenir un objet bloc unique par marqueur.

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

Exemple minimal

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

Schéma

marker(required): string
Marqueur du Bloc
exemple : "product_block"

langCode: string
Code de langue. Par défaut : "en_US"
exemple : "en_US"

offset: number
Paramètre pour la pagination. Par défaut : 0
exemple : 0

limit: number
Paramètre pour la pagination. Par défaut : 30
exemple : 30

Cette méthode retourne un objet bloc par marqueur.

Exemple de réponse

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

Schéma

attributeValues: AttributeType
Type d'attributs utilisés dans le bloc.
exemple :

{
  "block-text": {
    "type": "string",
    "value": "some text",
    "isIcon": false,
    "position": 0,
    "additionalFields": [],
    "isProductPreview": false
  }
}

id: number
Identifiant unique du bloc.
exemple : 1234

localizeInfos: ILocalizeInfo
Informations de localisation pour le bloc.
exemple :

{
  "key": "value"
}

version: number
Version de l'entité bloc.
exemple : 1

identifier: string
Identifiant unique sous forme de chaîne pour le bloc.
exemple : "block1"

type: string
Type du bloc, tel que 'produit', 'page_d'erreur', etc.
exemple : "produit"

templateIdentifier: string | null
Identifiant pour le modèle utilisé par le bloc, ou null si non applicable.
exemple : "template1"

isVisible: boolean
Indique si le bloc est visible.
exemple : true

countElementsPerRow: number
Nombre d'éléments affichés par ligne dans le bloc, si applicable.
exemple : 3

quantity: number
Quantité d'articles dans le bloc, si applicable.
exemple : 5

similarProducts: IProductsResponse
Réponse contenant des produits similaires associés au bloc.
exemple :

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

products: IProductsEntity[]
Tableau d'entités de produits associés au bloc.
exemple :

[
  {
    "id": 1,
    "name": "Produit 1"
  },
  {
    "id": 2,
    "name": "Produit 2"
  }
]

---