ドキュメントAEM 6.4開発ガイド

開発（汎用） developing-generic

Last update: Thu May 04 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

作成対象：

  • Developer
CAUTION
AEM 6.4 の拡張サポートは終了し、このドキュメントは更新されなくなりました。 詳細は、 技術サポート期間. サポートされているバージョンを見つける ここ.
NOTE
API に関するドキュメントもお読みください。

統合フレームワークには、API を備えた統合レイヤーが含まれます。 これにより、（特定の e コマースエンジンに関係なく）e コマース機能用のAEMコンポーネントを構築できます。 また、内部 CRX データベースを使用したり、e コマースシステムを接続して製品データをAEMに取り込んだりすることもできます。

この統合レイヤーを使用するために、すぐに使える AEM コンポーネントが多数用意されています。現在、次のものがあります。

  • 製品表示コンポーネント
  • 買い物かご
  • プロモーションと割引券
  • カタログおよびセクションのブループリント
  • チェックアウト
  • 検索

検索には、AEM検索、サードパーティ検索またはその組み合わせを使用できる統合フックが提供されます。

e コマースエンジンの選択 ecommerce-engine-selection

e コマースフレームワークは任意の e コマースソリューションと組み合わせて使用できますが、使用するエンジは AEM によって識別される必要があります（AEM の汎用エンジンを使用する場合でも同様です）。

  • e コマースエンジンは、CommerceService インターフェイスをサポートする OSGi サービスです。

    • エンジンは、commerceProvider サービスプロパティによって区別できます。

  • AEM では、CommerceService と Product に対して Resource.adaptTo() をサポートしています。

    • adaptTo 実装は、リソースの階層内で cq:commerceProvider プロパティを探します。

      • 見つかった場合、値は、コマースサービス参照のフィルターに使用されます。
      • 見つからない場合は、最上位のコマースサービスが使用されます。

    • 厳密に型指定されたリソースに cq:commerceProvider を追加できるように、cq:Commerce Mixin が使用されます。

  • 適切なコマースファクトリ定義を参照するために、cq:commerceProvider プロパティも使用されます。

    • 例えば、 という値を持つ cq:commerceProvider プロパティは、Geometrixx-Outdoors 向け Day CQ コマースファクトリ（com.adobe.cq.commerce.hybris.impl.GeoCommerceServiceFactory）の OSGi 設定に関連付けられます（ここでも、commerceProvider パラメーターの値は geometrixxgeometrixx となります）。
    • ここで、その他のプロパティも設定できます（適切かつ使用可能な場合）。

標準の AEM インストールでは、例えば次のような特定の実装が必要です。

cq:commerceProvider = geometrixx
geometrixx の例；これには、汎用 API の最小限の拡張が含まれます。

例 example

/etc/commerce/products/geometrixx-outdoors
+ cq:commerceProvider = geometrixx
  + adobe-logo-shirt
    + cq:commerceType = product
    + price = 12.50
  + adobe-logo-shirt_S
    + cq:commerceType = variant
    + size = S
  + adobe-logo-shirt_XL
    + cq:commerceType = variant
    + size = XL
    + price = 14.50
NOTE
CRXDE Liteを使用すると、AEMの汎用実装の製品コンポーネントでこれがどのように処理されるかを確認できます。
/apps/geometrixx-outdoors/components/product

セッション処理 session-handling

顧客の買い物かごに関連する情報を保存するためのセッションです。

CommerceSession は、

  • 買い物かご ​を所有しています。

    • 追加や削除などを実行します。

    • 買い物かごについての様々な計算を実行します。

      commerceSession.getProductPriceInfo(Product product, Predicate filter)

  • の永続性を所有します 注文 データ：

    CommerceSession.getUserContext()

  • updateOrder(Map<String, Object> delta) を使用して、配送の詳細情報を取得または更新できます。

  • また、 支払い 処理接続

  • また、 達成 接続

アーキテクチャ architecture

製品とバリアントのアーキテクチャ architecture-of-product-and-variants

1 つの製品に複数のバリエーションを含めることができます。例えば、色やサイズによって異なる場合があります。 製品では、バリエーションを構成するプロパティを定義する必要があります。このようなプロパティを​ バリアント軸 ​と呼びます。

ただし、すべてのプロパティがバリアント軸であるわけではありません。 バリエーションは他のプロパティにも影響を与えます。例えば、価格はサイズに依存する場合があります。 買い物客はこれらのプロパティを選択できないので、バリアント軸とは見なされません。

各製品やバリアントはリソースで表されるので、1:1 がリポジトリノードにマッピングされます。 特定の製品やバリアントをそのパスで一意に識別できるのも当然です。

すべての製品リソースは、Product API で表現できます。製品 API の呼び出しのほとんどはバリエーションごとに固有ですが（ただし、バリエーションは 1 つのオリジナルから共有される値を継承する場合があります）、一連のバリエーションを一覧で表示する呼び出しもあります（getVariantAxes() や getVariants() など）。

NOTE
事実上、バリアント軸は Product.getVariantAxes() の戻り値で決定されます。
  • 汎用実装の場合、AEM が製品データのプロパティ（cq:productVariantAxes）からバリアント軸を読み取ります。
（一般的に）製品には多数のバリアント軸を持たせることができますが、デフォルトの製品コンポーネントでは次の 2 つのバリアント軸のみが処理されます。

  1. size

  2. さらにもう 1 つ

    この追加バリアントは、製品リファレンスの variationAxis プロパティ（Geometrixx Outdoors の場合、通常は color）を使用して選択されます。

製品リファレンスと PIM データ product-references-and-pim-data

一般に、

  • PIM データは /etc の下に配置されます。

  • 製品リファレンスは /content の下に配置されます。

製品バリエーションと製品データノードの間には 1 対 1 のマッピングが必要です。

製品リファレンスには、各バリエーションを表すノードも必要ですが、すべてのバリエーションを表す必要はありません。例えば、製品に S、M、L のバリエーションがある場合、製品データは次のようになります。

etc
  commerce
    products
      shirt
        shirt-s
        shirt-m
        shirt-l

「Big and Tall」カタログには次のバリエーションだけが含まれます。

content
  big-and-tall
    shirt
      shirt-l

最後に、製品データを使用するための要件はありません。すべての製品データをカタログ内のリファレンスの配下に配置できますが、実際には、すべての製品データを複製せずに複数のカタログを用意することはできません。

API

com.adobe.cq.commerce.api.Product インターフェイス com-adobe-cq-commerce-api-product-interface

public interface Product extends Adaptable {

    public String getPath();            // path to specific variation
    public String getPagePath();        // path to presentation page for all variations
    public String getSKU();             // unique ID of specific variation

    public String getTitle();           // shortcut to getProperty(TITLE)
    public String getDescription();     // shortcut to getProperty(DESCRIPTION)
    public String getImageUrl();        // shortcut to getProperty(IMAGE_URL)
    public String getThumbnailUrl();    // shortcut to getProperty(THUMBNAIL_URL)

    public <T> T getProperty(String name, Class<T> type);

    public Iterator<String> getVariantAxes();
    public boolean axisIsVariant(String axis);
    public Iterator<Product> getVariants(VariantFilter filter) throws CommerceException;
}

com.adobe.cq.commerce.api.VariantFilter com-adobe-cq-commerce-api-variantfilter

/**
 * Interface for filtering variants and AxisFilter provided as common implementation
 *
 * The <code>VariantFilter</code> is used to filter variants,
 * e.g. when using {@link Product#getVariants(VariantFilter filter)}.
 */
public interface VariantFilter {
    public boolean includes(Product product);
}

/**
 * A {@link VariantFilter} for filtering variants by the given
 * axis and value. The following example returns a list of
 * variant products that have a value of <i>blue</i> on the
 * <i>color</i> axis.
 *
 * <p>
 * <code>product.getVariants(new AxisFilter("color", "blue"));</code>
 */
public class AxisFilter implements VariantFilter {

    private String axis;
    private String value;

    public AxisFilter(String axis, String value) {
        this.axis = axis;
        this.value = value;
    }

    /**
     * {@inheritDoc}
     */
    public boolean includes(Product product) {
        ValueMap values = product.adaptTo(ValueMap.class);

        if(values != null) {
            String v = values.get(axis, String.class);

            return v != null && v == value;
        }

        return false;
    }
}

  • 一般的なストレージメカニズム

    • 製品ノードは nt:unstructured です。

    • 製品ノードは、次のいずれかになります。

      • 参照。製品データは別の場所に保存されます。

        • 製品リファレンスには、productData プロパティが含まれます。このプロパティは、製品データ（一般的には /etc/commerce/products の下にあります）を指します。
        • 製品データは階層的です。製品属性は、製品データノードの上位ノードから継承されます。
        • また、製品の参照には、ローカルのプロパティを含めることもできます。このプロパティは、製品データで指定されたプロパティを上書きします。

      • 製品自体：

        • productData プロパティはありません。
        • すべてのプロパティをローカルに格納する product ノード（productData プロパティを含まない）は、独自の上位ノードから製品属性を直接継承します。

  • AEM-generic 製品構造

    • 各バリアントには、独自のリーフノードが必要です。
    • 製品インターフェイスは製品とバリアントの両方を表しますが、関連するリポジトリノードは、それがどれであるかに固有です。
    • product ノードは、製品の属性とバリアント軸を表します。

例 example-1

+ banyan_shirt
    - cq:commerceType = product
    - cq:productAttributes = [jcr:title, jcr:description, size, price, color]
    - cq:productVariantAxes = [color, size]
    - jcr:title = Banyan Shirt
    - jcr:description = Flowery, all-cotton shirt.
    - price = 14.00
    + banyan_shirt_s
        - cq:commerceType = variant
        - size = S
        + banyan_shirt_s_red
            - cq:commerceType = variant
            - color = red
        + banyan_shirt_s_blue
            - cq:commerceType = variant
            - color = blue
    + banyan_shirt_m
        - cq:commerceType = variant
        - size = M
        + banyan_shirt_m_red
            - cq:commerceType = variant
            - color = red
        + banyan_shirt_m_blue
            - cq:commerceType = variant
            - color = blue
    + banyan_shirt_l
        - cq:commerceType = variant
        - size = L
        + banyan_shirt_l_red
            - cq:commerceType = variant
            - color = red
        + banyan_shirt_l_blue
            - cq:commerceType = variant
            - color = blue
    + banyan_shirt_xl
        - cq:commerceType = variant
        - size = XL
        - price = 18.00

買い物かごのアーキテクチャ architecture-of-the-shopping-cart

コンポーネント

  • 買い物かごは、CommerceSession: によって管理されます。

    • CommerceSession は、追加や削除などを実行します。
    • CommerceSession は、買い物かごに対する様々な計算も実行します。
    • CommerceSession は、トリガーされた割引券とプロモーションも買い物かごに適用します。

  • 買い物かごに直接関連はしませんが、CommerceSession はカタログの価格情報も提供する必要があります（価格を管理しているので）。

    • 価格には、次の複数の修飾子があります。

      • 数量割引。
      • 様々な通貨。
      • VAT 対応および VAT 対応です。

    • 修飾子は、次のインターフェイスを使用して完全にオープンエンドになります。

      • int CommerceSession.getQuantityBreakpoints(Product product)
      • String CommerceSession.getProductPrice(Product product)

ストレージ

  • ストレージ

パーソナライズ機能

  • パーソナライズは、常に ClientContext から取得する必要があります。

  • 買い物かごの ClientContext /version/ は、すべてのケースで作成されます。

    • 製品は、CommerceSession.addCartEntry() メソッドを使用して追加する必要があります。

  • 次の図は、ClientContext に格納される買い物かご情報の例を示しています。

chlimage_1-33

チェックアウトのアーキテクチャ architecture-of-checkout

買い物かごと注文データ

CommerceSession は、次の 3 つの要素を管理します。

  1. 買い物かごの内容

    買い物かごのコンテンツスキーマは、次の API で固定されます。

    code language-java 
        public void addCartEntry(Product product, int quantity);
    public void modifyCartEntry(int entryNumber, int quantity);
    public void deleteCartEntry(int entryNumber);

  2. 価格

    価格のスキーマも、API によって決められています。

    code language-java 
        public String getCartPreTaxPrice();
    public String getCartTax();
    public String getCartTotalPrice();
    public String getOrderShipping();
    public String getOrderTotalTax();
    public String getOrderTotalPrice();

  3. 注文の詳細

    しかし、注文の詳細は API によって決められていません​ 。

    code language-java 
        public void updateOrderDetails(Map<String, String> orderDetails);
    public Map<String, String> getOrderDetails();
    public void submitOrder();

送料の計算

  • 注文フォームでは、多くの場合、複数の配送オプション（および価格）を提示する必要があります。

  • 価格は、品目や注文の詳細（重み付けや配送先住所など）に基づく場合があります。

  • CommerceSession はすべての依存関係にアクセスするので、製品価格と同じ方法で扱うことができます。

    • CommerceSession は送料を管理します。
    • updateOrder(Map<String, Object> delta) を使用すると、配送の詳細情報を取得または更新できます。

検索定義 search-definition

標準のサービス API モデルに従って、e コマースプロジェクトは、個々のコマースエンジンで実装できる検索関連の API のセットを提供します。

NOTE
現在、標準で Search API を実装しているのは hybris エンジンだけです。
ただし、検索 API は汎用的で、各 CommerceService で個別に実装できます。
そのため、標準で提供される汎用実装ではこの API は実装されませんが、拡張して検索機能を追加できます。

e コマースプロジェクトには、次の場所にあるデフォルトの検索コンポーネントが含まれています。

/libs/commerce/components/search

chlimage_1-34

これにより、検索 API を使用して、選択したコマースエンジンに対するクエリを実行できます ( e コマースエンジンの選択):

検索 API search-api

コアプロジェクトには、次のような汎用/ヘルパークラスが用意されています。

  1. CommerceQuery

    検索クエリの記述に使用します（クエリテキスト、現在のページ、ページサイズ、並べ替え、選択されているファセットについての情報を含みます）。検索 API を実装するすべての e コマースサービスは、検索を実行するために、このクラスのインスタンスを受け取ります。CommerceQuery は、リクエストオブジェクト（HttpServletRequest）からインスタンス化できます。

  2. FacetParamHelper

    1 つの静的メソッド（toParams）を提供するユーティリティクラス。このメソッドを使用して、ファセットのリストと 1 つのトグル値から GET パラメーター文字列を生成します。これは、UI 側で役立ちます。各ファセットの値ごとにハイパーリンクを表示する必要があります。ユーザーがハイパーリンクをクリックすると、それぞれの値が切り替えられます（つまり、選択した場合はクエリから削除され、それ以外の場合は追加されます）。 これは、複数値/単一値ファセットの処理、値の上書きなどのすべてのロジックを処理します。

検索 API のエントリポイントは、CommerceService#search オブジェクトを返す CommerceResult メソッドです。このトピックについて詳しくは、API ドキュメントを参照してください。

プロモーションおよび割引券の開発 developing-promotions-and-vouchers

  • 割引券:

    • 割引券はページベースのコンポーネントで、Web サイトコンソールを使用して作成および編集され、次の場所に保存されます。

      /content/campaigns

    • 割引券の供給：

      • 割引券コード（買い物客が買い物かごに入力する）。
      • 割引券ラベル（買い物客が買い物かごに入力した後に表示される）。
      • プロモーションパス（割引券が適用されるアクションを定義）。

    • 割引券には、独自の開始日時や終了日時は設定されておらず、親キャンペーンの開始日時や終了日時を使用します。

    • 外部のコマースエンジンも割引券を提供できます。これらには、以下が必要です。

      • 割引券コード
      • isValid() メソッド

    • 割引券 ​コンポーネント（/libs/commerce/components/voucher）は次のものを提供します。

      • 割引券管理用のレンダラー。買い物かごに現在入っている割引券があれば表示します。
      • 割引券を管理（追加/削除）するための編集ダイアログ（フォーム）。
      • 買い物かごへの割引券の追加/削除に必要なアクション。

  • プロモーション:

    • プロモーションは、ページベースのコンポーネントで、Web サイトコンソールを使用して作成／編集され、次の場所に保存されます。

      /content/campaigns

    • プロモーションの提供：

      • 優先度
      • プロモーションハンドラーのパス

    • プロモーションをキャンペーンに関連付けて、オン/オフの日時を定義できます。

    • プロモーションをエクスペリエンスに関連付けて、セグメントを定義できます。

    • エクスペリエンスに接続されていないプロモーションは、単独では実行されませんが、割引券で実行することはできます。

    • プロモーションコンポーネント（/libs/commerce/components/promotion）には、次のものが含まれます。

      • プロモーション管理用のレンダラーとダイアログ
      • プロモーションハンドラー固有の設定パラメーターをレンダリングおよび編集するためのサブコンポーネント

    • 標準では、次の 2 つのプロモーションハンドラーが提供されています。

      • DiscountPromotionHandler買い物かご全体に絶対価格による割引またはパーセンテージ割引を適用します。
      • PerfectPartnerPromotionHandlerパートナー製品も買い物かごに入っている場合に、製品の絶対価格による割引またはパーセンテージ割引を適用します。

    • ClientContext SegmentMgr がセグメントを解決し、ClientContext CartMgr がプロモーションを解決します。少なくとも 1 つの解決されたセグメントの対象となる各プロモーションが実行されます。

      • 発生したプロモーションは、買い物かごを再計算するために、AJAX呼び出しを介してサーバーに送り返されます。
      • 実行されたプロモーション（および追加された割引券）もClientContextパネルに表示されます。

割引券の買い物かごへの追加または買い物かごからの削除は、CommerceSession API を使用して実行されます。

/**
 * Apply a voucher to this session's cart.
 *
 * @param code the voucher's code
 * @throws CommerceException
 */
public void addVoucher(String code) throws CommerceException;

/**
 * Remove a voucher that was previously added with {@link #addVoucher(String)}.
 *
 * @param code the voucher's code
 * @throws CommerceException
 */
public void removeVoucher(String code) throws CommerceException;

/**
 * Get a list of vouchers that were added to this cart via {@link #addVoucher(String)}.
 *
 * @throws CommerceException
 */
public List<Voucher> getVouchers() throws CommerceException;

このように、CommerceSession は、割引券が存在するかどうか、割引券を適用できるかどうかをチェックします。このチェックは、特定の条件を満たした場合（例えば、買い物かごの合計価格が 1 万円を超える場合など）にのみ適用できる割引券に対して実行されます。何らかの理由で割引券を適用できない場合は、addVoucher メソッドが例外をスローします。また、CommerceSession によって、割引券の追加または削除後に買い物かごの価格の更新もおこないます。

Voucher は、以下のフィールドを含む、Bean のようなクラスです。

  • 割引券コード
  • 短い説明
  • 割引のタイプと値を示す関連プロモーションの参照

提供される AbstractJcrCommerceSession によって割引券を適用できます。クラス getVouchers() が返す割引券は、（特に）次のプロパティを持つ jcr:content ノードを含んだ cq:Page のインスタンスです。

  • sling:resourceType（String） - commerce/components/voucher である必要があります。

  • jcr:title（String） - 割引券の説明用

  • code（String） - この割引券を適用するためにユーザーが入力する必要があるコード。

  • promotion（String） - 適用されるプロモーション（例：/content/campaigns/geometrixx-outdoors/article/10-bucks-off）

プロモーションハンドラーは、買い物かごを変更する OSGi サービスです。買い物かごは、PromotionHandler インターフェイスで定義される、複数のフックをサポートします。

/**
 * Apply promotion to a cart line item. The method returns a discount
 * <code>PriceInfo</code> instance or <code>null</code> if no discount
 * was applied.
 * @param commerceSession The commerce session
 * @param promotion The configured promotion
 * @param cartEntry The cart line item
 * @return A discounted <code>PriceInfo</code> or <code>null</code>
 */
public PriceInfo applyCartEntryPromotion(CommerceSession commerceSession,
                                         Promotion promotion, CartEntry cartEntry)
    throws CommerceException;

/**
 * Apply promotion to an order. The method returns a discount
 * <code>PriceInfo</code> instance or <code>null</code> if no discount
 * was applied.
 * @param commerceSession The commerce session
 * @param promotion The configured promotion
 * @return A discounted <code>PriceInfo</code> or <code>null</code>
 */
public PriceInfo applyOrderPromotion(CommerceSession commerceSession, Promotion promotion)
    throws CommerceException;

public PriceInfo applyShippingPromotion(CommerceSession commerceSession, Promotion promotion)
    throws CommerceException;

/**
 * Allows a promotion handler to define a custom, author-oriented message for a promotion.
 * The {@link com.adobe.cq.commerce.common.promotion.PerfectPartnerPromotionHandler}, for instance,
 * uses this to list the qualifying pairs of products in the current cart.
 * @param commerceSession
 * @param promotion
 * @return A message to display
 * @throws CommerceException
 */
public String getMessage(SlingHttpServletRequest request, CommerceSession commerceSession, Promotion promotion) throws CommerceException;

/**
 * Informs the promotion handler that something under the promotions root has been edited, and the handler
 * should invalidate any caches it might be keeping.
 */
public void invalidateCaches();

次の 3 つのプロモーションハンドラーが、デフォルトで提供されています。

  • DiscountPromotionHandler買い物かご全体に絶対価格による割引またはパーセンテージ割引を適用します。
  • PerfectPartnerPromotionHandler製品パートナーも買い物かごに入っている場合に、製品の絶対価格による割引またはパーセンテージ割引を適用します。
  • FreeShippingPromotionHandler は送料無料を適用します。
recommendation-more-help
2315f3f5-cb4a-4530-9999-30c8319c520e