ClientContext の詳細 client-context-in-detail

クライアントコンテキストは、ユーザーデータを動的にまとめたコレクションを表します。このデータに基づいて、特定の状況で web ページ上に表示するコンテンツを決定できます（コンテンツのターゲティング）。このデータは、web サイト分析や、ページ上のあらゆる JavaScript にも使用できます。

ClientContext は、主として次の要素で構成されます。

スタンドアロンのセッションストアを作成して ClientContext に追加するか、コンテキストストアコンポーネントに関連付けられたセッションストアを作成するために、すぐに使用可能なコンテキストストアコンポーネントが Adobe Experience Manager（AEM）によっていくつかインストールされています。これらのコンポーネントは、作成するコンポーネントの基礎として使用できます。

ClientContext の起動、表示する情報の設定、ユーザーエクスペリエンスのシミュレーションについて詳しくは、ClientContext を参照してください。

セッションストア session-stores

ClientContext には、ユーザーデータを格納する様々なセッションストアが含まれます。ストアデータは以下のソースから得られます。

ClientContext フレームワークが提供する JavaScript API は、ユーザーデータの読み取りおよび書き込みや、ストアイベントのリッスンおよび対処のためのセッションストアとのやり取りに使用できます。コンテンツターゲティングなどに使用するユーザーデータ用のセッションストアを作成することもできます。

セッションストアのデータはクライアント上に残ります。ClientContext は、データをサーバーに書き戻しません。データをサーバーに送信するには、フォームを使用するか、カスタム JavaScript を作成してください。

各セッションストアは、プロパティと値のペアのコレクションです。セッションストアは（あらゆる種類の）データのコレクションを表し、その概念的な意味はデザイナーや開発者あるいは両者よって決定されます。次のサンプルの JavaScript コードは、セッションストアに格納されている可能性のあるプロファイルデータを表すオブジェクトを定義しています。

{
  age: 20,
  authorizableId: "aparker@geometrixx.info",
  birthday: "27 Feb 1992",
  email: "aparker@geometrixx.info",
  formattedName: "Alison Parker",
  gender: "female",
  path: "/home/users/geometrixx/aparker@geometrixx.info/profile"
}

セッションストアは、ブラウザーセッションをまたがって保持することも、そのストアが作成されたブラウザーセッションでのみ保持することもできます。

コンテキストストアコンポーネント context-store-components

コンテキストストアコンポーネントは、ClientContext に追加できる CQ コンポーネントです。一般的に、コンテキストストアコンポーネントは、関連付けられているセッションストアのデータを表示します。ただし、コンテキストストアコンポーネントが表示する情報は、セッションストアのデータに限定されません。

コンテキストストアコンポーネントには、次のアイテムを含めることができます。

コンテキストストアに追加できる、インストール済みのコンテキストストアコンポーネントについては、使用可能な ClientContext コンポーネントを参照してください。

ターゲット設定されたコンテンツの配信 targeted-content-delivery

ターゲット設定されたコンテンツの配信にはプロファイル情報も使用します。

ページへの ClientContext の追加 adding-client-context-to-a-page

ClientContext を有効にするには、ClientContext コンポーネントを eb ページの body セクションに含めます。ClientContext コンポーネントノードのパスは /libs/cq/personalization/components/clientcontext です。このコンポーネントを含めるには、次のコードをページコンポーネントの JSP ファイルに追加します。場所は、ページの body 要素のすぐ下です。

<cq:include path="clientcontext" resourceType="cq/personalization/components/clientcontext"/>

ClientContext コンポーネントによって、ClientContext を実装するクライアントライブラリをページが読み込みます。

ClientContext UI は、オーサーインスタンス上でのみ使用可能です。

ClientContext の拡張 extending-client-context

ClientContext を拡張するには、次のようなセッションストアを作成し、オプションでストアデータを表示します。

セッションストアの作成 creating-a-session-store

ClientContext に追加または ClientContext から取得する必要があるデータ用のセッションストアを作成します。一般的に、セッションストアを作成するには次の手順を実行します。

この JavaScript を personalization.stores.kernel クライアントライブラリに含めると、ClientContext フレームワークが読み込まれたときにストアが作成されます。

セッションストアのタイプ types-of-session-stores

セッションストアは、ブラウザーセッション中に作成されて使用可能になるか、ブラウザーストレージまたは Cookie に保持されます。ClientContext JavaScript API によって、次の 2 つのタイプのデータストアを表すクラスが定義されます。

また、API は JSON データまたは JSONP データの格納に特化したこれらのクラスを拡張します。

セッションストアオブジェクトの作成 creating-the-session-store-object

クライアントライブラリフォルダーの JavaScript によってセッションストアを作成し、初期化します。その後、Context Store Manager を使用して、セッションストアを登録する必要があります。次の例では、CQ_Analytics.SessionStore オブジェクトを作成して登録します。

//Create the session store
if (!CQ_Analytics.MyStore) {
    CQ_Analytics.MyStore = new CQ_Analytics.SessionStore();
    CQ_Analytics.MyStore.STOREKEY = "MYSTORE";
    CQ_Analytics.MyStore.STORENAME = "mystore";
    CQ_Analytics.MyStore.data={};
}
//register the session store
if (CQ_Analytics.ClientContextMgr){
    CQ_Analytics.ClientContextMgr.register(CQ_Analytics.MyStore)
}

次の例では、JSON データを格納するために、CQ_Analytics.JSONStore オブジェクトを作成して登録します。

if (!CQ_Analytics.myJSONStore) {
    CQ_Analytics.myJSONStore = CQ_Analytics.JSONStore.registerNewInstance("myjsonstore",{});
}

コンテキストストアコンポーネントの作成 creating-a-context-store-component

ClientContext でセッションストアデータをレンダリングするには、コンテキストストアコンポーネントを作成します。コンテキストストアコンポーネントを作成したら、ClientContext にドラッグして、セッションストアのデータをレンダリングできます。コンテキストストアコンポーネントは、以下のアイテムで構成されます。

提供されているコンテキストストアコンポーネントの拡張 extending-the-provided-context-store-components

AEM が提供する genericstore および genericstoreproperties コンテキストストアコンポーネントは拡張できます。ストアデータの構造によって、拡張するコンポーネントが決まります。

サイドキックでの表示の設定 configuring-the-appearance-in-sidekick

ClientContext の編集時、コンテキストストアコンポーネントがサイドキックに表示されます。すべてのコンポーネントと同様に、ClientContext コンポーネントの componentGroup プロパティと jcr:title プロパティによって、コンポーネントのグループと名前が決まります。

componentGroup プロパティの値が Client Context のすべてのコンポーネントが、デフォルトでサイドキックに表示されます。componentGroup プロパティに異なる値を使用する場合は、デザインモードを使用して、手動でコンポーネントをサイドキックに追加する必要があります。

コンテキストストアコンポーネントインスタンス context-store-component-instances

コンテキストストアコンポーネントを ClientContext に追加すると、コンポーネントインスタンスを表すノードが /etc/clientcontext/default/content/jcr:content/stores の下に作成されます。このノードには、コンポーネントの編集ダイアログを使用して設定するプロパティ値が格納されます。

ClientContext が初期化されると、これらのノードが処理されます。

関連付けられたセッションストアの初期化 initializing-the-associated-session-store

init.js.jsp ファイルをコンポーネントに追加して、コンテキストストアコンポーネントが使用するセッションストアを初期化する JavaScript コードを生成します。例えば、初期化スクリプトを使用して、コンポーネントの設定プロパティを取得し、そのプロパティを使用してセッションストアを設定します。

生成された JavaScript は、オーサーインスタンスおよびパブリッシュインスタンス上でのページの読み込み時に ClientContext が初期化されると、ページに追加されます。この JSP は、コンテキストストアコンポーネントインスタンスが読み込まれ、レンダリングされる前に実行されます。

コードでは、ファイルの MIME タイプを text/javascript に設定する必要があります。それ以外の場合は実行されません。

次の手順を実行すると、init.js.jsp スクリプトファイルが作成され、適切な MIME タイプを設定するコードが追加されます。ストアの初期化を実行するコードがその後に追加されます。

genericstoreproperties コンポーネントのセッションストアデータのレンダリング rendering-session-store-data-for-genericstoreproperties-components

一貫性ある形式を使用して、ClientContext にセッションストアデータを表示します。

プロパティデータの表示 displaying-property-data

パーソナライズタグライブラリが、セッションストアのプロパティの値を表示する personalization:storePropertyTag タグを提供します。このタグを使用するには、JSP ファイルに次のコード行を含めます。

<%@taglib prefix="personalization" uri="https://www.day.com/taglibs/cq/personalization/1.0" %>

タグの形式は次のとおりです。

<personalization:storePropertyTag propertyName="property_name" store="session_store_name"/>

propertyName 属性は、表示するストアプロパティの名前です。store 属性は、登録されたストアの名前です。次のサンプルのタグでは、profile ストアの authorizableId プロパティの値が表示されます。

<personalization:storePropertyTag propertyName="authorizableId" store="profile"/>

HTML 構造 html-structure

personalization.ui クライアントライブラリフォルダー（/etc/clientlibs/foundation/personalization/ui/themes/default）は、ClientContext が HTML コードの書式設定に使用する CSS スタイルを提供します。以下のコードは、ストアデータの表示に使用が推奨される構造を説明したものです。

<div class="cq-cc-store">
   <div class="cq-cc-thumbnail">
      <div class="cq-cc-store-property">
           <!-- personalization:storePropertyTag for the store thumbnail image goes here -->
      </div>
   </div>
   <div class="cq-cc-content">
       <div class="cq-cc-store-property cq-cc-store-property-level0">
           <!-- personalization:storePropertyTag for a store property goes here -->
       </div>
       <div class="cq-cc-store-property cq-cc-store-property-level1">
           <!-- personalization:storePropertyTag for a store property goes here -->
       </div>
       <div class="cq-cc-store-property cq-cc-store-property-level2">
           <!-- personalization:storePropertyTag for a store property goes here -->
       </div>
       <div class="cq-cc-store-property cq-cc-store-property-level3">
           <!-- personalization:storePropertyTag for a store property goes here -->
       </div>
   </div>
   <div class="cq-cc-clear"></div>
</div>

/libs/cq/personalization/components/contextstores/profiledata コンテキストストアコンポーネントは、この構造を使用してプロファイルセッションストアのデータを表示します。cq-cc-thumbnail クラスは、サムネール画像を配置します。cq-cc-store-property-level*x* クラスは、英数字データを次のようにフォーマットします。

genericstore コンポーネント用のセッションストアデータのレンダリング rendering-session-store-data-for-genericstore-components

genericstore コンポーネントを使用してストアデータをレンダリングするには、次の操作を実行する必要があります。

genericstore セッションストアの識別 identifying-the-genericstore-session-store

パーソナライズタグライブラリが、セッションストアのプロパティの値を表示する personalization:storePropertyTag タグを提供します。このタグを使用するには、JSP ファイルに次のコード行を含めます。

<%@taglib prefix="personalization" uri="https://www.day.com/taglibs/cq/personalization/1.0" %>

タグの形式は次のとおりです。

<personalization:storeRendererTag store="store_name"/>

セッションストアのレンダラーメソッドの実装 implementing-the-session-store-renderer-method

セッションストアには、コンポーネントをレンダリングする必要があるたびに呼び出される「レンダラー」メソッドが必要になります。レンダラー関数は、次の 2 つのパラメーターと一緒に呼び出されます。

セッションストアとのやり取り interacting-with-session-stores

セッションストアとのやり取りには、JavaScript を使用します。

セッションストアへのアクセス accessing-session-stores

ストアに対してデータを読み取りまたは書き込むためのセッションストアオブジェクトを取得します。CQ_Analytics.ClientContextMgr を使用すると、ストア名に基づいてストアにアクセスできます。取得したら、CQ_Analytics.SessionStore または CQ_Analytics.PersistedSessionStore というメソッドを使用して、ストアデータとやり取りします。

次の例では、profile ストアを取得し、このストアから formattedName プロパティを取得しています。

function getName(){
   var profilestore = CQ_Analytics.ClientContextMgr.getRegisteredStore("profile");
   if(profilestore){
      return profilestore.getProperty("formattedName", false);
   } else {
      return null;
   }
}

セッションストアの更新に対処するリスナーの作成 creating-a-listener-to-react-to-a-session-store-update

セッションストアはイベントを発生させるので、リスナーを追加して、これらのイベントに基づいてイベントを発生させることができます。

セッションストアは、Observable パターンを基盤として作成されています。セッションストアは CQ_Analytics.Observable メソッドを提供する [addListener](/docs/experience-manager-65/content/implementing/developing/personlization/client-context/ccjsapi.md#addlistener-event-fct-scope) を拡張します。

次の例では、profile セッションストアの update イベントにリスナーを追加しています。

var profileStore = ClientContextMgr.getRegisteredStore("profile");
if( profileStore ) {
  //callback execution context
  var executionContext = this;

  //add "update" event listener to store
  profileStore.addListener("update",function(store, property) {
    //do something on store update

  },executionContext);
}

セッションストアの定義および初期化の確認 checking-that-a-session-store-is-defined-and-initialized

セッションストアは、データを使用して読み込まれ、初期化されるまでは使用可能になりません。セッションストアが使用可能になるタイミングに影響を与える可能性がある要素としては、次のものがあります。

使用可能な場合にのみセッションストアにアクセスするには、CQ_Analytics.ClientContextUtils オブジェクトの onStoreRegistered メソッドと onStoreInitialized メソッドを使用します。これらのメソッドを使用すると、セッション登録イベントおよびセッション初期化イベントに対処するイベントリスナーを登録できます。

次の例では、profile セッションストアの onStoreRegistered イベントを使用しています。ストアが登録されると、リスナーがセッションストアの update イベントに追加されます。ストアが更新されると、ページ上の <div class="welcome"> 要素のコンテンツが profile ストアの名前で更新されます。

//listen for the store registration
CQ_Analytics.ClientContextUtils.onStoreRegistered("profile", listen);

//listen for the store's update event
function listen(){
 var profilestore = CQ_Analytics.ClientContextMgr.getRegisteredStore("profile");
    profilestore.addListener("update",insertName);
}

//insert the welcome message
function insertName(){
 $("div.welcome").text("Welcome "+getName());
}

//obtain the name from the profile store
function getName(){
 var profilestore = CQ_Analytics.ClientContextMgr.getRegisteredStore("profile");
 if(profilestore){
  return profilestore.getProperty("formattedName", false);
    } else {
        return null;
    }
}

sessionpersistence Cookie からのプロパティの除外 excluding-a-property-from-the-sessionpersistence-cookie

PersistedSessionStore プロパティを永続化しないようにする（つまり、sessionpersistence cookie から除外する）には、永続セッションストアの非永続プロパティリストにプロパティを追加します。

参照先 [CQ_Analytics.PersistedSessionStore.setNonPersisted(propertyName)](/docs/experience-manager-65/content/implementing/developing/personlization/client-context/ccjsapi.md#setnonpersisted-name)

CQ_Analytics.ClientContextUtils.onStoreRegistered("surferinfo", function(store) {
  //this will exclude the browser, OS and resolution properties of the surferinfo session store from the
  store.setNonPersisted("browser");
  store.setNonPersisted("OS");
  store.setNonPersisted("resolution");
});

デバイススライダーの設定 configuring-the-device-slider

条件 conditions

現在のページに対応するモバイルページがあることが必要です。この条件が満たされるのは、そのページに、モバイルロールアウト設定で設定されたライブコピーがある（rolloutconfig.path.toLowerCase に mobile が含まれる）場合のみです。

設定 configuration

デスクトップページから対応するモバイルページに切り替える場合：

次は例です。

window.CQMobileSlider["geometrixx-outdoors"] = {
  //CSS used by desktop that need to be removed when mobile
  DESKTOP_CSS: [
    "/etc/designs/${app}/clientlibs_desktop_v1.css"
  ],

  //CSS used by mobile that need to be removed when desktop
  MOBILE_CSS: [
    "/etc/designs/${app}/clientlibs_mobile_v1.css"
  ],

  //id of the content that needs to be removed when mobile
  DESKTOP_MAIN_ID: "main",

  //id of the content that needs to be removed when desktop
  MOBILE_MAIN_ID: "main",

  //body classes used by desktop that need to be removed when mobile
  DESKTOP_BODY_CLASS: [
    "page"
  ],

  //body classes used by mobile that need to be removed when desktop
  MOBILE_BODY_CLASS: [
    "page-mobile"
  ]
};

例：カスタムコンテキストストアコンポーネントの作成 example-creating-a-custom-context-store-component

この例では、外部サービスからデータを取得してセッションストアに保存するコンテキストストアコンポーネントを次のように作成します。

ジオロケーションコンポーネントの追加 add-the-geoloc-component

CQ アプリケーションを作成し、ジオロケーションコンポーネントを追加します。

ジオロケーション編集ダイアログを作成 create-the-geoloc-edit-dialog

コンテキストストアコンポーネントには編集ダイアログが必要です。ジオロケーション編集ダイアログには、設定するプロパティがないことを示す静的メッセージが表示されます。

初期化スクリプトの作成 create-the-initialization-script

init.js.jsp ファイルをジオロケーションコンポーネントに追加し、これを使用してセッションストアを作成し、ロケーションデータを取得してストアに追加します。

init.js.jsp ファイルは、ClientContext がページによって読み込まれると実行されます。この時点までに、ClientContext JavaScript API が読み込まれ、スクリプトで使用できるようになっています。

ジオロケーションセッションのストアデータのレンダリング render-the-geoloc-session-store-data

ClientContext でストアデータをレンダリングするには、ジオロケーションコンポーネントの JSP ファイルにコードを追加します。

ClientContext へのコンポーネントの追加 add-the-component-to-client-context

ページの読み込み時に初期化されるように、場所ストアコンポーネントを ClientContext に追加します。

ClientContext で場所情報を見る see-the-location-information-in-client-context

編集モードで Geometrixx Outdoors のホームページを開き、ClientContext を開いて場所ストアコンポーネントのデータを表示します。

カスタマイズされた ClientContext の作成 creating-a-customized-client-context

2 つ目の ClientContext を作成するには、次の分岐を複製します。

/etc/clientcontext/default

カスタマイズされた ClientContext を使用するには、ClientContext コンポーネントのデザインスタイルの
path
プロパティを、ページテンプレートに含まれているものと同じように編集します。例えば、標準的な場所は次のようになります。
/libs/cq/personalization/components/clientcontext/design_dialog/items/path