FacebookコンバージョンAPI連携 | サポートサイト

目次

1.機能概要
2.導入手順
3.FacebookコンバージョンAPIの連携内容

1.機能概要

FacebookコンバージョンAPIで直接マーケティングデータをMeta社と連携し、適切な広告を出すためのデータ計測、設定の最適化をします。
Meta（Facebook）ピクセルと併用することで、さらに精度の高いFacebook・Instagram広告の効果測定を行うことができます。
FacebookコンバージョンAPIはサードパーティーCookieを使用しないため、
サードパーティーCookieの利用が制限されユーザーを識別できずに適切な広告を出すための計測が行えない、という事態にも対処できます。
詳しくはMetaビジネスヘルプセンターのサポートページをご確認ください。

2.導入手順

「FacebookコンバージョンAPI連携」オプションを利用するための導入手順を紹介します。

1.弊社への申込み
2.各初期設定の追加
3.Facebook広告の計測タグ（Metaピクセル）の設置
4.m:id「common.META_PIXEL_EVENT_ID_SCRIPT_HERE」の設置
5.「個人情報の取り扱い」ページへの追記（任意）
6.動作確認

1.弊社への申込み

本オプション利用の申し込みの旨を、弊社担当営業またはサポート窓口までご連絡ください。

2.各初期設定の追加

1.FacebookコンバージョンAPI:ピクセルID
　Facebookの管理画面より確認できる「ピクセルID」を入力します。

2.FacebookコンバージョンAPI:アクセストークン
　Facebookの管理画面より確認できる「アクセストークン」を入力します。

3.FacebookコンバージョンAPI:テストイベントコード
　Facebookの管理画面より確認できる「テストイベントコード 」を入力します。
　テスト時にのみ使用します。

4.FacebookコンバージョンAPI:顧客情報ブラックリスト
　送信しない会員情報の項目を指定できます。
　送信を希望しない項目を、改行または、カンマ区切りで指定してください。

3.Facebook広告の計測タグ（Metaピクセル）の設置

ここでは、タグマネージャを使用した設置方法をご紹介します。
タグマネージャがメニューにない場合は、弊社サポート窓口へお問い合わせください。


1.Meta上でFacebook広告の計測タグ（Metaピクセル）を生成します。
　詳細はMetaビジネスヘルプセンターのサポートページの「Metaピクセルの設定方法」をご確認ください。

2.生成したFacebook広告の計測タグ（Metaピクセル）のソースをコピーします。
　詳細はMetaビジネスヘルプセンターのサポートページの「ピクセルコードを手動でウェブサイトに追加する」をご確認ください。

3.ショップ管理ツールより データ解析 ＞ タグマネージャ ＞ タグ新規登録/一覧 を開きます。

4.タグHTMLに、コピーしたFacebook広告の計測タグ（Metaピクセル）をペーストします。

5.タグ出力個所は、「上部」か「下部」を選択します。
　ページにあるbodyの開始タグと終了タグの間に出力する必要があるため、どちらかを選択してください。

6.タグタイプには「カスタムHTML」、タグコード、タグ名には任意の値を入れて登録します。

4.m:id「common.META_PIXEL_EVENT_ID_SCRIPT_HERE」の設置

FacebookコンバージョンAPIとFacebook広告の計測タグ（Metaピクセル）による計測を併用したとき、
同じイベントが重複してカウントされます。
これを防ぐために、m:idでeventIDをMeta社に連携して重複したイベントを除外します。

対象テンプレート

FacebookコンバージョンAPIが実行されるページにm:idを記載します。
追記するテンプレートは 1 もしくは 2 です。どちらに記載しても差し支えございません。

1.以下の3ページすべてに記載する。
・cart_index.xhtml（買い物かごのページ）
・item_detail.xhtml（商品詳細ページ）
・cart_result.xhtml（注文完了ページ）

もしくは

2.userweb/common、smartphone/common配下の共通テンプレートに記載する。
以下の3ページにて使用している共通テンプレートにm:idを記載します。
・cart_index.xhtml（買い物かごのページ）
・item_detail.xhtml（商品詳細ページ）
・cart_result.xhtml（注文完了ページ）

記載する共通テンプレート例：common/header_cart.xhtml,common/header.xhtml

埋め込み例

m:idを記載する場所は対象テンプレート内であれば、どこに記載しても問題ございません。

<span m:id='common.META_PIXEL_EVENT_ID_SCRIPT_HERE'></span> <script type="text/javascript"> fbq('track', 'ViewContent', {},{eventID: metaPixelEventId}); </script>

5.「個人情報の取り扱い」ページへの追記（任意）

本機能を利用される場合、ユーザーの情報がMeta社に送信され、「オーディエンス」情報として利用されます。
ご利用にあたってはMeta社の関連ヘルプをご確認の上、必要に応じて「個人情報の取り扱いについて」ページへの追記をご検討ください。

Meta社の関連ヘルプ

・顧客リストのカスタムオーディエンス利用規約
・外部顧客情報のハッシュ処理について
・Metaプライバシーポリシー

送信されるユーザー情報

論理名	ハッシュ化
メールアドレス	〇
電話番号	〇
名	〇
姓	〇
生年月日	〇
性別	〇
郵便番号	〇
国 ※1	〇
外部ID	〇
クライアントIPアドレス	〇
クライアントユーザーエージェント
FacebookクリックID値 ※2
FacebookブラウザーID値 ※3

6.動作確認

ユーザーウェブでの各タイミングで、Meta側に値が連携できているかを確認します。

商品詳細ページへの遷移時

1.facebookビジネスサイトのサイドメニューにある「すべてのツール」から「イベントマネージャ」を選択します。
2.「概要」タブを表示し、「コンテンツビュー」イベントが登録されていることを確認します。

カートへの商品投入時

1.facebookビジネスサイトのサイドメニューにある「すべてのツール」から「イベントマネージャ」を選択します。
2.「概要」タブを表示し、「カートへの追加」イベントが登録されていることを確認します。

注文完了時

1.facebookビジネスサイトのサイドメニューにある「すべてのツール」から「イベントマネージャ」を選択します。
2.「概要」タブを表示し、「購入」イベントが登録されていることを確認します。

3.FacebookコンバージョンAPIの連携内容

下記タイミングにおいて、FacebookコンバージョンAPIを実行した際の連携内容を紹介します。

・商品詳細ページへの遷移時
・カートへの商品投入時
・注文完了時

商品詳細ページへの遷移時

物理名			論理名	必須	ハッシュ化	設定値
test_event_code			テストのために使用されるコード			初期設定「FacebookコンバージョンAPI:テストイベントコード 」で設定した値。 値を設定した場合に連携します。
data
	event_name		facebookの標準イベント名	〇		ViewContent
	event_time		イベント時間	〇		イベントが発生した秒単位のUNIXタイムスタンプ
	event_source_url		URL			イベントの発生したURL
	action_source		コンバージョン発生箇所	〇		website
	data_processing_options		CCPAデータ処理オプション			LDU
	data_processing_options_country		CCPAデータ処理オプションを適用する国			0
	data_processing_options_state		データ処理オプションを適用する州			0
user_data
		em	メールアドレス		〇	会員マスタ.PCメールアドレス 会員マスタ.携帯メールアドレス
		ph	電話番号		〇	会員マスタ.電話番号
		fn	名		〇	会員マスタ.名（漢字）
		ln	姓		〇	会員マスタ.姓（漢字）
		db	生年月日		〇	会員マスタ.生年月日
		ge	性別		〇	会員マスタ.性別
		zp	郵便番号		〇	会員マスタ.郵便番号
		country	国		〇	JP
		external_id	外部ID		〇	会員マスタ.会員ID
		client_ip_address	クライアントIPアドレス	〇		クライアントIPアドレス
		client_user_agent	クライアントユーザーエージェント			クライアントユーザーエージェント
		fbc	クリックID			FacebookクリックID値 ドメインの_fbcブラウザーCookieに保存されるFacebookクリックID値。
		fbp	ブラウザーID			FacebookブラウザーID値 ドメインの_fbcブラウザーCookieに保存されるFacebookブラウザーID値。
custom_data
		content_ids	商品コード			商品バリエーションコード
		content_category	製品のカテゴリ			商品マスタ.代表カテゴリ
		content_name	商品名			商品マスタ.商品名
		contents	コンテンツ			商品バリエーションコード,商品投入数,商品価格 例）[{'id':'ABC123','item_price':100}、{'id':'XYZ789','item_price':220}]
		content_type	商品タイプ	〇		product
		currency				通貨マスタ.通貨コード 例）'JPY'
		value				商品価格

カートへの商品投入時

物理名			論理名	必須	ハッシュ化	連携値
test_event_code			テストのために使用されるコード			初期設定「FacebookコンバージョンAPI:テストイベントコード 」で設定した値。 値を設定した場合に連携します。
data
	event_name		facebookの標準イベント名	〇		AddToCart
	event_time		イベント時間	〇		イベントが発生した秒単位のUNIXタイムスタンプ
	event_source_url		URL			イベントの発生したURL
	action_source		コンバージョン発生箇所	〇		website
	data_processing_options		CCPAデータ処理オプション			LDU
	data_processing_options_country		CCPAデータ処理オプションを適用する国			0
	data_processing_options_state		データ処理オプションを適用する州			0
user_data
		em	メールアドレス		〇	会員マスタ.PCメールアドレス 会員マスタ.携帯メールアドレス
		ph	電話番号		〇	会員マスタ.電話番号
		fn	名		〇	会員マスタ.名（漢字）
		ln	姓		〇	会員マスタ.姓（漢字）
		db	生年月日		〇	会員マスタ.生年月日
		ge	性別		〇	会員マスタ.性別
		zp	郵便番号		〇	会員マスタ.郵便番号
		country	国		〇	JP
		external_id	外部ID		〇	会員マスタ.会員ID
		client_ip_address	クライアントIPアドレス	〇		クライアントIPアドレス
		client_user_agent	クライアントユーザーエージェント			クライアントユーザーエージェント
		fbc	クリックID			FacebookクリックID値 ドメインの_fbcブラウザーCookieに保存されるFacebookクリックID値。
		fbp	ブラウザーID			FacebookブラウザーID値 ドメインの_fbcブラウザーCookieに保存されるFacebookブラウザーID値。
custom_data
		content_ids	コンテンツID			商品バリエーションコード
		content_name	コンテンツ名			カート
		content_type	商品タイプ	〇		product
		contents	コンテンツ	〇		商品バリエーションコード、商品投入数、商品価格 例）[{'id':'ABC123','quantity':2,'item_price':100}、{'id':'XYZ789','quantity':2,'item_price':220}]
		currency	通貨			通貨マスタ.通貨コード 例）'JPY'
		value				商品価格

注文完了時

物理名			論理名	必須	ハッシュ化	連携値
test_event_code			テストのために使用されるコード			初期設定「FacebookコンバージョンAPI:テストイベントコード 」で設定した値。 値を設定した場合に連携します。
data
	event_name		facebookの標準イベント名	〇		Purchase
	event_time		イベント時間	〇		イベントが発生した秒単位のUNIXタイムスタンプ
	event_source_url		URL			イベントの発生したURL
	event_id					UUIDを発行
	action_source		コンバージョン発生箇所	〇		website
	data_processing_options		CCPAデータ処理オプション			LDU
	data_processing_options_country		CCPAデータ処理オプションを適用する国			0
	data_processing_options_state		データ処理オプションを適用する州			0
user_data
		em	メールアドレス		〇	受注ヘッダ.PCメールアドレス 受注ヘッダ.携帯メールアドレス
		ph	電話番号		〇	受注ヘッダ.電話番号
		fn	名		〇	受注ヘッダ.名（漢字）
		ln	姓		〇	受注ヘッダ.姓（漢字）
		db	生年月日		〇	会員マスタ.生年月日
		ge	性別		〇	会員マスタ.性別
		zp	郵便番号		〇	受注ヘッダ.郵便番号
		country	国		〇	JP
		external_id	外部ID		〇	会員マスタ.会員ID
		client_ip_address	クライアントIPアドレス	〇		クライアントIPアドレス
		client_user_agent	クライアントユーザーエージェント			クライアントユーザーエージェント
		fbc	クリックID			FacebookクリックID値 ドメインの_fbcブラウザーCookieに保存されるFacebookクリックID値。
		fbp	ブラウザーID			FacebookブラウザーID値 ドメインの_fbcブラウザーCookieに保存されるFacebookブラウザーID値。
custom_data
		content_ids	コンテンツID	〇		商品バリエーションコード
		content_name	コンテンツ名			カート精算
		contents	コンテンツ			商品バリエーションコード,商品投入数,商品価格 例）[{'id':'ABC123','quantity':2,'item_price':100}、{'id':'XYZ789','quantity':2,'item_price':220}]
		currency	通貨			通貨マスタ.通貨コード 例）'JPY'
		num_items	商品個数の合計			受注明細.個数の合計
		value	受注の請求金額			受注ヘッダ.請求合計金額