Data Science ツールキット - 品目モデル サービス
Line Item Model サービスは、カスタム モデルをカスタム モデル配列に関連付けるために使用されます。 標準の Line Item サービスと比較して、Line Item Model サービスでは、クライアントがアップロードしたモデルと Xandr によって生成されたモデルを区別できます。 クライアント モデルと Xandr モデルの違いは、次の点で重要です。
- カスタム モデルのログ レベル データ フィードを使用したレポート。
- 行項目に対して Xandr によって生成されるケイデンス モデルとその他のモデルタイプの関連付け。
- Xandr によって生成されたモデルは、V8 最適化システムの一部として自動的に行項目に追加されます。 入札者は、品目に関連付けられているカスタム モデルを評価するときに、クライアントがアップロードしたモデルを延期する必要があります。
- Xandr 自動プロセスは、クライアントがアップロードしたモデルを上書きしないでください。
使用方法
エンド ポイント
- ドメイン: https://api.appnexus.com
- パス:
/line-item-model
認証
/line-item-model
では、Xandr API 標準認証方法がサポートされています。
サポートされているメソッドとフィールド
Method | エンドポイント | 用途 |
---|---|---|
DELETE | /line-item-model?id={line_item_id} |
"line-item-model" JSON オブジェクトを指定して、行項目に対する 1 つのカスタム モデルの関連付けを削除する |
取得 | /line-item-model?id={line_item_id} |
行項目に関連付けられているカスタム モデルの一覧を取得する |
POST | メソッドはサポートされていません。 | |
PUT | /line-item-model?id={line_item_id} |
"line-item-model" JSON オブジェクトを指定して、行項目に関連付けられている既存のカスタム モデルを追加または更新します。 |
パラメーター
名前 | データ型 | 説明 | 例 |
---|---|---|---|
line-item-id |
int | クエリを実行する行項目オブジェクトの ID 必須: GET、PUT、DELETE |
/line-item-model?id=123 |
フィールド
名前 | データ型 | 説明 | 返されるオン | 例 |
---|---|---|---|---|
custom_model_id |
int | 行項目に関連付けられているカスタム モデルの ID | GET、PUT | "custom_model_id": 211973 |
line-item-models |
string、およびカスタム モデルの配列 | クエリを実行した行項目の ID と、その行項目に関連付けられているカスタム モデルの配列 | GET、PUT | "line_item_models": { "4125657": [ { "custom_model_id": 139527, "type": "cadence" }, { "custom_model_id": 130004, "type": "expected_value" } ] } |
type |
string | このモデル関連付けの "型"。 条件付きコンポーネント モデルの種類の完全な一覧は、[ カスタム モデルによる入札評価 ] ページにあります。 | GET、PUT | "type": "ev_click" |
使用例
GET の例
行項目に関連付けられている 'GET' カスタム モデル
curl -H 'Authorization: {api_token}' 'https://api.appnexus.com/line-item-model?id=123'
応答:
{
"response": {
"dbg_info": {...},
"num_elements": null,
"start_element": null,
"count": 2,
"line_item_models": {
"123": [
{
"custom_model_id": 139527,
"type": "cadence"
},
{
"custom_model_id": 130004,
"type": "expected_value"
}
]
},
"status": "OK"
}
}
PUT の例
'PUT' - 行項目に関連付けられているカスタム モデルを作成および更新する
注:
重要な使用情報
PUT
では、新しいモデルが行項目に追加されるか、既存のモデルが更新されます。 配列でモデルが参照されていない場合、配列にline_item_model
一覧表示されているモデルのいずれかが、既に行項目に関連付けられているモデルと同じtype
でない限り、要求の影響を受けません。
curl -H 'Authorization: {api_token}' -d @update_models.json -X PUT 'https://api.appnexus.com/line-item-model?id=12345'
update_models.json
// Update / Set a single model
{
"line_item_model": {
"custom_model_id": 123,
"type": "click_imp"
}
}
// Set / Update multiple models
{
"line_item_models": [
{
"custom_model_id": 123,
"type": "click_imp"
},
{
"custom_model_id": 456,
"type": "ev_click"
}
]
}
応答:
{
"response": {
"dbg_info": {...},
"num_elements": null,
"start_element": null,
"count": 1,
"line_item_models": {
"12345": [
{
"custom_model_id": 123,
"type": "click_imp"
},
{
"custom_model_id": 456,
"type": "ev_click"
}
]
},
"status": "OK"
}
}
DELETE の例
行項目に関連付けられているカスタム モデルの 'DELETE'
curl -H 'Authorization: {api_token}' -d @detach_model.json -X DELETE 'https://api.appnexus.com/line-item-model?id=:line_item_id'
detach_model.json
{
"line_item_model": {
"type": "cadence"
}
}
応答:
{
"response": {
"dbg_info": {...},
"num_elements": null,
"start_element": null,
"count": 1,
"status": "OK"
}
}