FBE Marketplaceのオンボーディング

Facebook Business Extension (FBE)を使うと、販売者はFacebookページやビジネスマネージャなどの既存のFacebookアセットを接続するか、またはまったく新しいアセットを作成することにより、Facebookのアプリファミリー全体で簡単に広告を掲載できます。FBEを使うと、Marketplace販売者はMetaソリューションのオンボーディングをシームレスに行えます。

以下では、Marketplaceフローに固有の主な手順を示します。これらの手順は、メインの開発者向けドキュメントと併せて使うことをおすすめします。

FBE Marketplaceフロー

パートナー = Marketplace

FBE = Facebook Business Extension (Facebookが所有するUI)


開始する前に

  1. アプリは、認証済みビジネスであるビジネスマネージャが所有するアプリでなければなりません。詳しくは、ビジネスの認証方法をご覧ください。
  2. Facebookアプリは、アプリレビューで以下のアクセス許可の承認を受ける必要があります。
  • 非公開アクセス許可

    1. manage_business_extension — これは、Meta担当者がアプリを許可リストに追加する必要がある非公開のアクセス許可です。サポートが必要な場合は、Metaの担当者にお問い合わせください。
  • 公開アクセス許可(Marketplaceはアプリレビューでこれをリクエストする必要があります)

    1. business_management — FBEで作成されたビジネスマネージャIDを取得し、ビジネスマネージャAPIを使用してビジネスアセットを管理するために必要です。
    2. ads_management — クライアントに代わって販売者の広告を管理するために必要です。

FBEとコラボレーション広告APIに関する主な手順

  • 販売者(ブランド)は、MarketplaceウェブサイトからFBEセットアップのポップアップ画面を起動します。
  • 販売者は、FBEのオンボーディングフローを実行して、コアアセット(ビジネスマネージャやページなど)の設定を完了します。
  • FBEは、販売者がアセットIDを正常に設定したという情報を(APIまたはWebhookを介して)返します。MarketplaceがそれらのIDを受信すると、APIまたはUIを介して(ビジネスマネージャ内のコラボレーションセンターツールを使って)カタログセグメントを作成/共有することが可能になります。
  • 販売者はFBE管理ビューを起動します。このビューで、作成されたカタログセグメントのステータスを表示できます。また、販売者がMarketplaceからカタログセグメントリクエストを初めて受信する場合は、利用規約に同意します。
  • Marketplaceは販売者を広告作成フロー(広告マネージャなど、既存のプロデューサーフロー)にリダイレクトします。

必須の構成

Extras

フィールド説明

setup

setup

必須

販売者のFacebookセットアップ。一意の識別情報(external_business_id)やカタログの通貨(currency)など。setupオブジェクトの詳細をご覧ください。

business_config

business_config

必須

Facebook Business ExtensionがFacebook Business Extensionワークフローを構成するために使用する構成オブジェクト。business_configオブジェクトの詳細をご覧ください。

repeat

ブーリアン

必須

この値はfalseに設定します。

設定

フィールド説明

external_business_id
型: 文字列

必須。
クライアントのビジネスを表す一意のビジネスID。Metaはこれを一意の識別情報として使います。例えば、販売者の会社名が「Fubar」である場合、「fubar-123」がexternal_business_idになります。

timezone
型: 文字列

必須。
ビジネスの所在地のタイムゾーン。使用可能なタイムゾーン値をご覧ください。

currency
型: 文字列

必須。
ビジネスのカタログアイテムで使われるデフォルト通貨の3文字のISO通貨コードサポートされる通貨コードをご覧ください。

business_vertical
型: 列挙値

必須。
Marketplaceでビジネスに関連付けられている業種はECOMMERCEです。

merchant_settings_id
型: 文字列

任意。
Facebook Business Extension v1からアップグレードする際に使います。v1からv2に移行する場合は、Facebook担当者にお問い合わせください。

channel
型: 列挙値

必須。
追加の手順または制約が必要となる機能に関して、パートナーがユーザーに意図を伝える手段を提供します。


注: Marketplace固有のFBEフローのchannelは、MARKETPLACEです。必ずこの値をchannelフィールドに渡してください。

business_manager_id
型: 文字列

任意。
セットアップフローでパートナーがユーザーへの事前選択のために入力できる、ユーザーの既存のビジネスマネージャのビジネスマネージャID。

page_id
型: 文字列

任意。
セットアップフローでパートナーがユーザーへの事前選択のために入力できる、ユーザーの既存のFacebookページのページID。

ビジネス構成

このオブジェクトを使用して、エンドユーザーのビジネス設定を構成します。これにはMessengerなどが含まれます。各フィールドにある「型」は、下記の対応する表にリンクしています。

フィールド説明

business
FBEBusinessPropertiesConfigData

必須。
エンドユーザーのビジネスに関する情報。

messenger_chat
FBEMessengerChatConfigData

任意。
エンドユーザーのFacebookページ上のMessengerチャット機能(enableddomainsなど)。

catalog_feed_scheduled
FBECatalogFeedConfigData

任意。
Facebook Business Extensionが、feed_urlからカタログアイテムを取得するフィードアプローチを使うかどうかを決定します。

page_cta
FBEPageCtaConfigData

任意。
エンドユーザーのページ上のコールトゥアクション(CTA)ボタン(cta_button_textcta_button_urlなど)。

ig_cta
FBEIGCtaConfigData

任意。
Instagramのコールトゥアクション機能のための機能(enabledcta_button_textcta_button_urlなど)。

messenger_menu
FBEMessengerMenuConfigData

任意。
Messengerの永続メニュー機能のための機能(cta_button-textcta_button_urlなど)。

インストール後

  • アセットIDの受信後、APIまたはUIを介して(ビジネスマネージャ内のコラボレーションセンターツールを使用して)カタログセグメントを作成/共有します。
  • カタログセグメント作成API呼び出しが成功したら、FBE管理ビューのポップアップの起動について詳細を確認し(こちらを参照)、販売者が共有カタログセグメントを承認してオンボーディングを完了するようにします。

FBEの設定が完了しWebhooks / APIがアセットIDを正常に返すようになったら、FBEマネジメントビューを起動します。