マイグレーションガイド: FBE v1からFBE v2へ

このマイグレーションガイドでは、FBE v1の既存の販売者がFBE v2との互換性を持つために必要な変更について説明します。

更新内容

FBE v2は技術的な実装の面でFBE v1とは大幅に異なっているため、FBE v2の種々のガイドに従い実装とベストプラクティスを実行するよう強くおすすめします。

FBE v1FBE v2

起動画面

認証と設定にはビジネスログインを活用します。管理ビューは、別個に起動されます。

ピクセル

ピクセルでは同様の実装になりますが、サーバーサイドAPIが追加されます。

カタログ

同様の実装になります。プル(フィード)手法ではなくプッシュ(API経由)を使用するよう強くおすすめします。詳細はFBE v2.0カタログのドキュメントをご覧ください。

メッセージ送信

廃止されました。現在、ビジネス情報を取得するには、WebhookとFBEインストールエンドポイントの2つのオプションがあります。

ビジネスログイン

FBE v2用ビジネスログインを開始する際には、merchant_settings_id設定オブジェクトに指定してください。FBE v1のmerchant_settings_idは、メッセージに入れてset merchant settings(リファレンス)経由で渡され、FBE v1のユーザーを返すための適切なFBEビューをポップアップするためには事前にパートナー側に保管されていなければなりません。

URL経由

https://facebook.com/dialog/oauth?client_id=<YOUR_FB_APP_ID>
&display=<popup|window|page>
&redirect_uri=<REDIRECT_URI> // e.g. "https://partner-site.com/redirectlanding"
&response_type=token
&scope=manage_business_extension,catalog_management
&extras={
    "setup": {
        "external_business_id": "<YOUR_ID_FOR_THE_BUSINESS>", // e.g. "foo-123"
        "timezone": "<BUSINESS_TIMEZONE>", // e.g. "America/Los_Angeles"
        "currency": "<BUSINESS_SERVICES_CURRENCY>", // e.g. "USD"
        "business_vertical": "ECOMMERCE"
        "merchant_settings_id": "<MERCHANT_SETTINGS_ID_FROM_FBE_V1>",
     },
     ...
}

SDK経由

function launchFBE() {
        FB.login(function (response) {
            if (response.authResponse) {
                // returns a User Access Token with scopes requested
                const accessToken = response.authResponse.accessToken;
                const message = {
                    'success':true,
                    'access_token':accessToken,
                };
                // store access token for later  
            } else {
              console.log('User cancelled login or did not fully authorize.');
            }
        }, {
            scope: 'catalog_management,manage_business_extension',
          // refer to the extras object table for details
            extras: {
                "setup":{
                  "external_business_id":"<external_business_id>",
                  "timezone":"America\/Los_Angeles",
                  "currency":"USD",
                  "business_vertical":"ECOMMERCE",
                  "merchant_settings_id": "<MERCHANT_SETTINGS_ID_FROM_FBE_V1>",
                },
                ...
            }
        });
    }

まだFBE v2にマイグレーションできていないユーザーは、理想を言えばmerchant_settings_idをビジネスログインでのみ渡す必要があります。merchant_settings_idが渡されると、ユーザーが選択したFBE v1のアセットを取得して、ユーザーのマイグレーション処理を効率化します。



merchant_settings_idをFBE設定フローで提供すると、次のマイグレーション手順を行うよう促されます。

  • ユーザーにFBE v1のすべてのアセットとそれぞれのビジネスマネージャに対する管理者アクセスがある場合、左に示すように、1画面でのマイグレーションを行うよう促されます。このマイグレーションでは、事前に選択されたビジネスマネージャはピクセルのビジネスマネージャの次にマイグレーションします。これは、ピクセルを他のビジネスマネージャにマイグレーションできないためです。

  • ユーザーにFBE v1のすべてのアセットに対する管理者アクセスがあるものの、ピクセルがビジネスマネージャに所有されていない場合、左に示すように、1画面でのマイグレーション(ただし編集機能付き)を行うよう促されます。このシナリオのユーザーの場合、既存のビジネスマネージャを選択することも、新しいビジネスマネージャを作成することもできます。

  • すべてのアセットとそれぞれのビジネスマネージャに対する管理者アクセスがない場合、右に示すように、エラー画面にリダイレクトされます。このマイグレーションでは、通常のFBE設定フローに従い各アセットを選択する必要があります。