React Native SDKでフローにデータを渡す

カスタムタグは、アプリからの値を持つカスタム変数です。変数の設定で Value comes from outside the app を選択すると、アプリはAdapty SDKを通じてその値を設定できます。たとえば、テキスト要素に「Coins:」とカスタムタグが含まれている場合、アプリがタグに「120」を渡すと、ユーザーには「Coins: 120」と表示されます。

始める前に

Adapty SDK v4 以降が必要です。v4 より前のバージョンではフローが表示されません。

フローにカスタムタグを追加する

アプリの値をフローで表示するには、ビルダーでカスタムタグを設定します。

アプリが渡す各値に対してカスタムタグを作成します。
各タグをテキスト要素に挿入します。
グループ名を含む各タグのフルネームを確認してください。アプリのコードはこの名前で各値を渡します。たとえば、user グループに streak タグが含まれている場合、タグのフルネームは user.streak となります。

カスタムタグの値を渡す

アプリの値をビューパラメータの customTags フィールドにオブジェクトとして渡します。AdaptyFlowView コンポーネントを使う場合は params プロップに、createFlowView を使う場合は第2引数に指定します。

各キーは user.streak のようなカスタムタグのフルネームです。
各値は、タグの代わりにユーザーに表示される文字列です。
各値は “1250.0” ではなく “1,250” のように、人が読める形式にしてください。Adapty は値のフォーマットや翻訳を行いません。

createFlowViewは、ビューの作成時に値を一度だけ読み込むため、フローが開いている間は値が変わりません。マウント済みのAdaptyFlowViewのparamsが変更されると、コンポーネントはフロービューを再作成し、フローは最初の画面から再開します。フローが開いている間はparamsを変更しないようにしてください。


const flowParams = {
  customTags: {
    'username': 'DragonSlayer42',
    'coins': '1,250',
  },
};

function MyFlow({ flow }: { flow: AdaptyFlow }) {
  return <AdaptyFlowView flow={flow} params={flowParams} style={{ flex: 1 }} />;
}


const customTags = {
  'username': 'DragonSlayer42',
  'coins': '1,250',
};

try {
  const view = await createFlowView(flow, { customTags });
  await view.present();
} catch (error) {
  // handle the error
}

カスタムタグをテストするには、タグの値を設定するコードを追加した後、アプリでフローを開いてください。ビルダーのキャンバスおよびデバイスでのプレビューには初期値のみが表示されます。Adapty モバイルアプリはカスタムタグの値を設定しません。

アプリが旧ペイウォールビルダーのペイウォール向けにすでにカスタムタグの値を設定している場合は、フローにおけるカスタムタグの違いを確認してください。

値が設定されていない場合にユーザーに表示されること

以下の場合、ユーザーにはカスタムタグの初期値がフォールバックとして表示されます。

アプリがそのタグに値を渡していない場合。
ユーザーがアプリを値を渡すバージョンにアップデートしていない場合。
アプリのコード内の名前が、大文字・小文字を含めタグのフルネームと一致していない場合。
同じテキスト要素内の別のカスタムタグに値がない場合。その場合、そのテキスト要素内のすべてのカスタムタグが初期値を表示します。

タグの位置に何も表示しないようにするには、空の文字列を渡してください。Adapty は空の文字列を値として扱うため、フォールバックは表示されません。

例：オンボーディングの回答からBMIを表示する

フローはユーザーから回答を収集でき、カスタムタグはアプリの値を表示できます。この2つを組み合わせることで、スコア、おすすめプラン、健康指標など、回答からアプリが計算した結果をユーザーに表示できます：

フローが回答を収集し、アプリに送信します。
アプリが結果を計算します。
アプリが次のフローにカスタムタグの値として結果を渡します。

この例では、オンボーディングフローがユーザーの体重と身長を収集します。ユーザーがオンボーディングフローの最後の画面を閉じると、アプリがBMI（ボディマス指数）を計算します。そして、BMIを表示するペイウォールフローを開きます。

フローを設定する

2つのフローを作成します: ユーザーの体重と身長を収集するオンボーディングフローと、BMIを表示するペイウォールフローです。
オンボーディングフローに2つのNumber入力を追加します:
- 体重（キログラム）用。Element IDをweightに設定します。
- 身長（センチメートル）用。Element IDをheightに設定します。
両方の入力で、FormatをIntegerに設定します。入力はユーザーが入力した通りのテキストとして値を送信するため、サンプルコードは”70.5”と”70,5”を同じように読み取りません。整数には小数点区切り文字がないため、すべてのロケールで同じように読み取られます。
アプリが両方の値を確実に受け取れるよう、オンボーディングフローを入力のない画面で終了させます。その画面に、Close flowアクションを持つボタンを追加します。入力はフォーカスを失ったとき、またはユーザーが別の画面に移動したときに値を送信します。Close flowアクションは値を送信しません。サンプルコードは、ユーザーが最後の画面に到達した場合にのみペイウォールを開きます。
ペイウォールフローで、bmiという名前のカスタムタグを作成します。Initial valueフィールドにダッシュ（—）を入力します。アプリがBMIを渡さない場合、ユーザーにはダッシュが表示されます。
ペイウォールフローに「Your BMI:」という文字列を含むテキスト要素を追加します。この文字列の後に、bmiカスタムタグを挿入します。
オンボーディングフローをonboardingなどのプレースメントに追加します。ペイウォールフローをID bmi_paywallのプレースメントに追加します。BMIをペイウォールに渡すのコードは、このIDでペイウォールを取得します。

ペイウォールにBMIを渡す

オンボーディングフローの flow_user_input イベントから体重と身長を収集します。詳しくはフローからのデータ処理を参照してください。ユーザーが最後の画面に到達したことを確認するには、is_last_screen が true に設定された flow_screen_showed イベントを監視します。詳しくはフロー画面ビューのトラッキングを参照してください。その画面の後にユーザーがオンボーディングフローを閉じたら、BMIを計算します。次にペイウォールのビューを作成し、bmi カスタムタグにBMIを渡します。

createFlowView がオンボーディングフローに対して返すビューである onboardingView に、以下のハンドラを登録します。AdaptyFlowView コンポーネントには onDisappeared ハンドラがないため、この例はそのコンポーネントでは動作しません。


const bodyAnswers = {};
let reachedLastScreen = false;

const unsubscribe = onboardingView.setEventHandlers({
  onAnalytics(name, params) {
    if (name === 'flow_screen_showed' && params.is_last_screen) {
      reachedLastScreen = true;
    }
    if (name === 'flow_user_input' && typeof params.value === 'string') {
      bodyAnswers[params.element_id] = params.value;
    }
    return false; // keep the flow open
  },
  onDisappeared() {
    // Number inputs send their values as strings.
    const weight = Number(bodyAnswers.weight);
    const height = Number(bodyAnswers.height);
    const finished = reachedLastScreen;
    delete bodyAnswers.weight;
    delete bodyAnswers.height;
    reachedLastScreen = false;

    if (finished && weight > 0 && height > 0) {
      const heightInMeters = height / 100;
      const bmi = weight / (heightInMeters * heightInMeters);
      showBmiPaywall(bmi.toLocaleString(undefined, { maximumFractionDigits: 1 }));
    }
    return false;
  },
});

async function showBmiPaywall(bmi) {
  try {
    const flow = await adapty.getFlow('bmi_paywall');
    const view = await createFlowView(flow, { customTags: { 'bmi': bmi } });
    await view.present();
  } catch (error) {
    // handle the error
  }
}

toLocaleString は、ユーザーのロケールに応じた小数点区切り文字を使用します（英語では「22.7」、ドイツ語では「22,7」）。

BMIをユーザーのプロファイルに保存する

BMIに基づいてユーザーに異なるフローを表示するには、BMIをプロファイルのカスタム属性として保存します。Adapty ダッシュボードで、キー bmi を持つ Number 型のカスタム属性を作成し、その属性をもとに作成したオーディエンスごとに各フローを表示します。

onDisappeared内で、bmiを計算する行の直後にupdateProfileメソッドを呼び出してください。フォーマットされた文字列ではなく数値をそのまま渡すことで、セグメントがBMIを閾値と比較できるようになります。onDisappearedはasyncにできないため、awaitの代わりに.catchで結果を処理してください：

adapty
  .updateProfile({ codableCustomAttributes: { bmi } })
  .catch((error) => {
    // handle the error
  });