Braze Web SDK タグ構成ガイド

サポートされているバージョン

Braze Web SDK タグは、タグテンプレートバージョン 3.3 およびそれ以前をサポートしています。最適なタグのパフォーマンスと機能性を得るために、最新のタグテンプレートに更新することをお勧めします。

タグのヒント

注文IDが存在する場合に購入イベントが発火します。
以下の E-Commerce 拡張パラメータをサポートしています：
- 顧客ID（_ccustidを上書き）
- 市区町村（_ccityを上書き）
- 国（_ccountryを上書き）
- 注文ID（_corderを上書き）
- 小計（_csubtotalを上書き）
- 通貨（_ccurrencyを上書き）
- 製品ID（_cprodを上書き）
- 製品数量（_cquanを上書き）
標準構成値を動的に上書きするためにマッピングを使用します。

タグの構成

タグマーケットプレイスにアクセスして新しいタグを追加します。タグを追加する方法についての詳細は、タグの管理を参照してください。

タグを追加した後、以下の構成を構成します：

コードバージョン
- 使用したい Braze Web SDK のメジャー.マイナーバージョンを入力します。
- 例えば、バージョン 4.8.1 をデプロイする場合は、4.8 を入力します。
- コードバージョン 4.0 以降は Internet Explorer をサポートしていません。
- Braze Web SDK の最新バージョンについては、変更履歴を参照してください。
API キー
- Braze ダッシュボードの アプリグループ管理 構成で利用可能なユニークな API キー。
ベース URL
- 割り当てられた Braze クラスターを指す API エンドポイント。
- 4.0 の例：https://js.appboycdn.com/web-sdk/4.0/braze.no-amd.min.js
- 3.5 およびそれ以前のバージョンの例：https://js.appboycdn.com/web-sdk/3.5/appboy.no-amd.min.js
- オプションのリストについては、Braze SDK エンドポイントを参照してください。
ログの有効化
- 有効にすると、ウェブコンソールにデバッグ情報が記録されます。

ロードルール

ロードルールは、サイト上でこのタグのインスタンスをいつ、どこでロードするかを決定します。

データマッピング

マッピングは、データレイヤー変数からベンダータグの対応する宛先変数にデータを送信するプロセスです。(詳細を学ぶ)

Braze Web SDK タグの宛先変数は、タグのデータマッピングタブに組み込まれています。以下の表は、利用可能な宛先カテゴリをリストし、各宛先名を説明しています。

標準

目的地名	説明
`api_key`	APIキー「Manage App Group」構成の下にあるBrazeダッシュボードで利用可能なユニークなAPIキー。
`code_version`	コードバージョン Braze Web SDKをロードするメジャー.マイナーバージョン。例えば、最新の6.8.xリリースをデプロイするには`6.8`と入力します。
`initOpt.allow_crawler`	クローラーを許可ウェブクローラーからのすべてのアクティビティをBrazeに記録させる。オプションは `true` または `false`。
`initOpt.app_ver`	アプリバージョンデータを関連付けるアプリのバージョン。
`initOpt.base_url`	ベースURL Brazeが提供するカスタムエンドポイントへの完全なURL。
`initOpt.no_cookies`	クッキーなし Brazeがユーザー情報をクッキーに保存するのを防ぐ。オプションは `true` または `false`。
`initOpt.no_fntawsm`	フォントアウェサムなし Brazeが `FontAwesome` をロードするのを防ぐ。オプションは `true` または `false`。
`initOpt.enable_htmlmsgs`	メッセージ内のHTMLを有効にする Brazeユーザーがアプリ内メッセージを通じてHTMLを送信できるようにする。オプションは `true` または `false`。
`initOpt.enable_logging`	ログを有効にするウェブコンソールにBrazeのエラーメッセージを表示させる。オプションは `true` または `false`。
`initOpt.localization`	ローカリゼーションブラウザのデフォルト言語を上書きするISO 639-1言語コード。
`initOpt.min_trggrinterval`	アクション間の最小間隔別のトリガーアクションが発生するまでの時間（秒）。デフォルト値は `30`。
`initOpt.msg_innewtab`	新しいタブでアプリ内メッセージを開くアプリ内メッセージのリンクを新しいタブまたはウィンドウで開くように強制する。オプションは `true` または `false`。
`initOpt.card_innewtab`	新しいタブでニュースフィードカードを開くニュースフィードカードのリンクを新しいタブまたはウィンドウで開くように強制する。オプションは `true` または `false`。
`initOpt.explicit_dissmisal`	明示的な解除を要求するユーザーがメッセージを解除するためにボタンをクリックすることを強制する。オプションは `true` または `false`。
`initOpt.safari_pushid`	SafariウェブサイトプッシュID Safariプッシュ証明書からのID。
`initOpt.srvcewrkr_location`	サービスワーカーの場所ルートディレクトリにない場合の`service-worker.js`ファイルへのパス。
`initOpt.session_timeout`	セッションタイムアウトセッションがタイムアウトするまでの時間（分）。デフォルト値は `30`。
`initOpt.devicePropertyAllowlist`	デバイスプロパティ許可リスト収集するデバイスプロパティの配列。リストにないプロパティは収集から除外されます。
`initOpt.enableSdkAuthentication`	SDK認証を有効にする Brazeサーバーへのネットワークリクエストに現在のユーザーの最後に知られているJSONウェブトークンを追加する。この構成はバージョン3.5以降で利用可能です。オプションは `true` または `false`。
`initOpt.sdk_auth_signature`	SDK認証署名 SDK認証が有効な場合にSDKリクエストを認証するために使用されるJSONウェブトークン。この構成はバージョン3.5以降で利用可能です。
`initOpt.allow_user_supplied_javascript`	ユーザー提供のJavaScriptを許可するアプリ内メッセージでユーザー提供のJavaScriptの実行を許可する。オプションは `true` または `false`。
`initOpt.content_security_nonce`	コンテンツセキュリティNonce コンテンツセキュリティポリシーの準拠のためにBraze SDKスクリプトタグに含めるべきnonce文字列。
`initOpt.disable_push_token_maintenance`	プッシュトークンメンテナンスを無効にするセッション開始時の自動プッシュトークンリフレッシュを無効にする。オプションは `true` または `false`。
`initOpt.in_app_message_zindex`	アプリ内メッセージZindex アプリ内メッセージオーバーレイのデフォルトz-indexを上書きする。

E-コマース

Braze Web SDKタグはE-コマース対応であり、デフォルトのE-コマース拡張マッピングを自動的に使用します。このカテゴリで手動でマッピングする必要は通常ありませんが、拡張マッピングを上書きしたい場合や、拡張に提供されていないE-コマース変数がある場合は必要です。

目的地名	説明
`order_id`	注文ID `_corder`を上書きします。
`order_subtotal`	小計 `_csubtotal`を上書きします。
`order_currency`	通貨 `_ccurrency`を上書きします。
`customer_id`	顧客ID `_ccustid`を上書きします。
`customer_city`	顧客の市 `_ccity`を上書きします。
`customer_country`	顧客の国 `_ccountry`を上書きします。
`product_id`	配列製品IDのリスト `_cprod`を上書きします。
`product_quantity`	配列数量のリスト `_cquan`を上書きします。

イベント

特定のイベントをページでトリガーするためにこれらの目的地にマッピングします。

イベントをトリガーするには、以下の手順を使用します：

ドロップダウンリストからイベントを選択します。

事前定義されたリストから選択するか、カスタムイベントを作成できます。
カスタムイベントの場合、それを識別する名前を入力します。

トリガー フィールドにマッピングされる変数の値を入力します。
より多くのイベントをマッピングするには、+ ボタンをクリックして手順1と2を繰り返します。
適用をクリックします。

以下の表は、データレイヤーで指定された値が見つかったときにイベントトリガーをリストしています。

目的地名	説明
`Purchase`	購入ログ現在のユーザーによるアプリ内購入が行われます。注文IDが存在する場合、購入イベントは自動的に構成されます。
`Alias`	ユーザーエイリアスの追加現在のユーザーの新しいエイリアスが追加されます。
`addToSubscriptionGroup`	メールまたはSMSのサブスクリプショングループにユーザーを追加します。この構成はバージョン3.5以降で利用可能です。
`AddAtt`	カスタム属性を配列に追加カスタム属性配列に新しい属性が追加されます。
`IncAtt`	カスタム属性のインクリメント現在のカスタム属性配列にある属性を増やします。
`RmvAtt`	カスタム属性を配列から削除カスタム属性配列から属性を削除します。
`SetAtt`	ユーザー属性の構成現在のユーザーの新しいカスタム属性を構成します。
`SetAvatar`	アバターの構成現在のユーザーのアバターURLを構成します。バージョン4.0以降では利用できません。
`SetLoc`	最後の位置の構成現在のユーザーの最後に知られている位置を構成します。
`SetDOB`	生年月日の構成現在のユーザーの生年月日（日、月、年）を構成します。
`SetEmail`	メールの構成現在のユーザーのメールを構成します。
`SetEmailSub`	メールサブスクリプションタイプの構成現在のユーザーのメールサブスクリプションの通知タイプを構成します。
`SetPushSub`	プッシュサブスクリプションタイプの構成現在のユーザーのプッシュ通知の通知タイプを構成します。
`SetFirst`	名の構成現在のユーザーの名を構成します。
`SetLast`	姓の構成現在のユーザーの姓を構成します。
`SetCity`	ホームシティの構成現在のユーザーの都市を構成します。
`SetCountry`	国の構成現在のユーザーの国を構成します。
`SetLang`	言語の構成現在のユーザーの言語を構成します。
`SetPhone`	電話番号の構成現在のユーザーの電話番号を構成します。
`SetGender`	性別の構成現在のユーザーの性別を構成します。
`removeFromSubscriptionGroup`	サブスクリプショングループから削除メールまたはSMSのサブスクリプショングループから現在のユーザーを削除します。この構成はバージョン3.5以降で利用可能です。
`setCustomLocationAttribute`	カスタム位置属性の構成現在のユーザーのカスタム位置属性（キー、緯度、経度）を構成します。
`SetLineId`	LINE IDの構成現在のユーザーのLINEメッセージングアプリIDを構成します。
`Ecommerce`	イーコマースイベントのログ現在のユーザーの構造化されたイーコマースイベントをログします。この構成はバージョン6.0以降で利用可能です。
`WipeData`	データのワイプ（ローカルSDKデータの削除）ローカルに保存されたすべてのSDKデータを削除し、SDKを無効にします。さらなるデータ収集を再開する前に、SDKを明示的に再有効化する必要があります。
`RefreshFeatureFlags`	フィーチャーフラグの更新 Brazeから現在のユーザーのフィーチャーフラグを更新するよう要求します。
`LogFeatureFlagImpression`	フィーチャーフラグインプレッションのログ指定されたフィーチャーフラグのインプレッションイベントをログします。
`RefreshContentCards`	コンテンツカードの更新 Brazeからコンテンツカードフィードを更新するよう要求します。
`ShowContentCards`	コンテンツカードの表示コンテンツカードフィードを表示します。
`LogContentCardImpressions`	コンテンツカードインプレッションのログコンテンツカードの配列のインプレッションイベントをログします。
`LogContentCardClick`	コンテンツカードクリックのログ特定のコンテンツカードのクリックイベントをログします。
`RequestPushPermission`	プッシュ通知の許可を要求ユーザーにプッシュ通知の許可を求めます。
`UnregisterPush`	プッシュの登録解除現在のデバイスをプッシュ通知から登録解除します。
`FlushData`	データのフラッシュキューに入れられた分析データを直ちにBrazeサーバーに送信します。
`RefreshBanners`	バナーの更新指定された配置IDのBrazeバナーを更新するよう要求します。この構成はバージョン6.0以降で利用可能です。
`LogBannerImpressions`	バナーインプレッションのログバナー配置IDの配列のインプレッションイベントをログします。この構成はバージョン6.0以降で利用可能です。
`LogBannerClick`	バナークリックを記録特定のバナーのクリックイベントを記録します。この構成はバージョン6.0以降で利用可能です。
`InsertBanner`	バナーを挿入指定された配置IDのバナーを取得し、指定された親要素に挿入します。この構成はバージョン6.0以降で利用可能です。
`Custom`	カスタム現在のユーザーによって作成されたカスタムイベントを送信します。

パラメータ

これらの目的地にデータをマッピングして、以前にマッピングされたイベントにデータを渡します。パラメータは事前定義されたイベントでのみ使用されます。カスタムイベントでパラメータを渡す方法については、以下のカスタムイベントデータセクションを参照してください。

事前定義されたイベントにパラメータを渡すには、次の手順を使用します：

イベントフィールドで、ドロップダウンリストからイベントを選択します。
パラメータフィールドで、ドロップダウンリストからパラメータを選択します。
カスタムパラメータの場合、カスタムイベントを識別する名前を入力します。
+ 追加をクリックします。

目的地名	説明
`product_id`	商品ID アプリ内で購入された商品のユニークID。 `_cprod`を上書きします。
`product_quantity`	商品数量アプリ内で購入された商品の数量。これはeコマース値`_cquan`を上書きします。
`order_id`	注文ID アプリ内購入のユニークID。 `_corder`を上書きします。
`order_subtotal`	注文小計アプリ内購入の小計。 `_csubtotal`を上書きします。
`order_currency`	注文通貨アプリ内購入のISO 4217通貨コード。 `_ccurrency`を上書きします。
`purchase_properties`	購入プロパティアプリ内購入の追加プロパティのオブジェクト。
`alias`	ユーザーエイリアス現在のユーザーの識別子。
`label`	エイリアスラベルエイリアスのソースなど、エイリアスのラベル。
`key`	カスタム属性キーカスタム属性の識別子。送信するパラメータの名前を入力します。
`value`	カスタム属性値カスタム属性の値。送信するパラメータの名前を入力します。
`inc_value`	カスタム属性増分値カスタムユーザー属性を増分する値。送信するパラメータの名前を入力します。減少させるには負の数を使用します。デフォルト値は`1`です。
`custom_attributes`	カスタム属性オブジェクト現在のユーザーに一度に構成するカスタム属性キー値ペアのオブジェクト。
`line_id`	ユーザーのLINE ID 現在のユーザーのLINEメッセージングアプリID。
`feature_flag_id`	フィーチャーフラグID 印象を記録するためのフィーチャーフラグのユニーク識別子。
`banner_placement_ids`	バナー配置ID（配列またはコンマ区切り）バナー配置IDの配列またはコンマ区切りの文字列で、リフレッシュまたは印象を記録します。この構成はバージョン6.0以降で利用可能です。
`banner_placement_id`	バナー配置ID 単一のバナー配置のユニーク識別子で、取得して挿入します。この構成はバージョン6.0以降で利用可能です。
`banner_click_id`	バナークリックID クリックされたバナーのクリック追跡ID。この構成はバージョン6.0以降で利用可能です。
`banner_parent_selector`	バナーペアレントセレクタ（CSS）バナーが挿入される親要素を識別するCSSセレクタ文字列。この構成はバージョン6.0以降で利用可能です。
`content_cards`	コンテンツカード配列印象を記録するためのコンテンツカードオブジェクトの配列。
`content_card`	コンテンツカードオブジェクトクリックを記録するための単一のコンテンツカードオブジェクト。
`ecommerce_event_name`	イーコマースイベント名記録するイーコマースイベントの名前。この構成はバージョン6.0以降で利用可能です。
`ecommerce_properties`	イーコマースプロパティイーコマースイベントのプロパティのオブジェクト。 `source`フィールドをサポートし、デフォルトは`“tealium”`です。この構成はバージョン6.0以降で利用可能です。
`avatar_url`	アバター画像URL 現在のユーザーが選択したアバターのURL。バージョン4.0以降では利用不可です。
`longitude`	ユーザーの経度ユーザーの位置の検証済み経度、度単位。値は`-180`から`180`です
`latitude`	ユーザーの緯度ユーザーの位置の検証済み緯度、度単位。値は`-90`から`90`です
`accuracy`	位置精度ユーザーの経度と緯度の精度、メートル単位。
`altitude`	ユーザーの高度ユーザーの位置の高度（メートル単位）。
`altitude_accuracy`	高度の精度ユーザーの高度の精度（メートル単位）。
`year`	ユーザーの生年現在のユーザーの誕生日に関連する年。
`month`	ユーザーの誕生月現在のユーザーの誕生日に関連する月。
`day`	ユーザーの誕生日現在のユーザーの誕生日に関連する日。
`email`	ユーザーのメールアドレス現在のユーザーの検証済みメールアドレス。
`notification_type`	通知の種類現在のユーザーの選択された通知タイプ。オプション: `opted_in`, `subscribed`, `unsubscribed`
`first_name`	ユーザーの名前現在のユーザーの名前。
`subscriptionGroupId`	サブスクリプショングループID サブスクリプショングループの一意の識別子。
`last_name`	ユーザーの姓現在のユーザーの姓。
`gender`	ユーザーの性別現在のユーザーの性別コード。オプションは男性 (`m`), 女性 (`f`), その他 `o`。
`customer_city`	ユーザーの居住都市現在のユーザーの居住都市。 `_ccity`を上書き。
`customer_country`	ユーザーの国現在のユーザーの国。 `_ccountry`を上書き。
`localization`	ユーザーの言語現在のユーザーの表示言語のISO 639-1言語コード。
`phone_number`	ユーザーの電話番号現在のユーザーの電話番号。数字、スペース、`+`, `.`, `-`, `(`, `)` の文字のみ許可

カスタムイベントデータ

イベントタブで以前にマッピングしたカスタムイベントにカスタムパラメータを渡したい場合、カスタムイベントデータの目的地にマップします。

カスタムイベントデータ変数をマッピングするには、以下の手順に従ってください：

イベント名に、イベントタブで指定されたカスタムイベントの名前を入力します。
パラメータに、送信したいパラメータの名前を入力します。
+ 追加をクリックします。

クッキー同意

ユーザーの同意状態に基づいてBraze SDKが有効または無効になるように、クッキー同意の目的地にマップします。同意ゲーティングはSDKの初期化前に実行されます。

値	説明
`grant`	SDKを有効にし、データ収集を進めます。SDKは初期化され、セッションが通常通り開始されます。
`revoke`	初期化前にSDKを無効にします。データは収集されず、セッションは開始されません。

ベンダー文書

Braze Web SDK