globalSearch

Recherche publique à travers les titres et les valeurs d'attribut des enregistrements visibles.

Description

Cette méthode recherche les noms et les valeurs d'attribut des enregistrements à travers les types d'entités. Elle renvoie une Promesse qui se résout en un objet IGlobalSearchResponse - la requête pour laquelle elle a été exécutée, plus les enregistrements trouvés regroupés par type d'entité, chaque élément portant le contexte de la manière dont il a été trouvé.

.globalSearch(

, , , ,

);

Schéma des paramètres

Schéma

query(obligatoire) : string
Requête de recherche
exemple : "hiver"

types : TGlobalSearchEntityType[]
Types d'entités à rechercher, envoyés séparés par des virgules. Recherche chaque type lorsqu'il est omis

visibility : 'all' | 'visible' | 'hidden'
Filtre de visibilité des enregistrements recherchés. Par défaut : "tous"
exemple : "tous"

offset : number
Décalage du mode drilldown. Ne le passez que avec un seul type accessible dans types

limit : number
Taille de page du mode drilldown. Ne le passez que avec un seul type accessible dans types, sinon l'API répond 400 "Le mode drilldown (limite/décalage) nécessite exactement un type accessible dans types". Sans cela, chaque groupe est retourné en entier

Exemples

Exemple minimal

const response = await Search.globalSearch('winter');

Exemple avec des attributs

// Drilldown: offset/limit are accepted only alongside exactly one type.
const response = await Search.globalSearch('winter', ['products'], 'visible', 0, 20);

Rendu des groupes

const { query, groups } = await Search.globalSearch('test');

groups.forEach((group) => {
  console.log(`${group.type} (${group.items.length}${group.hasMore ? '+' : ''})`);

  group.items.forEach((item) => {
    // fragment is plain text — safe to highlight yourself
    console.log(item.title ?? item.identifier, item.matchKind, item.fragment);
  });
});

Exemple de réponse

{
  "query": "test",
  "groups": [
    {
      "type": "pages",
      "items": [
        {
          "type": "pages",
          "id": 50,
          "title": "Test",
          "matchKind": "exact",
          "matchedField": "url",
          "subtitle": "test",
          "langCode": "en_US"
        }
      ],
      "hasMore": false
    },
    {
      "type": "blocks",
      "items": [
        {
          "type": "blocks",
          "id": 4,
          "title": "test",
          "identifier": "test",
          "matchKind": "exact",
          "matchedField": "identifier",
          "langCode": "en_US"
        }
      ],
      "hasMore": false
    },
    {
      "type": "discounts",
      "items": [
        {
          "type": "discounts",
          "id": 1,
          "title": "Example discount",
          "identifier": "example_discount",
          "matchKind": "attributeValue",
          "matchedField": "attributeValue",
          "matchedAttribute": {
            "identifier": "example_discount",
            "title": "example_discount"
          },
          "fragment": "test value",
          "langCode": "en_US"
        }
      ],
      "hasMore": false
    }
  ]
}

Schéma de réponse

Schéma : IGlobalSearchResponse

query : string
La requête pour laquelle les résultats ont été produits.
exemple : "hiver"

groups : IGlobalSearchGroup[]
Enregistrements trouvés regroupés par type d'entité.

groups.type : TGlobalSearchEntityType
Type d'entité du groupe.
exemple : "produits"

groups.items : IGlobalSearchItem[]
Enregistrements trouvés dans ce type d'entité.

groups.hasMore : boolean
Indique si d'autres enregistrements de ce type sont disponibles au-delà de la page demandée.
exemple : false

ℹ️ offset et limit nécessitent exactement un type accessible dans types ; toute autre combinaison répond 400. Omettez les deux pour obtenir chaque groupe en entier - voir Mode drilldown.

---