バリエーション名の取得

バリエーション名の取得

お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

概要  

バリエーション名取得APIは、指定された実験を評価し、実験のインプレッションを記録せずに、訪問者に割り当てられたバリエーションを返します。このAPIは、実験を表示済みとして記録せずに、割り当てられたバリエーションを判定する必要がある場合に役立ちます。

使用するタイミング  

実験を有効化せずに、訪問者に割り当てられたバリエーションを取得する必要がある場合は、バリエーション名取得APIを使用します。使用例は次のとおりです。
  • バリエーションの割り当てをプレビューする場合。
  • バックエンドで意思決定を行う場合。
  • ホームページで実験を有効化し、そのバリエーションを他のページで使用する場合。
  • 実験のインプレッションを記録しないアプリケーション内部のロジックで使用する場合。

メソッドシグネチャ  

get_variation_name(
experiment_name: str,
user_context: PageSenseUserContext
) -> str

パラメーター  

パラメーター
必須
説明
experiment_name
str
はい
FullStack A/Bテスト実験の名前。
user_context
PageSenseUserContext
はい
実験の評価時に使用する訪問者情報。

戻り値  

説明
str
実験のインプレッションを記録せずに、割り当てられたバリエーションを返します。バリエーションが割り当てられていない場合は、空の文字列を返します。

使用例  

from pagesense import PageSenseUserContext
# Create the user attributes
user_attributes = {
'Browser': 'Chrome',
'Device': 'Desktop'
}
# Create the PageSenseUserContext object
user_context = PageSenseUserContext(
user_id='USER_001',
user_attributes=user_attributes
)
# Get the Variation details
variation_name = pagesense_client.get_variation_name(
experiment_name,
user_context
)

動作の仕組み  

SDKは、実験のインプレッションイベントの追跡を除き、実験有効化APIで使用されるものと同じ訪問者評価プロセスを実行します。
  1. 指定された実験を検証します。
  2. 設定されたオーディエンスターゲティングルールに基づいて訪問者を評価します。
  3. 訪問者が実験のトラフィック割り当て範囲内に該当するかどうかを判定します。
  4. MurmurHashアルゴリズムによる決定論的なバケット割り当てを使用して、訪問者をバリエーションに割り当てます。
  5. 割り当てられたバリエーション名を返します。
実験有効化API」とは異なり、このAPIは実験のインプレッションイベントを記録しません

 注意事項  

  • バリエーションの割り当てに一貫性を持たせるため、固定の訪問者識別子を使用してください。
  • 訪問者のリクエストのライフサイクル全体で、同じPageSenseUserContextを再利用してください。
  • オーディエンスターゲティングは、PageSenseUserContextで使用可能な属性を使用して評価されます。
  • 返されたバリエーション名を使用して、バリエーション固有のアプリケーションロジックを実行できます。