Promotions Entity Views and Actions APIの操作 (C#)
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
外部システムは、Sitecore XCプロモーション関連の操作を統合し、Sitecore XCプロモーション エンティティ ビューとアクションAPIを使用してプロモーション関連データを他のシステムと交換できます。
この 例に示すように、Commerce Engineの操作とコマンドをコンテナ呼び出しに含める必要があります (C# を使用)。
Sitecore Experience Commerce (XC) システムで操作を実行するには、呼び出し元のシステムはまずSitecore Identity Serverの 有効なベアラー認証トークンを取得する 必要があります。
Promotions View APIとActions APIは、プロモーション ブックのAdd、Get、Edit 、Manage Associated Catalogsに対するアクションをサポートしています。
Views and Actions APIは、ビジネス・ユーザー・インターフェースを提供するように設計された オーサリングAPIであり、統合シナリオ用には最適化されていません。
コマース統合にViews and Actions APIを使用する場合は、次の点を考慮する必要があります。
-
Views and Actions APIは、一度に1つのCommerceエンティティのみを処理でき、バッチ処理をサポートしていません。
-
Views and Actions APIは、Commerce WebサービスAPIよりも多くのオーバーヘッドを伴います。Views and Action APIの呼び出しは、通常、アクションのビューを取得し、更新された値でビューのプロパティを変更してから、アクションを実行する必要がある3段階のプロセスです。
プロモーション ブックの追加 (C#)
プロモーション ブックの追加 (C#)
APIリクエストを使用して、新しいプロモーションブックをプログラムで作成できます。プロモーション ブックが存在すると、その名前を変更することはできません。プロモーションブックは削除できません。
C# を使用してプロモーションブックを追加するには:
-
エンティティ ビューを取得します。
-
ビューのプロパティを変更するには、Name、DisplayName 、およびDescriptionを指定します。たとえば、次の例です。
-
アクションを実行します。
プロモーション ブックからビューを取得する (C#)
プロモーション ブックからビューを取得する (C#)
Views APIを使用して、プロモーション ブックのさまざまなビューを取得できます。
Views APIはComposite EntityViewsを使用します。マスタービューをリクエストできますが、子ビューもリクエストできます。
プロモーションのブックマスタービューの取得
プロモーションのブックマスタービューの取得
プロモーションのブックマスタービューを取得するには:
プロモーションブックの詳細ビューを取得する
プロモーションブックの詳細ビューを取得する
プロモーションブックの詳細ビューを取得するには:
プロモーションブックの関連カタログビューの取得
プロモーションブックの関連カタログビューの取得
プロモーションブックに関連付けられたカタログビューを取得するには:
プロモーションブックのプロモーションビューを取得する
プロモーションブックのプロモーションビューを取得する
プロモーションブックのビューを取得するには:
プロモーション ブックの編集 (C#)
プロモーション ブックの編集 (C#)
既存のプロモーションブックのDisplayNameプロパティとDescriptionプロパティの値を変更できます。内部名 ( Nameプロパティの値) は変更できません。要求で値が指定されていない場合、既存の値は変更されません。
プロモーションブックの詳細を編集するには:
-
エンティティ ビューを取得します。
-
たとえば、次の例に示すように、DisplayNameまたはDescriptionまたはその両方を指定して、ビューのプロパティを変更します。
-
アクションを実行します。
カタログをプロモーション ブックに関連付ける (C#)
カタログをプロモーション ブックに関連付ける (C#)
カタログをプロモーションに関連付けて、ブックで定義されたプロモーションをカタログ品目に適用できるようにします。プロモーション ブックは複数のカタログに関連付けることができますが、カタログは1つのプロモーション ブックにのみ関連付けることができます。
カタログをプロモーションブックに関連付けるには:
-
エンティティ ビューを取得します。
-
たとえば、ビューのプロパティを変更して、関連付けるカタログを指定します。たとえば、次のようにします。
-
アクションを実行します。
プロモーションを追加する (C#)
プロモーションを追加する (C#)
プロモーション ブック内でプロモーションを作成します。プロモーション ブック内では、プロモーションの名前は一意である必要があります。プロモーションの名前は変更できません。
プロモーションを追加するには:
-
エンティティ ビューを取得します。
-
ビューのプロパティを変更して、プロモーションの詳細を指定します。たとえば、次のようにします。
-
アクションを実行する
このリクエストは、プロモーションのわかりやすいIDをPromotionAddedモデルの一部として返します。たとえば、次のようにします。
プロモーションのビューを取得する (C#)
プロモーションのビューを取得する (C#)
Views APIを使用して 、プロモーションのさまざまなビュー を取得できます。
プロモーションのマスタービューを取得するには:
プロモーションの詳細ビューを取得するには:
プロモーションの資格ビューを取得するには:
プロモーションの特典ビューを取得するには:
プロモーションのアイテム ビューを取得するには:
プロモーションの公開クーポンのビューを取得するには:
プロモーションのプライベートクーポンのビューを取得するには:
プロモーションの編集 (C#)
プロモーションの編集 (C#)
既存のプロモーションのプロパティの値を変更することができます。
プロモーションにaを変更できるのは、プロモーションがDraft状態の場合のみです。
プロモーションを編集するには:
-
エンティティ ビューを取得します。
-
必要に応じて、次のようにビューのプロパティを変更します。
手記DisplayNameやDescriptionに値が指定されていない場合、現在の値は変更されません。残りのプロパティは必須です。(IsRequiredが "true"に設定されている場合は、プロパティが必要です。
-
アクションを実行します。
条件を追加する (C#)
条件を追加する (C#)
資格とは、プロモーションに設定する条件であり、プロモーション特典を買い物客の注文に適用するために満たす必要がある条件です。 Sitecore XCには 、プロモーションに適用できる複数の資格が用意されています。
プロモーションに資格を追加するには:
-
たとえば、エンティティ ビューを取得して、プロモーションにCart Has [count] items?資格を追加します。
-
認定値を設定します。次の例では、Cart Has [count] items?のアイテム数が3に設定されています。
-
アクションを実行します。
認定IDは、次のようにQualificationAddedモデルで返されます。
条件の編集 (C#)
条件の編集 (C#)
既存の条件は、Views/Actions APIを使用して変更できます。
条件を編集するには (たとえば、Cart Has [count] Items?条件を編集するには、countプロパティを5に設定します。
-
エンティティ ビューを取得します。
-
必要に応じて、Cart Has [count] Items?条件の項目数を5に変更するには、必要に応じて条件のプロパティ値を編集します。
-
アクションを実行します。
特典を追加する (C#)
特典を追加する (C#)
特典とは、プロモーションに適用される可能性のある割引です。特典は、プロモーションの資格条件が満たされた場合に、お客様の注文に適用されます。 Sitecore XCでは、1つのプロモーションに適用できる特典が事前に定義されています。1つのプロモーションに複数の特典を追加できます。
プロモーションに特典を追加するには:
-
エンティティ ビューを取得します (たとえば、プロモーションにGet Cart Subtotal [specific] Amount Off特典を適用する場合など)。
-
給付金値プロパティを設定します。たとえば、次の例では、AmountOff値を50に設定します。
-
アクションを実行します。
特典IDは、次のようにBenefitAdded モデルを使用して返されます。
特典の編集 (C#)
特典の編集 (C#)
既存の特典に変更を加えるには、そのプロパティ値を変更します。
特典を編集するには (たとえば、Get Cart Subtotal [specific] Amount Off特典の割引額の値を変更するには):
-
エンティティ ビューを取得します。
-
"AmountOff" プロパティの値を次のように変更します (例: 20
-
アクションを実行します。
特典の削除 (C#)
特典の削除 (C#)
プロモーションの特典を削除できます。
特典を削除するには:
-
エンティティ ビューを取得し、プロモーションのフレンドリIDと削除する特典IDをクエリに含めます (例:
-
アクションを実行します。
プロモーションに項目を追加する (C#)
プロモーションに項目を追加する (C#)
目的ステートメントを確認する必要があります - ステップ2のコード サンプルと一致しているかどうかはわかりませんアイテム (Sellableアイテムやアイテムのバリアントなど) をプロモーションに追加して、プロモーションが個々のアイテムに適用されるようにします (カタログ レベルでプロモーションを適用するのではなく)。
プロモーションを変更できるのは、プロモーションがDraft状態の場合のみです。 approved 状態のプロモーションは変更できません。
プロモーションにアイテムを追加するには:
-
エンティティ ビューを取得します。
-
ビューのプロパティを変更します。たとえば、プロモーションにnot excludedプロパティを追加します。
-
アクションを実行します。
アイテムIDは、次のようにPromotionItemAdded モデルを使用して返されます。
プロモーションからの項目の削除 (C#)
プロモーションからの項目の削除 (C#)
プロモーションからアイテムを削除するには、Views and Actions APIを使用します。
プロモーションからアイテムを削除するには:
-
エンティティ ビューを取得し、プロモーションのフレンドリIDと削除するアイテムIDをクエリに含めます。
-
アクションを実行します。
プロモーションへの公開クーポンの追加 (C#)
プロモーションへの公開クーポンの追加 (C#)
公開クーポンは、複数回使用できるテキストの文字列です。
プロモーションに公開クーポンを追加するには:
-
エンティティ ビューを取得します。
-
ビューのプロパティを変更して、codeProperty.Valueを指定します。たとえば、次の例です。
-
アクションを実行します。
プロモーションへのプライベート クーポンの追加 (C#)
プロモーションへのプライベート クーポンの追加 (C#)
プライベートクーポンは、1人の顧客に割り当てられた割引コードです。作成するプライベートクーポンの数を指定できます
プロモーションにプライベートクーポンを追加するには:
-
エンティティ ビューを取得します。たとえば、次のようにします。
-
ビューのプロパティを変更して、クーポンの割り当ての詳細を指定します。次に示すのは、20個の可能な割り当てを作成するクエリです。
-
アクションを実行します。
クーポンに適したIDは、PrivateCouponGroupAddedモデルを使用して返されます (例:
プライベート クーポンの割り当て (C#)
プライベート クーポンの割り当て (C#)
Promotions Views and Actions APIを使用して、生成された非公開クーポンを特定のプロモーションキャンペーンに割り当てることができます。
プライベートクーポンを割り当てるには:
-
アクションのエンティティ ビューを取得します。
-
たとえば、ビューのプロパティを変更して、10個のクーポンを割り当てます。
-
アクションを実行します。
割り当てられたクーポン コードの一覧は、PrivateCouponListモデルを使用して返されます。
プロモーションの複製 (C#)
プロモーションの複製 (C#)
Views and Actions APIを使用して既存のプロモーションを複製し、同じプロモーション ブック内に新しいプロモーションを作成できます。新しいプロモーションはDraft ステータスになり、編集できます。
プロモーションを複製するには:
-
アクションのエンティティ ビューを取得します。
-
次のように、ビューのプロパティを変更します。
-
アクションを実行します。
プロモーションステータスの変更
プロモーションステータスの変更
プロモーションは、プロモーション承認プロセスの対象となります。承認フロー中、プロモーションステータスは次のように移行できます。
-
DraftからReadyForApprovalまで (「承認のためにプロモーションを提出する (C#)」を参照)
-
ReadyForApprovalからDraftへ (「昇格を拒否する (C#)」を参照)
-
ReadyForApprovalからApprovedへ (「プロモーションの承認 (C#)」を参照)
-
ApprovedからDisabledへ (「承認済みプロモーションの無効化」を参照)
承認のためにプロモーションを送信する (C#)
承認のためにプロモーションを送信する (C#)
プロモーションの下書きを提出して承認を受けることができます。
プロモーションの承認をリクエストするには:
-
アクションのビューを取得します。
-
ビューのプロパティを変更して承認を要求します。
-
アクションを実行します。
プロモーションのステータスがDraftからReadyForApprovalに変わります。
昇格を拒否する (C#)
昇格を拒否する (C#)
プロモーションは、ステータスがReadyForApprovalの場合に拒否できます。
プロモーションを却下してドラフトステータスに戻すには:
-
アクションのビューを取得します。
-
ビューのプロパティを変更して、承認リクエストを拒否します。
-
アクションを実行します。
プロモーションはDraft ステータスに戻ります。
プロモーションの承認 (C#)
プロモーションの承認 (C#)
プロモーションを承認できるのは、そのステータスがReadyForApprovalの場合です。
プロモーションを承認するには:
-
アクションのビューを取得します。
-
ビューのプロパティを変更して、プロモーションを承認します。
-
アクションを実行します。
プロモーションのステータスがApprovedに変わります。
承認済みのプロモーションを無効にする
承認済みのプロモーションを無効にする
承認済みのプロモーションを無効にすることができます。プロモーションを無効にすると、そのプロモーションは承認されたままになりますが、アクティブではなくなります。無効にしたプロモーションを再度アクティブ化することはできません。
承認済みのプロモーションを無効にするには
-
アクションのビューを取得します。
-
ビューのプロパティを変更して、アクティブなプロモーションを無効にします。
-
アクションを実行します。
プロモーションの削除 (C#)
プロモーションの削除 (C#)
プロモーションは、Draftステータスのときに削除できます。
プロモーションを削除するには:
-
アクションのエンティティ ビューを取得します。たとえば、次のようにします。
-
ビューのプロパティを変更して、promotionFriendlyIdを指定します。たとえば、次の例です。
-
アクションを実行します。