コンバージョンイベント

POST conversion_event

モバイル測定コンバージョンイベントを記録します。応答は、TwitterまたはTwitterオーディエンスプラットフォーム(TAP)アトリビューションを示します。

これはGET conversion_attributionエンドポイントに関連します。

Twitter、TAP、またはアトリビューションなしが応答で要求されます。Twitterアトリビューションがない場合、twitter_attributionノードは常に存在し、nullの値が含まれます(次の応答例を参照)。TAPアトリビューションが要求されると、tpn_attributionノードが存在し、それに従って入力されます。詳細については、「TAPの概要」を参照してください。

各コンバージョンイベントに関連付けられたメタデータを設定できるオプションのパラメーターがいくつかあります。このメタデータはアトリビューションの計算に影響しません。

リソースURL

https://ads-api.twitter.com/10/conversion_event

パラメーター

名前 説明
app_id
必須

対応するアプリストアに一意のID。

タイプ: 整数、文字列

例: 333903271com.vine.android

conversion_time
必須

ミリ秒が追加された、ISO-8601のタイムスタンプ形式によるコンバージョンイベントの時間。

タイプ: 文字列

例: 2014-05-22T02:38:28.103Z

conversion_type
必須

コンバージョンイベントのタイプ。

タイプ: 列挙

使用可能な値: PURCHASESIGN_UPINSTALLRE_ENGAGEUPDATETUTORIAL_COMPLETERESERVATIONADD_TO_CARTADD_TO_WISHLISTLOGINCHECKOUT_INITIATEDSEARCHLEVEL_ACHIEVEDACHIEVEMENT_UNLOCKEDCONTENT_VIEWSHAREINVITEADDED_PAYMENT_INFOSPENT_CREDITSRATED

hashed_device_id
必須

HMAC_SHA-256でハッシュ化されたIDFAまたはAdID。

タイプ: 文字列

例: ABCD1234XYZ

os_type
必須

アプリのOSタイプ。

タイプ: 列挙

使用可能な値: IOSANDROID

click_window
任意

このイベントのクリック期間(日単位)。

タイプ: 整数

: click_window view_through_window以上にする必要があります

デフォルト: 14
使用可能な値: 171430
device_ip_address
任意

コンバージョンが発生したときのデバイスのIPv4またはIPv6アドレス。

タイプ: 文字列

例: 192.133.78.1

level
任意

このイベントに関連付けられるレベル。

タイプ: 整数

例: 2
non_twitter_engagement_time
任意

コンバージョン前のTwitter以外の最後のエンゲージメント時間。

タイプ: 文字列

例: 2014-05-22T02:38:28.103Z

non_twitter_engagement_type
任意

コンバージョンイベント前のTwitter以外のエンゲージメントタイプ。

タイプ: 列挙

使用可能な値: CLICKVIEW

number_items
任意

このイベントに関連付けられる項目数。

タイプ: 整数

例: 2
price_currency
任意

通常は、このイベントに関連付けられる通貨を表すISO 4217コード。

タイプ: 文字列

例: EUR,USD,JPY
price_micro
任意

このイベントに関連付けられている価格(マイクロ単位)。

タイプ: 整数

例: 123450000
user_payment_info
任意

ユーザーのお支払い情報がこのイベントに関連付けられるアプリに保存されているかどうかを示すブール値。

タイプ: ブール値

使用可能な値: true または false
view_through_window
任意

このイベントのビュースルー期間(日単位)。

:

click_window view_through_window以上にする必要があります。

タイプ: 整数

デフォルト: 1
使用可能な値: 0171430

リクエストの例

https://ads-api.twitter.com/10/conversion_event?app_id=333903271&os_type=IOS&hashed_device_id=ABCD1234XYZ&conversion_type=INSTALL&conversion_time=2013-04-16T07:00:00.123Z&click_window=14&view_through_window=1

応答の例

{
  "data": {
    "conversion_value_micro": 0,
    "view_through_window": 1,
    "tpn_attribution": null,
    "conversion_time": "2017-01-21T01:14:00.602Z",
    "click_window": 30,
    "limit_ad_tracking": false,
    "event_metadata": null,
    "non_twitter_engagement_type": null,
    "conversion_type": "INSTALL",
    "partner_client_id": "com.appname contact id",
    "app_id": "com.appname",
    "hashed_device_id": "lke1GZa3AseB343ZcCQq7svfHzLfuSqyYnE+Rf49MOI=",
    "twitter_attribution": {
      "country_code": "US",
      "engagement_time": "2017-01-21T01:13:00.602Z",
      "engagement_type": "CLICK",
      "attribution_type": "PROMOTED",
      "promoted_properties": {
        "campaign_id": "4ns44",
        "line_item_id": "3x44d",
        "publisher_app_id": "333903271"
        "account_id":"18ce11e3egb",
        "line_item_objective": "APP_INSTALLS",
        "campaign_name": null
      },
      "tweet_id": "11434635565377600"
    },
    "os_type": "ANDROID",
    "non_twitter_engagement_time": null
  },
  "request": {
    "params": {
      "version_number": "1",
      "app_id": "com.appname",
      "conversion_type": "INSTALL",
      "os_type": "ANDROID",
      "hashed_device_id": "lke1GZa3AseB343ZcCQq7svfHzLfuSqyYnE+Rf49MOI=",
      "conversion_time": "2017-01-21T01:14:00.602Z",
      "click_window": "30",
      "view_through_window": "1",
      "limit_ad_tracking": "false"
    }
  }
}