メディアセットリクエスト

画像サービングは、特定のレコードのcatalog::ImageSetに関連付けられたすべてのリソースとメタデータを表す、階層テキスト応答(xmlまたはjson)を取得するメカニズムを提供します。

ビューアはこのメカニズムを使用して応答を生成し、単純な画像、ビデオ、ビデオセット、スウォッチセット、スピンセット、ページセット(eカタログ)、メディアセットの表示を通知できます。

リクエスト構文

catalog::ImageSetに対する設定応答は、req=set修飾子を使用して、ネットパス内のカタログレコードIDを参照することで取得できます。 または、 imageset=修飾子を使用して、画像セットをURL内で直接指定することもできます。 画像セットの指定にimageset=修飾子を使用する場合、画像セット値をエスケープし、含まれる修飾子がURLクエリ文字列の一部として解釈されないように、値全体を中括弧で囲む必要があります。

セット応答のタイプ

設定メカニズムでは、次のタイプの応答がサポートされます。

単純な画像

catalog::ImageSetが定義されていない画像レコード。

簡単なビデオ

静的コンテンツカタログ内のビデオレコード。

スウォッチセット

画像レコードへの参照と、スウォッチとして使用される画像レコードへのオプションの個別の参照から成る一連の項目です。

階層スウォッチセット

基本的なスウォッチ項目またはスウォッチセットレコードへの参照で構成される項目のセットです。

スピンセット

画像IDのシンプルなリストで構成される一連の項目。

2次元スピンセット

単純な画像または基本的なスピンセットへの参照から成る一連の項目。

ページセット

最大3ページの画像のリストから成る一連の項目

メディアセット

単純な画像、ビデオセット、スウォッチセット、階層的なスウォッチセット、スピンセット、2Dスピンセット、ページセット、ビデオアセットから成る一連の項目。 各メディアセット項目には、オプションのスウォッチを含めることもできます。

ビデオセット

シンプルなビデオのリストで構成される一連の項目です。

外部セット型検出

req=setリクエストを受け取ると、生成する応答のタイプはcatalog::AssetTypeの値によって決まります。 catalog::AssetTypeが定義されていない場合、応答タイプは次のルールに基づいて決定されます。

  • レコードが画像カタログに見つかり、 catalog::ImageSetが定義されている場合

    • レコード内の1つ以上のエントリにコロンが含まれている場合、eカタログセットを想定する
    • レコードの画像セットフィールド内に少なくとも1つのエントリに2つのセミコロンが含まれている場合、メディアセットを想定します。
    • レコード内の1つ以上のエントリがセミコロンを1つ含む場合、画像セットを使用します。
    • コロンとセミコロンが含まれていないエントリが1つも参照先のセットまたはインラインセット(これは2Dスピンセット)を含むエントリが1つも含まれている場合に、スピンセットを使用します。
    • コロン、セミコロン、参照セット、インラインセット(画像のコンマ区切りリスト)が含まれないエントリの場合、不明なセットを想定します。
  • 画像と静的コンテンツカタログの両方でレコードが見つかる場合

    • ファイル拡張子が次のセットの場合、ビデオを想定します。mp3, mp4, flv, f4v, swf, xml
    • それ以外の場合は画像を仮定
  • レコードが静的コンテンツカタログに見つかったが、画像カタログに見つからなかった場合

    • ファイル拡張子が次のセットの場合、ビデオを想定します。mp3, mp4, flv, f4v, swf, xml
    • それ以外は静的と見なす
  • レコードが画像カタログに見つかったが、静的コンテンツカタログに見つからなかった場合

    • 画像を仮定
  • レコードが画像カタログで見つからず、静的コンテンツカタログで見つからない場合

    • ファイル拡張子が次のセットにある場合、ファイルベースのビデオと見なします。mp3, mp4, flv, f4v, swf, xml
    • それ以外の場合はファイルベースの画像を想定する

どの場合でも、結果のXML応答は、検出された型に対応するset rootノードを持つ指定されたXMLドキュメントに準拠します。

内部セット型検出

外部セットがタイプのメディアセットとして検出された場合、応答はcatalog::ImageSet内の各メディアセットエントリに対応するメディアセット項目のセットを含む。 特定のメディアセットエントリに対してオプションのtypeパラメーターが指定されている場合、次の表に従って出力タイプにマッピングされます。

入力タイプ 出力タイプ
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

特定のメディアセットエントリのオプションのタイプパラメーターが指定されていない場合、またはサポートされていないタイプに対応する場合は、外部のセットレベルで適用されたのと同じルールを使用して、メディアセット項目タイプが自動検出されます。

XML仕様

返されるxml応答は、次の仕様に準拠しています。

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

LabelKey

labelkey=修飾子をcatalog::UserDataフィールドと共に使用して、画像とスウォッチのラベルを生成します。 catalog:UserDataフィールドはキーと値のペアのセットとして解析され、このセットのラベルキーインデックスが特定のキーの値を取得します。 次に、この値が​s​と​i​の​l​属性に返されます。

強制的な制限

応答のサイズを制限し、自己参照的な問題を防ぐために、ネストの最大深度はサーバーのプロパティPS::fvctx.nestingLimitで制御します。 この制限を超えると、エラーが返されます。

大きなeカタログセットに対するxml応答のサイズを制限するために、サーバのプロパティPS::fvctx.brochureLimitに従って、パンフレットセット項目のプライベートメタデータを抑制する。 パンフレットの上限に達するまで、パンフレットに関連付けられているすべてのプライベートメタデータが書き出されます。 制限を超えると、プライベートマップとユーザーデータは抑制され、対応するフラグが設定され、抑制されたデータの種類が示されます。

ネストされたメディアセットはサポートされていません。 ネストされたメディアセットは、メディアセットタイプのメディアセット項目を含むメディアセットとして定義されます。 この条件が検出されると、エラーが返されます。

req=setリクエストのXML応答のサンプルについては、HTMLの例ヘッダーのプロパティページを参照してください。

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

関連項目

req=imageset=catalog::ImageSet、画像カタログ の参照

このページ