Einbinden von Exposés

Markenübersicht für Exposés

Binden Sie eine Markenübersicht von Exposés mit der Funktion oxomi.galleryBrands ein. Mit Klick auf eine Marke erscheinen die entsprechenden Exposés der jeweiligen Marke.

Parameter Beschreibung
target

Gibt das Ziel-Element an, in welches die Markenübersicht eingefügt wird. Wird dieser Parameter nicht angegeben, so wird #oxomi-brands als Standard-Wert verwendet. Falls das Ziel-Element sich innerhalb eines scrollbaren Containers befindet, muss dieser Container unter dem Parameter scrollContainer angegeben werden.

brandCategory

Gibt den Namen einer gewünschten Kategorie an.

brandTag

Gibt einen Tag an, nach dem gefiltert werden soll.

brandSortBy Legt die Sortierung der Markenübersicht fest. Die nachfolgenden Werte stehen hier zur Verfügung.

Wert Beschreibung
priority Standard-Sortierung nach Priorität, kleinste Prioritäts-Zahl wird zuerst gezeigt. Bei gleicher Priorität wird alphanumerisch sortiert. Dies ist der verwendete Standard-Wert.
name Sortiert alphanumerisch nach dem Namen.
date Sortierung nach Datum, neuste Objekte werden zuerst gezeigt.
random Das Ergebnis ist zufällig gemischt.

brandGroupBy

Lässt das Ergebnis gruppiert zurückgeben, falls angegeben. Mögliche Gruppierungen sind:

Wert Beschreibung
category Gruppiert nach Kategorie
brand Gruppiert nach Marke
type Gruppiert nach Typ
tag Gruppiert nach Tags

Hinweis: Falls gruppiert wird, so wird eine andere Struktur des Ergebnisobjekts zurückgegeben.

brandLimit

Begrenzt die Anzahl der angezeigten Ergebnisse. Standard-Wert ist 1024 (max. 2048)

brandSearch

Gibt an, ob zusätzlich auch ein Sucheingabefeld eingebunden wird. Das hier verwendete Template kann über den Parameter searchBarTemplate geändert werden.

own

Wird dieser Parameter auf false gesetzt, so wird die eigene Marke aus der Ergebnisliste entfernt. Um keine Filterung vorzunehmen, müssen Sie den Filter leer lassen.

brandPriorityStart

Ist dieser Parameter gefüllt, erscheinen im Ergebnis nur Marken, deren Markenpriorität gleich oder höher als dieser Wert ist.

brandPriorityEnd

Ist dieser Parameter gefüllt, erscheinen im Ergebnis nur Marken, deren Markenpriorität gleich oder niedriger als dieser Wert ist.

Nachfolgende Parameter sind nur für PRO Portale verfügbar:
Parameter Beschreibung
lang

Gibt die Sprache (als 2-buchstabigen  ISO-Code) an, nach der gefiltert werden soll.

country

Gibt das Land (als 2-buchstabigen  ISO-Code) an, nach dem gefiltert werden soll.

Neben den hier angegebenen Parametern zur Filterung der anzuzeigenden Marken, können zusätzlich noch die Parameter von  oxomi.galleries angegeben werden, um die entsprechende Listen-Darstellung mit den verknüpften Exposés zu filtern.

Beispiel:

oxomi.galleryBrands({ brandCategory: 'Sanitär',
                      brandSearch: true });

Exposés anzeigen

Benutzen Sie hierfür die Funktion oxomi.galleries.

Parameter Beschreibung
target

Gibt das Ziel-Element an, in welches die Exposés eingefügt werden. Wird dieser Parameter nicht angegeben, so wird #oxomi-galleries als Standard-Wert verwendet. Falls das Ziel-Element sich innerhalb eines scrollbaren Containers befindet, muss dieser Container unter dem Parameter scrollContainer angegeben werden.

supplierNumber

Gibt die Lieferantennummer an für den Fall, dass die Werksnummer nicht eindeutig ist. Hier können Sie Ihre eigenen Lieferantennummern verwenden, wenn Sie diese in der Partnerschaft zum Lieferanten gepflegt haben (siehe:  Lieferantennummern).

excludedSupplierNumbers

Hiermit könnnen Sie Lieferantennummern ausschließen.

brand

Gibt einen Markennamen an, der als Auswahlkriterium verwendet wird. Beachten Sie, dass Groß-Kleinschreibung hierbei berücksichtigt wird.

Hinweis: Falls Sie die ID der gewünschten Marke kennen, können Sie alternativ auch mit dem Parameter brandId arbeiten.

tag

Gibt einen Tag an, nach dem gefiltert werden soll. Geben Sie mehrere Tags durch Kommas getrennt an.

sortBy

Legt eine Sortierung fest. Die nachfolgenden Werte stehen hier zur Verfügung.

Wert Beschreibung
priority Sortierung nach Marken-Priorität & Marken-Namen. Bei gleicher Marke werden die Exposés alphanumerisch nach dem Exposénamen sortiert. Dies ist der verwendete Standard-Wert.
name Sortiert alphanumerisch nach dem Namen. Keine Markensortierung.
date Sortierung nach Datum, neuste Objekte werden zuerst gezeigt.
random Das Ergebnis ist zufällig gemischt.

groupBy

Lässt das Ergebnis gruppiert zurückgeben, falls angegeben. Mögliche Gruppierungen sind:

Wert Beschreibung
category Gruppiert nach Kategorie
brand Gruppiert nach Marke
type Gruppiert nach Typ
tag Gruppiert nach Tags

Hinweis: Falls gruppiert wird, so wird eine andere Struktur des Ergebnisobjekts zurückgegeben.

groupFilter

Wird dieser Parameter auf true gesetzt und der Parameter groupBy ist gesetzt, werden über dem Ergebnis Schaltflächen zur Filterung durch den Nutzer auf einzelne Gruppen angezeigt.

start

Definiert wieviel Elemente in der Ergebnisliste übersprungen werden. Soll z.B. mit dem Dritten Element begonnen werden, dann tragen Sie hier den Wert 2 ein.

Hinweis: Nutzen Sie diesen Parameter, um "seitenweise" durch die Ergebnismenge zu navigieren.

limit

Begrenzt die Anzahl der angezeigten Ergebnisse. Standard-Wert ist 128 (max. 1024)

type

Gibt den Exposé-Typ an, nach dem gefiltert werden soll. Verwenden Sie hier die entsprechenden  Typen-Codes. Als Trennzeichen mehrerer Exposé-Typen wird | unterstützt.

category

Definiert den Namen einer Kategorie als Auswahlkriterium. Um mehrere Kategorien auszuwählen benutzten Sie | als Trennzeichen.

own

Wird dieser Parameter auf true gesetzt, so werden ausschließlich eigene Exposés angezeigt. Bei false werden ausschließlich Exposés von anderen Anbietern angezeigt. Um keine Filterung vorzunehmen, müssen Sie den Filter leer lassen.

search

Belegen Sie diesen Parameter mit dem Wert true, um ein funktionsfähiges Sucheingabefeld mit einzubinden.

showDetails

Belegen Sie diesen Parameter mit dem Wert true, damit der Name des Exposés als Beschriftung mit angezeigt wird.

includeOutdated

Belegen Sie diesen Parameter mit dem Wert true, damit auch archivierte Exposés in den Ergebnissen angezeigt werden.

onlyOutdated

Belegen Sie diesen Parameter mit dem Wert true, damit nur archivierte Exposés in den Ergebnissen angezeigt werden. Dieser Parameter überschreibt den Parameter includeOutdated.

Nachfolgende Parameter sind nur für PRO Portale verfügbar:
Parameter Beschreibung
lang

Gibt die Sprache (als 2-buchstabigen  ISO-Code) an, nach der gefiltert werden soll.

country

Gibt das Land (als 2-buchstabigen  ISO-Code) an, nach dem gefiltert werden soll.

Beispiel:

oxomi.galleries({ supplierNumber: 'L10190',
                  target: '#my-gallery-list' });

Exposé-Typen

Die nachfolgendende Liste zeigt alle verfügbaren Exposé-Typen und die dazugehörigen Codes für die Verwendung in der Integration:

Typ Code
Produktwelt product_world
Milieubild ambience
Ausstellung showroom
Veranstaltung event
Messe tradefair
Explosionszeichnung explosion_view
Aktion campaign

Einen Beschreibungstext der jeweiligen  Exposé-Typen finden Sie hinter dem Link.

Exposés eines Artikels anzeigen

Benutzen Sie hierfür die Funktion oxomi.itemGalleries. Diese Funktion findet alle Exposés des angegeben Lieferanten und Artikels. Das erhaltene Ergebnis wird in das definierte target gerendert.

Parameter Beschreibung
target

Gibt das Ziel-Element an, in welches das Exposé eingefügt werden. Wird dieser Parameter nicht angegeben, so wird #oxomi-galleries als Standard-Wert verwendet. Falls das Ziel-Element sich innerhalb eines scrollbaren Containers befindet, muss dieser Container unter dem Parameter scrollContainer angegeben werden.

supplierNumber

Gibt die Lieferantennummer an für den Fall, dass die Werksnummer nicht eindeutig ist. Hier können Sie Ihre eigenen Lieferantennummern verwenden, wenn Sie diese in der Partnerschaft zum Lieferanten gepflegt haben (siehe:  Lieferantennummer).

itemNumber

Gibt die Artikelnummer an, für die Exposés gesucht werden sollen.

type

Gibt den Video-Typ an, nach dem gefiltert werden soll. Verwenden Sie hier die entsprechenden  Typen-Codes. Als Trennzeichen mehrerer Video-Typen wird | unterstützt.

showDetails

Belegen Sie diesen Parameter mit dem Wert true, damit der Name des Exposés als Beschriftung mit angezeigt wird.

includeOutdated

Belegen Sie diesen Parameter mit dem Wert true, damit auch archivierte Dokumente in den Ergebnissen angezeigt werden.

onlyOutdated

Belegen Sie diesen Parameter mit dem Wert true, damit nur archivierte Exposés in den Ergebnissen angezeigt werden. Dieser Parameter überschreibt den Parameter includeOutdated.

Nachfolgende Parameter sind nur für PRO Portale verfügbar:
Parameter Beschreibung
lang

Gibt die Sprache (als 2-buchstabigen  ISO-Code) an, nach der gefiltert werden soll.

country

Gibt das Land (als 2-buchstabigen  ISO-Code) an, nach dem gefiltert werden soll.

Beispiel:

oxomi.itemGalleries({ supplierNumber: 'L10190',
                      itemNumber: 'A20876',
                      target: '#videos' });

Exposé einbetten

Benutzen Sie hierfür die Funktion oxomi.embedGallery.

Parameter Beschreibung
target

Gibt das Ziel-Element an, in welches das Exposé eingefügt wird. Wird dieser Parameter nicht angegeben, so wird #oxomi-gallery als Standard-Wert verwendet.

gallery

Gibt die ID oder den Code des Exposés an, welches eingebettet werden soll. Existieren mehrere Exposés mit dem gegebenen Code, wird das aktuellste verwendet.

Beispiel:

oxomi.embedGallery({ gallery: 'ausstellung',
                     target: '#my-gallery' });

Exposé öffnen

Benutzen Sie hierfür die Funktion oxomi.openGallery.

Parameter Beschreibung
gallery

Gibt die ID oder den Code des Exposés an, welches geöffnet werden soll. Existieren mehrere Exposés mit dem gegebenen Code, wird das aktuellste verwendet.

Beispiel:

oxomi.openGallery({ gallery: 'ausstellung' });