> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kameleoon.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Goal, segment, trigger, and product objects

> Referenz der Objekte Goal, Segment, Trigger, Product, Category, Param, Fashion, Color, Auto und Compatible.

Diese Objekte beschreiben Ziele, Segmente und Trigger sowie die Katalogelemente, die von den Produktmethoden verwendet werden.

## Goal

Ein `Goal`-Objekt stellt einen Key Performance Indicator (KPI) dar, der in der Kameleoon App definiert ist.

**Properties**

| Name | Type | Description |
| - | - | - |
| id | Number | ID des Ziels. |
| name | String | Name des Ziels. |
| type | String | Typ des Ziels. Mögliche Werte sind: **CLICK**, **SCROLL**, **URL**, **ENGAGEMENT** und **CUSTOM**. |

## Segment

Ein `Segment`-Objekt enthält Kriterien, die ein Besuch erfüllen muss, um zum Segment zu gehören. Auf der Kameleoon-Plattform enthalten Segmente konstante Bedingungen wie Alter oder Standort sowie Trigger-Bedingungen wie Zeit auf der Seite oder Warenkorbbefüllung.

**Properties**

| Name | Type | Description |
| - | - | - |
| id | Number | ID des Segments. |
| name | String | Name des Segments. |

## Trigger

Ein Trigger-Objekt enthält Kriterien, die ein Besuch erfüllen muss, um den Trigger auszulösen. Auf der Kameleoon-Plattform enthalten Trigger konstante Bedingungen wie Alter oder Standort sowie Trigger-Bedingungen wie Zeit auf der Seite oder Warenkorbbefüllung.

**Properties**

| Name | Type | Description |
| - | - | - |
| id | Number | ID des trigger. |
| name | String | Name des trigger. |

## Product

Ein `Product`-Objekt beschreibt Elemente in einem Katalog. Die meisten Eigenschaften sind optional und können **null** sein.

**Properties**

| Name | Type | Erforderlich | Description |
| - | - | - | - |
| id | String | True | Unique ID des product. |
| name | String | False | Name des product. |
| sku | String | False | Lagerhaltungseinheit (SKU) des Produkts. |
| categories | Array | False | Liste von [Category objects](#category) |
| imageURL | String | False | Die URL des Hauptbildes für dieses Produkt. |
| price | Number | False | Der aktuelle Preis des Produkts. |
| oldPrice | Number | False | Der ursprüngliche Preis des Produkts, üblicherweise vor Rabatten oder Aktionen. |
| brand | String | False | Name des product's brand. |
| description | String | False | Textliche Beschreibung des Produkts. |
| available | Boolean | False | Gibt an, ob das Produkt am Lager ist. |
| availableQuantity | Number | False | Aktueller Bestand des Produkts. |
| rating | Number | False | Bewertung (normalerweise von 0 bis 5, aber kann eine beliebige Zahl sein) des Produkts. |
| tags | Array | Falsch | Liste von Tags (als Strings) für dieses Produkt. |
| typePrefix | String | Falsch | Produkttyp, wie etwa "Mobiltelefon" oder "Waschmaschine". Wird von Such-Algorithmen verwendet. |
| merchantID | String | False | Verkäufer-/Handelskennung dieses Produkts, wenn Ihre Website einen Marktplatz betreibt. |
| groupId | String | False | Verwenden Sie dieses Feld, um Produktvarianten in eine Gruppe zu kombinieren. |
| model | String | False | Modell des Produkts. |
| leftovers | String | False | Bestand eines bestimmten Produkts. Verwenden Sie einen der folgenden Werte: `one` (eine Kopie verfügbar), `few` (begrenzte Mengen, bis zu 10 Einheiten) oder `lot` (10 oder mehr verfügbare Einheiten). |
| priceMargin | Number | False | Ein Gewichtungsfaktor der Produktgewinnmarge, zwischen 0 und 100. |
| isFashion | Boolean | False | Auf `true` setzen für Kleidungsprodukte. |
| isChild | Boolean | False | Verwenden Sie dieses Feld, wenn es sich um ein Kinderprodukt handelt. |
| isNew | Boolean | False | Verwenden Sie dieses Feld, wenn neues Produkt. |
| accessories | Array | False | Array von Produkt-IDs, die ergänzend oder gleichwertig zum aktuellen Produkt sein können. |
| seasonality | Array | False | Array von integers (months: 1-12). |
| params | Array | False | Liste von [Param objects](#param) |
| fashion | Object | False | [Fashion object](#fashion) |
| auto | Object | False | [Auto object](#auto) |

## Category

**Properties**

| Name | Type | Erforderlich | Description |
| - | - | - | - |
| id | String | True | Unique ID des category. |
| name | String | False | Name des category. |
| parent | String | False | Unique ID des parent category. |
| url | String | False | Die URL der Kategorie. |

## Param

Ein optionales generisches Feld, mit dem Sie benutzerdefinierte Informationen zu einem Produkt hochladen können, die in keines der anderen Felder passen.
Diese Informationen könnten beispielsweise den Mitgliedschaftsstatus sein, der zum Kauf eines Produkts erforderlich ist, oder Ab- und Rückdaten für eine Reiseroute.

**Properties**

| Name | Type | Erforderlich | Description |
| - | - | - | - |
| name | String | True | Name des param. |
| value | Array | True | Liste von Werten (als Strings). |
| unit | String | Falsch | Verwenden Sie zwei Buchstaben-Abkürzungen für SI-Einheiten, wie etwa cm (Zentimeter), wt (Watt) oder gr (Gramm). |

## Fashion

Ein optionales generisches Feld, das es Ihnen ermöglicht, benutzerdefinierte Informationen zum Produkt hochzuladen.

**Properties**

| Name | Type | Description |
| - | - | - |
| gender | String | Muss "f" (Weiblich) oder "m" (Männlich) sein. |
| type | String | Product type. Possible values: `shoe`, `shirt`, `tshirt`, `underwear`, `trouser`, `jacket`, `blazer`, `sock`, `belt`, `hat`, `glove`. |
| feature | String | Verwenden Sie dieses Feld, um anzugeben, ob das Produkt nur für Erwachsene oder Kinder bestimmt ist. Muss den Wert "child" oder "adult" annehmen. |
| colors | Array | Liste von [Color objects](#color). |

## Color

**Properties**

| Name | Type | Description |
| - | - | - |
| color | String | Product colors. |
| picture | String | Die URL des Bildes. |

## Auto

Ein optionales generisches Feld, das es Ihnen ermöglicht, benutzerdefinierte Informationen zum Produkt hochzuladen.

**Properties**

| Name | Type | Description |
| - | - | - |
| vds | Array | Array, das die Fahrzeugidentnummern (VIN) enthält, die als Fingerabdruck des Autos dienen. |
| compatibility | Array | Enthält eine Liste von [Compatible-Objekten](#compatible) |

## Compatible

**Properties**

| Name | Type | Erforderlich | Description |
| - | - | - | - |
| brand | String | True | Car brand name. |
| model | String | False | Car model name. |
