Webhook Facebook App Events APIの構成方法

概要

FacebookにHTTPリクエストを送信して、1つ以上のアプリ内コンバージョンを追跡します。イベントデータはJSONエンコードされた文字列として表現されます。詳細はFacebook App Events APIを参照してください。

API呼び出し例:

curl \
  -F "event=CUSTOM_APP_EVENTS" \
  -F "advertiser_id=1111-1111-1111-1111" \
  -F "advertiser_tracking_enabled=1" \
  -F "application_tracking_enabled=1" \
  -F "custom_events=[{\"_eventName\":\"fb_mobile_purchase\",
                      \"_valueToSum\":55.22,
                      \"_logTime\":1367017882,
                      \"fb_currency\":\"GBP\",
                    }]" \
  "https://graph.facebook.com/API_VERSION/APP_ID/activities"

提供されたcurlの例（-Fオプション付き）は、リクエストがPOSTメソッドを使用し、そのボディが"multipart/form-data"コンテンツタイプであることを示しています。Webhookで構成できる個々のコンポーネントに分けて、全体のリクエストを解説しましょう。

1. APIエンドポイント/URL

https://graph.facebook.com/API_VERSION/APP_ID/activities

この例では、URLにはAPIバージョンとAPP_IDのプレースホルダー値があります。これらはおそらくURLにハードコーディングできますが、デモンストレーションの目的で、動的な値を使用してこのコンポーネントを作成するURLテンプレートを使用します。

2. シンプルなフォームフィールドの値

  event = CUSTOM_APP_EVENTS
  advertiser_id = 1111-1111-1111-1111
  advertiser_tracking_enabled = 1
  application_tracking_enabled = 1

これらのキー/値のペアは、ボディデータセクションのカスタム値を使用してマッピングできるシンプルなフォームフィールドです。

3. JSON値

custom_events = [{ "_eventName"  : "fb_mobile_purchase",
                   "_valueToSum" : 55.22,
                   "_logTime"    : 1367017882,
                   "fb_currency" : "GBP",
                }]

この特定のフィールド名"custom_events"は、より複雑な値、JSON文字列を持っています。Webhookでこの値を再現するために、テンプレート変数とテンプレートを使用します。

Webhookの構成

メソッドフィールド

“POST"に構成します。

URLフィールド

{{url_template}}に構成します。

URLはハードコード（組み込みのAPIバージョンとアプリID）またはテンプレートベースであることができます。後者のアプローチは、データレイヤー属性の柔軟性を高めるために採用されています。下のテンプレートセクションを参照してください。

ボディコンテンツタイプ

オプションmultipart/form-dataを選択します。

ボディデータ

例のリクエストから各フィールドの名前/値のペアを構成します。custom_eventsの値は、作成するテンプレートの名前、events_templateであることに注意してください。

パラメータ値はこの例ではカスタム/静的な値ですが、動的なデータレイヤー属性として簡単に提供することができます。

テンプレート変数

テンプレートで参照され、置換される名前/値のペアを構成します。

テンプレート

URLとcustom_eventsパラメータに割り当てるためのJSON値の2つのテンプレートを作成します。テンプレートは、カーリーブラケット構文を使用してテンプレート変数を使用することに注意してください。

このテンプレートは、“eventSums.value"変数に基づいており、これは文字列のセット属性によって入力されます。これは配列属性なので、テンプレートはテンプレート変数名のプレフィックス（この場合は"eventSums”）のセクションを作成します。

url_template:

https://graph.facebook.com/{{apiVersion}}/{{appId}}/activities

events_template:

 [ 
 {{#eventSums}} 
 {     
  "_eventName"  : "{{name}}",     
  "_valueToSum" : {{value}},     
  "_logTime"    : {{logTime.toTimestamp}},     
  "fb_currency" : "{{currency}}"
}{{#iter.hasNext}}, {{/iter.hasNext}}
 {{/eventSums}} 
 ] 

レンダリングされたテンプレート

テンプレートはレンダリングされ、その内容はWebhook構成のどこでも参照されます（この例では、URLとBody Dataのcustom_eventsフィールド）。

_valueToSumパラメータは、文字列のセット属性から値を受け取ることに注意してください。

url_template:

https://graph.facebook.com/v2.6/12345/activities

events_template:

[     
 {         
  "_eventName"  : "fb_mobile_purchase",         
  "_valueToSum" : 0.99,         
  "_logTime"    : 1468358987,         
  "fb_currency" : "USD"     
  },     
  {         
    "_eventName"  : "fb_mobile_purchase",         
    "_valueToSum" : 4.99,         
    "_logTime"    : 1468358987,         
    "fb_currency" : "USD"     
  } 
]