文档已更新。
中文(简体) 译文尚未完成。
英语更新时间:2022年11月25日

入门引导集成

店铺入门引导是让卖家集成到 Meta 电商的必要步骤。通过流畅的入门引导流程,卖家可以及时更新自己的产品,实时同步订单信息,轻松开展季度或年度查核,并妥善设置银行与进账信息,以便及时进账和报告。

第三方平台/解决方案提供方需采取以下操作:

  • 您需要借助 Facebook Business 扩展程序 (FBE) 为卖家提供 Meta 电商的入门引导流程。此过程通常需要实现登录流程。通过登录流程,您的第三方网站或移动应用程序可以提醒卖家输入其 Facebook 或 Instagram 凭证。根据您要构建的集成类型,卖家还可以选择您的应用需要访问的 Meta 资产,例如 Instagram 帐户或商品目录。此流程结束时,系统会生成访问口令,您可以存储该口令,并用其代表相关卖家发出 API 调用。此口令可用于在商家的系统中创建系统用户。此解决方案更具持续性,可以在商家系统中实现程序化功能,而无需担心用户离职。
  • 您需要获得正在 Facebook 与 Instagram 渠道中开展销售活动的所有店铺(即您支持的卖家)的访问口令。

要求

您需要与 Facebook Business 扩展程序 (FBE) 集成并确保卖家可以执行以下操作,以达到店铺集成质量标准

  • 在平台中轻松探索 Meta 集成
  • 关联第三方帐户与 Meta 资产,例如商务管理平台、现有目录(如适用)、现有 Pixel 像素代码(如适用)、公共主页、Instagram 帐号
  • 设置和编辑站内店铺设置,例如退货设置、法律信息、银行帐户信息、税务信息
  • 将其他资产链接至店铺,例如公共主页、Instagram 帐号
  • 编辑设置
  • 退出

准备工作

  1. 将已认证的商家集成到 Facebook Business 扩展程序
  2. 将 Facebook Business 扩展程序添加到您的应用,然后获取对 Facebook Business 扩展程序开发者面板的访问权限。查看此图表,了解适用于电商的 Facebook Business 扩展程序流程。
  3. 按照 Facebook Business 扩展程序设置步骤操作,然后提交集成进行 Facebook Business 扩展程序集成审核。在操作过程中,您需要在平台中实现 Facebook Business 扩展程序功能管理体验,以便商家能够更改功能,甚至卸载 Facebook Business 扩展程序设置

要求 1:与 Facebook Business 扩展程序集成

Facebook Business 扩展程序 (FBE) 是 Meta 的弹窗式界面,以插件的形式在第三方网站上运行,可简化与 Meta 集成的整体流程。借助 Facebook Business 扩展程序,商家可轻松设置 Meta Pixel 像素代码、目录以及店铺。Facebook Business 扩展程序可帮助商家在您的平台上关联其产品和服务与 Facebook 和 Instagram 渠道。关联完成后,您即可帮助商家运用多种强大功能。

简而言之,采用基于 Facebook Business 扩展程序的集成时,各方责任划分大致如下:

  • Meta 的责任:界面、身份验证、连接,以及用于查看关联资产、管理已安装功能和查看电商集成状态的界面 [(Facebook Business 扩展程序管理视图)](Facebook Business 扩展程序功能管理视图
  • 合作伙伴的责任:Pixel 像素代码设置、通过 API 将库存上传到 Facebook 目录

设置完成后,您的任何商家都可以通过现有资产开始 Facebook Business 扩展程序入门引导流程,也可以选择创建新资产或将现有资产与新资产结合,从而开始此流程。

第 1 步:在您的应用中添加 Facebook Business 扩展程序的入口点

创建 Facebook Business 扩展程序的入口点,以便用户在其中选择、管理或创建其资产(例如商家、目录、店铺、Pixel 像素代码等)。这些入口点的可用形式如下:

  • 企业登录(又称为“Facebook 登录”)— 可允许企业使用您网站中的按钮从您的平台中启动其连接。
  • 业务应用 — 可允许企业从 Meta 界面启动其连接。为实现此流程并确保已将您的应用列为 Meta 的业务应用,您必须在网站中提供自定义身份验证用户界面。此用户界面必须允许用户选择其企业,然后根据用户选择的信息将其重定向回 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,您可借助该口令获取更多资产,例如 Pixel 像素代码编号、公共主页编号和 Instagram 商家编号
  • 业务应用 — 借助 Webhooks

第 2 步:设置 FBE_install Webhooks

所有想在应用商店上架的合作伙伴均须设置 Webhooks。如果您未计划在应用商店中上架应用,则可以选择忽略此部分或稍后再返回查看。每当企业安装、修改或卸载 Facebook Business 扩展程序时,Meta 便会触发 Webhooks 事件。每次收到 Webhooks 事件后,您的应用应可以使用该事件了解企业在与您应用的连接中修改、添加或移除了哪些资产。您应用的行为应该根据最新的关联资产进行更新。强烈建议您实现 Webhooks 订阅并加以测试

如要设置 Webhooks,请采取以下操作:

  1. 在可以妥善处理 Meta 请求的安全服务器上创建端点。
  2. 在应用面板中,按照以下步骤配置您的 Facebook Business 扩展程序 Webhooks 描述:
    1. 依次前往 FBE 部分 > Webhooks 选项卡,输入您应用的回调网址
    2. 输入验证口令,然后验证您的端点。

设置完成后,系统便会自动订阅 fbe_install Webhooks。

如需进一步了解详细步骤,请参阅 Webhooks

通知

收到有关安装的 Webhooks 通知后,您需要执行以下步骤:

  1. 存储访问口令(及其类型),并记录企业已授权您应用访问的资产。
  2. 根据授权的资产启用一系列功能。
  3. 如果缺少特定功能所需的资产,请仅禁用该功能。例如,如果您的应用获得访问目录的授权,但是未获得 Pixel 像素代码的访问权限,则只实现目录支持的功能,而不实现 Pixel 像素代码支持的功能。
  4. 根据应用有权访问的资产,通知用户关于应用运行方式的更新。

收到有关现有安装的动态更新后,您需要执行以下步骤:

  1. 更新已为您授权的资产的访问口令和记录。
  2. 根据已向平台授权的资产,更新您的应用要为卖家启用的一系列功能。
  3. 根据应用有权访问的资产,通知用户关于应用运行方式的更新。

收到有关卸载的通知后,您需要执行以下步骤:

  1. 禁用您的应用为相关卖家实现的功能。
  2. 通知卖家有关其配置变更的相关事宜。

第 3 步:通过返回的口令获取资产详情

您可以在以下 2 种方法中任选其一或同时使用,通过 Facebook Business 扩展程序获取关联到您平台的企业的相关信息:

  • Webhooks — 所有想在应用商店上架的合作伙伴均须设置 Webhooks。设置 Webhooks 后,如果企业通过 Facebook Business 扩展程序开始入门引导流程或编辑,您便可借助在第 2 步中设置的 Webhooks,在 Webhooks 负载中收到该企业的详细信息。
  • Facebook Business 扩展程序安装 API 端点推荐自托管企业使用这个方法。对于任何已安装 Facebook Business 扩展程序的企业,您都可以使用 fbe_installs 端点查询其基本安装信息。您可以使用企业的访问口令和外部企业编号调用 Facebook Business 扩展程序安装 API 端点,以获取企业的详细安装信息

您必须设置上述方法中的至少一种。您需要获取企业的资产编号才能为该企业妥善配置相关功能。

示例:Facebook Business 扩展程序安装 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 步:获取系统用户口令

在用户安装 Facebook Business 扩展程序后,该扩展程序将在客户的商务管理平台上生成工作人员系统用户。请注意,此系统用户虽然在商务管理平台中已不再可见,但是在后端中仍然存在。我们会遵循 {App Name} System User (FBE) 模式为此新系统用户命名。

该系统用户口令和 API 访问权限与单个用户无关。如果有工作人员离职或停用其个人主页,上述特性便会非常实用。如果安装 Facebook Business 扩展程序后,您通过 Webhooks 或企业登录收到用户访问口令,便可使用该口令获取商务管理平台的系统用户访问口令。

为此,请作出以下 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_managementcatalog_managementpages_read_engagementbusiness_managementinstagram_basicmanage_business_extension 权限。

  • 如果您的应用需要读取和管理企业的广告帐户,请请求 ads_management 权限。获取此权限后,您便能够创建广告系列、获取广告指标以及构建广告管理工具等。
  • 如果应用需要创建、读取、更新或删除企业拥有并且担任管理员的商品目录,则您应该请求 catalog_management 权限。建议您为所有应用请求此权限。这样做可确保您的应用能够构建与电商相关的动态广告以及库存管理解决方案。

第 5 步:设置管理视图

除安装时指定的功能以外,如要允许企业配置更多功能,您可以将企业从您的平台引导至我们的 Facebook Business 扩展程序功能管理视图。您可以使用 JavaScript SDK 或网址添加入口点,以便启动 Facebook Business 扩展程序管理视图。这 2 种方法都需要显示按钮,点击后即可启动 Facebook Business 扩展程序管理视图窗口。

第 6 步:添加用于卸载 Facebook Business 扩展程序的入口点

您应为平台添加一个入口点(例如按钮),以便企业卸载 Facebook Business 扩展程序。为实现此操作,我们建议您向相应端点发出 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 Webhooks,则可在用户卸载 Facebook Business 扩展程序时收到事件。