getTemplatesPreviewByMarker

Obtenir un objet de modèle par marqueur.

Description

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 d'aperçu de modèle ITemplatePreviewsEntity.

TemplatePreviews.getTemplatesPreviewByMarker(

marker*, langCode

);

Schéma des paramètres

Schéma

marker(required): string
Le marqueur de produit unique utilisé pour identifier le modèle. Si non fourni, un comportement par défaut ou une erreur peut se produire
exemple : "template_12345"

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

Exemples

Exemple minimal

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

Exemple avec des attributs

const response = await TemplatePreviews.getTemplatePreviewByMarker('my-marker', 'en_US');

Exemple de réponse

{
  "id": 3,
  "title": "Preview Templates",
  "proportions": {
    "default": {
      "horizontal": {
        "width": 234,
        "height": 324,
        "alignmentType": "middleBottom"
      },
      "vertical": {
        "width": 2,
        "height": 3,
        "alignmentType": "leftTop"
      },
      "square": {
        "side": 3,
        "alignmentType": "leftTop"
      }
    }
  },
  "identifier": "preview-templates",
  "version": 0,
  "attributeValues": {},
  "position": 1,
  "isUsed": false
}

Schéma de réponse

Schéma : ITemplatePreviewsEntity

id: number
L'identifiant unique de la position.
exemple : 3

title: string
Le nom de l'aperçu du modèle.
exemple : "Modèle de produit"

proportions: object
L'objet contient des informations sur les proportions de l'aperçu du modèle.
exemple :

{
  "default": {
    "horizontal": {
      "width": 234,
      "height": 324,
      "alignmentType": "middleBottom"
    },
    "vertical": {
      "width": 2,
      "height": 3,
      "alignmentType": "leftTop"
    },
    "square": {
      "side": 3,
      "alignmentType": "leftTop"
    }
  }
}

proportions.horizontal: IProportion | null
Proportion horizontale de l'aperçu du modèle.
exemple :

{
  "width": 234,
  "height": 324,
  "alignmentType": "middleBottom"
}

proportions.horizontal.width: string | number | null
largeur de l'aperçu du modèle.
exemple : 100

proportions.horizontal.height: string | number | null
hauteur de l'aperçu du modèle.
exemple : 200

proportions.horizontal.alignmentType: string
type d'alignement de l'aperçu du modèle.
exemple : "center"

proportions.vertical: IProportion | null
Proportion verticale de l'aperçu du modèle.
exemple :

{
  "width": 2,
  "height": 3,
  "alignmentType": "leftTop"
}

proportions.square: ISquare
Proportion carrée de l'aperçu du modèle.
exemple :

{
  "side": 3,
  "alignmentType": "leftTop"
}

proportions.square.side: number | string
Longueur du côté de l'aperçu du modèle carré, peut être un nombre ou une chaîne.
exemple : 100

proportions.square.alignmentType: string
Type d'alignement de l'aperçu du modèle carré.
exemple : "center"

identifier: string
L'identifiant textuel pour le champ d'enregistrement.
exemple : "preview-templates"

version: number
Le numéro de version de l'objet.
exemple : 1

attributeValues: AttributeType
Valeurs des attributs de l'index.
exemple :

position: number
La position de l'objet.
exemple : 1

isUsed: boolean
Indique si l'aperçu du modèle est utilisé.
exemple : true

attributeSetIdentifier: string | null
Identifiant textuel utilisé pour un ensemble d'attributs.
exemple : "attribute_set_1"

---