コンバージョンAPI

顧客情報パラメーター

顧客情報パラメーターとは、イベント情報とともに共有する一連のユーザー識別情報のことです。必須パラメーターと推奨パラメーターの詳細については、ベストプラクティス - コンバージョンAPI: 必須パラメーターと推奨パラメーターの送信をご覧ください。

グラフAPI v13.0のリリースでは、有効と見なされる顧客情報パラメーターの組み合わせに関して新たな要件がありました。ベストプラクティスを確認して、コンバージョンAPI統合が中断されないようにしてください。

コンバージョンAPIを使用するとどのようなデータが送信されるかについては、Metaのプライバシーとデータ使用に関するガイドをご覧ください。

Metaのシステムは、ハッシュ処理されていない連絡先情報である顧客情報を受け入れないように設計されています。ただし、下記のものは例外です。連絡先情報とは、名前、メールアドレス、電話番号などの個人識別情報のことで、これらはマッチングのためだけに使用されます。Meta Business SDKを使用している場合、ハッシュ処理は自動的に行われます。

ピクセル比較

一部のパラメーター(client_user_agentなど)はインターネットの動きの流れで自動的に送信されますが、顧客情報パラメーターのほとんどはMetaピクセルを通して送信できます。例えば、ピクセルでexternal_idを送信するには、次のコードを使用します。

fbq('init', 'PIXEL_ID', {'external_id': 12345});

詳細マッチングのドキュメントの、ピクセルで渡すことができるその他のパラメーターについてご覧ください。

逆に、システムが現在ブラウザー側と共有している顧客情報パラメーターの同じセットを、サーバー側に適用するようにしてください。

user_dataパラメーターのフォーマット化

リクエストでは、少なくとも次のいずれかのuser_dataパラメーターを正しくフォーマットして指定しなければなりません。

こちらのCSVファイルをダウンロードして

、

以下のパラメーターで適切に正規化およびハッシュ化されたデータの例をご覧ください。



ダウンロードする(右クリック > [名前を付けてリンクを保存])
パラメーター説明
em

メール

文字列またはリスト<string>

ハッシュ化必須。
先頭と末尾のスペースをすべてトリミングします。すべての文字を小文字に変換します。

例

入力: John_Smith@gmail.com
正規化されたフォーマット: john_smith@gmail.com
期待されるSHA256出力: 62a14e44f765419d10fea99367361a727c12365e2520f32218d505ed9aa0f62f

ph

電話番号

文字列またはリスト<string>

ハッシュ化必須。
記号、文字、すべての先行ゼロを削除します。電話番号には、マッチングのために使用する国番号を含める必要があります(例: 米国の場合、番号1を電話番号の前に付ける必要があります)。データがすべて同じ国のものであっても、顧客の電話番号には常に国番号を含めます。

例

入力: 米国の電話番号(650)555-1212
正規化されたフォーマット: 16505551212
予期されるSHA256出力:

e323ec626319ca94ee8bff2e4c87cf613be6ea19919ed1364124e16807ab3176

fn

名

文字列またはリスト<string>

ハッシュ化必須。
ローマ字のアルファベット文字a-zの使用が推奨されます。小文字のみ、句読点なし。特殊文字を使用する場合は、テキストをUTF-8フォーマットでエンコードしなければなりません。

例:
入力: Mary
正規化されたフォーマット: mary
期待されるSHA256出力: 6915771be1c5aa0c886870b6951b03d7eafc121fea0e80a5ea83beb7c449f4ec


入力: 정
正規化されたフォーマット: UTF-8文字"정"
期待されるSHA256出力: 8fa8cd9c440be61d0151429310034083132b35975c4bea67fdd74158eb51db14


入力: Valéry
正規化されたフォーマット: valéry
期待されるSHA256出力: 08e1996b5dd49e62a4b4c010d44e4345592a863bb9f8e3976219bac29417149c

ln

姓

文字列またはリスト<string>

ハッシュ化必須。
ローマ字のアルファベット文字a-zの使用が推奨されます。小文字のみ、句読点なし。特殊文字を使用する場合は、テキストをUTF-8フォーマットでエンコードしなければなりません。


例については、名(fn)をご覧ください。

db

生年月日

文字列またはリスト<string>

ハッシュ化必須。
YYYYMMDDフォーマットが受け入れられ、さまざまな年、月、日の組み合わせを、区切りありまたは区切りなしで入力できます。

  • 年: 1900から今年までのYYYYフォーマットを使用します。
  • 月: MMフォーマット: 01から12を使用します。
  • 日: DDフォーマット: 01から31を使用します。

例

入力: 2/16/1997
正規化されたフォーマット: 19970216
期待されるSHA256出力: 01acdbf6ec7b4f478a225f1a246e5d6767eeab1a7ffa17f025265b5b94f40f0c

ge

性別

文字列またはリスト<string>

ハッシュ化必須。
小文字のイニシャルで表した性別が受け入れられます。

例

  • 女性はf
  • 男性はm
ct

市区町村

文字列またはリスト<string>

ハッシュ化必須。
ローマ字のアルファベット文字a-zの使用が推奨されます。小文字のみ、句読点なし、特殊文字なし、空白文字なしで指定します。特殊文字を使用する場合は、テキストをUTF-8フォーマットでエンコードしなければなりません。

例:
paris
london
newyork

st

州

文字列またはリスト<string>

ハッシュ化必須。
2文字のANSI略語コード(小文字)を使用します。米国以外の州は、小文字のみ、句読点なし、特殊文字なし、空白文字なしに正規化します。

例:
az
ca

zp

郵便番号

文字列またはリスト<string>

ハッシュ化必須。
小文字を使用し、空白文字なし、ダッシュ文字なしにします。米国の郵便番号の場合は、先頭5文字のみを使用します。英国の場合は、エリア、地区、セクターフォーマットを使用します。

例:
米国の郵便番号: 94035
オーストラリアの郵便番号: 1987
フランスの郵便番号: 75018
英国の郵便番号: m11ae

country

国

文字列またはリスト<string>

ハッシュ化必須。
ISO 3166-1 alpha-2の2文字の国コードを使います(小文字)。
重要な注: 国コードがすべて同じ国のものであっても、顧客の国は必ず含めてください。Metaでは世界規模でマッチングをしています。この簡単な手順によって、リストからできる限り多くのアカウントセンターアカウントをマッチングできるようになります。

例:
入力: 米国
正規化されたフォーマット: us
期待されるSHA256出力: 79adb2a2fce5c6ba215fe5f27f532d4e7edbac4b6a5e09e1ef3a08084a904621

external_id

外部ID

文字列またはリスト<string>

ハッシュ処理推奨。
広告主が提供する任意の一意のID (ロイヤルティメンバーID、ユーザーID、外部Cookie IDなど)。特定のイベントの1つ以上の外部IDを送信できます。
外部IDが他のチャネルで送信される場合、コンバージョンAPIで送信するときと同じフォーマットで送信してください。

client_ip_address

クライアントIPアドレス

文字列

ハッシュ化なし。
イベントに対応するブラウザーのIPアドレスは、有効なIPV4またはIPV6アドレスでなければなりません。IPV6に対応しているユーザーは、IPV4よりもIPV6を優先してください。client_ip_addressユーザーデータパラメーターはハッシュ処理してはなりません。
スペースを含めないでください。常に実際のIPアドレスを提供し、正確なイベントレポートになるようにしてください。
注: この情報は、ブラウザーで送信されるイベントに自動的に追加されます。しかし、サーバーで送信されるイベントについては手動で設定する必要があります。

例:
IPV4: 168.212.226.204
IPV6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

client_user_agent

クライアントユーザーエージェント

文字列

ハッシュ化なし。
イベントに対応するブラウザーのユーザーエージェント。コンバージョンAPIを使用してシェアされたウェブサイトイベントには、client_user_agentが必要です。

コンバージョンAPIで送信するすべてのイベントについて、client_ip_addressパラメーターとclient_user_agentパラメーターの両方を送信するとイベントマッチングが向上する場合があります。これにより、コンバージョンAPIで送信されるイベントを使って最適化を行う広告キャンペーンでは、広告配信を改善できる場合があります。
注: この情報は、ブラウザーで送信されるイベントに自動的に追加されます。しかし、サーバーで送信されるイベントについては手動で設定する必要があります。

例:
Mozilla/5.0 (Windows NT 10.0;Win64; x64)
AppleWebKit/537.36 (KHTML, like Gecko)
Chrome/87.0.4280.141
Safari/537.36

fbc

クリックID

文字列

ハッシュ化なし。
ドメインの_fbcブラウザーCookieに保存されるFacebookクリックID値。この値を取得する方法、またはこの値をfbclidクエリパラメーターから生成する方法については、fbcパラメーターとfbpパラメーターの管理をご覧ください。

フォーマットは、fb.${subdomain_index}.${creation_time}.${fbclid}です。

例:
fb.1.1554763741205.AbCdEfGhIjKlMnOpQrStUvWxYz1234567890

fbp

ブラウザーID

文字列

ハッシュ化なし。
ドメインの_fbpブラウザーCookieに保存されるFacebookブラウザーID値。この値の取得方法については、fbcパラメーターとfbp パラメーターの管理をご覧ください。

フォーマットは、fb.${subdomain_index}.${creation_time}.${random_number}です。

例:
fb.1.1596403881668.1116446470

subscription_id

サブスクリプションID

文字列

ハッシュ化なし。
この取引におけるユーザーのサブスクリプションID。個々の製品の注文IDと似ています。

fb_login_id

FacebookログインID

整数

ハッシュ化なし。
利用者が最初にアプリのインスタンスにログインしたときに、Metaにより発行されたID。これは、App-Scoped IDとも呼ばれます。

lead_id

リードID

整数

ハッシュ化なし。
Metaのリード獲得広告によって獲得したリードに関連付けられたID。

anon_id
文字列

ハッシュ化なし。
インストールID。このフィールドは、固有のアプリケーションインストールインスタンスを表しています。


注: このパラメーターはアプリイベント専用です

madid
文字列

モバイル広告主ID、Androidデバイスの広告ID、またはAppleデバイスの広告識別情報(IDFA)。

page_id
文字列

ハッシュ化なし。
自分のページID。イベントのに関連付けられているページIDを指定します。ボットに関連付けられているページのFacebookページIDを使用します。

page_scoped_user_id
文字列

ハッシュ化なし。
イベントを記録するメッセンジャーボットに関連付けられた、ページスコープユーザーIDを指定します。Webhookに指定したpage-scoped user IDを使用します。

ctwa_clid
文字列

ハッシュ化なし。
WhatsApp誘導広告のためにMetaが生成したクリックID。

ig_account_id
文字列

ハッシュ化なし。
ビジネスに関連付けられているInstagramアカウントID。

ig_sid
文字列

ハッシュ化なし。
Instagramでアクションを実行するユーザーは、InstagramスコープユーザーID (IGSID)によって特定されます。IGSIDはこのwebhookから入手できます。

参考情報