Saltar al contenido principal

getAttributesByMarker

Obteniendo todos los atributos con datos del conjunto de atributos.

Descripción​

Este método devuelve todos los atributos con datos del conjunto de atributos. Devuelve una Promesa que se resuelve en un array de objetos IAttributesSetsEntity - las entidades de atributo en sí (marker, type, value, listTitles, validators, localizeInfos, additionalFields, …), no la entidad del conjunto de atributos.

AttributesSets.getAttributesByMarker(

marker*, langCode

);

Esquema de parámetros​

Esquema

marker(requerido): string
Marcador de atributo
ejemplo: "productAttributes"

langCode: string
Código de idioma. Predeterminado: "en_US"
ejemplo: "en_US"

Ejemplos​

Ejemplo mínimo​

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

Ejemplo con atributos​

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

Ejemplo de respuesta​

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

Esquema de respuesta​

Esquema: IAttributesSetsEntity[]

type: AttributeType
Tipo de atributo.
ejemplo: "string", "text", "integer", "etc"

value: unknown
Valor del atributo, normalizado de la misma manera que el valor de un atributo de entidad: number | null para tipos numéricos, el objeto de archivo en sí para un image/file de un solo archivo, null cuando el atributo no tiene valor.

initialValue: unknown
Valor inicial del atributo.

marker: string
Identificador textual del atributo (marcador).
ejemplo: "color", "size", "etc"

position: number
Número de posición para ordenar.
ejemplo: 1

listTitles: IListTitle[]
Array de valores (con datos extendidos) para atributos de lista y radioButton; array vacío para tipos no listados.
ejemplo:

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

listTitles.title: string
El título o nombre asociado con el elemento de la lista.
ejemplo: "Nombre del elemento"

listTitles.value: number | string
El valor del elemento de la lista, que puede ser un número o una cadena dependiendo del contexto.
ejemplo: 42

listTitles.position: string | number | null
La posición del elemento de la lista, que puede representarse como una cadena, número o null si no es aplicable.
ejemplo: 1

listTitles.extended: object
Un objeto que contiene propiedades adicionales o metadatos relacionados con el elemento de la lista. Esto podría incluir cualquier detalle extra que amplíe la información básica.

listTitles.extended.value: string | null
El valor extendido, que puede ser una cadena o null.
ejemplo: "extra_value"

listTitles.extended.type: string | null
El tipo del valor extendido, que puede ser una cadena o null.
ejemplo: "color"

validators: IAttributeValidators
Conjunto de validadores para la validación; objeto vacío cuando no se configuran validadores.
ejemplo:

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

validators.requiredValidator: object
Marca el campo como requerido. Forma: { strict: boolean }.
ejemplo:

{ strict: true }

validators.stringInspectionValidator: object
Restricciones de longitud para campos de cadena. Forma: { stringMin: number; stringMax: number; stringLength: number }.

validators.emailInspectionValidator: boolean
Alternar para la validación del formato de correo electrónico.

validators.defaultValueValidator: object
Configuración del valor predeterminado con texto de error personalizado opcional. Forma: { customErrorText?: string; fieldDefaultValue?: unknown; fieldDefaultValue2?: unknown }.

localizeInfos: IAttributeLocalizeInfo
El nombre de la plantilla, teniendo en cuenta la localización.
ejemplo:

{
  "title": "My attribute"
}

additionalFields: Record<string, IAttributesSetsEntity>
Atributos secundarios anidados indexados por marcador; objeto vacío cuando no hay ninguno.

Ejemplos de uso​

Guía paso a paso en la documentación:

Pruébalo en vivo​

Ejecuta este método de forma interactiva en el sandbox de JS SDK — conecta tu URL de Proyecto y Token de Aplicación en la primera visita, luego abre: