Digital Platform API - オブジェクト制限サービス
Xandr は、プラットフォームで使用できる広告申込情報、キャンペーン、クリエイティブ、パブリッシャー、サイト、プレースメント、パッケージ、取引、仲介ネットワーク、仲介入札の数を制限します。 さらに、Xandr では、1 つのドメイン リストで使用できるドメインの数、1 つのプロファイルで使用できる特定のターゲットの数、1 つの配置に割り当てることができるコンテンツ カテゴリの数が制限されます。 クリエイティブを除くすべてのオブジェクト タイプでは、アクティブオブジェクトと非アクティブオブジェクトの両方が制限に対してカウントされます。 クリエイティブの場合、期限切れでないオブジェクトのみが制限に対してカウントされます。
オブジェクト制限サービスを使用すると、これらの制限を表示し、現在の使用状況を事前に監視できます。
REST API
HTTP メソッド | エンドポイント | 説明 |
---|---|---|
GET |
https://api.appnexus.com/object-limit |
すべてのオブジェクトの種類の制限と現在の使用状況を表示します。 |
GET |
https://api.appnexus.com/object-limit?object_type=OBJECT_TYPE |
特定のオブジェクトの種類の制限と現在の使用状況を表示します。 注: 次のオブジェクト型を使用できます。 - campaign - profile - domain_list - creative - publisher - site - placement - package - deal - mediated_network - mediated_bid . 広告申込情報の制限を取得するには、 を使用 campaign_group する必要があることに注意してください。 |
JSON フィールド
フィールド | 種類 | 説明 |
---|---|---|
count_active |
int | アクティブなオブジェクトの現在の数。 クリエイティブの場合、この数には期限切れのオブジェクトは含まれません。 |
count_inactive |
int | 削除されたオブジェクトを含まない非アクティブなオブジェクトの現在の数。 クリエイティブの場合、この数には期限切れのオブジェクトは含まれません。 |
count_total |
int | アクティブなオブジェクトと非アクティブなオブジェクトの現在の合計数。 クリエイティブの場合、この数には期限切れのオブジェクトは含まれません。 |
limit |
int | メンバーが許可されるオブジェクトの最大数。 を除く "creative" すべてのオブジェクト型に対して、アクティブオブジェクトと非アクティブオブジェクトの両方が制限値としてカウントされます。 クリエイティブの場合、期限切れでないオブジェクトのみが制限に対してカウントされます。 |
mapping_limits |
object | このフィールドは、、"domain_list" 、および "placement" オブジェクトの型に対"profile" してのみ設定されます。 各プロファイルおよびドメイン リスト内のオブジェクトの制限が一覧表示されます。たとえば、1 つのプロファイルで使用できるセグメント ターゲットの最大数や、1 つのドメイン リストで使用できるドメインの最大数などです。 配置については、配置に適用できるコンテンツ カテゴリの最大数が一覧表示されます。詳細については、以下の 「マッピング制限 」を参照してください。 |
object_type |
列挙 | オブジェクトの種類を指定します。 使用可能な値: - "line_item" - "campaign" - "profile" - "domain_list" - "creative" - "publisher" - "site" - "placement" - "package" - "deal" - "mediated_network" - "mediated bid" .注: "profile" および "domain_list" の場合、limit count_total count_active count_inactive フィールドには のnull 値が表示されます。Xandr では、使用できるプロファイルとドメイン リストの数は制限されません。 ただし、Xandr では、各プロファイルまたはドメイン リスト内のオブジェクトの数が制限されます。 これらの制限がフィールドに mapping_limits 表示されます。 |
マッピングの制限
JSON 応答のこの部分は、、"domain_list"
、および "placement"
オブジェクト型に対"profile"
してのみ設定されます。
プロファイルの場合
フィールド | 種類 | 説明 |
---|---|---|
content_category_targets |
int | 1 つのプロファイルでターゲットにできるカスタム コンテンツ カテゴリの最大数。 |
inventory_source_targets |
int | 非推奨。 |
placement_targets |
int | 1 つのプロファイルでターゲットにできる配置の最大数。 |
platform_content_category_targets |
int | 1 つのプロファイルでターゲットにできるプラットフォーム定義コンテンツ カテゴリの最大数。 |
postal_code_targets |
int | 1 つのプロファイルでターゲットにできる郵便番号の最大数。 |
publisher_targets |
int | 1 つのプロファイルでターゲットにできるパブリッシャーの最大数。 |
segment_targets |
int | 1 つのプロファイルでターゲットにできるセグメントの最大数。 |
segment_group_targets |
int | 1 つのプロファイルでターゲットにできるセグメント グループの最大数。 |
site_targets |
int | 1 つのプロファイルでターゲットにできるサイトの最大数。 |
ドメイン リストの場合
フィールド | 種類 | 説明 |
---|---|---|
domains |
int | 1 つのドメイン リストに含めることができるドメインまたは除外できるドメインの最大数。 |
配置の場合
フィールド | 種類 | 説明 |
---|---|---|
content_categories |
int | 1 つの配置に適用できるコンテンツ カテゴリの最大数。 |
例
すべてのオブジェクトの種類の制限と現在の使用状況を表示する
$ curl -b cookies -c cookies 'https://api.appnexus.com/object-limit'
{
"response": {
"status": "OK",
"count": 21,
"start_element": 0,
"num_elements": 100,
"object-limits": [
{
"object_type": "site",
"limit": 10000,
"mappings": [
],
"count_active": 8,
"count_inactive": 0,
"count_total": 8
},
{
"object_type": "publisher",
"limit": 3000,
"mappings": [
],
"count_active": 8,
"count_inactive": 0,
"count_total": 8
},
{
"object_type": "profile",
"limit": null,
"mappings": {
"site_targets": 100,
"publisher_targets": 300,
"inventory_source_targets": 500,
"content_category_targets": 300,
"placement_targets": 250,
"segment_targets": 400
},
"count_active": null,
"count_inactive": null,
"count_total": null
},
{
"object_type": "placement",
"limit": 20000,
"mappings": [
],
"count_active": 21,
"count_inactive": 0,
"count_total": 21
},
{
"object_type": "line_item",
"limit": 3000,
"mappings": [
],
"count_active": 4,
"count_inactive": 1,
"count_total": 5
},
{
"object_type": "domain_list",
"limit": null,
"mappings": {
"domain": 30000
},
"count_active": null,
"count_inactive": null,
"count_total": null
},
{
"object_type": "creative",
"limit": 10000,
"mappings": [
],
"count_active": 32,
"count_inactive": 0,
"count_total": 32
},
{
"object_type": "campaign",
"limit": 10000,
"mappings": [
],
"count_active": 6,
"count_inactive": 6,
"count_total": 12
}
]
}
}
クリエイティブの制限と現在の使用状況を表示する
$ curl -b cookies -c cookies 'https://api.appnexus.com/object-limit?object_type=creative'
{
"response": {
"status": "OK",
"count": 2,
"start_element": 0,
"num_elements": 100,
"object-limits": [
{
"object_type": "creative",
"limit": 10000,
"mappings": [
],
"count_active": 32,
"count_inactive": 0,
"count_total": 32
}
]
}
}
既定の制限
既定のオブジェクト制限とよく寄せられる質問の一覧については、「 API 使用状況の制約」を参照してください。
オブジェクトの削除
広告申込情報、キャンペーン、パブリッシャー、サイト、またはプレースメントの上限に近づいたり、上限に達したりすると、 Network Advertiser Analytics や Network Publisher Analytics などのレポートを使用して、過去 30 日間に変更または使用されていないオブジェクトを特定し、それらのオブジェクトを手動で削除できます。 広告申込情報やキャンペーンの場合は、クエリ文字列フィルターを使用して、最初または最後にインプレッションが発生したタイミングに基づいてオブジェクトを検索することもできます。 詳細については、「 広告申込情報サービス と キャンペーン サービス 」を参照してください。
クリエイティブの制限に近づくか上限に達した場合は、期限切れでないクリエイティブを削除する必要があります。 期限切れでないクリエイティブのフィールドは is_expired
に false
設定されています。 期限切れのクリエイティブを削除した場合、クリエイティブの数には影響しません。