Aller au contenu principal

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

);

Parameters schema​

Schema

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"

Examples​

Minimal example​

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

Example with attributes​

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

Example response​

{
  "id": 3,
  "title": "Aperçu des Modèles",
  "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
}

Response schema​

Schema: ITemplatePreviewsEntity