コンテンツにスキップ

データ収集のカスタムルール

Action

このドキュメントでは、React Native SDK における Action 自動収集のカスタムルールについて説明します。

enableAutoTrackUserAction を有効にすると、SDK は React Native コンポーネントのクリック操作を自動収集します。Babel プラグインをインストールしていない場合、SDK は従来のランタイム自動収集方式を引き続き使用します。Babel プラグインをインストールすると、SDK はコンパイル段階でサポート対象のインタラクションハンドラーにトラッキングを追加し、より安定して可読性の高い action_name を生成します。

Babel プラグインによる Action 名の自動生成

SDK 0.4.3 以降でサポートされています。

Babel プラグインのバージョンは、react-native-mobile パッケージのバージョンと一致させる必要があります。

プラグインのインストール

Babel プラグインを開発依存関係としてインストールします:

npm install --save-dev @cloudcare/react-native-mobile-babel-plugin

プロジェクトの babel.config.js でプラグインを有効化します:

module.exports = {
  presets: ['module:metro-react-native-babel-preset'],
  plugins: [
'@cloudcare/react-native-mobile-babel-plugin',
],
};

enableAutoTrackUserAction を引き続きランタイムスイッチとして使用します。RUM 設定の追加は不要です:

const rumConfig: FTRUMConfig = {
  androidAppId: Config.ANDROID_APP_ID,
  iOSAppId: Config.IOS_APP_ID,
  enableAutoTrackUserAction: true,
};

await FTReactNativeRUM.setConfig(rumConfig);

Babel プラグインを有効化すると、SDK は Babel の自動収集経路のみを使用し、従来のランタイム経路との重複レポートを回避します。プラグインをインストールしていない場合、従来の自動収集動作は変更されません。

Action 名の生成ルール

プラグインは次の優先順位で action_name を生成します:

  1. ft-action-name 静的属性;
  2. actionNameAttribute で設定されたカスタム静的属性;
  3. accessibilityLabel 静的属性;
  4. trackingLabel、title、label、text、カスタムコンテンツ属性、またはコンポーネントの children;
  5. JSX コンポーネント名。

デフォルトではコンポーネント名のプレフィックスが保持されます。たとえば、次のコンポーネントで生成される action_name は Button ("Submit") です:

<Button
  ft-action-name="Submit"
  title="Pay now"
  onPress={submit}
/>

ft-action-name が設定されていない場合、上記の例では accessibilityLabel、title、コンポーネント名の順に試行されます。明示的な Action 名属性は静的文字列のみをサポートし、コンテンツ属性では式を使用できます。

カスタムコンポーネントの設定

プラグインはデフォルトで、react-native から名前付きでインポートされた Button、Pressable、TouchableOpacity、TouchableHighlight、TouchableWithoutFeedback、TouchableNativeFeedback、Switch、TextInput を認識し、import alias をサポートします。カスタムコンポーネントは components.tracked で設定できます:

このうち、ボタンと Touchable 系は onPress を収集し、Pressable は onLongPress も収集します。Switch は onValueChange、TextInput は onFocus を収集します。

module.exports = {
  presets: ['module:metro-react-native-babel-preset'],
  plugins: [
    [
'@cloudcare/react-native-mobile-babel-plugin',
{
        actionNameAttribute: 'analytics-name',
        components: {
          useContent: true,
          useNamePrefix: true,
          tracked: [
            {
              name: 'CustomButton',
              contentProp: 'caption',
              handlers: [
                {
                  event: 'onPress',
                  actionType: 'submit',
                },
              ],
            },
          ],
        },
      },
    ],
  ],
};
設定項目 型 デフォルト値 説明
actionNameAttribute string - 追加の静的 Action 名属性を設定します。優先順位は ft-action-name より低くなります
components.useContent boolean true コンテンツ属性と children から名前を抽出するかどうか
components.useNamePrefix boolean true Button ("Submit") 形式のコンポーネント名プレフィックスを生成するかどうか。無効にすると Submit のみを生成します
components.tracked Array [] 追跡するカスタムコンポーネントを設定します
tracked[].name string - JSX コンポーネント名。Menu.Item 形式のメンバーコンポーネントも設定できます
tracked[].contentProp string - 追加のコンテンツ属性を指定します
tracked[].handlers Array - 追跡するインタラクション属性を設定します
tracked[].handlers[].event string - コンポーネントのインタラクションハンドラー属性名(例:onPress)
tracked[].handlers[].actionType string click RUM の action_type にレポートする値を設定します。省略、空文字列、または空白文字のみの場合は click を使用します
tracked[].handlers[].mode string default delayed に設定すると、ハンドラーを実際のインタラクション関数を返すファクトリ関数として扱います

tracked[] では useContent と useNamePrefix を個別に設定し、components レベルのデフォルト値を上書きできます。

複数の候補名を持つ複合コンポーネントでは、SDK はインタラクションハンドラーの最初の数値引数を使用して名前を選択します。引数が有効なインデックスでない場合は、最初の候補名を使用します。

使用上の制限

  • プラグインは startAction(actionName, actionType, property) を介して Action をレポートします。actionType はデフォルトで click を使用しますが、カスタムコンポーネントの handler 設定で安定した低カーディナリティのカスタム値を指定することもできます;
  • import * as ReactNative from 'react-native' 形式の namespace import は自動認識されません;
  • Web ビルドおよび node_modules 配下のファイルは変換されません;
  • TextInput に onFocus がない場合、プラグインは元のコンポーネント名を使用し、かつ spread 属性が存在しない安全なシナリオでのみハンドラーを注入します;
  • ft-enable-track と ft-extra-property は引き続き有効です。イベントに React Native Fiber target が含まれない場合、デフォルトで収集を許可し、拡張属性は追加しません。

特定のコンポーネントのクリックイベントの actionName をカスタマイズする

Babel プラグインをインストールした後は、ft-action-name で設定することを推奨します。プラグインをインストールしていない場合は、引き続き accessibilityLabel で設定できます。

<Button
  title="Custom Action Name"
  ft-action-name="custom_action_name"
  accessibilityLabel="custom_action_name"
  onPress={() => {
    console.log('btn click');
  }}
/>

特定のコンポーネントのクリックイベントを収集しない

ft-enable-track カスタムパラメータを追加し、値を false に設定します。

<Button
  title="Action Click"
  ft-enable-track="false"
  onPress={() => {
    console.log('btn click');
  }}
/>

特定のコンポーネントのクリックイベントに追加属性を付与する

ft-extra-property カスタムパラメータを追加して設定します。値は JSON 文字列である必要があります。

<Button
  title="Action 添加额外属性"
  ft-extra-property='{"e_name": "John Doe", "e_age": 30, "e_city": "New York"}'
  onPress={() => {
    console.log('btn click');
  }}
/>

フィードバック

このページは役に立ちましたか?