フロー定義REST API

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

フロー定義REST APIを使用すると、フロー定義に対してCRUD操作を実行できます。フロー定義は、Web、インタラクティブ、またはトリガーされた実験またはエクスペリエンスです。

フロー定義には、次の属性を使用します。

属性	種類	形容	使用例
name	糸	フロー定義の名前。	"Alert bar"
friendlyId	糸	フロー定義の一意のID。小文字の英数字とアンダースコアのみを使用できます。	"alert_bar_1"
type	string enum (大文字)	フロー定義のタイプ。 Web実験またはエクスペリエンスの場合は、この値を "INTERACTIVE_WEB_FLOW"に設定します。インタラクティブな実験またはエクスペリエンスの場合は、この値を "INTERACTIVE_API_FLOW"に設定します。トリガーによる実験またはエクスペリエンスの場合は、この値を "TRIGGERED_V3"に設定します。	次のいずれかである必要があります。 "INTERACTIVE_WEB_FLOW" "INTERACTIVE_API_FLOW" "TRIGGERED_V3"
subtype	string enum (大文字)	フローのサブタイプ。この値は "EXPERIMENT" または "EXPERIENCE"に設定します。	次のいずれかである必要があります。 "EXPERIMENT" "EXPERIENCE"
status	string enum (大文字)	フロー定義のステータス。テストやエクスペリエンスを作成するときは、この値を "DRAFT"に設定します。	次のいずれかである必要があります。 "DRAFT" "PUBLISHING" "PRODUCTION" "SCHEDULED" "LIVE" "PAUSED" "COMPLETED"
channels	大文字の文字列の配列 (enum)	ユーザーがブランドとやり取りするタッチポイント。たとえば、Webページの場合、チャネルは "WEB"です。モバイルアプリの画面の場合、チャネルは "MOBILE_APP"です。	すべての文字列は次のいずれかである必要があります。 "CALL_CENTER" "EMAIL" "MOBILE_APP" "MOBILE_WEB" "PUSH_NOTIFICATION" "SMS" "WEB"
businessProcess	糸	ウェブまたはインタラクティブな実験やエクスペリエンスの場合は、この値を "interactive_v1"に設定します。トリガーによる実験またはエクスペリエンスの場合は、この値を "triggered_v1"に設定します。	"interactive_v1" "triggered_v1"
variants	配列	同じテストの異なるバージョン。エクスペリエンスの場合は、この値を空の配列に設定します。
traffic	オブジェクト	実験の場合、このオブジェクトは、実験の各バリアントにゲストの何パーセントを露出させるかを決定します。エクスペリエンスの場合、このオブジェクトは、ゲストの何パーセントをエクスペリエンスに公開するかを決定します。	該当なし
schedule	オブジェクト	テストまたはエクスペリエンスを実行できる期間。	該当なし
sampleSizeConfig	オブジェクト	主な目標を持つ実験の場合、このオブジェクトはA/Bテストのパラメーターを定義します。これらのパラメータは、検定が統計的有意性に到達するために必要な最小サンプルサイズに影響します。	該当なし
archived	ブーリアン	フロー定義のアーカイブステータス。	true, false
revisions	オブジェクトの配列	フロー定義のリビジョンの配列。	該当なし
revision	整数	テンプレートリビジョンの連番。	2

trafficオブジェクト:

属性	種類	形容	使用例
type	文字列列挙型	テストのトラフィック割り当てタイプ。エクスペリエンスの場合は、これを "simpleTraffic" または "advancedTraffic"に設定します。	次のいずれかである必要があります。 "simpleTraffic" "advancedTraffic"
weightingAlgorithm	文字列列挙型	実験で各バリアントに与えられる重みを決定するアルゴリズム。	次のいずれかである必要があります。 "MULTI_ARMED_BANDIT" "USER_DEFINED"
coupled	ブーリアン	この値は、実験が他の実験と結合されるかどうかを定義します。連成実験の場合、すべてのゲストには、ゲスト参照に基づいて永続的なバケット番号が割り当てられます。バケット番号は、すべての結合実験でゲストに対して同じままです。	true, false
allocation	整数最小0。最大100。	実験の場合は、この値を実験に公開するゲストの割合に設定します。エクスペリエンスの場合は、この値を100に設定します。	100
splits	オブジェクトの配列	テストの場合は、トラフィックを複数のパターンに分割する方法を指定します。各オブジェクトはバリアントを表します。各オブジェクトでは、refはバリアント参照です。 splitは、バリアントが受信するトラフィックの割合を表す数値です。エクスペリエンスの場合は、この値を空の配列に設定します。	該当なし

以下は、ゲストの60% が1つのパターンに、40% が別のバリアントに公開されるテストのsimpleTrafficトラフィックの例です。

{
  "traffic": {
    "type": "simpleTraffic",
    "weightingAlgorithm": "USER_DEFINED",
    "splits": [
      {
        "ref": "71206a12-b1b0-4baa-93ea-a0752a2762b0",
        "split": 60
      },
      {
        "ref": "ffe19d2a-b531-468d-a155-fedf757208e5",
        "split": 40
      }
    ]
  }
}

以下は、テストのadvancedTeafficトラフィックの例です。バケツ1から11のゲストは、実験にさらされることはありません。バケット12から55のゲストは1つの変異株に曝露し、バケット56から120のゲストは別の変異株に曝露します。

{
  "traffic": {
    "type": "advancedTraffic",
    "weightingAlgorithm": "USER_DEFINED",
    "modifiedAt": "2025-07-21T16:09:54.583Z",
    "allocationLow": 12,
    "allocationHigh": 120,
    "splits": [
      {
        "ref": "3e0c4419-5679-47e8-9d95-7f34b074af4b",
        "lowSplit": 12,
        "highSplit": 55
      },
      {
        "ref": "61705a82-a5d2-4a0f-920f-2c0990897b39",
        "lowSplit": 56,
        "highSplit": 120
      }
    ]
  }
}

scheduleオブジェクト:

属性	種類	形容	使用例
type	文字列列挙型	フロースケジュールのタイプ。この値を "simpleSchedule"に設定します。	"simpleSchedule"
startDate	文字列 (ISO 8601)	フローを実行できる最も早い時間。	2025-07-04T11:46:41.810Z
endDate 随意	文字列 (ISO 8601)	フローを実行できる最後の可能な時間。	2025-07-22T12:00:00.810Z

属性

種類

形容

使用例

type

文字列列挙型

フロースケジュールのタイプ。

この値を "simpleSchedule"に設定します。

"simpleSchedule"

startDate

文字列 (ISO 8601)

フローを実行できる最も早い時間。

2025-07-04T11:46:41.810Z

endDate

随意

文字列 (ISO 8601)

フローを実行できる最後の可能な時間。

2025-07-22T12:00:00.810Z

sampleSizeConfigオブジェクト:

属性	種類	形容	使用例
baseValue	数	メイン目標の予想コンバージョン目標の値。デフォルトは0.02です。	0.02
minimumDetectableDifference	数	基本値に対して検出する最小コンバージョン目標の差。デフォルトは0.2です。	0.2
confidenceLevel	数	テストが完了したと見なされる前に必要な信頼水準。この値は、帰無仮説が真である場合、測定された差がランダムな変動によるものではないという組織の信頼度を表します。デフォルトは0.95です。	0.95

属性

種類

形容

使用例

baseValue

数

メイン目標の予想コンバージョン目標の値。

デフォルトは0.02です。

0.02

minimumDetectableDifference

数

基本値に対して検出する最小コンバージョン目標の差。

デフォルトは0.2です。

0.2

confidenceLevel

数

テストが完了したと見なされる前に必要な信頼水準。

この値は、帰無仮説が真である場合、測定された差がランダムな変動によるものではないという組織の信頼度を表します。

デフォルトは0.95です。

0.95

この記事を改善するための提案がある場合は、お知らせください!