B2C Commerce でのカタログオブジェクトのインポート/エクスポート

スキーマ要素

このセクションでは、catalog.xsd に含まれる要素、およびその要素の値を作成する際に考慮すべきことについて説明します。

要素: Category (カテゴリ)

category 要素をインポートする際には、要素固有の詳細を考慮してください。

• category 要素はフィード内で順不同で表示されます。
• 削除モードはカテゴリ要素レベルで指定し、インポート処理モードを上書きします (例: <category category-id="Electronics" mode="delete"/>)。
• カタログのルートカテゴリを削除モードで削除することはできません。また、置換モードでも削除できません。ただし、置換モードでは更新されます。
• カテゴリを削除すると、カテゴリのカテゴリ割り当て (カテゴリ内の商品ではない)、カテゴリのリンク (受信と送信)、およびすべての下位カテゴリが削除されます。
• ルートカテゴリの表示名と説明も、カタログの表示名および説明として設定されます。
• フィードに用意されていない場合、一部の category 下位要素には、特別なセマンティックまたはデフォルトのセットが含まれています。以下の表に詳細を示します。

属性: online-from および online-to

カタログインポート処理中に、online-from および online-to カテゴリ属性値をリセットしなければならない場合があります。たとえば、これらの要素を XML で空白の値 ( 例: <online-from/> ) で送信すると、XML 検証は失敗します。カタログインポート処理中に、online-fromおよびonline-toカテゴリ属性をリセットします。

カタログインポート処理中にこれらの属性値をリセットするには、インポートファイルが次の XML 形式の例に準拠している必要があります:

 <category category-id="RESET_ME">
 <!-- デフォルトの online-from 値をリセット -->
 <online-from xsi:nil="true" />
 <!-- デフォルトの online-to 値をリセット -->
 <online-to xsi:nil="true" /> </category>

カタログインポートファイルに以下を追加します:

 xsi:noNamespaceSchemaLocation="catalog.xsd"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

以下に例を示します。

 <catalog xmlns="http://www.demandware.com/xml/impex/catalog/2006-10-31"
 xsi:noNamespaceSchemaLocation="catalog.xsd"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" catalog-id="catalog">

更新モードを使用する場合:

カタログの差分ファイルを作成してカタログを更新できる顧客は、更新モードの動作を理解することが重要です。

メモ カタログのインポート中に古いデータを削除するには、置換モードを使用します。

• カテゴリリンクのリンク先のカテゴリをインポートするときに、リンク元のカテゴリがないと、リンクは削除されません。
• 子カテゴリをもつカテゴリをインポートし、その子カテゴリがないと、子カテゴリは削除されません。

要素: 商品

product 要素をインポートする際には、要素固有の詳細を考慮してください。

• product 要素はフィード内で順不同で表示されます。
• 削除モードは商品要素レベルで指定し、インポート処理モードを上書きします。例: <product product-id="PN00001" mode="delete"/>。
• バンドル、商品セット、マスター商品の各商品タイプは互いに排他的です。このため、bundled-products、product-set-products、variations の各要素は互いに排他的です。
• バンドル、商品セット、マスター商品の各商品タイプのバリアントは指定できません。
• 各商品バリエーションとバリエーショングループを 1 つのマスター商品が所有します。このオーナーシップを 1 つのマスター商品から別のマスター商品に 1 回のインポート処理で変更できます。
• マスター商品がない状態でバリエーション商品をインポートすると、その商品はバリエーションのままになります。
• バリエーション商品なしでマスター商品をインポートした場合、 <バリエーション商品> セクションで指定した商品はマスター商品に関連付けられたままになります。他のバリエーション商品はマスター商品からリンク解除され、通常の商品になります。
• 上位の商品セットなしで商品セットをインポートした場合、そのセットのメンバーのままになります。
• バンドルされた商品をそのバンドルなしでインポートした場合、そのバンドルのメンバーのままになります。
• 商品リンクのリンク先の商品をインポートするときに、リンク元の商品がないと、リンクは削除されません。
• バンドルを削除しても、バンドルされた商品は削除されません。
• マスター商品を削除すると、バリエーション商品も削除されます。

商品属性のリセット

マージモードでのインポート中、商品属性の値を削除しなければならないケースもあります。

カタログインポート中に以下の属性をリセットします:

• online-from
• online-to
• search-rank
• search-placement
• sitemap-included-flag
• sitemap-changefrequency
• sitemap-priority

<product product-id="RESET_ME">
    <!-- デフォルトの online-from 値をリセット -->
    <online-to xsi:nil="true" />

    <!-- デフォルトの search-placement 値をリセット -->
    <search-placement xsi:nil="true" />

    <!-- サイト固有の search-placement 値をリセット -->
    <search-placement site-id="YourSite" xsi:nil="true" />
</product>

インポートファイルのルート要素に

xsi:noNamespaceSchemaLocation="catalog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

を追加して、以下のようになります:

<catalog xmlns="http://www.demandware.com/xml/impex/catalog/2006-10-31" xsi:noNamespaceSchemaLocation="catalog.xsd" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" catalog-id="catalog">

メモ カタログ要素が XML ファイルの 1 行に収まるようにしてください。

下位要素の特別処理

フィードに用意されていない場合、一部の product 下位要素には、特別なセマンティックまたはデフォルトのセットが含まれています。以下の表に詳細を示します。

サイト特有の属性

<product> import/export 要素<online-flag>、<online-from>、<online-to>、<searchable-flag>、<search-rank>、<search-placement>、<sitemap-included-flag>、<sitemap-priority>、<sitemap-changefrequency>、および <custom-attribute>の各要素では、属性値がサイト固有であることを示すオプションのsite-id。サイト固有の値を指定するには、人間が判読できるサイト ID を使用します。以下がその例です:

<online-flag site-id="MySiteEurope">false</online-flag>

要素: Images

カタログのインポートでは、<images> セクションで merge-mode 属性がサポートされています。この属性には、次の 2 つの設定可能な値があります:

• マージ: デフォルト値です。
• 置換: 保存されている商品の画像情報をすべて消去してから、再インポートする場合に使用します。たとえば、さまざまな画像を設定するために、バリエーションマスターで使用するバリエーション属性を変更した場合などにこの値を使用します。

メモ merge-mode 属性がサポートされている他のケースと同様、インポートモードが全般的に更新またはマージである場合に、この属性を使用してください。

要素: Category-Assignment

インポート中、catalog.xsd の一部として product-category 割り当てが保持されるため、事前設定された商品割り当てをカテゴリとともにワンステップでインポートできます。この動作は、単一の (分類) カタログを複数のサイト固有 (ナビゲーション) カタログと同時に使用する場合に特に役立ちます。

variation-configuration 要素とコンプレックスタイプ VariationConfiguration によって、カテゴリレベルでバリエーション商品のスライスを構成できます。

Business Manager でカテゴリに商品の位置値を割り当てると、各商品の位置値はシーケンス番号として表示されます。商品をインポート/エクスポートする際には、category-assignment の position 要素には auto の値が割り当てられます。共通する値を解決して商品の位置を決定するには、ファイル内での順番によって各商品の実際の位置が決まります。

たとえば、Business Manager によってカテゴリに商品 A の位置 1 と商品 B の位置 2 が割り当てられているとします。インポート中に、両方の商品の position 要素は auto に設定されます。商品 A はファイル内で最初にあるため、商品 A が最初に表示され、商品 B が 2 番目に表示されます。

要素: Product-Attribute-Definitions

product-attribute-definitions 要素は、サードパーティまたはバックエンドシステムからのフィード経由で商品オブジェクトの属性定義をサポートすることを目的とするものです。インポートによって属性のメタデータを一般的な方法でインポートすることが趣旨ではありません。商品属性定義メタデータはエクスポートできません。product-attribute-definitions 要素にシステム属性の定義が含まれている場合、インポートファイルは無効です。

属性定義は ImportCatalog パイプレットでのみインポートでき、Business Manager のインポートでインポートすることはできません。カタログインポートで作成された商品属性には、以下のデフォルト値があります:

• order-required は false に設定されます
• searchable は false に設定されます
• externally-defined は true に設定されます

メモ これらの属性の値は Business Manager で変更できます。これらの属性はストアフロントの他の部分、特に注文手続きの処理に大きな影響を与えることがあります。カタログインポートは、バックエンドシステムから自動的に商品属性定義を作成できるようにすることを目的としていて、変更は明示的に別個に行う必要があるため、誤ってストアフロントに問題を起こすことはありません。

product-attribute-definitions要素がインポートファイルで定義されていない場合、インポートによって既存の商品属性定義が変更されることはありません。

インポートでは、マージ、置換、更新の各モードで要素が同じように処理されます。インポートファイルでproduct-attribute-definitions要素を定義すると、インポートでは、属性定義がデータベース内にすでに存在するかどうかチェックされ、以下が実行されます:

• 新しい属性定義が追加され、B2C Commerce データベースで externally-defined フラグが true に設定されます。
• B2C Commerce データベースで externally-defined フラグが true に設定されている既存の属性定義は更新されますが、置換はされません。
• B2C Commerce データベースで externally-defined フラグが false に設定されている既存の属性定義はインポートで無視され、データエラーがログされます。
• インポートでは、無効な属性定義はスキップされます。同じ ID をもつ既存の属性があり、externally-defined-flagが true に設定されている場合、インポートによってその属性が削除されます。インポートによって、B2C Commerce データベースからその属性に構成された値もすべて削除されます。
• B2C Commerce データベースで externally-defined フラグが true に設定されている属性定義であり、その属性がインポートフィードに含まれていない場合、その属性は削除されます。インポートによって、B2C Commerce データベースからその属性に構成された値もすべて削除されます。

  バックエンドシステムでは古くなった情報についての情報を提供できないことが珍しくないため、B2C Commerce では、インポートフィードに含まれていない外部定義属性が削除されます。古くなった属性の自動削除により、データベースに多数の古い属性が累積されないようになっています。

インポートモードが DELETE の場合、インポートファイルで定義されているproduct-attribute-definitions要素はすべて無視されます。

メモ 新しい値タイプや新しいローカライズ可能ステータスが付随する既存の属性定義のインポートは、新しい属性定義と見なされ、既存の属性定義は同じ ID で置換されます。

コンプレックスタイプ: AttributeDefinition

catalog.xsd のコンプレックスタイプ AttributeDefinition では、site-specific-flag 属性がサポートされます。

属性: System

システム属性のサイト固有値はカタログのインポートおよびエクスポートでサポートされます。

属性: Custom

カスタム属性のサイト固有値はカタログのインポートおよびエクスポートでサポートされます。

<online-flag site-id="MySiteAmerica">false</online-flag>

要素: Variants

属性: Merge-Mode

merge-mode 属性は、更新、マージ、置換の各モードで、特定の variants 要素の指定されたマージセマンティックを上書きします。属性に使用できる値は、add、merge、replace、および remove です。

置換モードでは、すべてのバリエーション商品が、フィードにリストされているバリエーション商品に置換される前に自動的に削除されるため、このモードでは属性を使用する必要がありません。

バリエーションを別々に追加または削除するには、バリエーションを別々のvariants要素に配置します。1 つの variations 要素と商品につき、1 つの variants 要素とモードのみを使用します。

<product product-id="28447">
    ...
    <variations>
        <variants merge-mode="add">
                <variation product-id="883239585285"/>
                <variation product-id="883239585289"/>
        </variants>       
    </variations>
</product>

<product product-id="28447">
    ...
    <variations>
        <variants merge-mode="remove">
                <variation product-id="883239585281"/>
                <variation product-id="883239585282"/>
                <variation product-id="883239585283"/>
        </variants>
    </variations>
</product>

<product product-id="28447">
    ...
    <variations>
        <variants merge-mode="replace">
                <variation product-id="883239585287"/>
        </variants>
    </variations>
</product>

インポート時のバリエーション商品とバリエーションの属性値の並べ替え

カタログインポート時のバリエーション商品とバリエーションの属性値の並べ替えを制御します。この機能は、インポートのときに既存のバリエーション商品とバリエーションの属性値の並べ替えを保持する必要がある場合に役立ちます。

variation-attribute-values要素とvariants要素のmerge-mode属性にmergeを指定した場合、インポーターは次の処理を行います。

• インポートファイルに指定されているすべての新しい値を、インポートファイルに指定されている順序と同じ順序でリストの最後に追加します。
• インポートファイルに指定されている既存の値をすべて更新します。この動作は、インポートファイルに指定されている場合、表示名などの値のすべての属性がインポーターによって更新されることを意味します。既存の値の位置は更新されません。インポーターは、インポートファイルに指定されていない既存の値をすべて削除します。
  

  メモ バリエーション商品は削除されませんが、バリエーションマスターとのリンクが解除され、独立した商品になります。

merge-mode 属性がファイルで指定されていない場合、システムに格納されているリストは、インポーターによってインポートファイル内の値に完全に置換されます。インポートでは、要素のリストにデフォルトの replace セマンティックが使用されます。

メモ これら要素の処理は、カタログインポートで使用される最上位レベルのインポートモードから独立しています。