ユニバーサル ピクセル サービス
ユニバーサル ピクセル サービスは、1 つ以上のユニバーサル ピクセルと関連する対象ユーザーとコンバージョンにアクセスできる REST API サービスのセットです。
ユニバーサル ピクセル サービスの概要
ユニバーサル ピクセルは、ユーザーが Web サイトとのやり取りについて分析情報を提供するため、ユーザーを簡単にセグメント化し、ユーザーが実行したアクションを測定し、広告のターゲットを絞り込むことができます。 ユニバーサル ピクセル サービスには、次の 3 つのエンドポイント セットがあります。
- ユニバーサル ピクセル REST API - ユニバーサル ピクセル を作成、削除、表示、更新するには。
- 対象ユーザー REST API - 対象ユーザー を作成、削除、表示、更新するには。
- 変換 REST API - 変換 を作成、削除、表示、更新するには。
各ユニバーサル ピクセル エンドポイント の例については、 以下を参照してください。
ユニバーサル ピクセル REST API (エンドポイント)
/universal-pixel
エンドポイントを使用してユニバーサル ピクセルを作成できます。 ユニバーサル ピクセルが作成されたら、 /universal-pixel
エンドポイントを使用して表示、更新、または削除できます。
対象ユーザー REST API (エンドポイント)
/universal-pixel/audience
エンドポイントを使用して、ユニバーサル ピクセル対象ユーザーを作成できます。 対象ユーザーが作成されたら、 /universal-pixel/audience
エンドポイントを使用して表示、更新、または削除できます。
変換 REST API (エンドポイント)
/universal-pixel/conversion
エンドポイントを使用してユニバーサル ピクセル変換を作成します。 変換が作成されたら、 /universal-pixel/conversion
エンドポイントを使用して、それを表示、更新、または削除できます。
ユニバーサル ピクセル REST API
HTTP メソッド | エンドポイント | 説明 |
---|---|---|
GET |
https://api.appnexus.com/universal-pixel/pixel | メンバーまたは広告主に関連付けられているユニバーサル ピクセルの一覧を表示します。 |
POST |
https://api.appnexus.com/universal-pixel/pixel | 新しいユニバーサル ピクセルを作成します。 |
GET |
https://api.appnexus.com/universal-pixel/pixel/PIXEL_ID | ID でユニバーサル ピクセルを表示します。 |
PUT |
https://api.appnexus.com/universal-pixel/pixel/PIXEL_ID | ID でユニバーサル ピクセルを更新します。 |
DELETE |
https://api.appnexus.com/universal-pixel/pixel/PIXEL_ID | ID でユニバーサル ピクセルを削除します。 |
GET |
https://api.appnexus.com/universal-pixel/pixel-uuid/PIXEL_UUID | UUID でユニバーサル ピクセルを表示します。 |
ユニバーサル ピクセルの一覧を表示する
クエリ フィールド
フィールド | 種類 | 説明 |
---|---|---|
member_id |
integer | 操作のためにユニバーサル ピクセルに関連付けられているメンバーの ID。 |
advertiser_id |
integer | ユニバーサル ピクセルに関連付けられている広告主の ID。 |
sort |
string | フィールドと方向で並べ替え: - ID 昇順 = id.asc - ID 降順 = id.dsc 既定値: id.asc |
num_elements |
integer | 返す要素の数。 maximum = 1000 、 minimum = 1 、 default = 1000 。 |
start_element |
integer | 開始要素 (ページングに使用)。 default = 0 。 |
JSON フィールド (応答本文)
フィールド | 種類 | 説明 |
---|---|---|
data |
配列 | ユニバーサル ピクセル オブジェクトの配列。 |
id |
integer | API によって割り当てられたユニバーサル ピクセル ID。 |
name |
string | ユニバーサル ピクセルの名前。 |
uuid |
string | API によって割り当てられたユニバーサル ピクセルの一意の ID。 |
member_id |
integer | ユニバーサル ピクセルに関連付けられているメンバーの ID。 |
advertiser_id |
integer | ユニバーサル ピクセルに関連付けられている広告主の ID。 |
created_on |
string | ユニバーサル ピクセルが作成されたタイムスタンプ。 Format: YYYY-MM-DD HH:MM:SS たとえば、 2019-03-08 15:34:18 。 |
last_updated |
string | ユニバーサル ピクセルが最後に更新されたときのタイムスタンプ。 Format: YYYY-MM-DD HH:MM:SS たとえば、 2019-03-08 15:34:18 。 |
新しいユニバーサル ピクセルを作成する
新しいユニバーサル ピクセルを作成するためのクエリ フィールド
フィールド | 種類 | 説明 |
---|---|---|
member_id |
integer | 操作のためにユニバーサル ピクセルに関連付けられているメンバーの ID。 |
新しいユニバーサル ピクセルを作成するための JSON フィールド (要求本文)
フィールド | 種類 | 説明 |
---|---|---|
name |
string | ユニバーサル ピクセルの名前。 文字列の最小長は 1、最大値は 100 です。 これは 必須 フィールドです。 |
advertiser_id |
integer | ユニバーサル ピクセルに関連付けられている広告主の ID。 |
新しいユニバーサル ピクセルを作成するための JSON フィールド (応答本文)
フィールド | 種類 | 説明 |
---|---|---|
id |
integer | API によって割り当てられたユニバーサル ピクセル ID。 |
name |
string | ユニバーサル ピクセルの名前。 |
uuid |
string | API によって割り当てられたユニバーサル ピクセルの一意の ID。 |
member_id |
integer | ユニバーサル ピクセルに関連付けられているメンバーの ID。 |
advertiser_id |
integer | ユニバーサル ピクセルに関連付けられている広告主の ID。 |
created_on |
string | ユニバーサル ピクセルが作成されたタイムスタンプ。 Format: YYYY-MM-DD HH:MM:SS たとえば、 2019-03-08 15:34:18 。 |
last_updated |
string | ユニバーサル ピクセルが最後に更新されたときのタイムスタンプ。 Format: YYYY-MM-DD HH:MM:SS たとえば、 2019-03-08 15:34:18 。 |
ID でユニバーサル ピクセルを表示する
ユニバーサル ピクセルを表示するためのクエリ フィールド
フィールド | 種類 | 説明 |
---|---|---|
id |
integer | 操作のために API によって割り当てられたユニバーサル ピクセルの ID。 |
ユニバーサル ピクセルを表示するための JSON フィールド (応答本文)
フィールド | 種類 | 説明 |
---|---|---|
id |
integer | 操作のために API によって割り当てられたユニバーサル ピクセル ID。 |
name |
string | ユニバーサル ピクセルの名前。 |
uuid |
string | API によって割り当てられたユニバーサル ピクセルの一意の ID。 |
member_id |
integer | ユニバーサル ピクセルに関連付けられているメンバーの ID。 |
advertiser_id |
integer | ユニバーサル ピクセルに関連付けられている広告主の ID。 |
created_on |
string | ユニバーサル ピクセルが作成されたタイムスタンプ。 Format: YYYY-MM-DD HH:MM:SS たとえば、 2019-03-08 15:34:18 。 |
last_updated |
string | ユニバーサル ピクセルが最後に更新されたときのタイムスタンプ。 Format: YYYY-MM-DD HH:MM:SS たとえば、 2019-03-08 15:34:18 。 |
ID でユニバーサル ピクセルを更新する
ユニバーサル ピクセルを更新するためのクエリ フィールド
フィールド | 種類 | 説明 |
---|---|---|
id |
integer | 操作のために API によって割り当てられたユニバーサル ピクセルの ID。 |
ユニバーサル ピクセルを更新するための JSON フィールド (要求本文)
既存の値から新しい値に変更する必要があるフィールド。 例:
フィールド | 種類 | 説明 |
---|---|---|
name |
string | ユニバーサル ピクセルの名前を更新しました。 これは 必須 フィールドです。 |
ID でユニバーサル ピクセルを削除する
ユニバーサル ピクセルを削除するためのクエリ フィールド
フィールド | 種類 | 説明 |
---|---|---|
id |
integer | 削除される API によって割り当てられたユニバーサル ピクセルの ID。 |
UUID でユニバーサル ピクセルを表示する
UUID でユニバーサル ピクセルを表示するためのクエリ フィールド
フィールド | 種類 | 説明 |
---|---|---|
uuid |
integer | 操作のために API によって割り当てられたユニバーサル ピクセルの一意の ID。 |
UUID でユニバーサル ピクセルを表示するための JSON フィールド (応答本文)
フィールド | 種類 | 説明 |
---|---|---|
id |
integer | 操作のために API によって割り当てられたユニバーサル ピクセル ID。 |
name |
string | ユニバーサル ピクセルの名前。 |
uuid |
string | API によって割り当てられたユニバーサル ピクセルの一意の ID。 |
member_id |
integer | ユニバーサル ピクセルに関連付けられているメンバーの ID。 |
advertiser_id |
integer | ユニバーサル ピクセルに関連付けられている広告主の ID。 |
created_on |
string | ユニバーサル ピクセルが作成されたタイムスタンプ。 Format: YYYY-MM-DD HH:MM:SS たとえば、 2019-03-08 15:34:18 。 |
last_updated |
string | ユニバーサル ピクセルが最後に更新されたときのタイムスタンプ。 Format: YYYY-MM-DD HH:MM:SS たとえば、 2019-03-08 15:34:18 。 |
Audience REST API
HTTP メソッド | エンドポイント | 説明 |
---|---|---|
GET |
https://api.appnexus.com/universal-pixel/audience | メンバーまたは広告主に関連付けられている対象ユーザーの一覧を表示します。 |
POST |
https://api.appnexus.com/universal-pixel/audience | 新しい対象ユーザーを作成します。 |
GET |
https://api.appnexus.com/universal-pixel/audience/AUDIENCE_ID | ID で対象ユーザーを表示します。 |
PUT |
https://api.appnexus.com/universal-pixel/audience/AUDIENCE_ID | ID で対象ユーザーを更新します。 |
DELETE |
https://api.appnexus.com/universal-pixel/audience/AUDIENCE_ID | ID で対象ユーザーを削除します。 |
対象ユーザーの一覧を表示する
対象ユーザーの一覧を表示するためのクエリ フィールド
フィールド | 種類 | 説明 |
---|---|---|
member_id |
integer | 操作のためにユニバーサル ピクセルに関連付けられているメンバーの ID。 |
advertiser_id |
integer | ユニバーサル ピクセルに関連付けられている広告主の ID。 |
sort |
string | フィールドと方向で並べ替え: - ID 昇順 = id.asc - ID 降順 = id.dsc デフォルト = id.asc |
num_elements |
integer | 返す要素の数。 maximum = 1000 、 minimum = 1 、 default = 1000 。 |
start_element |
integer | 開始要素 (ページングに使用)。 default = 0 。 |
universal_pixel_id |
integer | フィルター処理するユニバーサル ピクセル ID。 |
segment_id |
integer | フィルター処理するセグメント ID。 |
search |
string | 検索用語。 |
対象ユーザーの一覧を表示するための JSON フィールド (応答本文)
フィールド | 種類 | 説明 |
---|---|---|
data |
配列 | Audience オブジェクトの配列。 |
id |
integer | API によって割り当てられた対象ユーザー ID。 |
version_id |
integer | 対象ユーザーに関連付けられているバージョン ID。 |
universal_pixel_id |
integer | 対象ユーザーを関連付けるユニバーサル ピクセルの ID。 |
advertiser_id |
integer | 対象ユーザーに関連付けられている広告主の ID。 |
name |
string | 対象ユーザーの名前。 |
user_ttl_minutes |
integer | この対象ユーザーの TTL (Time To Live) (分単位)。 maximum = 259200 、 minimum = 0 、 default = 43200 。 |
segment_id |
integer | この対象ユーザーをターゲットにするために使用するセグメント ID。 |
rule |
object | 対象ユーザーのルール セット。 このフィールドはオブジェクトであり、ユニバーサル ピクセルの火災を変換と見なすために満たす必要があるルールの配列を含める必要があります。 たとえば、以下の ルール は、ユニバーサル ピクセル火災が microsoft.com を含むドメインを持つ Web サイト上にある必要があることを意味し、ピクセル火災のイベントは Purchase であり、 item_id は 123 。 |
created_on |
string | 対象ユーザーが作成されたときのタイムスタンプ。 Format: YYYY-MM-DD HH:MM:SS たとえば、 2019-03-08 15:34:18 。 |
published_on |
string | 対象ユーザーが公開されたときのタイムスタンプ。 Format: YYYY-MM-DD HH:MM:SS たとえば、 2019-03-08 15:34:18 。 |
rule
対象ユーザー向け
"rule":{"and":[{"domain":{"contains":["microsoft.com"]}},{"event":{"equals":["Purchase"]}},
{"item_id":{"equals":["123"]}}],"pixel_uuid":"0b3758f1-cf0f-46c1-9957-00bd36f19ad0"},
新しい対象ユーザーを作成する
新しい対象ユーザーを作成するためのクエリ フィールド
フィールド | 種類 | 説明 |
---|---|---|
member_id |
integer | 操作のために対象ユーザーに関連付けられているメンバーの ID。 |
新しい対象ユーザーを作成するための JSON フィールド (要求本文)
フィールド | 種類 | 説明 |
---|---|---|
name |
string | 対象ユーザーの名前。 必須フィールドです。 |
universal_pixel_id |
integer | 対象ユーザーを関連付けるユニバーサル ピクセルの ID。 必須フィールドです。 |
user_ttl_minutes |
integer | この対象ユーザーの TTL (Time To Live) (分単位)。 maximum = 259200 、 minimum = 0 、 default = 43200 。 |
rule |
object | 対象ユーザーのルール セット。 このフィールドは 必須 フィールドとオブジェクトです。 ユニバーサル ピクセルの火災をコンバージョンと見なすために満たす必要があるルールの配列を含める必要があります。 たとえば、以下の ルール は、ユニバーサル ピクセル火災が microsoft.com を含むドメインを持つ Web サイト上にある必要があることを意味し、ピクセル火災のイベントは Purchase であり、 item_id は 123 。 |
rule
新しい対象ユーザーを作成するための (要求本文)
"rule":{"and":[{"domain":{"contains":["microsoft.com"]}},
{"event":{"equals":["Purchase"]}},{"item_id":{"equals":["123"]}}],
"pixel_uuid":"0b3758f1-cf0f-46c1-9957-00bd36f19ad0"},
新しい対象ユーザーを作成するための JSON フィールド (応答本文)
フィールド | 種類 | 説明 |
---|---|---|
id |
integer | API によって割り当てられた対象ユーザー ID。 |
version_id |
integer | 対象ユーザーに関連付けられているバージョン ID。 |
universal_pixel_id |
integer | ユニバーサル ピクセルに関連付けられている対象ユーザーの ID。 |
name |
string | 対象ユーザーの名前。 |
segment_id |
integer | この対象ユーザーをターゲットにするために使用するセグメント ID。 |
user_ttl_minutes |
integer | この対象ユーザーの TTL (Time To Live) (分単位)。 maximum = 259200 、 minimum = 0 、 default = 43200 。 |
rule |
object | 対象ユーザーのルール セット。 このフィールドはオブジェクトであり、ユニバーサル ピクセルの火災を変換と見なすために満たされるルールの配列が含まれています。 たとえば、以下の ルール は、ユニバーサル ピクセル火災が 、microsoft.com を含むドメインを持つ Web サイト上にあることを意味し、ピクセル火災のイベントは [購入] で、 item_id は 123 。 |
created_on |
string | 対象ユーザーが作成されたときのタイムスタンプ。 Format: YYYY-MM-DD HH:MM:SS たとえば、 2019-03-08 15:34:18 。 |
published_on |
string | 対象ユーザーが公開されたときのタイムスタンプ。 Format: YYYY-MM-DD HH:MM:SS たとえば、 2019-03-08 15:34:18 。 |
rule
新しい対象ユーザーを作成するための (応答本文)
"rule":{"and":[{"domain":{"contains":["microsoft.com"]}},
{"event":{"equals":["Purchase"]}},{"item_id":{"equals":["123"]}}],
"pixel_uuid":"0b3758f1-cf0f-46c1-9957-00bd36f19ad0"},
ID で対象ユーザーを表示する
ID で対象ユーザーを表示するためのクエリ フィールド
フィールド | 種類 | 説明 |
---|---|---|
id |
integer | API によって割り当てられた対象ユーザーの ID。 |
ID で対象ユーザーを表示するための JSON フィールド (応答本文)
フィールド | 種類 | 説明 |
---|---|---|
id |
integer | API によって割り当てられた対象ユーザー ID。 |
version_id |
integer | 対象ユーザーに関連付けられているバージョン ID。 |
universal_pixel_id |
integer | 対象ユーザーを関連付けるユニバーサル ピクセルの ID。 |
advertiser_id |
integer | 対象ユーザーに関連付けられている広告主の ID。 |
name |
string | 対象ユーザーの名前。 |
user_ttl_minutes |
integer | この対象ユーザーの TTL (Time To Live) (分単位)。 maximum = 259200 、 minimum = 0 、 default = 43200 。 |
segment_id |
integer | この対象ユーザーをターゲットにするために使用するセグメント ID。 |
rule |
object | 対象ユーザーのルール セット。 このフィールドはオブジェクトであり、ユニバーサル ピクセルの火災を変換と見なすために満たす必要があるルールの配列が含まれています。 たとえば、以下の ルール は、ユニバーサル ピクセル火災が microsoft.com を含むドメインを持つ Web サイト上にある必要があることを意味し、ピクセル火災のイベントは Purchase であり、 item_id は 123 。 |
created_on |
string | 対象ユーザーが作成されたときのタイムスタンプ。 Format: YYYY-MM-DD HH:MM:SS たとえば、 2019-03-08 15:34:18 。 |
published_on |
string | 対象ユーザーが公開されたときのタイムスタンプ。 Format: YYYY-MM-DD HH:MM:SS たとえば、 2019-03-08 15:34:18 。 |
rule
ID (応答本文) で対象ユーザーを表示する場合
"rule":{"and":[{"domain":{"contains":["microsoft.com"]}},
{"event":{"equals":["Purchase"]}},{"item_id":{"equals":["123"]}}],
"pixel_uuid":"0b3758f1-cf0f-46c1-9957-00bd36f19ad0"},
ID で対象ユーザーを更新する
ID で対象ユーザーを更新するためのクエリ フィールド
フィールド | 種類 | 説明 |
---|---|---|
id |
integer | API によって割り当てられた対象ユーザーの ID。 |
ID で対象ユーザーを更新するための JSON フィールド (要求本文)
既存の値から新しい値に変更する必要があるフィールド。 例:
フィールド | 種類 | 説明 |
---|---|---|
name |
string | 対象ユーザーの名前を更新しました。 これは 必須 フィールドです。 |
rule |
object | 対象ユーザーのルール セット。 これは 必須 フィールドとオブジェクトです。 ユニバーサル ピクセルの火災をコンバージョンと見なすために満たす必要があるルールの配列を含める必要があります。 たとえば、以下の ルール は、ユニバーサル ピクセル火災が microsoft.com を含むドメインを持つ Web サイト上にある必要があることを意味し、ピクセル火災のイベントは Purchase であり、 item_id は 123 。 |
user_ttl_minutes |
integer | この対象ユーザーの TTL (Time To Live) (分単位)。 maximum = 259200 、 minimum = 0 、 default = 43200 。 |
rule
ID (要求本文) で対象ユーザーを更新する場合
"rule":{"and":[{"domain":{"contains":["microsoft.com"]}},
{"event":{"equals":["Purchase"]}},{"item_id":{"equals":["123"]}}],
"pixel_uuid":"0b3758f1-cf0f-46c1-9957-00bd36f19ad0"},
ID で対象ユーザーを更新するための JSON フィールド (応答本文)
フィールド | 種類 | 説明 |
---|---|---|
id |
integer | API によって割り当てられた対象ユーザー ID。 |
version_id |
integer | 対象ユーザーに関連付けられているバージョン ID。 |
universal_pixel_id |
integer | 対象ユーザーを関連付けるユニバーサル ピクセルの ID。 |
advertiser_id |
integer | 対象ユーザーに関連付けられている広告主の ID。 |
name |
string | 対象ユーザーの名前。 |
user_ttl_minutes |
integer | この対象ユーザーが存在する分。 maximum = 259200 、 minimum = 0 、 default = 43200 。 |
segment_id |
integer | この対象ユーザーをターゲットにするために使用するセグメント ID。 |
rule |
object | 対象ユーザーのルール セット。 このフィールドはオブジェクトであり、ユニバーサル ピクセルの火災を変換と見なすために満たす必要があるルールの配列が含まれています。 たとえば、以下の ルール は、ユニバーサル ピクセル火災が microsoft.com を含むドメインを持つ Web サイト上にある必要があることを意味し、ピクセル火災のイベントは Purchase であり、 item_id は 123 。 |
created_on |
string | 対象ユーザーが作成されたときのタイムスタンプ。 Format: YYYY-MM-DD HH:MM:SS たとえば、 2019-03-08 15:34:18 。 |
published_on |
string | 対象ユーザーが公開されたときのタイムスタンプ。 Format: YYYY-MM-DD HH:MM:SS たとえば、 2019-03-08 15:34:18 。 |
rule
ID (応答本文) による対象ユーザーの更新
"rule":{"and":[{"domain":{"contains":["microsoft.com"]}},
{"event":{"equals":["Purchase"]}},{"item_id":{"equals":["123"]}}],
"pixel_uuid":"0b3758f1-cf0f-46c1-9957-00bd36f19ad0"},
ID で対象ユーザーを削除する
ID で対象ユーザーを削除するためのクエリ フィールド
フィールド | 種類 | 説明 |
---|---|---|
id |
integer | 削除される API によって割り当てられた対象ユーザーの ID。 |
変換 REST API
HTTP メソッド | エンドポイント | 説明 |
---|---|---|
GET |
https://api.appnexus.com/universal-pixel/conversion | メンバーまたは広告主に関連付けられているコンバージョンの一覧を表示します。 |
POST |
https://api.appnexus.com/universal-pixel/conversion | 新しい変換を作成します。 |
GET |
https://api.appnexus.com/universal-pixel/conversion/CONVERSION_ID | ID で変換を表示します。 |
PUT |
https://api.appnexus.com/universal-pixel/conversion/CONVERSION_ID | ID による変換を更新します。 |
DELETE |
https://api.appnexus.com/universal-pixel/conversion/CONVERSION_ID | ID による変換を削除します。 |
コンバージョンの一覧を表示する
変換の一覧を表示するためのクエリ フィールド
フィールド | 種類 | 説明 |
---|---|---|
member_id |
integer | 操作の変換に関連付けられているメンバーの ID。 |
advertiser_id |
integer | コンバージョンに関連付けられている広告主の ID。 |
sort |
string | フィールドと方向で並べ替え: - ID 昇順 = id.asc - ID 降順 = id.dsc デフォルト = id.asc |
num_elements |
integer | 返す要素の数。 maximum = 1000 、 minimum = 1 、 default = 1000 。 |
start_element |
integer | 開始要素 (ページングに使用)。 既定値 = 0 。 |
universal_pixel_id |
integer | フィルター処理するユニバーサル ピクセル ID。 |
conversion_pixel_id |
integer | レガシ変換ピクセルの ID。 |
search |
string | 検索用語。 |
変換の一覧を表示するための JSON フィールド (応答本文)
フィールド | 種類 | 説明 |
---|---|---|
data |
配列 | 変換オブジェクトの配列。 |
id |
integer | API によって割り当てられた変換 ID。 |
universal_pixel_id |
integer | この変換に関連付けられているユニバーサル ピクセルの ID。 |
name |
string | 変換の名前。 |
conversion_pixel_id |
integer | レガシ変換ピクセルの ID。 |
conversion_category_id |
integer | 変換イベント カテゴリの ID。
conversion_category_id の値を参照してください。 |
conversion_category_custom |
string | カスタム変換イベント カテゴリのラベル。 このフィールドは、変換を含めるカテゴリの文字列値に設定されます。 注: このフィールドは、 conversion_category_id が null されている場合にのみ設定されます。 |
count_type |
列挙 | 変換カウントの種類 - view 、 click 、または hybrid 。 |
min_minutes_per_conversion |
integer | 繰り返し変換を許可する間隔 (分単位)。 最大値は 32767 (22 日) です。- [ 0 ] に設定されている場合: すべての変換をカウントします。- null に設定されている場合 (既定値): ユーザーごとに 1 人をカウントします。 |
post_click_value |
番号 | クリック後の変換に属性を設定する値。 |
post_click_expire_minutes |
番号 | ビューのコンバージョンが対象としてカウントされるインプレッション時間からの間隔 (分単位)。 最大値は 43200 (30 日) です。
0 またはnull に設定すると、最大ルックバック ウィンドウが適用されます。 |
post_view_value |
番号 | ビューの後の変換に属性を設定する値。 |
post_view_expire_minutes |
番号 | ビューの後の変換に属性を設定する値。 |
rule |
object | 対象ユーザーのルール セット。 このフィールドはオブジェクトであり、ユニバーサル ピクセルの火災を変換と見なすために満たす必要があるルールの配列が含まれています。 たとえば、以下の ルール は、ユニバーサル ピクセル火災が microsoft.com を含むドメインを持つ Web サイト上にある必要があることを意味し、ピクセル火災のイベントは Purchase であり、 item_id は 123 。 |
created_on |
string | 対象ユーザーが作成されたときのタイムスタンプ。 Format: YYYY-MM-DD HH:MM:SS たとえば、 2019-03-08 15:34:18 。 |
published_on |
string | 対象ユーザーが公開されたときのタイムスタンプ。 Format: YYYY-MM-DD HH:MM:SS たとえば、 2019-03-08 15:34:18 。 |
conversion_category_id
価値観
{ id: 1, title: ' Page view', event: 'PageView' },
{ id: 2, title: ' Landing page', event: 'LandingPage' },
{ id: 3, title: ' Item view', event: 'ItemView' },
{ id: 4, title: ' Add to cart', event: 'AddToCart' },
{ id: 5, title: ' Initiate checkout', event: 'InitiateCheckout' },
{ id: 6, title: ' Add payment info', event: 'AddPaymentInfo' },
{ id: 7, title: ' Purchase', event: 'Purchase' },
{ id: 8, title: ' Lead', event: 'Lead' },
{ id: null, title: ' Other' },
rule
変換の一覧を表示するための (応答本文)
"rule": {
"and": [
{
"domain":
{ "contains": [ "microsoft.com" ] }
},
{
"event":
{ "equals": [ "Purchase" ] }
},
{
"item_id":
{ "equals": [ "123" ] }
}
],
"pixel_uuid": "0b3758f1-cf0f-46c1-9957-00bd36f19ad0"
},
新しいコンバージョンを作成する
新しい変換を作成するためのクエリ フィールド
フィールド | 種類 | 説明 |
---|---|---|
member_id |
integer | 操作の Conversion に関連付けられているメンバーの ID。 |
新しい変換を作成するための JSON フィールド (要求本文)
フィールド | 種類 | 説明 |
---|---|---|
universal_pixel_id |
integer | この変換が関連付けられているユニバーサル ピクセルの ID。 これは 必須 フィールドです。 |
name |
string | 変換の名前。 これは 必須 フィールドです。 |
conversion_category_id |
integer | 変換イベント カテゴリの ID。
conversion_category_id の値を参照してください。 |
conversion_category_custom |
string | カスタム変換イベント カテゴリのラベル。 このフィールドは、変換を含めるカテゴリの文字列値に設定されます。 手記: このフィールドは、 conversion_category_id が null されている場合にのみ設定されます。 |
count_type |
列挙 | 変換カウントの種類 - view 、 click 、または hybrid 。 これは 必須 フィールドです。 |
min_minutes_per_conversion |
integer | 繰り返し変換を許可する間隔 (分単位)。 最大値は 32767 (22 日) です。- [ 0 ] に設定されている場合: すべての変換をカウントします。- null に設定されている場合 (既定値): ユーザーごとに 1 人をカウントします。 |
post_click_value |
番号 | クリック後の変換に属性を設定する値。 |
post_click_expire_minutes |
番号 | ビューのコンバージョンが対象としてカウントされるインプレッション時間からの間隔 (分単位)。 最大値は 43200 (30 日) です。
0 またはnull に設定すると、最大ルックバック ウィンドウが適用されます。 |
post_view_value |
番号 | ビューの後の変換に属性を設定する値。 |
post_view_expire_minutes |
番号 | ビューの後の変換に属性を設定する値。 |
rule |
object | 対象ユーザーのルール セット。 これは 必須 フィールドとオブジェクトです。 ユニバーサル ピクセルの火災をコンバージョンと見なすために満たす必要があるルールの配列を含める必要があります。 たとえば、以下の ルール は、ユニバーサル ピクセル火災が microsoft.com を含むドメインを持つ Web サイト上にある必要があることを意味し、ピクセル火災のイベントは Purchase であり、 item_id は 123 。 |
conversion_category_id
新しい変換を作成するための値 (要求本文)
{ id: 1, title: ' Page view', event: 'PageView' },
{ id: 2, title: ' Landing page', event: 'LandingPage' },
{ id: 3, title: ' Item view', event: 'ItemView' },
{ id: 4, title: ' Add to cart', event: 'AddToCart' },
{ id: 5, title: ' Initiate checkout', event: 'InitiateCheckout' },
{ id: 6, title: ' Add payment info', event: 'AddPaymentInfo' },
{ id: 7, title: ' Purchase', event: 'Purchase' },
{ id: 8, title: ' Lead', event: 'Lead' },
{ id: null, title: ' Other' },
rule
新しい変換を作成するための (要求本文)
"rule": {
"and": [
{
"domain":
{ "contains": [ "microsoft.com" ] }
},
{
"event":
{ "equals": [ "Purchase" ] }
},
{
"item_id":
{ "equals": [ "123" ] }
}
],
"pixel_uuid": "0b3758f1-cf0f-46c1-9957-00bd36f19ad0"
},
新しい変換を作成するための JSON フィールド (応答本文)
フィールド | 種類 | 説明 |
---|---|---|
id |
integer | API によって割り当てられた変換 ID。 |
member_id |
integer | 操作の変換に関連付けられているメンバーの ID。 |
version_id |
integer | この変換のバージョン。 |
universal_pixel_id |
integer | この変換に関連付けられているユニバーサル ピクセルの ID。 |
name |
string | 変換の名前。 |
conversion_pixel_id |
integer | レガシ変換ピクセルの ID。 |
conversion_category_id |
integer | 変換イベント カテゴリの ID。
conversion_category_id の値を参照してください。 |
conversion_category_custom |
string | カスタム変換イベント カテゴリのラベル。 このフィールドは、変換を含めるカテゴリの文字列値に設定されます。 警告: このフィールドは、 conversion_category_id が null されている場合にのみ設定されます。 |
count_type |
列挙 | 変換カウントの種類 - view 、 click 、または hybrid 。 |
min_minutes_per_conversion |
integer | 繰り返し変換を許可する間隔 (分単位)。 最大値は 32767 (22 日) です。- [ 0 ] に設定されている場合: すべての変換をカウントします。- null に設定されている場合 (既定値): ユーザーごとに 1 人をカウントします。 |
post_click_value |
番号 | クリック後の変換に属性を設定する値。 |
post_click_expire_minutes |
番号 | ビューのコンバージョンが対象としてカウントされるインプレッション時間からの間隔 (分単位)。 最大値は 43200 (30 日) です。
0 またはnull に設定すると、最大ルックバック ウィンドウが適用されます。 |
post_view_value |
番号 | ビューの後の変換に属性を設定する値。 |
post_view_expire_minutes |
番号 | ビューの後の変換に属性を設定する値。 |
rule |
object | 対象ユーザーのルール セット。 このフィールドはオブジェクトであり、ユニバーサル ピクセルの火災を変換と見なすために満たす必要があるルールの配列が含まれています。 たとえば、以下の ルール は、ユニバーサル ピクセル火災が microsoft.com を含むドメインを持つ Web サイト上にある必要があることを意味し、ピクセル火災のイベントは Purchase であり、 item_id は 123 。 |
created_on |
string | 対象ユーザーが作成されたときのタイムスタンプ。 Format: YYYY-MM-DD HH:MM:SS たとえば、 2019-03-08 15:34:18 。 |
published_on |
string | 対象ユーザーが公開されたときのタイムスタンプ。 Format: YYYY-MM-DD HH:MM:SS たとえば、 2019-03-08 15:34:18 。 |
conversion_category_id
新しい変換を作成するための値
{ id: 1, title: ' Page view', event: 'PageView' },
{ id: 2, title: ' Landing page', event: 'LandingPage' },
{ id: 3, title: ' Item view', event: 'ItemView' },
{ id: 4, title: ' Add to cart', event: 'AddToCart' },
{ id: 5, title: ' Initiate checkout', event: 'InitiateCheckout' },
{ id: 6, title: ' Add payment info', event: 'AddPaymentInfo' },
{ id: 7, title: ' Purchase', event: 'Purchase' },
{ id: 8, title: ' Lead', event: 'Lead' },
{ id: null, title: ' Other' },
rule
新しい変換を作成するための (応答本文)
"rule": {
"and": [
{
"domain":
{ "contains": [ "microsoft.com" ] }
},
{
"event":
{ "equals": [ "Purchase" ] }
},
{
"item_id":
{ "equals": [ "123" ] }
}
],
"pixel_uuid": "0b3758f1-cf0f-46c1-9957-00bd36f19ad0"
},
ID で変換を表示する
ID による変換を表示するためのクエリ フィールド
フィールド | 種類 | 説明 |
---|---|---|
id |
integer | 操作のために API によって割り当てられたユニバーサル ピクセルの ID。 |
ID による変換を表示するための JSON フィールド (応答本文)
フィールド | 種類 | 説明 |
---|---|---|
id |
integer | API によって割り当てられた変換 ID。 |
member_id |
integer | 操作の変換に関連付けられているメンバーの ID。 |
version_id |
integer | この変換のバージョン。 |
universal_pixel_id |
integer | この変換に関連付けられているユニバーサル ピクセルの ID。 |
name |
string | 変換の名前。 |
conversion_pixel_id |
integer | レガシ変換ピクセルの ID。 |
conversion_category_id |
integer | 変換イベント カテゴリの ID。
conversion_category_id の値を参照してください。 |
conversion_category_custom |
string | カスタム変換イベント カテゴリのラベル。 このフィールドは、変換を含めるカテゴリの文字列値に設定されます。 重要: このフィールドは、 conversion_category_id が null されている場合にのみ設定されます。 |
count_type |
列挙 | 変換カウントの種類 - view 、 click 、または hybrid 。 |
min_minutes_per_conversion |
integer | 繰り返し変換を許可する間隔 (分単位)。 最大値は 32767 (22 日) です。- [ 0 ] に設定されている場合: すべての変換をカウントします。- null に設定されている場合 (既定値): ユーザーごとに 1 人をカウントします。 |
post_click_value |
番号 | クリック後の変換に属性を設定する値。 |
post_click_expire_minutes |
番号 | ビューのコンバージョンが対象としてカウントされるインプレッション時間からの間隔 (分単位)。 最大値は 43200 (30 日) です。
0 またはnull に設定すると、最大ルックバック ウィンドウが適用されます。 |
post_view_value |
番号 | ビューの後の変換に属性を設定する値。 |
post_view_expire_minutes |
番号 | ビューの後の変換に属性を設定する値。 |
rule |
object | 対象ユーザーのルール セット。 このフィールドはオブジェクトであり、ユニバーサル ピクセルの火災を変換と見なすために満たす必要があるルールの配列が含まれています。 たとえば、以下の ルール は、ユニバーサル ピクセル火災が microsoft.com を含むドメインを持つ Web サイト上にある必要があることを意味し、ピクセル火災のイベントは Purchase であり、 item_id は 123 。 |
created_on |
string | 対象ユーザーが作成されたときのタイムスタンプ。 Format: YYYY-MM-DD HH:MM:SS たとえば、 2019-03-08 15:34:18 。 |
published_on |
string | 対象ユーザーが公開されたときのタイムスタンプ。 Format: YYYY-MM-DD HH:MM:SS たとえば、 2019-03-08 15:34:18 。 |
conversion_category_id
ID による変換を表示するための値
{ id: 1, title: ' Page view', event: 'PageView' },
{ id: 2, title: ' Landing page', event: 'LandingPage' },
{ id: 3, title: ' Item view', event: 'ItemView' },
{ id: 4, title: ' Add to cart', event: 'AddToCart' },
{ id: 5, title: ' Initiate checkout', event: 'InitiateCheckout' },
{ id: 6, title: ' Add payment info', event: 'AddPaymentInfo' },
{ id: 7, title: ' Purchase', event: 'Purchase' },
{ id: 8, title: ' Lead', event: 'Lead' },
{ id: null, title: ' Other' },
rule
ID (応答本文) で変換を表示する場合
"rule": {
"and": [
{
"domain":
{ "contains": [ "microsoft.com" ] }
},
{
"event":
{ "equals": [ "Purchase" ] }
},
{
"item_id":
{ "equals": [ "123" ] }
}
],
"pixel_uuid": "0b3758f1-cf0f-46c1-9957-00bd36f19ad0"
},
ID による変換の更新
ID による変換を更新するためのクエリ フィールド
フィールド | 種類 | 説明 |
---|---|---|
id |
integer | 操作用に API によって割り当てられた変換の ID。 |
ID による変換を更新するための JSON フィールド (要求本文)
既存の値から新しい値に変更する必要があるフィールド。 例:
フィールド | 種類 | 説明 |
---|---|---|
name |
string | 変換の名前。 |
conversion_category_id |
integer | 変換イベント カテゴリの ID。
conversion_category_id の値を参照してください。 |
conversion_category_custom |
string | カスタム変換イベント カテゴリのラベル。 このフィールドは、変換を含めるカテゴリの文字列値に設定されます。 警告: このフィールドは、 conversion_category_id が null されている場合にのみ設定されます。 |
count_type |
列挙 | 変換カウントの種類 - view 、 click 、または hybrid 。 これは 必須 フィールドです。 |
min_minutes_per_conversion |
integer | 繰り返し変換を許可する間隔 (分単位)。 最大値は 32767 (22 日) です。- [ 0 ] に設定されている場合: すべての変換をカウントします。- null に設定されている場合 (既定値): ユーザーごとに 1 人をカウントします。 |
post_click_value |
番号 | クリック後の変換に属性を設定する値。 |
post_click_expire_minutes |
番号 | ビューのコンバージョンが対象としてカウントされるインプレッション時間からの間隔 (分単位)。 最大値は 43200 (30 日) です。
0 またはnull に設定すると、最大ルックバック ウィンドウが適用されます。 |
post_view_value |
番号 | ビューの後の変換に属性を設定する値。 |
post_view_expire_minutes |
番号 | ビューの後の変換に属性を設定する値。 |
rule |
object | 対象ユーザーのルール セット。 これは 必須 フィールドとオブジェクトです。 ユニバーサル ピクセルの火災をコンバージョンと見なすために満たす必要があるルールの配列を含める必要があります。 たとえば、以下の ルール は、ユニバーサル ピクセル火災が microsoft.com を含むドメインを持つ Web サイト上にある必要があることを意味し、ピクセル火災のイベントは Purchase であり、 item_id は 123 。 |
conversion_category_id
ID による変換を更新するための値
{ id: 1, title: ' Page view', event: 'PageView' },
{ id: 2, title: ' Landing page', event: 'LandingPage' },
{ id: 3, title: ' Item view', event: 'ItemView' },
{ id: 4, title: ' Add to cart', event: 'AddToCart' },
{ id: 5, title: ' Initiate checkout', event: 'InitiateCheckout' },
{ id: 6, title: ' Add payment info', event: 'AddPaymentInfo' },
{ id: 7, title: ' Purchase', event: 'Purchase' },
{ id: 8, title: ' Lead', event: 'Lead' },
{ id: null, title: ' Other' },
rule
ID (要求本文) による変換を更新する場合
"rule": {
"and": [
{
"domain":
{ "contains": [ "microsoft.com" ] }
},
{
"event":
{ "equals": [ "Purchase" ] }
},
{
"item_id":
{ "equals": [ "123" ] }
}
],
"pixel_uuid": "0b3758f1-cf0f-46c1-9957-00bd36f19ad0"
},
ID による変換を更新するための JSON フィールド (応答本文)
フィールド | 種類 | 説明 |
---|---|---|
id |
integer | API によって割り当てられた変換 ID。 |
member_id |
integer | 操作の変換に関連付けられているメンバーの ID。 |
version_id |
integer | この変換のバージョン。 |
universal_pixel_id |
integer | この変換に関連付けられているユニバーサル ピクセルの ID。 |
name |
string | 変換の名前。 |
conversion_pixel_id |
integer | レガシ変換ピクセルの ID。 |
conversion_category_id |
integer | 変換イベント カテゴリの ID。
conversion_category_id の値を参照してください。 |
conversion_category_custom |
string | カスタム変換イベント カテゴリのラベル。 このフィールドは、変換を含めるカテゴリの文字列値に設定されます。 警告: このフィールドは、 conversion_category_id が null されている場合にのみ設定されます。 |
count_type |
列挙 | 変換カウントの種類 - view 、 click 、または hybrid 。 |
min_minutes_per_conversion |
integer | 繰り返し変換を許可する間隔 (分単位)。 最大値は 32767 (22 日) です。- 0 に設定されている場合: すべての変換をカウントします。- null に設定されている場合 (既定値): ユーザーごとに 1 人をカウントします。 |
post_click_value |
番号 | クリック後の変換に属性を設定する値。 |
post_click_expire_minutes |
番号 | ビューのコンバージョンが対象としてカウントされるインプレッション時間からの間隔 (分単位)。 最大値は 43200 (30 日) です。
0 またはnull に設定すると、最大ルックバック ウィンドウが適用されます。 |
post_view_value |
番号 | ビューの後の変換に属性を設定する値。 |
post_view_expire_minutes |
番号 | ビューの後の変換に属性を設定する値。 |
rule |
object | 対象ユーザーのルール セット。 このフィールドはオブジェクトであり、ユニバーサル ピクセルの火災を変換と見なすために満たす必要があるルールの配列が含まれています。 たとえば、以下の ルール は、ユニバーサル ピクセル火災が microsoft.com を含むドメインを持つ Web サイト上にある必要があることを意味し、ピクセル火災のイベントは Purchase であり、 item_id は 123 。 |
created_on |
string | 対象ユーザーが作成されたときのタイムスタンプ。 Format: YYYY-MM-DD HH:MM:SS たとえば、 2019-03-08 15:34:18 。 |
published_on |
string | 対象ユーザーが公開されたときのタイムスタンプ。 Format: YYYY-MM-DD HH:MM:SS たとえば、 2019-03-08 15:34:18 。 |
conversion_category_id
ID による変換を更新するための値 (応答本文)
{ id: 1, title: ' Page view', event: 'PageView' },
{ id: 2, title: ' Landing page', event: 'LandingPage' },
{ id: 3, title: ' Item view', event: 'ItemView' },
{ id: 4, title: ' Add to cart', event: 'AddToCart' },
{ id: 5, title: ' Initiate checkout', event: 'InitiateCheckout' },
{ id: 6, title: ' Add payment info', event: 'AddPaymentInfo' },
{ id: 7, title: ' Purchase', event: 'Purchase' },
{ id: 8, title: ' Lead', event: 'Lead' },
{ id: null, title: ' Other' },
rule
ID による変換を更新するための (応答本文)
"rule": {
"and": [
{
"domain":
{ "contains": [ "microsoft.com" ] }
},
{
"event":
{ "equals": [ "Purchase" ] }
},
{
"item_id":
{ "equals": [ "123" ] }
}
],
"pixel_uuid": "0b3758f1-cf0f-46c1-9957-00bd36f19ad0"
},
ID による変換の削除
ID による変換を削除するためのクエリ フィールド
フィールド | 種類 | 説明 |
---|---|---|
id |
integer | 削除される API によって割り当てられたユニバーサル ピクセルの ID。 |
例
ユニバーサル ピクセルの一覧を取得する
$ curl -b cookies "https://api.appnexus.com/universal-pixel/pixel"
{
"data": [{
"id": 0,
"name": "string",
"uuid": "string",
"member_id": 0,
"advertiser_id": 0,
"created_on": "2019-04-16T20:43:33.663Z",
"last_modified": "2019-04-16T20:43:33.663Z"
}],
"meta": {
"count": 0,
"start_element": 0,
"num_elements": 0,
"sort": [
"string"
]
}
}
例: 新しいユニバーサル ピクセルを作成する
$ cat new-universal-pixel.json
{
"name": "string",
"advertiser_id": 0
}
$ curl -b cookies -d @new-universal-pixel.json -X POST https://api.appnexus.com/universal-pixel/pixel
{
"id": 0,
"name": "string",
"uuid": "string",
"member_id": 0,
"advertiser_id": 0,
"created_on": "2019-04-16T21:23:52.049Z",
"last_modified": "2019-04-16T21:23:52.049Z"
}
例: ID でユニバーサル ピクセルを表示する
$ curl -b cookies "https://api.appnexus.com/universal-pixel/pixel/3"
response:
{
"created_on": "2019-04-09T21:27:54.455Z",
"id": 3,
"last_modified": "2019-04-09T21:27:54.455Z",
"member_id": 0,
"name": "Production Pixel 1",
"uuid": "b95be84e-d95b-4c88-8242-d9c6c026ed30"
}
例: ID でユニバーサル ピクセルを更新する
{
"name": "string"
}
例: UUID でユニバーサル ピクセルを表示する
$ curl -b cookies "https://api.appnexus.com/universal-pixel/pixel-uuid/239e941-0356-47bd-9f92-f46e46d34d16`
response:
{
"advertiser_id": 4647027,
"created_on": "2020-05-26T16:05:12.049Z",
"id": 2716,
"last_modified": "2020-05-26T16:05:12.049Z",
"member_id": 1370,
"name": "Test",
"uuid": "7239e941-0356-47bd-9f92-f46e46d34d16"
}
メンバーまたは広告主に関連付けられている対象ユーザーの一覧を表示する
- member: curl -b cookies "https://api.appnexus.com/universal-pixel/audience?member_id=1111"
- advertiser: grab the Universal Pixel ID created under the advertiser and run:
curl -b cookies "https://api.appnexus.com/universal-pixel/audience?universal_pixel_id=2716"
{
"data": [
{
"id": 0,
"version_id": 0,
"universal_pixel_id": 0,
"advertiser_id": 0,
"name": "string",
"segment_id": 0,
"user_ttl_minutes": 0,
"rule": {
"and": [
{
"domain":
{ "contains": [ "microsoft.com" ] }
},
{
"event":
{ "equals": [ "Purchase" ] }
},
{
"item_id":
{ "equals": [ "123" ] }
}
],
"pixel_uuid": "0b3758f1-cf0f-46c1-9957-00bd36f19ad0"
},
"created_on": "2020-04-16T13:15:19.056Z",
"published_on": "2020-04-16T13:15:19.057Z"
}
],
"meta": {
"count": 0,
"start_element": 0,
"num_elements": 0,
"sort": [
"string"
]
}
例: 新しい対象ユーザーを作成する
$ cat new-audience.json
{
"universal_pixel_id": 0,
"name": "string",
"user_ttl_minutes": 0,
"rule": {
"and": [
{
"domain":
{ "contains": [ "microsoft.com" ] }
},
{
"event":
{ "equals": [ "Purchase" ] }
},
{
"item_id":
{ "equals": [ "123" ] }
}
],
"pixel_uuid": "0b3758f1-cf0f-46c1-9957-00bd36f19ad0"
}
}
$ curl -b cookies -d @new-audience.json -X POST https://api.appnexus.com/universal-pixel/audience
{
"id": 0,
"version_id": 0,
"universal_pixel_id": 0,
"advertiser_id": 0,
"name": "string",
"segment_id": 0,
"user_ttl_minutes": 0,
"rule": {
"and": [
{
"domain":
{ "contains": [ "microsoft.com" ] }
},
{
"event":
{ "equals": [ "Purchase" ] }
},
{
"item_id":
{ "equals": [ "123" ] }
}
],
"pixel_uuid": "0b3758f1-cf0f-46c1-9957-00bd36f19ad0"
},
"created_on": "2020-04-16T13:15:48.648Z",
"published_on": "2020-04-16T13:15:48.648Z"
}
例: ID で対象ユーザーを表示する
$ curl -b cookies "https://api.appnexus.com/universal-pixel/audience/10181"
response:
{
"advertiser_id": 4443337,
"created_on": "2020-06-09T15:47:26.578Z",
"id": 11111,
"name": "purchase_capture",
"published_on": "2020-06-09T15:47:27.056Z",
"rule": {
"and": [
{
"domain":
{ "contains": [ "microsoft.com" ] }
},
{
"event":
{ "equals": [ "Purchase" ] }
},
{
"item_id":
{ "equals": [ "123" ] }
}
],
"pixel_uuid": "0b3758f1-cf0f-46c1-9957-00bd36f19ad0"
},
"segment_id": 22222227,
"universal_pixel_id": 2222,
"user_ttl_minutes": 43200,
"version_id": 15000
}
例: ID で対象ユーザーを更新する
$ cat update-audience.json
{
"name": "string",
"user_ttl_minutes": 0,
"rule": {
"and": [
{
"domain":
{ "contains": [ "microsoft.com" ] }
},
{
"event":
{ "equals": [ "Purchase" ] }
},
{
"item_id":
{ "equals": [ "123" ] }
}
],
"pixel_uuid": "0b3758f1-cf0f-46c1-9957-00bd36f19ad0"
},
}
$ curl -b cookies -d @new-universal-pixel.json -X POST https://api.appnexus.com/universal-pixel/audience
{
"id": 0,
"version_id": 0,
"universal_pixel_id": 0,
"advertiser_id": 0,
"name": "string",
"segment_id": 0,
"user_ttl_minutes": 0,
"rule": {
"and": [
{
"domain":
{ "contains": [ "microsoft.com" ] }
},
{
"event":
{ "equals": [ "Purchase" ] }
},
{
"item_id":
{ "equals": [ "123" ] }
}
],
"pixel_uuid": "0b3758f1-cf0f-46c1-9957-00bd36f19ad0"
},
"created_on": "2020-04-16T13:17:29.915Z",
"published_on": "2020-04-16T13:17:29.915Z"
}
メンバーまたは広告主に関連付けられているコンバージョンの一覧を表示する
- member: curl -b cookies "https://api.appnexus.com/universal-pixel/conversion?member_id=2222"
- advertiser: grab the Universal Pixel ID created under the advertiser and run:
curl -b cookies "https://api.appnexus.com/universal-pixel/conversion?universal_pixel_id=27777"
{
"data": [
{
"id": 0,
"member_id": 0,
"version_id": 0,
"universal_pixel_id": 0,
"name": "string",
"conversion_pixel_id": 0,
"conversion_category_id": 7,
"conversion_category_custom": "string",
"count_type": "hybrid",
"min_minutes_per_conv": 0,
"post_view_value": 0,
"post_click_value": 0,
"post_click_expire_minutes": 0,
"post_view_expire_minutes": 0,
"rule": {
"and": [
{
"domain":
{ "contains": [ "microsoft.com" ] }
},
{
"event":
{ "equals": [ "Purchase" ] }
},
{
"item_id":
{ "equals": [ "123" ] }
}
],
"pixel_uuid": "0b3758f1-cf0f-46c1-9957-00bd36f19ad0"
},
"published_on": "2020-04-16T13:20:02.601Z",
"created_on": "2020-04-16T13:20:02.601Z"
}
],
"meta": {
"count": 0,
"start_element": 0,
"num_elements": 0,
"sort": [
"string"
]
}
例: 新しい変換を作成する
$ cat new-conversion.json
{
"universal_pixel_id": 0,
"name": "string",
"conversion_category_id": 2,
"conversion_category_custom": "string",
"count_type": "hybrid",
"min_minutes_per_conv": 0,
"post_view_value": 0,
"post_click_value": 0,
"post_click_expire_minutes": 0,
"post_view_expire_minutes": 0,
"rule": {
"and": [
{
"domain":
{ "contains": [ "microsoft.com" ] }
},
{
"event":
{ "equals": [ "Purchase" ] }
},
{
"item_id":
{ "equals": [ "123" ] }
}
],
"pixel_uuid": "0b3758f1-cf0f-46c1-9957-00bd36f19ad0"
}
}
$ curl -b cookies -d @new-conversion.json -X POST https://api.appnexus.com/universal-pixel/conversion
{
"id": 0,
"member_id": 0,
"version_id": 0,
"universal_pixel_id": 0,
"name": "string",
"conversion_pixel_id": 0,
"conversion_category_id": 2,
"conversion_category_custom": "string",
"count_type": "hybrid",
"min_minutes_per_conv": 0,
"post_view_value": 0,
"post_click_value": 0,
"post_click_expire_minutes": 0,
"post_view_expire_minutes": 0,
"rule": {
"and": [
{
"domain":
{ "contains": [ "microsoft.com" ] }
},
{
"event":
{ "equals": [ "Purchase" ] }
},
{
"item_id":
{ "equals": [ "123" ] }
}
],
"pixel_uuid": "0b3758f1-cf0f-46c1-9957-00bd36f19ad0"
},
"published_on": "2020-04-16T13:20:24.931Z",
"created_on": "2020-04-16T13:20:24.931Z"
}
例: ID で変換を表示する
$ curl -b cookies "https://api.appnexus.com/universal-pixel/conversion/4444"
response:
{
"conversion_category_custom": null,
"conversion_category_id": 7,
"conversion_pixel_id": 1111111,
"count_type": "hybrid",
"created_on": "2020-05-29T21:52:08.388Z",
"id": 4444,
"min_minutes_per_conv": 0,
"name": "Install",
"post_click_expire_minutes": 20160,
"post_click_value": null,
"post_view_expire_minutes": 20160,
"post_view_value": null,
"published_on": "2020-05-29T21:52:09.093Z",
"rule": {
"and": [
{
"domain":
{ "contains": [ "microsoft.com" ] }
},
{
"event":
{ "equals": [ "Purchase" ] }
},
{
"item_id":
{ "equals": [ "123" ] }
}
],
"pixel_uuid": "0b3758f1-cf0f-46c1-9957-00bd36f19ad0"
},
"universal_pixel_id": 2222,
"version_id": 4444
}
例: ID で変換を更新する
$ cat update-conversion.json
{
"name": "string",
"conversion_category_id": 7,
"conversion_category_custom": "string",
"count_type": "hybrid",
"min_minutes_per_conv": 0,
"post_view_value": 0,
"post_click_value": 0,
"post_click_expire_minutes": 0,
"post_view_expire_minutes": 0,
"rule": {
"and": [
{
"domain":
{ "contains": [ "microsoft.com" ] }
},
{
"event":
{ "equals": [ "Purchase" ] }
},
{
"item_id":
{ "equals": [ "123" ] }
}
],
"pixel_uuid": "0b3758f1-cf0f-46c1-9957-00bd36f19ad0"
}
}
$ curl -b cookies -d @update-conversion.json -X POST https://api.appnexus.com/universal-pixel/conversion
{
"id": 0,
"member_id": 0,
"version_id": 0,
"universal_pixel_id": 0,
"name": "string",
"conversion_pixel_id": 0,
"conversion_category_id": 7,
"conversion_category_custom": "string",
"count_type": "hybrid",
"min_minutes_per_conv": 0,
"post_view_value": 0,
"post_click_value": 0,
"post_click_expire_minutes": 0,
"post_view_expire_minutes": 0,
"rule": {
"and": [
{
"domain":
{ "contains": [ "microsoft.com" ] }
},
{
"event":
{ "equals": [ "Purchase" ] }
},
{
"item_id":
{ "equals": [ "123" ] }
}
],
"pixel_uuid": "0b3758f1-cf0f-46c1-9957-00bd36f19ad0"
},
"published_on": "2020-04-16T13:20:24.937Z",
"created_on": "2020-04-16T13:20:24.937Z"
}