MBEピクセルおよびコンバージョンAPIのオンボーディング

Meta Business拡張機能(FBE)のピクセルおよびコンバージョンAPIフローを使用すると、ユーザーはビジネスマネージャ、ページ、Metaピクセルを作成または選択できるようになります。このフローは、ウェブサイトホスティング機能を持っているパートナーの場合に推奨されます。パートナーは、このフローの完了後に返されたピクセルを使用して、ブラウザーまたはコンバージョンAPI経由で、クライアントに代わってFacebookにイベントを送信できます。このフローにカタログ機能はありません。

開始する前に

アプリは、認証済みビジネスであるビジネスマネージャが所有するアプリでなければなりません。詳しくは、ビジネスの認証方法をご覧ください。
Facebookアプリには、以下のアクセスレベル、機能、アクセス許可が必要です。
- アクセスレベル: Advanced Access
- 機能: 広告管理への標準アクセス
- 公開アクセス許可: ads_management、pages_read_engagement、ads_read
- 非公開アクセス許可: manage_business_extension — これは、Facebook担当者がアプリを許可リストに追加する必要がある非公開のアクセス許可です。
- システムユーザーアクセストークン: コンバージョンAPIにイベントを送信するには、アクセストークンが必要です。クライアントに代わってアクセストークンを生成するには、FBE経由で返されたアクセストークンを使用し、追加のAPI呼び出しを実行してアクセストークンをシステムユーザーアクセストークンに変換します。

必須の構成

Extras

フィールド型説明

フィールド	型	説明
`setup`	setup	必須販売者のFacebookセットアップ。一意の識別情報(`external_business_id`)やカタログの通貨(`currency`)など。setupオブジェクトの詳細をご覧ください。
`business_config`	business_config	必須 Facebook Business ExtensionがFacebook Business Extensionワークフローを構成するために使用する構成オブジェクト。`business_config`オブジェクトの詳細をご覧ください。
`repeat`	ブーリアン	必須この値は`false`に設定します。

setup

setup

必須

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

business_config

business_config

必須

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

repeat

ブーリアン

必須

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

設定

このオブジェクトを使用して、エンドユーザーのFacebookプレゼンスの設定を定義します。

フィールド	説明
`external_business_id` 文字列	必須クライアントのビジネスを表す一意のビジネスID。Facebookはこれを一意の識別情報として使用します。例えば、販売者の会社の名前が「Fubar」である場合、「fubar-123」を`external_business_id`として指定します。
`timezone` 文字列	任意ビジネスの所在地のタイムゾーン。使用可能なタイムゾーン値をご覧ください。
`currency` 文字列	任意ビジネスのカタログアイテムで使用されるデフォルト通貨の3文字のISO通貨コード。サポートされる通貨コードをご覧ください。
`business_vertical` 列挙型	必須ビジネスに関連付けられている業種値:`ECOMMERCE`
`merchant_settings_id` 文字列	任意 Facebook Business Extension, v1からアップグレードする際に使用します。v1からv2に移行する場合は、Facebook担当者にお問い合わせください。
`domain` 文字列	必須(COMMERCEおよびCOMMERCE_OFFSITEチャネルの場合) Instagramの手動承認に使用されるドメイン。例: `https://exampleshop.partnersite.com`。
`channel` 列挙型	必須パートナーがFBEのコンバージョンAPIフローを構成する手段を提供します。コンバージョンAPIフローでは、この値は`CONVERSIONS_API`でなければなりません。 `CONVERSIONS_API` — エンドユーザーがビジネスマネージャ、広告アカウント、Metaピクセルオブジェクトを作成または選択できるようにするフロー。これらのオブジェクトを作成すると、エンドユーザーはコンバージョンAPIまたはブラウザーピクセル経由で、ウェブサイトからFacebookにイベントを送信できます。
`business_manager_id` 文字列	任意セットアップフローでパートナーがユーザーへの事前選択のために入力できる、ユーザーの既存のビジネスマネージャのビジネスマネージャID。
`ad_account_id` 文字列	任意セットアップフローでパートナーがユーザーへの事前選択のために入力できる、ユーザーの既存の広告アカウントの広告アカウントID。
`page_id` 文字列	任意セットアップフローでパートナーがユーザーに関する事前選択のために入力できる、ユーザーの既存のFacebookページのページID。
`ig_profile_id` 文字列	任意セットアップフローでパートナーがユーザーに関する事前選択のために入力できる、ユーザーの既存のInstagramビジネスプロフィールのInstagramビジネスプロフィールID。
`pixel_id` 文字列	任意セットアップフローでパートナーがユーザーに関する事前選択のために入力できる、ユーザーの既存のピクセルのピクセルID。
`catalog_id` 文字列	任意セットアップフローでパートナーがユーザーへの事前選択のために入力できる、ユーザーの既存のカタログのカタログID。

ビジネス構成

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

フィールド	説明
`business` タイプ: FBEBusinessPropertiesConfigData	必須エンドユーザーのビジネスに関する情報
`messenger_chat` タイプ: FBEMessengerChatConfigData	任意エンドユーザーのFacebookページ上のMessengerチャット機能(`enabled`、`domains`など)。
`catalog_feed_scheduled` タイプ: FBECatalogFeedConfigData	任意 Facebook Business Extensionが、`feed_url`からカタログアイテムを取得するフィードアプローチを使用するかどうかを決定します。
`page_cta` タイプ: FBEPageCtaConfigData	任意エンドユーザーのページ上のコールトゥアクション(CTA)ボタン(`cta_button_text`、`cta_button_url`など)。
`ig_cta` タイプ: FBEIGCtaConfigData	任意 Instagramのコールトゥアクション(CTA)機能のための機能(`enabled`、`cta_button_text`、`cta_button_url`など)。
`messenger_menu` タイプ: FBEMessengerMenuConfigData	任意 Messengerの永続メニュー機能のための機能(`cta_button-text`、`cta_button_url`など)