FacebookコンバージョンAPI連携

目次

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


1.機能概要

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

データ連携するタイミング
・商品詳細ページへの遷移時
・カートへの商品投入時
・注文完了時



国内ユーザーのデータのみ連携可能です。
海外ユーザーも対象にする場合は別途カスタマイズが必要です。


2.導入手順

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

1.弊社への申込み
2.Metaピクセル(データセット)の作成
3.各初期設定の追加
4.Metaピクセル(データセット)の設置
5.m:id「common.META_PIXEL_EVENT_ID_SCRIPT_HERE」の設置
6.「個人情報の取り扱い」ページへの追記(任意)
7.動作確認

デモ環境への導入について

本設定は、Meta側にテスト環境がないため、本番環境にのみ導入します。

もし、デモ環境への導入を希望する場合は、デモ環境用のMetaピクセルを作成してください。(作成手順の詳細はこちら
本番環境とデモ環境とで、集計するデータが混在しても問題ない場合は、同じMetaピクセルをご利用いただけます。

Metaピクセルをご用意できたら、導入手順の2~6にしたがってデモ環境への導入をすすめてください。
各初期設定に値を登録する際は、
利用するMetaピクセルの、ピクセルID(データセットID)、アクセストークン、テストイベントコードを確認しご登録ください。


1.弊社への申込み

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


2.Metaピクセル(データセット)の作成

Metaビジネスマネージャーのアカウントが必要です。
作成方法についてはMetaビジネスヘルプセンターのサポートページの「ビジネスマネージャを作成する」をご確認ください。

本オプションの導入以前にMetaピクセルをご利用の店舗様の場合は、
すでに設置済みのデータセットが「13.イベント詳細パラメーターを追加し、[次へ]をクリック」の設定内容と、
同等となるようご調整ください。


1.Metaビジネスマネージャにログイン


2.店舗様のビジネスアカウントを選択


3.サイドメニューにある「すべてのツール」から「イベントマネージャ」を開く


4.サイドメニューから「データソースをリンク(+)」を選択


5.「ウェブ」を選択し、[リンクする]をクリック


6.データセットの名前(ピクセル名)を入力し、[作成]をクリック


7.店舗様のECサイトのURLを入力し、[次へ]をクリック


8.「自分でやる」を選択し、[次へ]をクリック


9.「MetaピクセルとコンバージョンAPI」を選択し、[次へ]をクリック


10.「手動で設定」を選択し、[次へ]をクリック


11.[次へ]をクリック


12.イベントを選択し、[次へ]をクリック

指定可能なイベントは以下の通りです。

・カートに追加
・購入
・コンテンツビュー


13.イベント詳細パラメーターを追加し、[次へ]をクリック

各イベントに設定可能なパラメーターについては、イベントをクリックしてご確認ください。

カートに追加


選択可能なパラメータ一
イベント詳細パラメーター イベントID
データ処理オプション
国のデータ処理オプション
州のデータ処理オプション
コンテンツタイプ
完了
通貨
コンテンツ名
コンテンツID
コンテンツ
顧客情報パラメーター クライアントIPアドレス - ハッシュ化しない
クライアントユーザー・エージェント - ハッシュ化しない
生年月日
メールアドレス
外部ID
クリックID(fbc) Cookie - ハッシュ化しない
ブラウザーID(fbp) Cookie - ハッシュ化しない
性別
電話番号
郵便番号

購入


選択可能なパラメータ一
イベント詳細パラメーター イベントID
データ処理オプション
国のデータ処理オプション
州のデータ処理オプション
完了
アイテム数
コンテンツ名
コンテンツID
コンテンツ
顧客情報パラメーター クライアントIPアドレス - ハッシュ化しない
クライアントユーザー・エージェント - ハッシュ化しない
生年月日
メールアドレス
外部ID
クリックID(fbc) Cookie - ハッシュ化しない
ブラウザーID(fbp) Cookie - ハッシュ化しない
性別
電話番号
郵便番号

コンテンツビュー


選択可能なパラメータ一
イベント詳細パラメーター イベントID
イベント
データ処理オプション
国のデータ処理オプション
州のデータ処理オプション
コンテンツタイプ
完了
コンテンツカテゴリ
通貨
コンテンツ名
コンテンツID
コンテンツ
顧客情報パラメーター クライアントIPアドレス - ハッシュ化しない
クライアントユーザー・エージェント - ハッシュ化しない
生年月日
メールアドレス
外部ID
クリックID(fbc) Cookie - ハッシュ化しない
ブラウザーID(fbp) Cookie - ハッシュ化しない
性別
電話番号
郵便番号


14.[設定を確認]をクリック


15.[完了]をクリック



データソース画面にて、ご自身で作成したMetaピクセル(データセット)をご確認いただけます。

詳細は、Metaビジネスヘルプセンターのサポートページ「Metaピクセルの設定とインストールの方法」をご確認ください。


3.各初期設定の追加

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

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

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

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


アクセストークンについて

生成したアクセストークンは、Meta上に保存されません。
アクセストークンを紛失した場合は、再度アクセストークンを生成してください。


4.Metaピクセル(データセット)の設置

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

1.2.Metaピクセル(データセット)の作成で生成したMetaピクセル(データセット)のソースをコピーします。
 詳細はMetaビジネスヘルプセンターのサポートページの「ピクセルコードを手動でウェブサイトに追加する」をご確認ください。

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

3.タグHTMLに、コピーしたMetaピクセル(データセット)をペーストします。

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

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


・Metaピクセル(データセット)の設置は必須です。
 設置しないと、下記2点のパラメータがFacebookコンバージョンAPIで送信されないため、ユーザーのコンバージョンが取れません。
 
 ・fbc(クリックID)
 ・fbq(ブラウザーID)

・本オプションの導入以前にMetaピクセルをご利用の店舗様の場合は、
 すでに設置済みのデータセットが、上記タグマネージャの設定に準じた状態になるようご調整ください。


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

FacebookコンバージョンAPIとMetaピクセル(データセット)による計測を併用したとき、同じイベントが重複してカウントされます。
これを防ぐために以下の方法で、同じイベントが重複しないよう制御する必要があります。

■本オプションの導入以前にMetaピクセルをご利用の店舗様で、
 イベントに「カートに追加(AddToCart)」「コンテンツビュー(ViewContent)」「購入(Purchase)」を導入している場合
 ↓
 ・以下a.b.のいずれかでご対応ください。
  a.すでに記述済みのMetaピクセルの対象イベントを削除、またはコメントアウト
   対象イベント:「カートに追加(AddToCart)」「コンテンツビュー(ViewContent)」「購入(Purchase)」
   ※削除、またはコメントアウトした場合、下記対象テンプレートと埋め込み例のm:id追加は不要です。
  b.下記対象テンプレートと埋め込み例を参考にm:idを追加

■本オプションの導入にあわせて、新規でMetaピクセルを導入する店舗様の場合(4.Metaピクセル(データセット)の設置を利用した場合)
 ↓
 ・下記対象テンプレートと埋め込み例のm:id追加は不要です。


対象テンプレートと埋め込み例

FacebookコンバージョンAPIが実行される以下のページにm:idを記載します。

※下記テンプレートをクリックすると埋め込み例が表示されます。

cart_index.xhtml(買い物かごのページ)

m:id埋め込みに関するご注意
・m:id「common.META_PIXEL_EVENT_ID_SCRIPT_HERE」は、イベント送信タグ「fbq」より上部に記載してください。
・「eventID」は、イベント「AddtoCart」の第4引数として指定してください。
・下記埋め込み例はサンプルです。実際の店舗様の記述例とは違う場合があります。


<span m:id='common.META_PIXEL_EVENT_ID_SCRIPT_HERE'></span>
<script type="text/javascript">
 fbq('track', 'AddToCart', {xxx:xxx,xxx:xxx,...(店舗固有の値)}, {eventID: metaPixelEventId});
</script>


item_detail.xhtml(商品詳細ページ)

m:id埋め込みに関するご注意
・m:id「common.META_PIXEL_EVENT_ID_SCRIPT_HERE」は、イベント送信タグ「fbq」より上部に記載してください。
・「eventID」は、イベント「ViewContent」の第4引数として指定してください。
・下記埋め込み例はサンプルです。実際の店舗様の記述例とは違う場合があります。


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


cart_result.xhtml(注文完了ページ)

m:id埋め込みに関するご注意
・m:id「common.META_PIXEL_EVENT_ID_SCRIPT_HERE」は、イベント送信タグ「fbq」より上部に記載してください。
・「eventID」は、イベント「Purchase」の第4引数として指定してください。
・下記埋め込み例はサンプルです。実際の店舗様の記述例とは違う場合があります。


<span m:id='common.META_PIXEL_EVENT_ID_SCRIPT_HERE'></span>
<script type="text/javascript">
 fbq('track', 'Purchase', {xxx:xxx,xxx:xxx,...(店舗固有の値)}, {eventID: metaPixelEventId});
</script>



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


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


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

※1 エンドユーザーの情報に関わらず、常に「JP」が固定で送信されます。
※2 エンドユーザーが広告をクリックした際に自動的に保存されるクリックIDです。
※3 MetaピクセルがCookieを使用する際に自動的に保存されるブラウザーIDです。


初期設定「FacebookコンバージョンAPI:顧客情報ブラックリスト」によって、送信しない会員情報の項目を指定できます。



7.動作確認

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


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

1.Meta Business Suiteのサイドメニューにある「すべてのツール」から「イベントマネージャ」を選択します。
2.サイドメニューから「データソース」をクリックします。
3.ECサイトに設定したデータセットIDをクリックします。
4.「概要」メニューをクリックし、「コンテンツビュー」イベントが登録されていることを確認します。


カートへの商品投入時

1.Meta Business Suiteのサイドメニューにある「すべてのツール」から「イベントマネージャ」を選択します。
2.サイドメニューから「データソース」をクリックします。
3.ECサイトに設定したデータセットIDをクリックします。
4.「概要」メニューをクリックし、「カートへの追加」イベントが登録されていることを確認します。


注文完了時

1.Meta Business Suiteのサイドメニューにある「すべてのツール」から「イベントマネージャ」を選択します。
2.サイドメニューから「データソース」をクリックします。
3.ECサイトに設定したデータセットIDをクリックします。
4.「概要」メニューをクリックし、「購入」イベントが登録されていることを確認します。


下記タイミングにおいて、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 商品価格

商品バリエーションが1000件以上ある商品の商品詳細ページへの遷移時、
負荷高騰を避けるためFacebookコンバージョンAPIは実行されません。



カートへの商品投入時
物理名 論理名 必須 ハッシュ化 連携値
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 商品価格

ユーザーウェブにおいて、カートへの商品投入時にFacebookコンバージョンAPIが実行されます。
数量変更や商品削除は反映されません。



注文完了時
物理名 論理名 必須 ハッシュ化 連携値
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 受注の請求金額 受注ヘッダ.請求合計金額

・ユーザーウェブにおいて注文完了した時に、FacebookコンバージョンAPIが実行されます。
 ショップ管理ツールで受注作成した際は連携対象外です。
予約販売を利用している場合、予約受注作成時は連携されます。
見積管理を利用している場合、見積作成時は連携されますが、見積から注文した時は連携対象外です。  


当ページの記載内容は、標準機能に関するものです。
機能に関するカスタマイズをされている場合にはこの限りではありません。