オンボーディング統合

ショップへのオンボーディングは、販売者によるMetaコマースへの統合を可能にする上で必要な手順です。オンボーディングをシームレスに実施することにより、販売者の商品が最新の状態に保たれ、注文情報が正しく同期され、四半期ごとまたは年ごとの照合が簡単になり、支払いと報告が的確なタイミングで行われるように銀行や支払いの情報が適切に設定されるようになります。

要件

ショップに関する当社の統合品質基準を満たすには、Facebook Business Extension (FBE)と統合する必要があり、そのためには販売者が次のことを行えるようにします。

• プラットフォーム内でMeta統合を簡単に見つける
• それぞれの3PアカウントをMetaアセット(出力マネージャ、既存のカタログ(該当する場合)、既存のピクセル(該当する場合)、ページ、Instagramハンドル)に接続する
• ショップのオンサイト設定(返品設定、法的情報、銀行口座情報、税金情報)の設定と編集
• ショップに追加のアセット(ページ、Instagramハンドル)をリンク
• 設定を編集
• オフボーディング

開始する前に

1. 認証済みのビジネスをFBEに統合します。
2. アプリにFBEを追加して、FBE Developer Panelにアクセスします。この図を確認し、コマースのFBEフローについて理解します。
3. FBE設定ステップに従い、統合をFBE統合レビューに提出します。これには、ビジネスが機能を変更したり、さらにはFBE設定をアンインストールしたりできるように、FBE機能管理エクスペリエンスをプラットフォーム内で有効にすることも含まれます。

要件1: Facebook Business Extensionと統合する

Facebook Business Extension (FBE)は、サードパーティサイト上でプラグインとして動作する、ポップアップによるMeta独自のインターフェイスであり、Metaとの統合処理全般を簡素化します。ビジネスはFBEを利用して、Metaのピクセル、カタログ、およびショップを簡単に設定できます。そうすることで、ビジネスは、それぞれの商品やサービスを該当プラットフォーム上でFacebookやInstagramのさまざまなチャネルにリンクすることができます。一度リンクすれば、機能の充実した大規模なスイートを活用できるようになります。

要約すると、FBEベースの統合でのさまざまな責任は、次に示すように分離されています。

• Metaが所有: 接続されているアセットを表示したり、インストールされている機能やコマース統合のステータスを管理したりするためのインターフェイス、認証、接続およびサーフェス[(FBE管理ビュー)](FBE機能管理ビュー)
• パートナーが所有: ピクセルの設定、API経由でFacebookカタログへのインベントリーアップロード

設定が完了すると、ビジネスは、FBEオンボーディングフローを既存のアセットで、新しいアセットを作成するオプションを設けることで、あるいはその両方を組み合わせることで開始できるようになります。

ステップ1: FBEへのエントリーポイントをアプリに追加する

FBEへのエントリーポイントを作成します。ユーザーはこのFBEからアセット(ビジネス、カタログ、ショップ、ピクセルなど)を選択、管理、または作成できます。エントリーポイントは、次のいずれかの形式を取ることができます。

• ビジネスログイン(Facebookログイン) – ビジネスが、あなたのサイト上に配置したボタンを使って、あなたのプラットフォームからそれぞれの接続を開始できるようにします。
• ビジネスアプリ – ビジネスがMetaサーフェスからそれぞれの接続を開始できるようにします。このフローを有効にして、該当アプリがMetaのビジネスアプリのリストに含まれるようにするには、カスタム認証UIを自分のサイト上に用意する必要があります。このUIでは、ユーザーがビジネスを選択してから、選択した情報に基づいてMetaフローに戻ることができるようになっていなければなりません。

例

https://facebook.com/dialog/oauth?
client_id=<FB_APP_ID>
&display=page
&redirect_uri="https://partner-site.com/redirectlanding"
&response_type=token
&scope=manage_business_extension
//   additionally use catalog_management or ads_management
//   &scope=manage_business_extension,catalog_management,ads_management
&extras={
  "setup": {
    "external_business_id": "foo-123",
    "timezone": "America/Los_Angeles",
    "currency": "USD",
    "domain": "https://example-shop.partner-site.com/",
    "channel": "ECOMMERCE",
    "business_vertical": "ECOMMERCE"
  },
  "business_config": {
    "business": {
      "name": "Foo Business"
    },
    "catalog_feed_scheduled": {
      "enabled": true,
      "feed_url": "https://partner-site.com/feed-url"
    },
    "page_cta": {
      "enabled": true,
      "cta_button_text": "Shop Now",
      "cta_button_url": "https://partner-site.com/foo-business",
      "below_button_text": "Powered by FBE Partner"
    },
    "ig_cta": {
      "enabled": true,
      "cta_button_text": "Shop Now",
      "cta_button_url": "https://partner-site.com/foo-business"
    },
    "messenger_menu": {
      "enabled": true,
      "cta_button_text": "Shop Now",
      "cta_button_url": "https://partner-site.com/foo-business"
    }
  },
  "repeat": false
}

選択の設定によっては、複数の方法でビジネスのアクセストークンを取得することができます。

• ビジネスログイン – 通常のFacebookログイン同様、このフローが終了するとaccess_tokenが返されます。これを使って、さらに多くのアセット(ピクセルID、ページID、Instagram Business IDなど)を取得できます。
• ビジネスアプリ – Webhooks経由。

ステップ2: FBE_install Webhooksを設定する

Webhooksは、アプリストアのリストへの表示を希望するすべてのパートナーに必要です。このセクションは、アプリをアプリストアにリストする予定がない場合は無視することも、後ほど設定することもできます。ビジネスがFBEをインストール、変更、アンインストールするたびに、MetaからWebhookイベントが発行されます。Webhookイベントを受信するたびに、アプリでこのイベントを使い、ビジネスがアプリに接続して変更、追加、または削除したアセットを把握することが見込まれます。アプリでは、最後に接続したアセットに基づいて更新が行われる必要があります。当社のWebhookのサブスクリプションを実装し、テストすることを強くおすすめします。

Webhookの設定手順は次のとおりです。

1. Metaからのリクエストを適切に処理できる安全なサーバー上にエンドポイントを作成します。
2. アプリダッシュボードで、FBE Webhooksの説明を設定します。
1. [FBE]セクション> [Webhooks]タブに、アプリのコールバックURLを入力します。
2. 認証トークンを入力して、エンドポイントを確認してください。

設定後、fbe_install Webhookが自動的にサブスクリプション登録されます。

詳細な手順については、Webhookをご覧ください。

通知

インストールに関するWebhook通知を受け取ったら、以下を行う必要があります。

1. アクセストークン(とそのタイプ)を保管し、アプリによるアクセスが認可されたアセットを記録する。
2. 認可されたアセットに基づいて機能セットを有効にする。
3. 特定の機能に必要なアセットが欠けている場合は、その機能のみ無効にします。例えば、カタログへのアクセスが認可されているが、ピクセルへのアクセスは認可されていないアプリの場合、ピクセル駆動の機能ではなく、カタログ駆動の機能のみを実装します。
4. アプリが、アクセス権を持つアセットに基づいてどのように動作するかに関する最新情報をユーザーに通知します。

既存のインストールに関する最新情報を受け取ったら、以下を行う必要があります。

1. アクセストークンと認可されているアセットの記録を更新します。
2. プラットフォームに認可されているアセットに基づいて、販売者のためにアプリで有効にされる機能セットを更新します。
3. アプリが、アクセス権を持つアセットに基づいてどのように動作するかに関する最新情報をユーザーに通知します。

アンインストールに関する通知を受け取ったら、以下を行う必要があります。

1. 販売者のためにアプリが実装する機能を無効にします。
2. 販売者に対して設定の変更を通知します。

ステップ3: 返されるトークンを使ってアセットの詳細を取得する

FBEを通じてプラットフォームに接続されているビジネスに関する情報は、次の2つの方法のいずれかまたは両方により取得できます。

• Webhook—アプリストアへのリストを希望するすべてのパートナーに必要。Webhookの設定により、FBEを利用したビジネスのオンボーディングまたは編集に関する詳細は、ステップ2のWebbookの設定からWebhookペイロード経由で受け取ることになります。
• FBEインストールAPIエンドポイント—自己ホストビジネスの場合におすすめ。FBEをインストールしたビジネスについては、fbe_installsエンドポイントを使用して基本的なインストール情報をクエリできます。ビジネスのアクセストークンと外部ビジネスIDを使用して、FBEインストールAPIエンドポイントを呼び出し、その設定に関する詳細情報を取得することができます。

例: FBEインストールAPI呼び出し

curl -i -X GET \   "https://graph.facebook.com/<version>/fbe_business/fbe_installs?fbe_external_business_id=<external business id>&access_token=<access token sanitized>"

ステップ4: システムユーザートークンを取得する

FBEは、インストールされるとクライアントのビジネスマネージャに従業員システムユーザーを生成します。このシステムユーザーは、ビジネスマネージャには表示されませんが、バックエンドに存在します。この新しいシステムユーザーは、{App Name} System User (FBE)スキーマに従って命名されます。

そうする場合、次のAPI呼び出しを実行します。

curl -X POST \
  -F 'app_id={app_id}' \
  -F 'scope=ads_management,catalog_management,manage_business_extension' \ 
  -F 'access_token={user_access_token}' \
  -F 'fbe_external_business_id={fbe_external_business_id}' \ 
https://graph.facebook.com/<API_VERSION>/<client_business_manager_id>/access_token

scopeフィールドには、manage_business_extensionアクセス許可を使います。実際の用途に応じて(ステップ5を参照)、ads_management、catalog_management、pages_read_engagement、business_management、instagram_basic、およびmanage_business_extensionのアクセス許可も必要になると思われます。

• アプリでビジネスの広告アカウントを読み取って管理する必要がある場合は、ads_managementのアクセス許可をリクエストしてください。この許可により、広告キャンペーンを作成する、広告指標を取得する、広告管理ツールを構築することなどが可能になります。
• ビジネスが管理者となっているビジネス所有の商品カタログをアプリで作成、読み取り、更新、または削除する必要がある場合は、catalog_managementアクセス許可をリクエストしてください。このアクセス許可はすべてのアプリにおすすめします。このアクセス許可により、アプリがコマース関連、ダイナミック広告、在庫管理ソリューションを構築できるようになります。

ステップ5: 管理ビューを設定する

ビジネスが(インストールで指定したものより)さらに詳細に機能を設定できるようにするため、該当プラットフォームからビジネスに対して、当社のFBE機能管理ビューを表示することができます。JavaScript SDKまたはURLを使って、FBE管理ビューを起動するエントリーポイントを追加できます。どちらの方法でも、クリックしてFBE管理ビューのウィンドウを起動するためのボタンを表示する必要があります。

ステップ6: FBEをアンインストールするためのエントリーポイントを追加する

プラットフォームで、ビジネスがFBEをアンインストールするためのエントリーポイント(ボタンなど)を追加します。これは、適切なエンドポイントにDELETEリクエストを発行して行うことをおすすめします。

例: 当社の削除エンドポイントへの呼び出し

curl -X DELETE \
"https://graph.facebook.com/v<API_VERSION>/fbe_business/fbe_installs?fbe_external_business_id=<FBE_EXTERNAL_BUSINESS_ID>&access_token=<ACCESS_TOKEN>"

fbe_install Webhookを実装している場合は、ユーザーがFBEをアンインストールした時点でイベントを受け取ります。

詳しくはこちら

• Facebook Business Extension (FBE)
• FBE設定手順
• FBE開発者パネル
• FBEをアンインストールする
• Webhooks