「Messengerに送信」プラグイン

2024年9月30日以降、この機能は利用できなくなります。利用者をMessengerの特定の人、ページ、スレッドにリダイレクトするm.me linksなどの機能は、引き続き利用できます。

Facebookアプリが開発モードの場合、プラグインとAPI機能は、有効なセッションに入っているアプリの管理者、開発者、テスト担当者のみ使用できます。アプリが承認されて公開された後は、一般の人も使用できるようになります。

Webhookの認証イベントをトリガーするには、「Messengerに送信」プラグインが使われます。データを渡してその認証イベントにどのユーザーとトランザクションが結び付けられていたかを知り、ユーザーをバックエンドでリンクすることができます。

このボタンをユーザーが初めてクリックすると、確認ポップアップが表示されます。

要件

Facebook JavaScript SDK

「Messengerに送信」プラグインを使うには、そのプラグインがレンダリングされるページの中に、Facebook for JavaScript SDKを含める必要があります。

SDKを含める手順については、Facebook for Javascript SDKクイックスタートをご覧ください。

設定

<div class="fb-send-to-messenger" 
  messenger_app_id="<APP_ID>" 
  page_id="PAGE_ID" 
  data-ref="<PASS_THROUGH_PARAM>" 
  color="<blue | white>" 
  size="<standard | large | xlarge>">
</div>

利用可能な属性の詳しい説明については、「Messengerに送信」プラグインのリファレンスをご覧ください。

イベントサブスクリプション

プラグインイベントをサブスクリプション登録します。

<script>

      FB.Event.subscribe('send_to_messenger', function(e) {
      // callback for events triggered by the plugin

      });

      </script>

イベントフィールド

フィールド名 説明

event

列挙型

イベントの名前。値はrenderedclickednot_youopt_inのいずれか。

ref

文字列

プラグインのdata-refパラメーターで設定されている値が入れられます。使用できる文字は英数字と「-」「_」「=」のみです。

is_after_optin

ブーリアン

イベントが、確認ポップアップで確認された後に発生したものかどうかを示します。

pluginID

未定義

このフィールドは使われていません。

Webhookイベント

「Messengerに送信」プラグインは、messaging_optins Webhookイベントをトリガーします。

ログイン動作のカスタマイズ

ログインしているFacebookユーザーがいない場合、プラグインはユーザーIDを表示せずにレンダリングされます。ボタンをクリックすると、ユーザーにログインを促すプロンプトが表示されます。

allow_loginをfalseに設定すると、プラグインはログインしていないユーザーのレンダリングを行いません。

プラグインがFacebookセッションなしでレンダリングするのは、アプリが承認されて公開されている場合のみです。

CTAのテキストオプション

「Messengerに送信」プラグインでは、cta_text属性もサポートされています。それにより、事前定義されている文字列リストからプラグインのボタンテキストを選択できます。cta_text属性が使われている場合、サインイン済みユーザーの多くは、ポップアップで再確認しなくてもプラグインのボタンをクリックするだけでオプトインでき、messaging_optinsイベントがすぐに配信されます。

cta_text属性でサポートされている値は、次のとおりです。

  • GET_THIS_IN_MESSENGER
  • RECEIVE_THIS_IN_MESSENGER
  • SEND_THIS_TO_ME
  • GET_CUSTOMER_ASSISTANCE
  • GET_CUSTOMER_SERVICE
  • GET_SUPPORT
  • LET_US_CHAT
  • SEND_ME_MESSAGES
  • ALERT_ME_IN_MESSENGER
  • SEND_ME_UPDATES
  • MESSAGE_ME
  • LET_ME_KNOW
  • KEEP_ME_UPDATED
  • TELL_ME_MORE
  • SUBSCRIBE_IN_MESSENGER
  • SUBSCRIBE_TO_UPDATES
  • GET_MESSAGES
  • SUBSCRIBE
  • GET_STARTED_IN_MESSENGER
  • LEARN_MORE_IN_MESSENGER
  • GET_STARTED