メインコンテンツにスキップ
すべてのコレクション解約インサイト
解約インサイトコードの埋め込み
解約インサイトコードの埋め込み

セットアップを成功させるためのヒント

Baremetrics avatar
対応者:Baremetrics
3年以上前に更新

これを機能させるにはコーディングの能力が必要です。プロダクトのコードにアクセスできない場合、またはコードの編集に不安がある場合は、チームのデベロッパーに処理を依頼することをお勧めします。

ただし、このステップを実行するのに数分しかかからないもので、簡単なものです。

埋め込み

セットアップページに表示されている埋め込みコードをコピーすることをお勧めします。

access_token_id

の部分には、トークンが自動的に入力されます。

customer_oid

部分は、動的に渡す必要があるものです。これは、特定のプロバイダーによって提供された顧客OIDです。 (例:Stripe、Recover、Braintreeなど)通常、これはサーバーのデータベースに保存されます。

(プロバイダーのテスト環境とは同期しません。ライブIDのみを使用してください。つまり、解約というイベントが解約インサイトダッシュボードに表示されると予想される場合は常に、実際のライブカスタマーOIDを使用する必要があります。このコードは、現在のキャンセルボタン、フォーム、またはリンクがあるページの終了</ body>タグの前に含める必要があります。)

トリガー

埋め込みコードを入力したら、フォームをトリガーするボタン、フォーム、またはリンクに、barecancel-triggerのHTMLIDを追加する必要があります。

(解約インサイトは、実際には顧客のアカウントをキャンセルしません。プロセスにフォームを挿入し、プロバイダーのアカウントをキャンセルするために使用しているリンクまたはフォームアクションにユーザーを送信するだけです。)

あなたの仕事をテストする

ウィジェットコードを埋め込み、ライブのcustomer_oidに配置したら、テストキャンセルを送信する必要があります。心配しないでください。最初の呼び出しをインターセプトするので、ダッシュボードに渡されてメトリックが混乱することはありません。解約インサイトフォームを送信するだけで、実際の顧客を解約しないでください。

追加の埋め込みコードオプション

カスタマイズが必要な場合のために、いくつかの追加機能があります。

callback_send

「アカウントの解約」ボタンがクリックされた後にトリガーされます。標準のフォーム要素またはリンクリダイレクトを使用していない場合に、実際のアカウント解約イベントを自分の側からキャプチャするのに役立ちます。

<strong><code>window.barecancel.params = {<br> access_token_id: "ABC-123-ACCESS-TOKEN",<br> customer_oid: "CUSTOMER_ID",<br><br> callback_send: function(data) {<br> // Your own callback logic <br> // e.g. <br> axios.delete(`/api/users/${user_id}`)<br> }<br>}

callback_error

Barecancelプロセス内でエラーが発生するたびにトリガーされます。何が悪かったのかを解読するためのすべてのデータを含む1つのエラー引数でスローします。これを使用して、サポートを依頼する前に、独自のエラーをログに記録し、デバッグに役立ててください。

<strong><code>window.barecancel.params = {<br> access_token_id: "ABC-123-ACCESS-TOKEN",<br> customer_oid: "CUSTOMER_ID",<br><br> callback_error: function(err) {<br> // Your own error logic <br> // e.g. <br> console.error(err)<br> }<br>}

test_mode

ローカルまたはステージングをいじくり回して、Baremetricsダッシュボードをテスト解約イベントで乱雑にしたくないはずです。

<strong><code>window.barecancel.params = {<br> access_token_id: "ABC-123-ACCESS-TOKEN",<br> customer_oid: "CUSTOMER_ID",<br><br> test_mode: true<br>}

本番環境にプッシュする前に、必ずこのブール値を削除するか、falseに切り替えてください。

subscription_oids

個々のサブスクリプションの理由を把握する必要がありますか? Subscription_oidsフラグの下でサブスクリプションOIDの配列を送信します。

<strong><code>window.barecancel.params = {<br> access_token_id: "ABC-123-ACCESS-TOKEN",<br> customer_oid: "CUSTOMER_ID",<br><br> // Array of subscription IDs you're looking to cancel<br> subscription_oids: ["EXAMPLE_SUB_1_ID", "EXAMPLE_SUB_2_ID"]<br>}

comment_required

コメントを要求し、オプションでエラーメッセージを設定できます。

<strong><code>window.barecancel.params = {<br> access_token_id: "ABC-123-ACCESS-TOKEN",<br> customer_oid: "CUSTOMER_ID",<br><br> // Can be a Boolean or a String<br> // In case of String we'll use that as the error message <br> // If the comment is not set<br> comment_required: true<br>}

trigger

キャンセルモーダルをトリガーする要素を変更する場合は、document.getQuerySelectorでサポートされている任意のセレクターによってデフォルトの#barecancel-triggerセレクターを変更できます。

<strong><code>window.barecancel.params = {<br> access_token_id: "ABC-123-ACCESS-TOKEN",<br> customer_oid: "CUSTOMER_ID",<br><br> trigger: ".my-custom-trigger-buttons"<br>}

こちらの回答で解決しましたか?