Aller au contenu principal

getTemplatesPreviewByMarker

Obtenir un objet de modèle par marqueur.

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.

TemplatePreviews.getTemplatesPreviewByMarker( marker, langCode );

Exemple minimal

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

Exemple avec des attributs

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

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"

Exemple de réponse

{
"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 de réponse

Schéma : TemplatePreviewsEntity