getTemplatesPreviewByMarker

Obtenir un objet de modèle par marqueur

TemplatePreviews.getTemplatesPreviewByMarker(marker, langCode)

const value = await TemplatePreviews.getTemplatePreviewByMarker('my-marker')

Schéma

marker:* chaîne
Marqueur de produit
exemple : my-marker

langCode: chaîne
Paramètre optionnel du code de langue
exemple : en_US

Cette méthode récupère un seul objet de modèle basé sur son identifiant textuel (marqueur) depuis l'API. Elle renvoie une promesse qui se résout en un objet TemplatePreviewsEntity.

Exemple de retour :

{
  "id": 1,
  "version": 0,
  "identifier": "preview-templates",
  "attributeValues": {
    "marker": {
      "value": "",
      "type": "string",
      "position": 1,
      "isProductPreview": false,
      "isIcon": false,
      "attributeFields": {
        "marker": {
          "type": "string",
          "value": "test"
        }
      }
    }
  },
  "attributeSetIdentifier": "my-set",
  "proportion": {
    "vertical": {
      "width": "2",
      "height": "3",
      "alignmentType": "leftTop",
      "marker": "v"
    },
    "horizontal": {
      "width": "234",
      "height": "324",
      "alignmentType": "middleBottom",
      "marker": "h"
    },
    "square": {
      "side": "3",
      "alignmentType": "middleBottom",
      "marker": "s"
    }
  },
  "title": "Aperçu des modèles",
  "position": 1
}

Schéma

id: nombre
identifiant de l'objet
exemple : 1764

version nombre
numéro de version de modification de l'objet
exemple : 10

identifier: chaîne
identifiant textuel pour un champ dans l'enregistrement
exemple : catalog

proportion ITemplateProportionType
paramètres de proportion du modèle
exemple :

{
  "horizontal": {
    "height": 200,
    "weight": 10,
    "marker": "horizontal",
    "title": "Horizontal",
    "alignmentType": "left"
  },
  "vertical": {
    "height": 10,
    "weight": 200,
    "marker": "vertical",
    "title": "Vertical",
    "alignmentType": "left"
  },
  "square": {
    "marker": "square",
    "title": "Carré",
    "slide": 3,
    "alignmentType": "center"
  }
}

title: chaîne
nom du modèle
exemple : modèle de page

positionId objet
numéro de position
exemple : 0

positionId: nombre
identifiant de l'objet de position
exemple : 12