Exposés anzeigen

Die Integration oxomi.galleries rendert eine Liste von Exposés in den angegebenen DOM-Container. Dabei wird das Vorschau-Bild des Exposés sowie dessen Name angezeigt. Die Integration bietet verschiedene Filter-, Sortier- und Gruppiermöglichkeiten, mit denen Sie die Ergebnisse einschränken und anpassen können. Darüber hinaus kann ein Gruppenfilter angezeigt werden.

Die gerenderte Liste von Exposés enthält bis zu 50 Einträge. Falls mehr Exposés gefunden wurden, so wird eine Karte mit dem Label „Weitere anzeigen“ dargestellt. Durch einen Klick auf diese Karte werden jedes Mal bis zu 15 weitere Exposés nachgeladen.

Die Integration bietet verschiedene CSS -cust Klassen an, um das Aussehen oder den Funktionsumfang der Integration zu beeinflussen. Weitere Informationen hierzu finden Sie im Artikel Individuelle CSS Regeln.

Der Aufruf der Integration liefert ein Promise zurück, welches Ihnen die Möglichkeit gibt, entsprechend auf den Abschluss des Aufrufs zu reagieren. Hierfür können Sie die then und catch Methoden des Promise Objekts verwenden. Der nachfolgende JavaScript-Code zeigt ein Beispiel, wie Sie auf den Abschluss des Aufrufs reagieren können.

oxomi.galleries({
    target: "#output",
    showActions: true,
    showGroupFilter: true,
    groupBy: "brand",
    supplierNumbers: "L10190"
}).then((result) => {
    console.log("success");
}).catch((error) => {
    console.log("failed");
});

Die nachfolgende Tabelle enthält eine Übersicht über die verfügbaren Parameter. Fett gedruckte Parameter sind Pflichtparameter. Die Beschreibung der Parameter enthält Informationen über den Typ des Parameters, die möglichen Werte und die Bedeutung sowie weitere Verwendungshinweise.

Parameter Parametertyp Beschreibung
target string

Gibt das Ziel-Element an, in welches die gerenderte Liste von Exposés eingefügt wird.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird #oxomi-galleries als Default-Wert verwendet.
supplierNumbers string

Gibt die Lieferantennummern der Partner an, auf welche die Ergebnisse eingeschränkt werden sollen.

Hinweis:

  • Sie können Ihre eigenen Lieferantennummern verwenden, wenn Sie diese in der Partnerschaft zum Lieferanten gepflegt haben (siehe: Lieferantennummern).
  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
excludedSupplierNumbers string

Gibt die Lieferantennummern der Partner an, deren Inhalte von den Ergebnissen ausgeschlossen werden sollen.

Hinweis:

  • Sie können Ihre eigenen Lieferantennummern verwenden, wenn Sie diese in der Partnerschaft zum Lieferanten gepflegt haben (siehe: Lieferantennummern).
  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
brandIds string

Gibt die IDs der Marken an, auf welche die Ergebnisse eingeschränkt werden sollen.

Hinweis:

  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
  • Die ID kann in der Detailansicht gefunden werden. Hierzu muss unten rechts auf das Info-Icon geklickt werden. Anschließend kann die ID (Entity-ID) mit einem Klick auf das Kopieren-Icon kopiert werden.
seriesIds string

Gibt die IDs der Serien an, auf welche die Ergebnisse eingeschränkt werden sollen.

Hinweis:

  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
  • Die ID kann in der Detailansicht gefunden werden. Hierzu muss unten rechts auf das Info-Icon geklickt werden. Anschließend kann die ID (Entity-ID) mit einem Klick auf das Kopieren-Icon kopiert werden.
tags string

Gibt die Tags an, auf welche die Ergebnisse eingeschränkt werden sollen.

Hinweis:

  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
  • Die Groß- und Kleinschreibung wird bei der Angabe der Werte berücksichtigt.
categoryIds string

Gibt die IDs der Kategorien an, auf welche die Ergebnisse eingeschränkt werden sollen.

Hinweis:

  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
  • Die ID kann in der Detailansicht gefunden werden. Hierzu muss unten rechts auf das Info-Icon geklickt werden. Anschließend kann die ID (Entity-ID) mit einem Klick auf das Kopieren-Icon kopiert werden.
types string

Gibt die Exposés-Typen an, auf welche die Ergebnisse eingeschränkt werden sollen. Die verfügbaren Werte können hier eingesehen werden: gallery-types

Hinweis:

  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
filterLanguages string

Gibt die Sprachen als 2-buchstabige ISO-Codes an, auf welche die Ergebnisse eingeschränkt werden sollen. Die verfügbaren Werte können hier eingesehen werden: ISO-Sprachcodes

Hinweis:

  • Dieser Parameter steht nur für PRO Portale zur Verfügung. To the prices & ordering options
  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
filterCountries string

Gibt die Länder als 2-buchstabige ISO-Codes an, auf welche die Ergebnisse eingeschränkt werden sollen. Die verfügbaren Werte können hier eingesehen werden: ISO-Ländercodes

Hinweis:

  • Dieser Parameter steht nur für PRO Portale zur Verfügung. To the prices & ordering options
  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
own boolean

Gibt an, ob nur eigene Exposés oder nur Exposés von anderen Anbietern angezeigt werden sollen.

Hinweis:

  • Dieser Parameter bezieht sich dabei ausschließlich auf die eigene Standardmarke.
  • Wird dieser Parameter auf true gesetzt, so werden ausschließlich eigene Exposés angezeigt.
  • Wird dieser Parameter auf false gesetzt, so werden ausschließlich Exposés von anderen Anbietern angezeigt.
  • Wird dieser Parameter nicht angegeben, so werden sowohl eigene als auch Exposés von anderen Anbietern angezeigt, sofern diese über eine Partnerschaft verfügbar sind.
includeOutdated boolean

Gibt an, ob auch archivierte Exposés in den Ergebnissen angezeigt werden sollen.

Hinweis:

  • Wird dieser Parameter auf true gesetzt, so werden auch archivierte Exposés angezeigt.
  • Wird dieser Parameter auf false gesetzt, so werden ausschließlich aktuelle Exposés angezeigt.
  • Wird der Parameter nicht angegeben, so wird false als Default-Wert verwendet.
  • Dieser Parameter wird nur angewendet, wenn in den Portaleinstellungen im Abschnitt „Standard“ die Option „Archiv aktivieren“ mit einem Wert größer 0 eingestellt ist.
onlyOutdated boolean

Gibt an, ob ausschließlich archivierte Exposés in den Ergebnissen angezeigt werden sollen.

Hinweis:

  • Wird dieser Parameter auf true gesetzt, so werden ausschließlich archivierte Exposés in den Ergebnissen angezeigt.
  • Sollte der Parameter auf true gesetzt sein, hat er Vorrang vor dem Parameter includeOutdated. Bei Einstellung auf false verhält sich der Parameter so, als wäre er nicht angegeben worden.
  • Wird der Parameter nicht angegeben, so wird false als Default-Wert verwendet.
  • Dieser Parameter wird nur angewendet, wenn in den Portaleinstellungen im Abschnitt „Standard“ die Option „Archiv aktivieren“ mit einem Wert größer 0 eingestellt ist.
sortBy string

Gibt die Sortierung der Ergebnisse vor. Die nachfolgenden Werte stehen hier zur Verfügung:

Wert Beschreibung
priority Sortierung nach Marken-Priorität & Marken-Namen. Bei gleicher Marke werden die Dokumente alphanumerisch nach dem Dokumentnamen 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.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird priority als Default-Wert verwendet.
showGroupFilter boolean

Gibt an, ob ein Gruppenfilter angezeigt werden soll. Wird dieser Parameter auf true gesetzt, werden über dem Ergebnis Schaltflächen zur Filterung durch den Nutzer auf einzelne Gruppen angezeigt.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird false als Default-Wert verwendet.
  • Der Gruppenfilter wird nur angezeigt, wenn der Parameter groupBy mit einem gültigen Wert angegeben wurde.
groupBy string

Gibt an ob und wie das Ergebnis gruppiert werden soll. Die nachfolgenden Werte stehen hier zur Verfügung:

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

Hinweis:

  • Wenn der Parameter angegeben wird, so verändert sich die Struktur der gerenderten Ansicht. Die Exposés werden dann in Gruppen angezeigt, welche durch eine Überschrift gekennzeichnet sind.
  • In jeder Gruppe werden dann maximal 15 Exposés angezeigt. Falls mehr Exposés in einer Gruppe vorhanden sind, so wird eine Karte mit dem Label „Weitere Exposés“ angezeigt. Durch einen Klick auf diese Karte werden jedes Mal bis zu 15 weitere Exposés nachgeladen.
  • Exposés die nicht in eine Gruppe eingeordnet werden können, werden in dieser Ansicht nicht angezeigt.
limit integer

Gibt die maximale Anzahl an Exposés an, welche initial angezeigt werden sollen.

Hinweis:

  • Der maximal zulässige Wert für den Parameter beträgt 50.
  • Sind mehr Exposés vorhanden, so ist es über eine entsprechend angezeigte Kachel möglich, weitere Exposés nachzuladen.
  • Wird dieser Parameter nicht angegeben, so werden bei gruppierter Ansicht (siehe groupBy) bis zu 15 Exposés pro Gruppe angezeigt. Andernfalls werden maximal 50 Exposés angezeigt.
Exposés anzeigen - Showcase

Allgemeine Parameter

Bitte geben Sie hier den Portal-Code beziehungsweise die Portal-ID an. Hier finden Sie weitere Informationen.
Für die externe Authentifizierung kann ein im integrierenden System generierter Access-Token eingesetzt werden. Benutzen Sie den Access-Token Rechner, um Ihren individuellen Access-Token zu berechnen. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
Bitte geben Sie hier den Benutzernamen eines Portalbenutzers ein. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
Bitte geben Sie hier wahlweise die Portallrollen an, um den Zugriff auf die Inhalte zu steuern. Hier finden Sie weitere Informationen.

Aufruf Parameter

Gibt die Lieferantennummern der Partner an, auf welche die Ergebnisse eingeschränkt werden sollen.
Gibt die Lieferantennummern der Partner an, dessen Inhalte von den Ergebnissen ausgeschlossen werden sollen.
Gibt die IDs der Marken an, auf welche die Ergebnisse eingeschränkt werden sollen.
Gibt die IDs der Serien an, auf welche die Ergebnisse eingeschränkt werden sollen.
Gibt die IDs der Kategorien an, auf welche die Ergebnisse eingeschränkt werden sollen.
Gibt die Tags an, auf welche die Ergebnisse eingeschränkt werden sollen.
Gibt die Exposé-Typen an, auf welche die Ergebnisse eingeschränkt werden sollen. Die verfügbaren Werte können hier eingesehen werden: gallery-types
Gibt an ob und wie das Ergebnis gruppiert werden soll.
Gibt an, ob ein Gruppenfilter angezeigt werden soll. Wird dieser Parameter auf Ja (true) gesetzt, werden über dem Ergebnis Schaltflächen zur Filterung durch den Nutzer auf einzelne Gruppen angezeigt. Dieser Parameter wird nur angewandt, wenn der Parameter Gruppierung mit einem gültigen Wert angegeben wurde.
Gibt an, ob auch archivierte Exposés in den Ergebnissen angezeigt werden sollen. Dieser Parameter wird nur angewandt, wenn der Parameter Nur archivierte Exposés anzeigen mit einem anderen Wert als Ja (true) angegeben wurde.
Gibt an, ob ausschließlich archivierte Exposés in den Ergebnissen angezeigt werden sollen. Wenn dieser Parameter auf Ja (true) gesetzt wird, werden nur archivierte Exposés in den Ergebnissen angezeigt. Außerdem hat der Parameter dann Vorrang vor dem Parameter Archivierte Exposés anzeigen.
Gibt an, ob nur eigene Exposés oder nur Exposés von anderen Anbietern angezeigt werden sollen.
Gibt die Sprachen als 2-buchstabige ISO-Codes an, auf welche die Ergebnisse eingeschränkt werden sollen. Die verfügbaren Werte können hier eingesehen werden: ISO-Sprachcodes
Gibt die Länder als 2-buchstabige ISO-Codes an, auf welche die Ergebnisse eingeschränkt werden sollen. Die verfügbaren Werte können hier eingesehen werden: ISO-Ländercodes
Gibt die maximale Anzahl an Exposés an, welche initial angezeigt werden sollen.

Ausgabebereich

Exposé einbetten

Die Integration oxomi.embedGallery rendert entweder das Cover-Bild eines einzelnen angegebenen Exposés (sowie dessen Name) oder das Exposé im Viewer geöffnet in den angegebenen DOM-Container.

Die Integration bietet zudem verschiedene CSS -cust Klassen an um das Aussehen oder den Funktionsumfang der Integration zu beeinflussen. Weitere Informationen hierzu finden Sie im Artikel Individuelle CSS Regeln.

Der Aufruf der Integration liefert ein Promise zurück, welches Ihnen die Möglichkeit gibt, entsprechend auf den Abschluss des Aufrufs zu reagieren. Hierfür können Sie die then und catch Methoden des Promise Objekts verwenden. Der nachfolgende JavaScript-Code zeigt ein Beispiel, wie Sie auf den Abschluss des Aufrufs reagieren können.

oxomi.embedGallery({
    target: "#output",
    gallery: "7733",
    image: "1",
    inline: false
}).then((result) => {
    console.log("success");
}).catch((error) => {
    console.log("failed");
});

Die nachfolgende Tabelle enthält eine Übersicht über die verfügbaren Parameter. Fett gedruckte Parameter sind Pflichtparameter. Die Beschreibung der Parameter enthält Informationen über den Typ des Parameters, die möglichen Werte und die Bedeutung sowie weitere Verwendungshinweise.

Parameter Parametertyp Beschreibung
gallery string

Gibt die ID oder den Code des Exposés an.

Hinweis:

  • Wird ein Code angegeben, für den mehrere Exposés existieren, so wird das aktuellste verwendet.
  • Die ID kann in der Detailansicht gefunden werden. Hierzu muss unten rechts auf das Info-Icon geklickt werden. Anschließend kann die ID (Entity-ID) mit einem Klick auf das Kopieren-Icon kopiert werden.
target string

Gibt das Ziel-Element an, in welches das gerenderte Exposé eingefügt wird.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird #oxomi-gallery als Default-Wert verwendet.
image string

Gibt die Nummer des Bildes an, das beim Öffnen des Exposés angezeigt werden soll (beginnend bei 1).

Hinweis:

  • Wird der Parameter nicht angegeben, so wird 1 als Default-Wert verwendet.
inline boolean

Gibt an, ob das Exposé im Ziel-Element mit geöffnetem Viewer direkt eingebettet werden soll.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird false als Default-Wert verwendet.
  • Wird dieser Parameter auf true gesetzt, so wird das Exposé direkt im Ziel-Element eingebettet. Dies ändert das Standardverhalten der Integration! Zusätzliche Aktionen werden dann nicht angezeigt.
  • Wird dieser Parameter auf false gesetzt oder nicht angegeben, so wird das Standardverhalten der Integration verwendet.
  • Das Ziel-Element wird mit dem Parameter target angegeben.
  • Aktuell kann auf diese Weise nur ein Dokument pro Seite eingebettet werden.
Exposé einbetten - Showcase

Allgemeine Parameter

Bitte geben Sie hier den Portal-Code beziehungsweise die Portal-ID an. Hier finden Sie weitere Informationen.
Für die externe Authentifizierung kann ein im integrierenden System generierter Access-Token eingesetzt werden. Benutzen Sie den Access-Token Rechner, um Ihren individuellen Access-Token zu berechnen. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
Bitte geben Sie hier den Benutzernamen eines Portalbenutzers ein. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
Bitte geben Sie hier wahlweise die Portallrollen an, um den Zugriff auf die Inhalte zu steuern. Hier finden Sie weitere Informationen.

Aufruf Parameter

Gibt die ID oder den Code des Exposés an.
Gibt die Nummer des Bildes an, das beim Öffnen des Exposés angezeigt werden soll (beginnend bei 1).
Gibt an, ob das Exposé im Ziel-Element mit geöffnetem Viewer direkt eingebettet werden soll.

Ausgabebereich

Exposé öffnen

Mit der Integration oxomi.openGallery kann ein Exposé in einem Overlay geöffnet werden. So können Sie beispielsweise ein Exposé aus einer Liste oder aus einem anderen Kontext heraus anzeigen. Dabei können Sie die Nummer des Bildes angeben, das initial angezeigt werden soll.

Der Aufruf der Integration liefert ein Promise zurück, welches Ihnen die Möglichkeit gibt, entsprechend auf den Abschluss des Aufrufs zu reagieren. Hierfür können Sie die then und catch Methoden des Promise Objekts verwenden. Der nachfolgende JavaScript-Code zeigt ein Beispiel, wie Sie auf den Abschluss des Aufrufs reagieren können.

oxomi.openGallery({
    gallery: "7733",
    image: "1"
}).then((result) => {
    console.log("success");
}).catch((error) => {
    console.log("failed");
});

Die nachfolgende Tabelle enthält eine Übersicht über die verfügbaren Parameter. Fett gedruckte Parameter sind Pflichtparameter. Die Beschreibung der Parameter enthält Informationen über den Typ des Parameters, die möglichen Werte und die Bedeutung sowie weitere Verwendungshinweise.

Parameter Parametertyp Beschreibung
gallery string

Gibt die ID oder den Code des Exposés an.

Hinweis:

  • Wird ein Code angegeben, für den mehrere Exposés existieren, so wird das aktuellste verwendet.
  • Die ID kann in der Detailansicht gefunden werden. Hierzu muss unten rechts auf das Info-Icon geklickt werden. Anschließend kann die ID (Entity-ID) mit einem Klick auf das Kopieren-Icon kopiert werden.
image string

Gibt die Nummer des Bildes an, das beim Öffnen des Exposés angezeigt werden soll (beginnend bei 1).

Hinweis:

  • Wird der Parameter nicht angegeben, so wird 1 als Default-Wert verwendet.
Interactive Code Example
See also
Enthält die Grundlagen zum Thema Javascript Integration.