インベントリリストアイテムサービス
インベントリ リスト アイテム サービスを使用すると、アプリ バンドル ID と生の URL (ドメインまたはアプリ) を既存のインベントリ リストに追加できます。 例:
- アプリ バンドル ID:
- 617263396
- com.magmamobile.game.Elements
- raw URL (domain): yahoo.com
- raw URL (app): https://itunes.apple.com/us/app/funny-pics-lol!-daily-laughs/id617263396
REST API
HTTP メソッド | エンドポイント | 説明 |
---|---|---|
GET |
https://api.appnexus.com/inventory-list/%5BLIST_ID%5D/item | 特定のインベントリ リスト内のすべてのアイテム (ドメイン/アプリ) を表示します。 |
GET |
https://api.appnexus.com/inventory-list/%5BLIST_ID%5D/item?search=SEARCH_TERM | 特定の文字を含むドメインまたはアプリを検索します。 |
POST |
https://api.appnexus.com/inventory-list/%5BLIST_ID%5D/item | インベントリ リストに新しいドメイン/アプリを追加します。 注: 1000 個のアイテム (ドメイン/アプリ) は、 POST 要求ごとにインベントリ リストに追加できるアイテムの最大数です。 |
PUT |
https://api.appnexus.com/inventory-list/%5BLIST_ID%5D/item/%5BINVENTORY_LIST_ITEM_ID%5D | インベントリ リスト アイテムを更新します。 手記: include_children フィールドは、在庫リストアイテムの唯一のフィールドであり、PUT 要求で更新できます。 |
DELETE |
https://api.appnexus.com/inventory-list/%5BLIST_ID%5D/item?id=1,2,3 | インベントリ リストからアイテム (ドメイン/アプリ) を削除します。 |
JSON フィールド
フィールド | 種類 | 説明 |
---|---|---|
app_name |
string | アプリアイテムの名前 (ドメインの場合null )。 |
audit_status |
列挙 | ドメインまたはアプリの現在の状態。 使用可能な値は次のとおりです。 - audited : ドメインまたはアプリが Xandr インベントリ監査に合格しました。- rejected : ドメインまたはアプリが Xandr インベントリ監査に失敗しました (Xandr ポリシー違反が原因)。- unaudited : ドメインまたはアプリが監査されませんでした。- unauditable : ドメインまたはアプリが監査されませんでした。- pending : ドメインまたはアプリが監査されませんでした (既定値)。- masked : ドメインまたはアプリの実際の URL は、ターゲット設定またはレポートのために販売者によって公開されませんでしたが、まだ監査され、Xandr インベントリ監査に合格しました。- is_adserver : ドメインまたはアプリが監査されず、広告サーバー ドメインとして検出されました。 |
id |
int | 追加するアプリまたはドメインに関連付けられている ID。
POST で自動生成されます。読み取り専用。 必須: PUT |
is_supported |
ブール値 | アプリまたはドメインが現在 Xandr でサポートされているかどうかを示します (監査されているかどうかなど)。
true 場合はサポートされます。 |
inventory_url |
string | 検証されたアプリまたはドメインの URL。 検証の実行方法の詳細については、「 インベントリ項目サービスの検証」を参照してください。 |
include_children |
ブール値 | 親ドメインのサブドメインとサブパスを含めるかどうかを示します。
true 場合、サブドメインが含まれます。 |
rejection_reason |
string | [audit_status ] フィールドが [rejected ] に設定されている場合、このドメインまたはアプリが Xandr ポリシー (Violence 、Hate Speech など) に違反している理由。
audit_status フィールドがrejected に設定されていない場合、このフィールドはnull されます。 |
url |
string |
必須:POST 追加するアイテム (ドメインまたはアプリ) に指定する未加工の URL またはアプリ バンドル ID。 |
例
インベントリ リストにドメインとアプリ (アイテム) を追加する
この例では、ドメインとアプリ (アイテム) をインベントリ リストに追加します。
$ cat inventory-list-item
{
"inventory-list-items": [
{
"url": "bad-domain.com",
"include_children": false
},
{
"url": "app_id"
},
...
]
}
curl -b cookies -X POST -d @inventory-list-item "https://api.appnexus.com/inventory-list/3452/item"
{
"response": {
"status": "OK",
"inventory-list-items": [
{
"audit_status": "rejected",
"inventory_url": "bad-domain.com",
"include_children": false,
"is_supported": true,
"rejection_reason": "Violence"
},
{
"audit_status": "audited",
"inventory_url": "app_url.com",
"include_children": false,
"is_supported": true,
"rejection_reason": null
},
...
]
}
}
特定のインベントリ リスト内のすべてのドメイン/アプリ (アイテム) を表示する
この例では、インベントリ リストにドメインとアプリ (アイテム) を表示します。
$ curl -b cookies -X GET "https://api.appnexus.com/inventory-list/3452/item"
{
"response": {
"status": "OK",
"inventory-list-items": [
{
"id": 1,
"audit_status": "rejected",
"app_name": null,
"inventory_url": "bad-domain.com",
"include_children": false,
"is_supported": true,
"rejection_reason": "Violence"
},
{
"id": 2,
"audit_status": "audited",
"app_name": "Name of the app",
"inventory_url": "app_url.com",
"include_children": false,
"is_supported": true,
"rejection_reason": null
},
...
]
}
}
インベントリ リスト内のインベントリ リスト アイテムを更新する
この例では、インベントリ リスト内のインベントリ リスト アイテムを更新します。
$ cat inventory-list-item
{
"inventory-list-item": {
"include_children": true
}
}
curl -b cookies -X PUT -d @nventory-list-item 'https://api.appnexus.com/inventory-list/3452/item/2'
{
"response": {
"inventory-list-item": {
"id": 2,
"include_children": true,
"audit_status": "audited",
"app_name": "Name of the app",
"inventory_url": "app_url.com"
},
"status": "OK",
"num_elements": 1,
"start_element": 0,
"count": 1
}
}