event_name文字列 | 必須。
標準イベントまたはカスタムイベントの名前。このフィールドは、ウェブ(Metaピクセルにより)またはアプリ(SDKまたはアプリイベントAPIにより)と、コンバージョンAPIの両方から送信されるイベントの重複除外処理をするために使われます。event_idパラメーターも重複除外で使用します。 同一のカスタマーアクションである場合、ブラウザーイベントまたはアプリイベントのeventとサーバーイベントのevent_nameが一致します。48時間以内に送信された複数のイベントの間に一致が検出された場合、最初のものだけが考慮されます。サーバーイベントとブラウザー/アプリイベントがほぼ同時(時差5分以内)に到着した場合は、ブラウザー/アプリイベントが優先されます。ピクセルとサーバーイベントの重複除外についての詳細をご確認ください。 |
event_time整数 | 必須。
実際のイベントがいつ発生したかを示す秒単位のUNIXタイムスタンプ。イベントをFacebookに送信する時間より前の時間を指定することもできます。バッチ処理を行い、サーバーパフォーマンスを最適化するためです。この日付はGMT時間帯で送信する必要があります。 event_timeには、イベントをFacebookに送信する最大7日前までの時間を指定できます。dataのevent_timeが過去7日間より前である場合、リクエスト全体に対してエラーが返され、どのイベントも処理されません。
|
user_dataオブジェクト | 必須。
カスタマー情報データを含むマップ。オプションについては、カスタマー情報パラメーターをご覧ください。また、Metaピクセルを介して送信されるデータに対して利用できる同等のオプションについては、詳細マッチングをご覧ください。 |
custom_dataオブジェクト | 任意。
イベントに関する付加的なビジネスデータが含まれるマップ。詳しくは、カスタムデータパラメーターをご覧ください。 |
event_source_url文字列 | 任意。
イベントが発生したブラウザーURL。URLは認証済みドメインと一致する必要があります。
注:コンバージョンAPIを使用して共有するウェブサイトイベントには、event_source_urlが必要です。 |
opt_outブーリアン | 任意。
このイベントを広告配信最適化に使用するべきでないことを示すフラグ。trueに設定されている場合、イベントはアトリビューションのためにのみ使用されます。 |
event_id文字列 | 任意。
このIDは、広告主が選択した任意の一意の文字列にできます。event_idとevent_nameのパラメーターは、ウェブ(Metaピクセルにより)またはアプリ(SDKまたはアプリイベントAPIにより)と、コンバージョンAPIの両方から送信されるイベントの重複除外処理をするために使われます。event_idは任意とされていますが、イベントの重複除外のために指定することが推奨されています。 重複除外のためには、ブラウザーイベントまたはアプリイベントのeventIDが、対応するサーバーイベントのevent_idと一致する必要があります。重複したピクセルイベントとコンバージョンAPIイベントの処理についてご確認ください。 注文番号または取引IDの2つは、event_idに使用できる識別情報です。例えば、カスタマーがウェブサイトで注文番号123と456で2回購入を行った場合、各コンバージョンAPI呼び出しでそれぞれの注文番号をevent_idとして含める必要があります。これにより、これらの2つの購入イベントを別個の注文として適切に見分けることができます。対応する2つのブラウザーピクセル購入イベントも同じ注文番号をeventIDパラメーターに入れてMetaに送信し、発生したイベントは2つだけであり、個別の4つの購入ではないことが分かるようにしなければなりません。 固有のID番号がないほかのイベントの場合、乱数を使用できます(ブラウザーイベントとサーバーイベントで使用可能な同じ乱数を送信する限り)。 |
action_source文字列 | 必須。
このフィールドでは、コンバージョンが発生した場所を指定できます。イベントの発生場所が分かると、広告を適切な対象者に表示するのに役立ちます。コンバージョンAPIを使用することで、自分が知る限りaction_sourceパラメーターが正確であることに同意するものとします。 action_sourceフィールドで送信できる値は以下のとおりです。
email — コンバージョンはメールで発生しました。
website — コンバージョンはウェブサイトで行われました。
app — コンバージョンはモバイルアプリで行われました。
phone_call — コンバージョンは電話で行われました。
chat — コンバージョンはメッセージアプリ、SMS、またはオンラインメッセージ機能を通して行われました。
physical_store — コンバージョンは実店舗で対面で行われました。
system_generated — コンバージョンは自動的に発生しました(毎月自動的に支払いが行われるように設定されているサブスクリプション更新など)。
business_messaging — Messenger、Instagram、またはWhatsAppへのクリック広告からコンバージョンが行われました。
other — コンバージョンは上記以外の方法で発生しました。
注: すべてのアクションソース値は、広告の効果測定機能とカスタムオーディエンス作成機能を有効にします。すべてのアクションソースが広告最適化機能を有効にします。 |
data_processing_options配列 | 任意。
特定のイベントに対して有効にする処理オプション。現在指定可能な値は、限定データ利用を表すLDUです。このイベントがデータ使用制限付きで処理されないように明示的に指定するには、空の配列を送信します。データ処理オプションの詳細を参照してください。コンバージョンAPIの実装例もご覧ください。 |
data_processing_options_country整数 | LDU をdata_processing_optionsで送信した場合必須。
このデータ処理オプションに関連付ける国。現在指定可能な値は、米国の場合は1、Metaにそのイベントの地理的位置情報を特定するようリクエストする場合は0です。データ処理オプションの詳細を参照してください。コンバージョンAPIの実装例もご覧ください。
|
data_processing_options_state整数 | 必須の場合もあります。(詳しくは下の注をご覧ください。)
このデータ処理オプションに関連付ける州。現在指定可能な値は、カリフォルニア州を表す1000か、Metaにそのイベントの地理的位置情報を特定するようリクエストする場合の0です。 注: データ処理オプションの詳細を参照してください。コンバージョンAPIの実装例もご覧ください。 |
app_data
オブジェクト | アプリイベントで必須 コンバージョンAPIにアプリデータとデバイス情報をシェアするためのパラメーター。 extinfoはapp_dataのサブパラメーターです。
|
extinfo
オブジェクト | アプリイベントで必須
拡張デバイス情報(画面の幅や高さなど)。このパラメーターは、値をコンマで区切った配列です。extinfoを使う場合、すべての値が必要で、以下に示されているインデックスの順序でなければなりません。値が欠落していると、プレースホルダーとして空文字列で補われます。 注: Androidの場合、versionはa2でなければなりません iOSの場合、versionはi2でなければなりません
|
0
文字列 | 必須 extinfoバージョン
例: i2 |
1
文字列 | アプリパッケージ名
例: com.facebook.sdk.samples.hellofacebook |
2
文字列 | 短いバージョン(整数または文字列)
例: 1.0 |
3
文字列 | 長いバージョン
例: 1.0 long |
4
文字列 | 必須 OSのバージョン
例: 13.4.1 |
5
文字列 | デバイスのモデル名
例: iPhone5,1 |
6
文字列 | ロケール
例: En_US |
7
文字列 | タイムゾーン略号
例: PDT |
8
文字列 | 携帯電話会社
例: AT&T |
9
int64 | 画面の幅
例: 320 |
10
int64 | 画面の高さ
例: 568 |
11
文字列 | 画面密度
例: 2 |
12
int64 | CPUコア数
例: 2 |
13
int64 | 外部ストレージのサイズ(GB)
例: 13 |
14
int64 | 外部ストレージの空き容量(GB)
例: 8 |
15
文字列 | デバイスのタイムゾーン
例: USA/New York |
referrer_url文字列 | 任意。
コンバージョンAPIまたはMetaピクセルイベントをトリガーするページによって観測されたHTTPリファラーヘッダー。これは通常、ブラウザーの前のページです。 |
original_event_dataオブジェクト | 任意。
広告主が「遅延」イベントを過去の獲得イベントに関連付ける方法を指定する際に使用できる、すべてのメタデータフィールド。 イベントが送信されてから、関連付ける過去の獲得イベントまでに遅延が発生する場合、original_event_dataを使用することを強くおすすめします。詳しくは、オリジナルイベントデータパラメーターをご覧ください。 |
customer_segmentation列挙型 | 任意。
当該イベントを実行しているユーザーが所属するユーザーセグメントを広告主が指定することができます。これを使って、ユーザーとビジネスとの関係に関するより詳細なコンテキストを提供できます。 このフィールドには、以下の事前定義された列挙値のいずれかを指定できます。 new_customer_to_business: ユーザーがビジネスにとって新しい顧客である。
new_customer_to_business_line: ユーザーが特定のビジネスライン(製品やサービスなど)にとって新しい顧客である。
new_customer_to_product_area: ユーザーが特定の製品エリア(Eコマースやファイナンスなど)にとって新しい顧客である。
new_customer_to_medium: ユーザーが特定のマーケティングメディア(ソーシャルメディアやメールなど)にとって新しい顧客である。
existing_customer_to_business: ユーザーがビジネスの既存の顧客である。
existing_customer_to_business_line: ユーザーが特定のビジネスライン(製品やサービスなど)の既存の顧客である。
existing_customer_to_product_area: ユーザーが特定の製品エリア(Eコマースやファイナンスなど)の既存の顧客である。
existing_customer_to_medium: ユーザーが特定のマーケティングメディア(ソーシャルメディアやメールなど)の既存の顧客である。
customer_in_loyalty_program: ユーザーがロイヤルティプログラムのメンバーである。
JSONペイロードの例 {
"event_name": "Purchase",
"event_time": 1643723400,
"user_data": {
"em": "user@example.com"
},
"custom_data": {
"currency": "USD",
"value": 100.00,
"customer_segmentation": "new_customer_to_business"
}
} |
