‏ملحق Meta للأعمال‏
عودة إلى اللغة ‏العربية‏
تم تحديث هذا المستند.
لم تكتمل الترجمة إلى اللغة ‏العربية‏ حتى الآن.
تاريخ تحديث المصدر باللغة الإنجليزية: ‏١٨ أكتوبر‏
تاريخ تحديث اللغة ‏العربية‏: ‏١١‏/١٠‏/٢٠٢٣‏

FBE Marketplace Onboarding

Facebook Business Extension (FBE) allows your sellers to easily run ads across the Facebook family of apps by connecting existing Facebook assets such as a Facebook Page or Business Manager or by creating entirely new assets. FBE can be used to help seamlessly onboard marketplace sellers to Meta solutions.

Below are the key steps specific to the marketplace flow. We recommend that you use these steps in tandem with the main developer docs.

FBE Marketplace Flow

Partner = Marketplace

FBE = Facebook Business Extension (Facebook-owned UI)


Before You Start

  1. Your app must be owned by a Business Manager that is a verified business. Learn more about how to verify your business.
  2. A Facebook app is required with the following permissions approved via App Review:

  • Private permission

    1. manage_business_extension — This is a private permission that requires your Meta representative to add your app to the allow list. Reach out to your Meta representative for assistance.

  • Public permissions (marketplace needs to request these through App Review).

    1. business_management — required to get back Business Manager ID created through FBE and to use Business Manager API to manage business assets.
    2. ads_management — required to manage sellers’ ads on behalf of the client.

Key Steps for FBE and Collaborative Ads API

  • Seller (brand) launches FBE setup pop-up screen through the marketplace website
  • Seller goes through the FBE onboarding flow and completes setup of core assets (Business Manager, Page, and so on)
  • FBE returns that the seller has successfully set up asset IDs (via API or Webhook). Once marketplace receives the IDs, the catalog segment can be created/shared via API or UI (using the Collaboration Center tool within Business Manager).
  • Seller launches the FBE Management View, where they can view the status of the created catalog segment, and accept the Terms of Service (if it’s the first time the seller is receiving a catalog segment request from the marketplace).
  • Marketplace redirects the seller to the ads creation flow (existing producer flow - Ads Manager and so on.)

Required Configurations

Extras

FieldDescription

setup

Type: setup

Required.

Seller’s Facebook setup, such as their unique identifier (external_business_id) or the currency of their catalog (currency). See setup object details.

business_config

Type: business_config

Required.

Configuration object that the Meta Business Extension uses to configure the Meta Business Extension workflow. See business_config object details.

repeat

Type: boolean

Required.

Set this value to false.

Setup

FieldDescription

external_business_id
Type: string

Required.
Unique business ID to represent your client's business. We use this as a unique identifier. For example, if the seller's company is called "Fubar", then "fubar-123" could be their external_business_id.

timezone
Type: string

Required.
The time zone in which the business is located. See possible time zone values.

currency
Type: string

Required.
Three-letter ISO currency code of the default currency used by the business's catalog items. See supported currency codes.

business_vertical
Type: enum

Required.
Vertical associated with the business for Marketplace is ECOMMERCE

merchant_settings_id
Type: string

Optional.
Used when upgrading from Facebook Business Extension, v1. Contact your Facebook representative if you are migrating from v1 to v2.

channel
Type: enum

Required.
Provides a way for the partner to express intent for the user regarding features that require additional steps or constraints:


Note: The channel for the Marketplace specific FBE flow is MARKETPLACE. Please make sure that you pass this in the channel field.

business_manager_id
Type: string

Optional.
Business Manager ID for user's existing Business Manager that a partner can enter to preselect for the user in the setup flow.

page_id
Type: string

Optional.
Page ID for the user's existing Facebook Page the partner can enter to preselect for the user in the setup flow.

Business Config

Use this object to configure the business settings for an end user; this includes Messenger and more. Each field includes a "type" linked to the respective tables below.

FieldDescription

business
FBEBusinessPropertiesConfigData

Required.
Information for the end user's business

messenger_chat
FBEMessengerChatConfigData

Optional.
Messenger chat features on the end user's Facebook page, such as enabled and domains

catalog_feed_scheduled
FBECatalogFeedConfigData

Optional.
Determines if the Facebook Business Extension should use a feed approach, which grabs catalog items from a feed_url

page_cta
FBEPageCtaConfigData

Optional.
Call to action (CTA) button on end user's page, such as cta_button_text, cta_button_url, etc.

ig_cta
FBEIGCtaConfigData

Optional.
Features for the Instagram call-to-action feature, such as enabled, cta_button_text, cta_button_url, etc.

messenger_menu
FBEMessengerMenuConfigData

Optional.
Features for the Messenger persistent menu feature, such as cta_button-text and cta_button_url

After Installation

  • Get asset IDs, verify Webhook notifications and Pixel events.
  • Once the asset IDs are received, create/share the catalog segment via API or UI (using the Collaboration Center tool within Business Manager).
  • Once the catalog segment creation API call is successful, check here for details on launching the FBE Management View pop-up to have the seller accept the shared catalog segments and complete the onboarding.

Launch the FBE Management View after the FBE set up is completed and the asset IDs are successfully returned through Webhooks / APIs.