DokumentationDynamic Media Image Serving and Rendering API

Medienset-Anforderungen media-set-requests

Last update: Sat Jul 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Themen:

Erstellt für:

  • Entwickler
  • Benutzende

Image Serving bietet einen Mechanismus zum Abrufen einer hierarchischen Textantwort (xml oder json), die alle Ressourcen und Metadaten darstellt, die mit catalog::ImageSet für einen bestimmten Datensatz verknüpft sind.

Mit diesem Mechanismus können Viewer Antworten generieren, um die Präsentation einfacher Bilder, Videos, Videosets, Mustersets, Rotationssets, Seitensätze (E-Kataloge) und Mediensets zu informieren.

Anforderungssyntax section-d72b1d95e4ce4bb1b332ce096c2b99f1

Die festgelegte Antwort für einen catalog::ImageSet kann mithilfe des Modifikators req=set abgerufen werden und die Katalogdatensatz-ID im Netzpfad referenzieren. Alternativ kann das Bildset direkt in der URL mit dem Modifikator imageset= angegeben werden. Wenn der Modifikator imageset= zum Angeben des Bildsets verwendet wird, sollte der gesamte Wert in geschweifte Klammern gesetzt werden, um den Bildsatzwert zu maskieren und sicherzustellen, dass eingeschlossene Modifikatoren nicht als Teil der URL-Abfragezeichenfolge interpretiert werden.

Typen von festgelegten Antworten section-93eb0a1f70344da2a888e56372ad3896

Der festgelegte Mechanismus unterstützt die folgenden Arten von Antworten:

einfache Bilder
Ein Bilddatensatz ohne definierten Katalog::ImageSet.
einfache Videos
Ein Videodatensatz im statischen Inhaltskatalog.
Mustersets
Ein Satz von Elementen, bestehend aus einem Verweis auf einen Bilddatensatz und einem optionalen separaten Verweis auf einen Bilddatensatz, der als Muster verwendet wird.
hierarchische Mustersets
Ein Satz von Elementen, bestehend aus einem grundlegenden Musterelement oder einem Verweis auf einen Musterset-Datensatz.
Rotationssets
Ein Satz von Elementen, der aus einer einfachen Liste von Bild-IDs besteht.
zweidimensionale Rotationssets
Ein Satz von Elementen, der aus einem einfachen Bild oder einem Verweis auf ein einfaches Rotationsset besteht.
Seitensätze
Ein Satz von Elementen, bestehend aus einer Liste mit bis zu drei Seitenbildern
Mediensets
Eine Gruppe von Elementen, die aus einfachen Bildern, Videosets, Mustersets, hierarchischen Mustersets, Rotationssets, zweidimensionalen Rotationssets, Seitensätzen und Video-Assets bestehen. Jedes Medienset-Element kann auch ein optionales Muster enthalten.
Videosets
Ein Satz von Artikeln, bestehend aus einer Liste einfacher Videos.

Typerkennung für äußere Einsätze section-3dd6e453528d46898e559d31458a59ba

Wenn eine req=set -Anfrage empfangen wird, wird der Typ der zu generierenden Antwort durch den Wert catalog::AssetType bestimmt. Wenn catalog::AssetType nicht definiert ist, wird der Antworttyp durch die folgenden Regeln bestimmt:

  • Wenn der Datensatz im Bildkatalog gefunden wird UND catalog::ImageSet definiert ist

    • Nehmen wir einen E-Katalog-Satz an, wenn mindestens ein Eintrag im Datensatzbildset-Feld einen Doppelpunkt enthält
    • Nehmen Sie als Medienset an, wenn mindestens ein Eintrag im Datensatzbildset-Feld zwei Semikolons enthält.
    • Nehmen wir an, dass ein Bildset mindestens einen Eintrag im Bildset-Datensatzfeld ein Semikolon enthält.
    • Angenommen, ein Rotationsset ist vorhanden, wenn kein Eintrag Doppelpunkt oder Semikolon enthält, aber mindestens ein Eintrag einen Referenzsatz oder einen Inline-Satz enthält (dies ist ein 2D-Rotationsset).
    • Nehmen Sie als unbekannter Satz an, wenn kein Eintrag Doppelpunkt, keinen Semikolon oder einen Referenzsatz oder einen Inline-Satz enthält (d. h. eine durch Kommas getrennte Liste von Bildern).

  • Wenn Datensatz sowohl in Bild- als auch in statischen Inhaltskatalogen gefunden wird

    • Angenommen, ein Video ist im folgenden Satz enthalten: mp3, mp4, flv, f4v, swf, xml
    • Ansonsten Bild annehmen

  • Wenn Datensatz im statischen Inhaltskatalog, NICHT jedoch im Bildkatalog gefunden wird

    • Angenommen, ein Video ist im folgenden Satz enthalten: mp3, mp4, flv, f4v, swf, xml
    • Ansonsten statische Annahme

  • Wenn Eintrag im Bildkatalog, aber NICHT im statischen Inhaltskatalog gefunden wird

    • Angenommen, Bild

  • Wenn der Datensatz NICHT im Bildkatalog gefunden wird und NICHT im statischen Inhaltskatalog zu finden ist

    • Nehmen Sie ein dateibasiertes Video an, wenn die Dateierweiterung in folgendem Satz liegt: mp3, mp4, flv, f4v, swf, xml
    • Angenommen, dateibasiertes Bild ist anders

In allen Fällen konform die resultierende XML-Antwort mit dem angegebenen XML-Dokument mit dem festgelegten Stammknoten, der dem erkannten Typ entspricht.

Erkennung des inneren Sets section-8f46490e467247e69ce284704def06f3

Wenn der äußere Satz als Mediensatz vom Typ erkannt wird, enthält die Antwort einen Satz von Medienset-Elementen, die jedem Medienset-Eintrag in catalog::ImageSet entsprechen. Wenn der optionale Typparameter für einen bestimmten Mediensatzeintrag angegeben ist, wird er einem Ausgabetyp gemäß der folgenden Tabelle zugeordnet:

Eingabetyp
Ausgabetyp
img
img
basic
img
advanced_image
img
img_set
img_set
advanced_image_set
img_set
advanced_swatchset
img_set
spin
spin
video
video
video_set
video_set
static
static
ecat
ecat

Wenn der optionale Typparameter für einen bestimmten Mediensatzeintrag nicht angegeben ist oder einem nicht unterstützten Typ entspricht, wird der Mediensatz-Elementtyp automatisch anhand der gleichen Regeln erkannt, die auf der äußeren Satzebene angewendet wurden.

XML-Spezifikation section-c1bd60948ef545759a16885bb6fcc607

Die zurückgegebene XML-Antwort entspricht der folgenden Spezifikation:

http://crc.scene7.com/is-docs/examples/mediaset.dtd

LabelKey section-bf565de6f7294cf89620343c9071f415

Der Modifikator labelkey= wird zusammen mit dem Feld catalog::UserData verwendet, um Beschriftungen für Bilder und Muster zu generieren. Das Feld catalog:UserData wird als Satz von Schlüssel/Wert-Paaren analysiert und die Beschriftungsschlüssel indiziert in diesen Satz, um den Wert für den angegebenen Schlüssel abzurufen. Dieser Wert wird dann im Attribut l für die Werte s und i zurückgegeben.

Erzwungene Einschränkungen section-b9f042873bee45a5ae11b69fd42f2bca

Um die Größe der Antwort zu begrenzen und selbstreferenzierende Probleme zu vermeiden, wird die maximale Verschachtelungstiefe durch die Servereigenschaft PS::fvctx.nestingLimit gesteuert. Wenn diese Grenze überschritten wird, wird ein Fehler zurückgegeben.

Um die Größe der XML-Antworten für große E-Katalog-Sets zu begrenzen, werden private Metadaten für Prospektset-Elemente gemäß der Servereigenschaft "PS::fvctx.brochureLimit"unterdrückt. Alle privaten Metadaten, die mit der Broschüre verknüpft sind, werden exportiert, bis die Prospektbegrenzung erreicht ist. Nach Überschreiten des Grenzwerts werden private Maps und Benutzerdaten unterdrückt und ein entsprechendes Flag festgelegt, das angibt, welcher Datentyp unterdrückt wurde.

Verschachtelte Mediensets werden nicht unterstützt. Ein verschachteltes Medienset ist definiert als ein Medienset, das ein Medienset-Element vom Typ Medienset enthält. Wenn diese Bedingung erkannt wird, wird ein Fehler zurückgegeben.

Beispiele section-588c9d33aa05482c86cd2b1936887228

Beispiel-XML-Antworten für req=set-Anforderungen finden Sie auf der Seite Eigenschaften unter HTML-Beispiele .

http://crc.scene7.com/is-docs/examples/properties.htm

Verwandte Themen section-625ec466c948476e800dc0c52a4532d3

req= , imageset=, catalog::ImageSet, Referenz zum Bildkatalog

recommendation-more-help
a26166cd-f2f4-45ce-996d-96a0f0d6cf49