ラベル サービス
この読み取り専用サービスでは、広告主、挿入注文、広告申込情報、キャンペーン、パブリッシャーに適用できるラベルを表示できます。 また、既に適用されているラベルを表示することもできます。
広告主ラベルの例として、 "Salesperson"
があります。 このラベルを使用して、各広告主を担当する営業担当者の名前を指定できます。 その後、 "salesperson_for_advertiser"
でフィルター処理された Network Analytics レポートを実行して、特定の営業担当者が担当する広告主に焦点を当てたり、 "salesperson_for_advertiser"
でグループ化して営業担当者のパフォーマンスをランク付けしたりできます。
現在、次のレポートでは、 Network Analytics、 Network Advertiser Analytics、および Advertiser Analytics のラベルがサポートされています。 ラベルに関連付けられているレポート列の完全な一覧については、以下の "report_field"
を参照してください。
REST API
HTTP メソッド | エンドポイント | 説明 |
---|---|---|
GET |
https://api.appnexus.com/label | 使用可能なすべてのラベルを表示します。 |
GET |
https://api.appnexus.com/label?id=LABEL_ID | 特定のラベルを表示します。 |
GET |
https://api.appnexus.com/label?show_values=true&object_type=OBJECT_TYPE | 特定のオブジェクトの種類に適用されているラベルを表示します。 注: 使用できるオブジェクトの種類は、 advertiser 、 publisher 、 line_item 、 campaign 、 insertion_order です。 |
JSON フィールド
フィールド | 種類 | 説明 |
---|---|---|
id |
int | ラベルの ID。 使用可能な値: 1 、 2 、 3 、 4 、 5 、 7 、 8 、 9 、 11 、 12 、 14 、 15 、 16 。 |
is_user_associated |
ブール値 | このフィールドは に固有です。
true 場合、ラベルはユーザー (つまり、"Salesperson" または"Account Manager" ) に関連付けられるので、ユーザーの名 (姓) によるラベル値の自動補完が可能になります。 |
is_reporting_enabled |
ブール値 |
true 場合、ラベルはレポートで使用できます。 |
last_modified |
timestamp | ラベルが最後に変更された日時。 |
member_id |
int | 現在、すべてのラベルはすべてのメンバーが使用できるため、このフィールドは常に NULL されます。 今後、メンバーが一意のラベルを作成できるようになる可能性があります。その場合、このフィールドは所有するメンバーの ID を返します。 |
name |
string | ラベルの名前。 使用可能な値: "Salesperson" 、 "Account Manager" 、 "Trafficker" 、 "Sales Rep" 、 "Test/Control" 、 "Campaign Type" 、または "Advertiser Type" 。
id
/
name
/
object_type マッピングについては、以下の最初の例を参照してください。 |
object_type |
列挙 | ラベルを適用できるオブジェクトの種類。 使用可能な値: "advertiser" 、 "insertion_order" 、 "line_item" 、 "campaign" 、または "publisher" 。
id
/
name
/
object_type マッピングについては、以下の最初の例を参照してください。 |
report_field |
string | ラベルでレポートできるレポート列。 可能なレポート列 (対応するレポートあり): - salesperson_for_advertiser (Network Analytics)- salesperson_for_publisher (Network Analytics)- account_manager_for_advertiser (Network Analytics)- account_manager_for_publisher (Network Analytics)- trafficker_for_line_item (Network Analytics、Network Advertiser Analytics)- salesrep_for_line_item (Network Analytics、Network Advertiser Analytics)- user_group_for_campaign (Network Analytics、Network Advertiser Analytics、Advertiser Analytics)- advertiser_type (Network Analytics、Network Advertiser Analytics)- line_item_type (Network Analytics、Network Advertiser Analytics)- insertion_order_type (Network Analytics、Network Advertiser Analytics) |
values |
オブジェクトの配列 | このフィールドは、要求GET を使用する場合に返されますhttps://api.appnexus.com/label?show_values=true&。object_type=OBJECT_TYPE。 詳細については、 値 と以下の 2 番目の例 を参照してください。 |
値
フィールド | 種類 | 説明 |
---|---|---|
object_id |
int | ラベルが適用されるオブジェクトの ID。 たとえば、 object_type が "advertiser" されている場合、 object_id は広告主の ID になります。 |
value |
string | ラベルに割り当てられた値。 たとえば、パブリッシャー "Salesperson" ラベルの場合、これは "Michael Sellers" などの名前になります。 |
例
使用可能なすべてのラベルを表示する
$ curl -b cookies -c cookies 'https://api.appnexus.com/label'
{
"response": {
"status": "OK",
"labels": [
{
"id": 1,
"name": "Salesperson",
"member_id": null,
"is_user_associated": true,
"is_reporting_enabled": true,
"object_type": "advertiser",
"report_field": "salesperson_for_advertiser",
"last_modified": "2010-09-14 22:12:38"
},
{
"id": 2,
"name": "Salesperson",
"member_id": null,
"is_user_associated": true,
"is_reporting_enabled": true,
"object_type": "publisher",
"report_field": "salesperson_for_publisher",
"last_modified": "2010-09-14 22:12:43"
},
{
"id": 3,
"name": "Account Manager",
"member_id": null,
"is_user_associated": true,
"is_reporting_enabled": true,
"object_type": "advertiser",
"report_field": "account_manager_for_advertiser",
"last_modified": "2010-09-14 22:12:47"
},
{
"id": 4,
"name": "Account Manager",
"member_id": null,
"is_user_associated": true,
"is_reporting_enabled": true,
"object_type": "publisher",
"report_field": "account_manager_for_publisher",
"last_modified": "2010-09-14 22:12:51"
},
{
"id": 5,
"name": "Region",
"member_id": null,
"is_user_associated": false,
"is_reporting_enabled": true,
"object_type": "advertiser",
"report_field": "region_for_advertiser",
"last_modified": "2011-01-21 19:39:37"
},
{
"id": 7,
"name": "Trafficker",
"member_id": null,
"is_user_associated": true,
"is_reporting_enabled": true,
"object_type": "line_item",
"report_field": "trafficker_for_line_item",
"last_modified": "2011-05-31 16:11:21"
},
{
"id": 8,
"name": "Sales Rep",
"member_id": null,
"is_user_associated": true,
"is_reporting_enabled": true,
"object_type": "line_item",
"report_field": "salesrep_for_line_item",
"last_modified": "2011-05-31 16:11:29"
},
{
"id": 9,
"name": "Test/Control",
"member_id": null,
"is_user_associated": true,
"is_reporting_enabled": true,
"object_type": "campaign",
"report_field": "user_group_for_campaign",
"last_modified": "2011-12-06 18:07:44"
},
...
],
"count": 10,
"start_element": 0,
"num_elements": 100
}
}
広告主に適用されているラベルを表示する
$ curl -b cookies -c cookies 'https://api.appnexus.com/label?show_values=true&object_type=advertiser'
{
"response": {
"status": "OK",
"labels": [
{
"id": 1,
"name": "Salesperson",
"member_id": null,
"is_user_associated": true,
"is_reporting_enabled": true,
"object_type": "advertiser",
"report_field": "salesperson_for_advertiser",
"values": [
{
"object_id": "7669",
"value": "Phillip Turner"
},
{
"object_id": "7670",
"value": "Ami Kraft"
},
{
"object_id": "7713",
"value": "Michelle Jacobs"
},
{
"object_id": "7719",
"value": "Michelle Jacobs"
},
{
"object_id": "7759",
"value": "Phillip Turner"
},
{
"object_id": "7760",
"value": "Phillip Turner"
},
{
"object_id": "7761",
"value": "Ami Kraft"
}
],
"last_modified": "2011-12-18 20:13:32"
},
{
"id": 3,
"name": "Account Manager",
"member_id": null,
"is_user_associated": true,
"is_reporting_enabled": true,
"object_type": "advertiser",
"report_field": "account_manager_for_advertiser",
"values": [
{
"object_id": "7669",
"value": "Tina Rivera"
},
{
"object_id": "7670",
"value": "Richard Seiken"
},
{
"object_id": "7713",
"value": "Richard Seiken"
},
{
"object_id": "7719",
"value": "Norman Fischer"
},
{
"object_id": "7759",
"value": "Norman Fischer"
},
{
"object_id": "7760",
"value": "Tina Revera"
},
{
"object_id": "7761",
"value": "Norman Fisher"
}
],
"last_modified": "2010-09-28 20:13:32"
}
],
"count": 2,
"start_element": null,
"num_elements": null
}
}