Aller au contenu principal

getAttributesByMarker

Récupération de tous les attributs avec des données de l'ensemble d'attributs.

Description​

Cette méthode retourne tous les attributs avec des données de l'ensemble d'attributs. Elle renvoie une promesse qui se résout en un tableau d'objets IAttributesSetsEntity - les entités d'attribut elles-mêmes (marker, type, value, listTitles, validators, localizeInfos, additionalFields, …), et non l'entité d'ensemble d'attributs.

AttributesSets.getAttributesByMarker(

marker*, langCode

);

Schéma des paramètres​

Schéma

marker(obligatoire): string
Marqueur d'attribut
exemple : "productAttributes"

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

Exemples​

Exemple minimal​

const response = await AttributesSets.getAttributesByMarker('my-marker');

Exemple avec attributs​

const response = await AttributesSets.getAttributesByMarker('my-marker', 'en_US');

Exemple de réponse​

[
  {
    "type": "string",
    "value": null,
    "marker": "admin-text",
    "position": 1,
    "listTitles": [],
    "validators": {},
    "multiselect": false,
    "initialValue": null,
    "localizeInfos": {
      "title": "Admins text"
    },
    "additionalFields": {}
  }
]

Schéma de réponse​

Schéma : IAttributesSetsEntity[]

type: AttributeType
Type d'attribut.
exemple : "string", "text", "integer", "etc"

value: unknown
Valeur de l'attribut, normalisée de la même manière qu'une valeur d'attribut d'entité : number | null pour les types numériques, l'objet de fichier lui-même pour un image/file à fichier unique, null lorsque l'attribut ne porte aucune valeur.

initialValue: unknown
Valeur initiale de l'attribut.

marker: string
Identifiant textuel de l'attribut (marqueur).
exemple : "color", "size", "etc"

position: number
Numéro de position pour le tri.
exemple : 1

listTitles: IListTitle[]
Tableau de valeurs (avec données étendues) pour les attributs de liste et de bouton radio ; tableau vide pour les types non-liste.
exemple :

[
  {
    "title": "red",
    "value": 1,
    "position": 1,
    "extendedValue": null,
    "extendedValueType": null
  },
  {
    "title": "yellow",
    "value": 2,
    "position": 2,
    "extendedValue": null,
    "extendedValueType": null
  }
]

listTitles.title: string
Le titre ou le nom associé à l'élément de la liste.
exemple : "Nom de l'élément"

listTitles.value: number | string
La valeur de l'élément de la liste, qui peut être soit un nombre soit une chaîne selon le contexte.
exemple : 42

listTitles.position: string | number | null
La position de l'élément de la liste, qui peut être représentée comme une chaîne, un nombre ou null si non applicable.
exemple : 1

listTitles.extended: object
Un objet contenant des propriétés ou des métadonnées supplémentaires liées à l'élément de la liste. Cela pourrait inclure des détails supplémentaires qui étendent les informations de base.

listTitles.extended.value: string | null
La valeur étendue, qui peut être une chaîne ou null.
exemple : "extra_value"

listTitles.extended.type: string | null
Le type de la valeur étendue, qui peut être une chaîne ou null.
exemple : "color"

validators: IAttributeValidators
Ensemble de validateurs pour la validation ; objet vide lorsque aucun validateur n'est configuré.
exemple :

{
  "requiredValidator": {
    "strict": true
  },
  "defaultValueValidator": {
    "fieldDefaultValue": 11
  }
}

validators.requiredValidator: object
Marque le champ comme obligatoire. Forme : { strict: boolean }.
exemple :

{ strict: true }

validators.stringInspectionValidator: object
Contraintes de longueur pour les champs de chaîne. Forme : { stringMin: number; stringMax: number; stringLength: number }.

validators.emailInspectionValidator: boolean
Basculer pour la validation du format d'email.

validators.defaultValueValidator: object
Configuration de la valeur par défaut avec un texte d'erreur personnalisé optionnel. Forme : { customErrorText?: string; fieldDefaultValue?: unknown; fieldDefaultValue2?: unknown }.

localizeInfos: IAttributeLocalizeInfo
Le nom du modèle, en tenant compte de la localisation.
exemple :

{
  "title": "My attribute"
}

additionalFields: Record<string, IAttributesSetsEntity>
Sous-attributs imbriqués indexés par marqueur ; objet vide lorsqu'il n'y en a pas.

Exemples d'utilisation​

Guide étape par étape dans la documentation :

Essayez-le en direct​

Exécutez cette méthode de manière interactive dans le bac à sable JS SDK — connectez votre URL de projet et votre jeton d'application lors de votre première visite, puis ouvrez :