Webコンバージョン

コンバージョン

Webコンバージョン

POST version/measurement/conversions/:pixel_id

単一のユニバーサルウェブサイトタグのピクセルIDのウェブサイトコンバージョンイベントを送信します。

応答コードで成功（HTTP 200 OK）を確認する必要があります。エラーコードが返された場合に備えて、再試行メカニズムと基本的なログインを用意しておくことをおすすめします。

レート制限は、15分の時間枠につき6万リクエストまでです（リクエストごとに500イベントまで可能）。

リソースURL

https://ads-api.twitter.com/11/measurement/conversions/:pixel_id

パラメータ

名前 説明
pixel_id
必須
 広告アカウントのユニバーサルウェブサイトタグ（UWT）ID。base36でエンコードされた広告アカウントのUWT IDの値を表しています。

タイプ: 文字列

例: o5h34
conversions
必須

APIリクエストのPOST本文のオブジェクト。コンバージョンイベントのリスト。最大で500個までコンバージョンイベントを指定できます。サポートされているフィールドについては、以下の表を参照してください。

タイプ: 配列

例: "conversions":[{"conversion_time": "2022-02-18T01:14:00.603Z", "event_id":"tw-o5h34-o9p5x", "identifiers": [{"twclid": "23opevjt88psuo13lu8d020qkn"}], "conversion_id": "23294827"}]

コンバージョンオブジェクト

名前 説明
conversion_time
必須

時間（ISO 8601で表します）。

タイプ: 文字列

例: 2017-10-05T00:00:00Z
event_id
必須

特定のイベントのbase-36 ID。この広告アカウントに含まれている事前構成済みイベントを照合します。これは、広告マネージャーと広告APIの対応する単一イベントウェブサイトタグではIDと呼ばれます。

タイプ: 文字列

例: tw-o5h34-o9p5x
identifiers
必須

コンバージョンイベントを照合する識別子オブジェクトのリスト。サポートされているフィールドは以下の表にまとめられています。少なくともいずれか1つの識別子オブジェクト（twclidまたはemail）が必要です。

タイプ: 配列

例: "identifiers": [{"twclid": "23opevjt88psuo13lu8d020qkn"},{"hashed_email": "e586883b2b4faf78d48300a79e0e15138d664cdf796ffb86e533170a9893eda8"}]
number_items
任意

イベントで購入されるアイテムの数。0より大きい正の数字にする必要があります。

タイプ: 整数

例: 4
price_currency
任意

イベントの購入対象アイテムの通貨（ISO-4217で表します）。詳細については「通貨」を参照してください。

タイプ: 文字列

デフォルト: USD

例: JPY
value
任意

price_currency通貨で表される、イベントの購入対象アイテムの価格値。

タイプ: 倍精度

例: 100.00
conversion_id
任意

ピクセルとコンバージョンAPIのコンバージョン間の重複排除に使用します。コンバージョンイベントの識別子。同じイベントタグ内でウェブピクセルとコンバージョンAPIのコンバージョン間の重複排除に使用できます。詳細については、コンバージョンガイドの「イベントと重複排除のテスト」セクションを参照してください。

タイプ: 文字列

例: 23294827
description
任意

コンバージョンの追加情報に関する説明。

タイプ: 文字列

例: test conversion
search_string
任意

広告主のウェブサイトで検索されたテキスト。

タイプ: 文字列

例: milk
contents
任意

特定の製品/コンテンツに関する詳細のリスト。きめ細かい情報を提供します。サポートされているフィールドについては、以下の表を参照してください。

タイプ: 配列

例: contents": [{"content_id": "1", "content_name": "Blankets", "content_type": "home improvement", "content_price": 100.00, "num_items": 1, "content_group_id": "123"}, {"content_id": "2", "content_price": 50.00}]

識別子オブジェクト（少なくともいずれか1つの識別子が必要）

名前 説明
twclid
必須の場合あり

クリックスルーURLから解析されたTwitterクリックID。hashed_email識別子が追加されていない場合は必須です。

タイプ: 文字列

例: 26l6412g5p4iyj65a2oic2ayg2
hashed_email
必須の場合あり

ハッシュ化されたメールアドレス（SHA256）。テキストには小文字しか使用できず、ハッシュ前後のスペースは削除する必要があります。twclid識別子が追加されていない場合は必須です。

タイプ: 文字列

例: test-email@test.com = e586883b2b4faf78d48300a79e0e15138d664cdf796ffb86e533170a9893eda8

コンテンツオブジェクト

名前 説明
content_id
任意

SKUまたはGTIN（コンテンツを表す識別子）。

タイプ: 文字列

例: jhp
content_group_id
任意

製品バリアントのグループに関連付けられているID

タイプ: 整数

例: group 1
content_name
任意

製品またはサービスの名前。

タイプ: 文字列

例: radio flyer
content_price
任意

製品またはサービスの価格。

タイプ: 倍精度

例: 5.00
content_type
任意

購入された製品のカテゴリー。

タイプ: 文字列

例: clothes
num_items
任意

購入された商品の数

タイプ: 整数

例: 1

応答パラメータ

名前 説明
conversions_processed

正常に処理されたコンバージョンの数

タイプ: 整数

例: 1
debug_id

後続の調査で使用できるデバッグUUID

タイプ: 文字列

例: ff02e052-36e4-47d6-bdf0-6d8986446562

リクエストの例

twurl -H 'ads-api.twitter.com' -X POST '/11/measurement/conversions/o5h34' --data '
{
   "conversions":[
      {
         "conversion_time":"2022-02-18T01:14:00.603Z",
         "event_id":"tw-o5h34-o9p5x",
         "identifiers":[
            {
               "twclid":"23opevjt88psuo13lu8d020qkn"
            },
            {
               "hashed_email":"63dc92389e3326e3ee3d7e6e715fda270977b9d293d97760f89105c86b3e2f11"
            }
         ],
         "value":250.00,
         "number_items":3,
         "conversion_id":"23294827",
         "description":"Pet supply purchases",
         "contents":[
            {
               "content_id":"1",
               "content_price":50.00,
               "num_items":1,
            },
            {
               "content_id":"2",
               "content_price":100.00,
               "num_items":2,

            }
         ]
      }
   ]
}' --header 'Content-Type: application/json'

 

応答の例

{
   "request":{
      "params":{
         "account_id":"18ce552mlaq"
      }
   },
   "data":{
      "conversions_processed":1,
      "debug_id":"ff02e052-36e4-47d6-bdf0-6d8986446562"
   }
}