コンバージョン ピクセル サービス
Pixel Service を使用すると、広告主ページに配置する コンバージョン ピクセル を作成して、ビューとクリックベースのコンバージョンの両方を追跡できます。
注:
変換ピクセル ID を取得すると、画像変換ピクセルの基本的な形式が <img src="media/px?id=37&t=2" width="1" height="1" />
されます。
ヒント
セグメント ピクセルは、 セグメント サービスを介して個別に作成されます。
REST API
JSON フィールド
フィールド | 種類 | 説明 |
---|---|---|
advertiser_id |
int | ピクセルを所有する広告主の ID。 必須: POST |
campaigns |
配列 | ピクセルが関連付けられているキャンペーン。 この配列のフィールドの詳細については、以下の 「キャンペーン 」を参照してください。 読み取り専用。 |
code |
string | ピクセルのカスタム コード。 |
created_on |
timestamp | ピクセルが作成された日時。 読み取り専用。 |
id |
int | ピクセルに関連付けられている内部 ID。 必須: PUT |
name |
string | ピクセルの名前。 必須: POST |
last_modified |
timestamp | ピクセルが最後に変更された日時。 読み取り専用。 |
line_items |
配列 | ピクセルが関連付けられている行項目。 この配列のフィールドの詳細については、以下の 「行項目 」を参照してください。 読み取り専用。 |
min_minutes_per_conv |
int | 繰り返し変換を許可する間隔 (分単位)。 最大値は 32767 (22 日) です。- 0 に設定されている場合: すべての変換をカウントします。- null に設定されている場合 (既定値): ユーザーごとに 1 人をカウントします。デフォルト: null |
piggyback_pixels |
オブジェクトの配列 | 変換ピクセルが起動したときに起動するピクセルの URL。 詳細については、以下の 「ピギーバック ピクセル」 を参照してください。 |
pixel_conversion_event |
配列 | ピクセルが関連付けられているピクセル変換イベント カテゴリ。 詳細については、以下の 「ピクセル変換イベント 」を参照してください。 読み取り専用。 |
pixel_conversion_event_id |
列挙 | 省略可能。 ピクセルに関連付けられている変換イベントの ID。 イベント カテゴリを設定すると、最適化アルゴリズムにすぐには影響しません。 代わりに、最適化チームに予測のための貴重なデータを提供し、テストと組み込みを開始できます。 変換イベントの種類に適切な一致が表示されない場合は、このフィールドを空白のままにします。 使用可能な値は次のとおりです。 - null : カテゴリが選択されていない。- 2 : ランディング ページにアクセス する - ユーザーが広告を配信された後に Web サイトにアクセスします。- 3 : アイテム ビュー - ユーザーが Web サイト上の 1 つ以上の製品またはサービスを表示するページにアクセスします。- 4 : カートに追加する - ユーザーがショッピング カートに 1 つ以上の製品またはサービスを追加します。- 5 : チェックアウトを開始 する - ユーザーがチェックアウト プロセスを開始します。- 6 : 支払い情報を追加 する - ユーザーはチェックアウト プロセス中に、クレジット カード番号などの支払い情報を追加します。- 7 : 購入 - 製品またはサービスの確認済みの販売。- 8 : リードの生成 - ビジネスに関心のあるユーザーから、メール アドレスや郵便番号などのリード情報を収集します。 |
post_click_expire_mins |
int | クリックコンバージョンが対象としてカウントされるインプレッション時間からの間隔 (分単位)。 最大値は 129600 (90 日) です。
0 またはnull に設定すると、最大ルックバック ウィンドウが適用されます。 |
post_click_value |
double | クリック後の変換に属性を設定する値。 |
post_view_expire_mins |
int | ビューのコンバージョンが対象としてカウントされるインプレッション時間からの間隔 (分単位)。 最大値は 43200 (30 日) です。
0 またはnull に設定すると、最大ルックバック ウィンドウが適用されます。 |
post_view_value |
double | ビューの後の変換に属性を設定する値。 |
state |
列挙 | ピクセルの状態。 使用可能な値: "active" または "inactive" 。 |
trigger_type |
列挙 | 有効な (属性付き) 変換に必要なイベントの種類。 使用可能な値: view 、 click 、または hybrid 。デフォルト: click |
キャンペーン
この配列には、キャンペーンの関連付けが表示されます。 ピクセルをキャンペーンに関連付けるには、 キャンペーン サービスを使用します。
フィールド | 種類 | 説明 |
---|---|---|
id |
string | キャンペーンの ID。 読み取り専用。 |
行項目
この配列には、行項目の関連付けが表示されます。 ピクセルをライン アイテムに関連付けるには、 Line Item Service を使用します。
フィールド | 種類 | 説明 |
---|---|---|
id |
string | 明細の ID。 読み取り専用。 |
name |
string | 行項目の名前。 読み取り専用。 |
state |
列挙 | 行項目の状態。 使用可能な値: "active" または "inactive" 。読み取り専用。 |
ピギーバック ピクセル
piggyback_pixels
配列内の各オブジェクトには、次のフィールドが含まれています。
ピギーバック ピクセルを追加する場合は、次の点に注意してください。
- 画像ピクセルは他の画像ピクセルからのみピギーバックでき、JavaScript ピクセルは他の JavaScript ピクセルのみをピギーバックできます。
- イメージ ピクセルはピギーバック ピクセルを 1 つだけ持つことができます。 複数のピクセルをピギーバックする必要がある場合は、必ず JavaScript ピクセルを使用してください。
- AppNexus ではピギーバックされたピクセルに文字制限はありませんが、ブラウザー/サーバー URL の制限が適用される場合があります。
フィールド | 型 (長さ) | 説明 |
---|---|---|
pixel_type |
列挙 | ピギーバックするピクセルの種類。 使用可能な値: "js" または "img" 。 |
url |
string (255) | ピギーバックするピクセルの URL。 |
ピクセル変換イベント
フィールド | 種類 | 説明 |
---|---|---|
id |
列挙 | 必要に応じて、このピクセルに関連付けられている変換イベントの ID。 指定できる値は 2 から 8 までの整数で、以下の name 値に関連付けられています。- null : カテゴリが選択されていない。- 2 : ランディングページ - ユーザーが広告を配信された後にウェブサイトにアクセスします。- 3 : ItemView - ユーザーが Web サイト上の 1 つ以上の製品またはサービスを表示するページにアクセスします。- 4 : AddToCart - ユーザーが 1 つ以上の製品またはサービスをショッピング カートに追加します。- 5 : InitiateCheckout - ユーザーがチェックアウト プロセスを開始します。- 6 : AddPaymentInfo - チェックアウト プロセス中に、ユーザーがクレジット カード番号などの支払い情報を追加します。- 7 : 購入 - 製品またはサービスの確認済みの販売。- 8 : 潜在顧客 - ビジネスに関心を持つユーザーから、メール アドレスや郵便番号などのリード情報を収集します。読み取り専用。 |
name |
列挙 | 必要に応じて、このピクセルに関連付けられている変換イベントの名前。 使用可能な値は、上記の id 値に関連付けられています。- null : カテゴリが選択されていない。- 2 : ランディングページ - ユーザーが広告を配信された後にウェブサイトにアクセスします。- 3 : ItemView - ユーザーが Web サイト上の 1 つ以上の製品またはサービスを表示するページにアクセスします。- 4 : AddToCart - ユーザーが 1 つ以上の製品またはサービスをショッピング カートに追加します。- 5 : InitiateCheckout - ユーザーがチェックアウト プロセスを開始します。- 6 : AddPaymentInfo - チェックアウト プロセス中に、ユーザーがクレジット カード番号などの支払い情報を追加します。- 7 : 購入 - 製品またはサービスの確認済みの販売。- 8 : 潜在顧客 - ビジネスに関心を持つユーザーから、メール アドレスや郵便番号などのリード情報を収集します。読み取り専用。 |
例
広告主のコンバージョン ピクセルを追加する 2
$ cat pixel
{
"pixel": {
"min_minutes_per_conv": 120,
"name": "ProStarr Post View Pixel 2",
"piggyback_pixels": [
{
"pixel_type": "img",
"url": "https://www.testing.com"
}
],
"post_view_expire_mins": 3600,
"post_view_value": 1,
"state": "active",
"trigger_type": "view"
}
}
$ curl -b cookies -c cookies -X POST -d @pixel 'https://api.appnexus.com/pixel?advertiser_id=2'
{
"response":{
"status":"OK",
"id":17
}
}
広告主 2 のコンバージョン ピクセル 17 を表示する
$ curl -b cookies -c cookies 'https://api.appnexus.com/pixel?id=17&advertiser_id=2'
{
"response": {
"status": "OK",
"pixels": [
{
"id": 17,
"code": null,
"name": "ProStarr Hybrid Pixel",
"state": "active",
"campaigns": [
{
"id": "17607"
}
],
"line_items": [
{
"id": 382,
"name": "Line Item",
"state": "active"
}
],
"trigger_type": "hybrid",
"min_minutes_per_conv": null,
"post_view_expire_mins": null,
"post_click_expire_mins": null,
"post_click_value": 10,
"post_view_value": 1,
"piggyback_pixels": [
{
"url": "https://www.testing.com",
"pixel_type": "img"
}
],
"created_on": "2010-01-01 19:24:20",
"last_modified": "2010-01-15 21:41:40",
"advertiser_id": 2
}
]
}
}
すべての広告主のコンバージョン ピクセルを表示する
注:
"advertiser_id"
フィールドは、ピクセルが属する広告主を示します。
$ curl -b cookies -c cookies -X POST -d @pixel 'https://api.appnexus.com/pixel'
{
"response": {
"status": "OK",
"pixels": [
{
"id": 5,
"code": null,
"name": "Sample Pixel 1",
"state": "active",
"campaigns": [
{
"id": "17883"
},
{
"id": "34091"
}
],
"line_items": [
{
"id": 67729,
"name": "5556",
"state": "active"
},
{
"id": 67734,
"name": "7017",
"state": "active"
},
{
"id": 67733,
"name": "8302",
"state": "active"
}
],
"trigger_type": "view",
"min_minutes_per_conv": 32767,
"post_view_expire_mins": 1440,
"post_click_expire_mins": null,
"post_click_value": null,
"post_view_value": 0,
"piggyback_pixels": [
{
"url": "https://test.com/test",
"pixel_type": "img"
}
],
"created_on": "2011-08-12 18:11:13",
"last_modified": "2011-09-12 19:55:21",
"advertiser_id": 8
},
{
"id": 6,
"code": null,
"name": "blargh2",
"state": "active",
"campaigns": [
{
"id": "17775"
},
{
"id": "17776"
}
],
"line_items": [
{
"id": 67895,
"name": "7082",
"state": "active"
},
{
"id": 67477,
"name": "3468",
"state": "active"
},
{
"id": 67679,
"name": "7870",
"state": "active"
}
],
"trigger_type": "click",
"min_minutes_per_conv": 1,
"post_view_expire_mins": null,
"post_click_expire_mins": 20160,
"post_click_value": 0,
"post_view_value": null,
"piggyback_pixels": null,
"created_on": "2011-05-07 18:11:13",
"last_modified": "2011-06-07 20:23:08",
"advertiser_id": 10
},
...
],
"count": 10,
"start_element": null,
"num_elements": null
}
}
ピクセルに変換イベント カテゴリを追加する
次の使用例は、変換ピクセル 1017110をイベント カテゴリ 3 に追加します (項目の表示)。
$ cat pixel-category
{
"pixel":
{"pixel_conversion_event_id": 3
}
}
$ curl -b cookies -c cookies -X PUT -s -d @pixel-category "https://api.appnexus.com/pixel?id=1017110&advertiser_id=57992"
{
"response": {
"count": 1,
"dbg_info": {
"output_term": "pixel",
"version": "1.18.651",
"warnings": []
},
"id": "1017110",
"num_elements": 100,
"pixel": {
"advertiser_id": 57992,
"campaigns": null,
"code": null,
"created_on": "2018-07-25 18:39:30",
"id": 1017110,
"last_modified": "2018-07-27 20:55:31",
"line_items": null,
"member_id": 1370,
"min_minutes_per_conv": 0,
"name": "Confirmation Page",
"piggyback_pixels": null,
"pixel_conversion_event": {
"id": 3,
"name": "ItemView"
},
"pixel_conversion_event_id": 3,
"post_click_expire_mins": 20160,
"post_click_value": null,
"post_view_expire_mins": 10080,
"post_view_value": null,
"state": "active",
"trigger_type": "hybrid"
},
"start_element": 0,
"status": "OK"
}
}