Skip to main content

Documentation Index

Fetch the complete documentation index at: https://dokumentation.websale.de/llms.txt

Use this file to discover all available pages before exploring further.

Der knoten seoMetaData steuert, wie Meta-Title und Meta-Description im Shop gebaut werden - für Kategorien, Produkte, die Startseite und frei definierte Templates. Statt jeden Text manuell zu pflegen, lassen sich Bausteine Kombinieren, inklusive Trennzeichen und Reihenfolge.

seoMetaData* - Grundstruktur

Nachfolgend der Grundaufbau des Knotens seoMetaData:
{
    "seoMetaData": {
      "categorySchemes": {...},
      "generalSchemes": {...},
      "productSchemes": {...},
      "startPage": {...},
      "viewSchemes": {...}
    }
}
Parameterbeschreibung
ParameterBeschreibung
categorySchemesBausteine für Meta-Title und Description von Kategorien.
generalSchemesDefiniert das globale SEO-Schema.
productSchemesBausteine für Meta-Title und Description von Produkten.
startPageBausteine für Meta-Title und Description für die Startseite.
viewSchemesBausteine für Meta-Title und Description für Templates.

seoMetaData.categorySchemes - Kategorie-Meta-Daten

Der Knoten seoMetaData.categorySchemes liefert Bausteine für Meta-Title und Meta-Description von Kategorien. Beispielkonfiguration
{
  "generalMetaDescription": false,
  "generalMetaTitle": false,
  "metaTitleForms": [
    {
      "separator": "",
      "termType": "categoryField",
      "termData": { "categoryField": "content.categoryField:name" }
    },
    {
      "separator": " | ",
      "termType": "customCategoryField",
      "termData": { "customCategoryField": "content.customCategoryField:brandTagline" }
    },
    {
      "separator": " – ",
      "termType": "freeText",
      "termData": { "freeText": "Jetzt online kaufen" }
    }
  ],
  "metaDescriptionForms": [
    {
      "separator": "",
      "termType": "customCategoryField",
      "termData": { "customCategoryField": "content.customCategoryField:metaIntro" }
    },
    {
      "separator": " ",
      "termType": "categoryField",
      "termData": { "categoryField": "content.categoryField:descr" }
    },
    {
      "separator": " ",
      "termType": "freeText",
      "termData": { "freeText": "Top Auswahl • Schneller Versand" }
    }
  ]
}
Parameterübersicht
ParameterTypBeschreibung
metaTitleFormslist (object)Liste der “Bausteine” für den Meta-Titel einer Kategorie.
Die Einträge werden der Reihe nach mit seperator aneinandergefügt.
seperatorstringTrennzeichen, das vor diesem Term eingefügt wird. (z.B. “`
termTypeenumArt des Terms.
Folgende Werte sind möglich:
- categoryField - verweist auf Standard-Kategoriefelder (z.B. name, descr)
- customCategoryField - verweist auf selbst angelegte Kategoriefelder
- freeText - ein fester Text, der in termDatadefiniert werden kann.
termDataoneOfDaten des Terms - je nach gewähltem termType.
freeTextstringSelbst definierter, fester Text für freeText.
categoryFieldsingleAssocAngabe eines Standard-Kategoriefelds aus content.CategoryFields.
customCategoryFieldsingleAssocAngabe eines benutzerdefinierten Kategoriefelds aus content.customCategoryField.
generalMetaTitleboolNutzt den Standard-Meta-Title statt den obigen Bausteinen.
metaDescriptionFormslist (object)Bausteinliste für die Meta-Description - analog zu metaTitleForms.
seperatorstringTrennzeichen, das vor diesem Term eingefügt wird. (z.B. “`
termTypeenumArt des Terms.
Folgende Werte sind möglich:
- categoryField - verweist auf Standard-Kategoriefelder (z.B. name, descr)
- customCategoryField - verweist auf selbst angelegte Kategoriefelder
- freeText - ein fester Text, der in termDatadefiniert werden kann.
termDataoneOfDaten des Terms - je nach gewähltem termType.
freeTextstringSelbst definierter, fester Text für freeText.
categoryFieldsingleAssocAngabe eines Standard-Kategoriefelds aus content.CategoryFields.
customCategoryFieldsingleAssocAngabe eines benutzerdefinierten Kategoriefelds aus content.customCategoryField.
generalMetaDescriptionboolNutzt die Standard-Meta-Description statt den obigen Bausteinen.

seoMetaData.generalSchemes - Allgemeines SEO-Schema

Der Knoten seoMetaData.generalSchemes definiert globale SEO-Texte und Muster. Dazu zählen Standard-Meta-Daten für die Startseite sowie „Formeln“ (Forms), mit denen z. B. Tab-Titel oder Snippets automatisch aus Kategorie-/Produktfeldern und freiem Text zusammengesetzt werden. Beispielkonfiguration
{
  "initialTabs": [
    {
      "forms": [
        {
          "separator": "-",
          "termData": {
            "categoryField": "content.categoryField.name"
          },
          "termType": "categoryField"
        },
        {
          "separator": null,
          "termData": {
            "categoryField": "content.categoryField.descr"
          },
          "termType": "categoryField"
        }
      ]
    },
    {
      "forms": [
        {
          "separator": null,
          "termData": {
            "categoryField": "content.categoryField.descr"
          },
          "termType": "categoryField"
        }
      ]
    },
    {
      "forms": null
    },
    {
      "forms": [
        {
          "separator": null,
          "termData": {
            "productField": "content.productField.descr"
          },
          "termType": "productField"
        }
      ]
    },
    {
      "forms": [
        {
          "separator": "-",
          "termData": {
            "freeText": "test"
          },
          "termType": "freeText"
        },
        {
          "separator": null,
          "termData": {},
          "termType": "resourceId"
        }
      ]
    },
    {
      "forms": [
        {
          "separator": null,
          "termData": {},
          "termType": "resourceId"
        }
      ]
    }
  ],
  "startPageMetaData": {
    "metaDescription": "",
    "metaTitle": "startseite beschreibung"
  }
}
Parameterübersicht
ParameterTypBeschreibung
initialTabslist (object)Liste von Bausteinen für Tabs, aus denen der Shop SEO-Texte zusammenstellt.
formslist (object)Die einzelnen Textbausteine, aus denen ein Tab zusammengesetzt wird.
separatorstringTrennzeichen, das vor diesem Baustein eingefügt wird. (z.B. “-“)
termDataoneOfDaten des Terms - je nach gewähltem termType.
termTypeenumArt des Terms.
Folgende Werte sind möglich:
- categoryField - verweist auf Standard-Kategoriefelder (z.B. name, descr)
- customCategoryField - verweist auf selbst angelegte Kategoriefelder
- productField - verweist auf ein Standardfeld eines Produkts (z.B. name)
- customProductField - verweist auf selbst angelegte Produktfelder.
- resourceId- verweist auf eine Kategorie- oder Produkt-ID.
- freeText - ein fester Text, frei zu vergebender Text.
categoryFieldsingleAssocWert aus einem Standard-Kategoriefeld (z.b. name).
Wert aus content.categoryField.
customCategoryFieldsingleAssocWert aus einem benutzerdefinierten Kategoriefeld.
Wert aus content.customCategoryField
productFieldsingleAssocWert aus einem Standard-Produktfeld. (z.B. descr).
Wert aus content.productField.
customProductFieldsingleAssocWert aus einem benutzerdefinierten Produktfeld.
Wert aus content.customProductField
freeTextstringFest vorgegebener, selbst gewählter Text.
startPageMetaDataobjectStandard-Meta-Daten der Startseite.
metaDescriptionstringMeta-Description der Startseite.
metaTitlestringMetal-Title der Startseite

seoMetaData.productSchemes - Produkt-Meta-Daten

Der Knoten seoMetaData.productSchemes steuert, wie Meta-Title und Meta-Description für Produktseiten zusammengesetzt werden. Beispielkonfiguration
{
  "generalMetaTitle": false,
  "generalMetaDescription": false,

  "metaTitleForms": [
    {
      "separator": " – ",
      "termType": "productField",
      "termData": { "productField": "content.productField.name" }
    },
    {
      "separator": " | ",
      "termType": "customProductField",
      "termData": { "customProductField": "content.customProductField.brand" }
    },
    {
      "separator": null,
      "termType": "freeText",
      "termData": { "freeText": "Offizieller Shop" }
    }
  ],

  "metaDescriptionForms": [
    {
      "separator": "",
      "termType": "productField",
      "termData": { "productField": "content.productField.descr" }
    },
    {
      "separator": " • ",
      "termType": "customProductField",
      "termData": { "customProductField": "content.customProductField.keyFeatures" }
    }
  ]
}
Parameterübersicht
ParameterTypBeschreibung
generalMetaTitleboolAktiviert einen globalen Meta-Title nach den definierten Bausteinen, falls am Produkt kein eigener Titel hinterlegt ist.
generalMetaDescriptionboolAktiviert eine globale Meta-Description nach den definierten Bausteinen, falls am Produkt keine Beschreibung hinterlegt ist.
metaTitleFormslist (object)Reihenfolge von Textbausteinen, aus denen der Meta-Title für Produktseiten generiert wird.
seperatorstringTrennzeichen, das vor diesem Baustein eingefügt wird. (z.B. “-“)
termTypeenumArt des Terms.
Folgende Werte sind möglich:
- productField - verweist auf ein Standardfeld eines Produkts (z.B. name).
- customProductField - verweist auf selbst angelegte Produktfelder.
- freeText - ein fester Text, frei zu vergebender Text.
termDataoneOfDaten des Terms - je nach gewähltem termType.
metaDescriptionFormslist (object)Reihenfolge von Textbausteinen, aus denen die Meta-Description für Produktseiten generiert wird.
seperatorstringTrennzeichen, das vor diesem Baustein eingefügt wird. (z.B. “-“)
termTypeenumArt des Terms.
Folgende Werte sind möglich:
- productField - verweist auf ein Standardfeld eines Produkts (z.B. name).
- customProductField - verweist auf selbst angelegte Produktfelder.
- freeText - ein fester Text, frei zu vergebender Text.
termDataoneOfDaten des Terms - je nach gewähltem termType.

seoMetaData.startPage - Startseite Meta-Daten

Der Knoten seoMetaData.startPage definiert die SEO-Texte für die Starseite. Hier können Meta-Title und Meta-Description hinterlegt werden. Beispielkonfiguration
{
  "metaTitle": "Willkommen im WEBSALE Demo-Shop – Neuheiten & Bestseller",
  "metaDescription": "Jetzt Neuheiten, Bestseller und attraktive Angebote entdecken. Schneller Versand, sichere Zahlung und erstklassiger Service."
}
Parameterbeschreibung
ParameterTypBeschreibung
metaTitlestringSEO-Titel der Startseite (kurz und prägnant, ideal ca. 50-60 Zeichen).
metaDescriptionstringSEO-Beschreibung der Startseite (zusammenfassend, ideal ca. 140-160 Zeichen).

seoMetaData.viewSchemes - Template-Meta-Daten

Der Knoten seoMetadata.viewSchemesdefiniert, wie Meta-Title und Meta-Description für z.B. Templates automatisch zusammengesetzt werden. Beispielkonfiguration
 {
  "generalMetaDescription": false,
  "generalMetaTitle": false,
  "metaTitleForms": [
    {
      "separator": null,
      "termType": "freeText",
      "termData": { "freeText": "Onlineshop" }
    },
    {
      "separator": " | ",
      "termType": "resourceId",
      "termData": {}
    }
  ],
  "metaDescriptionForms": [
    {
      "separator": null,
      "termType": "freeText",
      "termData": { "freeText": "Infos & Service" }
    },
    {
      "separator": null,
      "termType": "resourceId",
      "termData": {}
    }
  ]
}
Parameterübersicht
ParameterTypBeschreibung
generalMetaDescriptionboolAktiviert eine globale Meta-Description nach den definierten Bausteinen, falls am Produkt keine Beschreibung hinterlegt ist.
generalMetaTitleboolAktiviert einen globalen Meta-Title nach den definierten Bausteinen, falls am Produkt kein eigener Titel hinterlegt ist.
metaTitleFormslist (object)Reihenfolge von Textbausteinen, aus denen der Meta-Title für Produktseiten generiert wird.
separatorstringTrennzeichen, das vor diesem Baustein eingefügt wird. (z.B. “-“)
termTypeenumArt des Terms.
Folgende Werte sind möglich:
- resourceId - verweist auf eine Kategorie- oder Produkt-ID.
- freeText - ein fester Text, frei zu vergebender Text.
termDataoneOfDaten des Terms - je nach gewähltem termType.
metaDescriptionFormslist (object)Reihenfolge von Textbausteinen, aus denen die Meta-Description für Produktseiten generiert wird.
separatorstringTrennzeichen, das vor diesem Baustein eingefügt wird. (z.B. “-“)
termTypeenumArt des Terms.
Folgende Werte sind möglich:
- resourceId - verweist auf eine Kategorie- oder Produkt-ID.
- freeText - ein fester Text, frei zu vergebender Text.
termDataoneOfDaten des Terms - je nach gewähltem termType.