匿名セッションのユースケース

ユーザーがアプリケーションで認証されると、匿名セッションとActionsを使用して、ショッピングカートの内容、設定、閲覧履歴などの匿名セッションデータを認証済みユーザーのユーザープロファイルに移行できます。 Actions では、event.anonymous_session オブジェクトを参照できます。

{
  user_id: string;     // 匿名ユーザーのID 
  session_id: string;  // 匿名セッショントークンのID
  created_at: number;  // 匿名セッションの作成日時のタイムスタンプ
  expires_at: number;  // 匿名セッションの有効期限のタイムスタンプ
  metadata: {          // 匿名セッションのメタデータオブジェクト
    [key: string]: string
  };
}

匿名セッションとActionsのユースケース

匿名セッションのメタデータを新規ユーザーに保存する

ユーザーがサインアップする際に、pre-user-registration Action トリガーを使用して、匿名メタデータを新しいユーザープロファイルにコピーできます。

exports.onExecutePreUserRegistration = async (event, api) => {
  if (event.anonymous_session) {
    // 匿名セッションへの参照を保存
    api.user.setAppMetadata(
      'linked_anonymous_id',
      event.anonymous_session.user_id
    );

    // カートデータを移行
    if (event.anonymous_session.metadata.cart) {
      api.user.setAppMetadata(
        'migrated_cart',
        event.anonymous_session.metadata.cart
      );
    }

    // 設定をユーザーメタデータにコピー
    if (event.anonymous_session.metadata.preferences) {
      api.user.setUserMetadata(
        'preferences',
        event.anonymous_session.metadata.preferences
      );
    }
  }
};

匿名セッションのメタデータを既存ユーザーに保存する

ユーザーのログイン時に、post-login Action トリガーを使用して、匿名メタデータを既存ユーザーに保存できます。

exports.onExecutePostLogin = async (event, api) => {
  if (event.anonymous_session) {
    // 最後の匿名セッションへの参照を保存する
    api.user.setAppMetadata(
      'last_anonymous_session',
      event.anonymous_session.user_id
    );

    // APIで処理できるように、匿名カートをaccess tokenに追加する
    api.accessToken.setCustomClaim(
      'anonymous_cart',
      event.anonymous_session.metadata.cart
    );

    // リンクされたすべてのセッションを追跡する（任意）
    const linkedSessions =
      event.user.app_metadata?.linked_sessions || [];
    if (!linkedSessions.includes(event.anonymous_session.user_id)) {
      api.user.setAppMetadata('linked_sessions', [
        ...linkedSessions,
        event.anonymous_session.user_id,
      ]);
    }
  }
};

ユーザーメタデータに匿名メタデータを統合する

ユーザーがログインした際に、post-login Action トリガーを使用して、カート情報などの匿名メタデータを既存のユーザーメタデータに統合できます。

exports.onExecutePostLogin = async (event, api) => {
  if (!event.anonymous_session?.metadata?.cart) {
    return; // マージ対象の匿名カートがない
  }

  const anonymousCart = event.anonymous_session.metadata.cart;
  const existingCart = event.user.app_metadata?.cart || { items: [] };

  // カート内の商品をマージし、SKUが一致する場合は数量を合算する
  const mergedItems = [...existingCart.items];
  for (const anonItem of anonymousCart.items) {
    const existingIndex = mergedItems.findIndex(
      (item) => item.sku === anonItem.sku
    );
    if (existingIndex >= 0) {
      mergedItems[existingIndex].qty += anonItem.qty;
    } else {
      mergedItems.push(anonItem);
    }
  }

  api.user.setAppMetadata('cart', { items: mergedItems });
  api.accessToken.setCustomClaim('cart', { items: mergedItems });
};

複数の匿名セッションを処理する

ユーザーのログイン時に、post-login Action トリガーを使用して、異なるデバイスの匿名セッションのメタデータを管理できます。

exports.onExecutePostLogin = async (event, api) => {
  if (!event.anonymous_session) return;

  const linkedSessions =
    event.user.app_metadata?.linked_sessions || [];

  // オプション1: リンクされたセッションをすべて保持する
  api.user.setAppMetadata('linked_sessions', [
    ...linkedSessions,
    {
      user_id: event.anonymous_session.user_id,
      linked_at: new Date().toISOString(),
      device: event.request.user_agent,
    },
  ]);

  // オプション2: 最新のもののみを保持する
  api.user.setAppMetadata('last_anonymous_session', {
    user_id: event.anonymous_session.user_id,
    metadata: event.anonymous_session.metadata,
  });
};

詳細情報

匿名セッションを設定する

匿名セッションの設定方法を学びます。

匿名セッションのカスタムクレームを設定する

匿名セッションのメタデータをアクセストークンのクレームにマッピングする方法を学びます。