Xandr プラットフォームは、形式、メディアの種類、およびメディア サブタイプによってクリエイティブを分類します。 形式は、クリエイティブのリソースの種類 (フラッシュ、画像など) を定義します。メディアの種類は、クリエイティブの一般的な表示スタイル (バナー、展開可能、ビデオなど) を定義します。メディア サブタイプは、クリエイティブの特定の表示スタイル (標準バナー、MediaMind expandable、Standard VAST など) を定義します。
この読み取り専用サービスを使用すると、サポートされているすべてのメディア サブタイプと、それらが属するメディアの種類を表示できます。
ヒント
サポートされているすべての形式とメディアの種類を表示するには、 Creative Format Service と Media Type Service を使用します。
REST API
| HTTP メソッド | エンドポイント | 説明 |
|---|---|---|
GET |
https://api.appnexus.com/media-subtype | すべてのメディア サブタイプを表示します。 |
GET |
https://api.appnexus.com/media-subtype?id=MEDIA_SUBTYPE_ID | 特定のメディア サブタイプを表示します。 |
GET |
https://api.appnexus.com/media-subtype?media_type.id=MEDIA_TYPE_ID | 特定のメディアの種類に属するメディア サブタイプを表示します。 |
JSON フィールド
| フィールド | 型 (長さ) | 説明 |
|---|---|---|
id |
int | メディア サブタイプの ID。 |
last_modified |
timestamp | Xandr がメディア サブタイプを最後に変更した日時。 |
media_type |
object | サブタイプが属するメディアの種類。 詳細については、以下の 「メディアの種類 」を参照してください。 |
name |
string | メディア サブタイプの名前。 ("Standard Banner"、"In-Banner Video"、または "15-Second VAST" など)。 |
native_assets |
オブジェクトの配列 | このメディア サブタイプのネイティブ広告の要素に対する制約を記述する配列。 ネイティブ広告の要素には、タイトル、本文コンテンツなどを含めることができます。 形式の制約は、本文の内容が必須か推奨されるか、テキストの長さが制限される可能性があります。 詳細については、以下の 「ネイティブアセット 」を参照してください。 |
permitted_sizes |
オブジェクトの配列 | メディア サブタイプのクリエイティブに許可されるサイズ。 詳細については、以下 の「許可されるサイズ 」を参照してください。 メモ： すべてのメディア サブタイプでサイズ要件が許可されているわけではありません。 |
メディアの種類
オブジェクトには media_type 、次のフィールドが含まれています。
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | メディアの種類の ID。 |
media_type_group_id |
int | メディアの種類が属するグループ。 この情報は、プレースメントで許可されるメディア タイプを設定する場合に関連します ( 「プレースメント サービス」を参照してください)。 1 つの配置で許可できるのは、同じグループに属するメディアタイプのみです。 |
name |
string | メディアの種類の名前。 たとえば、"Banner" および "Video" が禁止となります。 |
uses_sizes |
列挙 | メディアの種類に属するクリエイティブのサイズ要件。 使用可能な値: - "always": クリエイティブを追加する場合は幅と高さが必要です (バナーと展開可能)。- "sometimes": クリエイティブ (ポップとテキスト) を追加するときに、幅と高さが必要になる場合があります。- "never": クリエイティブ (スポット、ビデオ、スキン) を追加する場合、幅と高さは必要ありません。 |
許可されるサイズ
配列内の permitted_sizes 各オブジェクトには、次のフィールドが含まれています。
| フィールド | 種類 | 説明 |
|---|---|---|
aspect_ratio_tolerance |
double | と scaling_permitted が両方のtrue場合validate_image_size、画像はこの量の と platform_height のplatform_width縦横比から逸脱する可能性があります。 たとえば、 と platform_height 254x133 の縦横比platform_widthは 1.19:1 です。
aspect_ratio_toleranceが 0.03 の場合は、縦横比が 1.16:1 から 1.22:1 の間で許容されます。 |
max_image_height |
int | が のtrue場合validate_image_size、このメディア サブタイプのクリエイティブで許容される最大画像の高さ (ピクセル単位)。 |
min_image_height |
int | が のtrue場合validate_image_size、このメディア サブタイプのクリエイティブで許容される最小の画像の高さ (ピクセル単位)。 |
max_image_width |
int | が のtrue場合validate_image_size、このメディア サブタイプのクリエイティブで許容される最大画像幅 (ピクセル単位)。 |
min_image_width |
int | が のtrue場合validate_image_size、このメディア サブタイプのクリエイティブで許容される最小の画像幅 (ピクセル単位)。 |
platform_height |
int | このメディア サブタイプのクリエイティブの実際のレンダリング高さ (ピクセル単位)。 これは、レポートに表示される高さでもあります。 |
platform_width |
int | このメディア サブタイプのクリエイティブの実際のレンダリング幅 (ピクセル単位)。 これは、レポートに表示される幅でもあります。 |
scaling_permitted |
ブール値 | の場合 true、このメディア サブタイプのクリエイティブの画像の縦横比は と platform_width/platform_height同じである必要があります。の場合 false、このメディア サブタイプのクリエイティブの画像の幅と高さは、 と 正確に一致するplatform_widthplatform_height必要があります。 |
validate_image_size |
ブール値 | の場合 true、このメディア サブタイプのクリエイティブの画像は、このオブジェクトの次のフィールドで定義されている要件に照らして検証されます。- scaling_permitted- aspect_ratio_tolerance- min_image_width- max_image_width- min_image_height- max_image_height |
ネイティブ資産
| フィールド | 種類 | 説明 |
|---|---|---|
max_text_length |
int | このメディア サブタイプのネイティブ アセットのテキストの最大許容長 (文字単位)。 |
min_text_length |
int | このメディア サブタイプのネイティブ資産のテキストの最小許容長 (文字単位)。 |
native_asset_name |
列挙 | ネイティブ資産の名前。 これは次のいずれかになります。 - "title"- "content"- "description"- "full_text"- "context"- "icon_img_url"- "main_media"- "cta"- "rating"- "click_fallback_url" |
requirement |
列挙 | この特定のメディア サブタイプでこの資産が必要かどうか。 このフィールドには、 の複数のレベルを "requiredness"含めることができます。- "required"- "recommended"- "optional" |
例
すべてのメディア サブタイプを表示する
$ curl -b cookies -c cookies 'https://api.appnexus.com/media-subtype'
{
"response": {
"status": "OK",
"count": 26,
"start_element": null,
"num_elements": null,
"media-subtypes": [
{
"id": 1,
"name": "Standard Banner",
"last_modified": "2012-01-27 16:14:43",
"media_type": {
"id": 1,
"name": "Banner",
"media_type_group_id": 1,
"uses_sizes": "always"
}
},
{
"id": 2,
"name": "Popup",
"last_modified": "2012-01-27 16:14:43",
"media_type": {
"id": 2,
"name": "Pop",
"media_type_group_id": 2,
"uses_sizes": "sometimes"
}
},
{
"id": 3,
"name": "In-Banner Video",
"last_modified": "2012-01-27 16:14:43",
"media_type": {
"id": 1,
"name": "Banner",
"media_type_group_id": 1,
"uses_sizes": "always"
}
},
{
"id": 4,
"name": "Popunder",
"last_modified": "2012-01-27 16:14:43",
"media_type": {
"id": 2,
"name": "Pop",
"media_type_group_id": 2,
"uses_sizes": "sometimes"
}
},
{
"id": 5,
"name": "Standard Interstitial",
"last_modified": "2012-01-27 16:14:43",
"media_type": {
"id": 3,
"name": "Interstitial",
"media_type_group_id": 1,
"uses_sizes": "never"
}
},
{
"id": 7,
"name": "15-second VAST",
"last_modified": "2012-02-17 22:58:10",
"media_type": {
"id": 4,
"name": "Video",
"media_type_group_id": 4,
"uses_sizes": "never"
}
},
{
"id": 8,
"name": "30-second VAST",
"last_modified": "2012-02-17 22:58:10",
"media_type": {
"id": 4,
"name": "Video",
"media_type_group_id": 4,
"uses_sizes": "never"
}
},
{
"id": 9,
"name": "Text",
"last_modified": "2012-01-27 16:14:43",
"media_type": {
"id": 5,
"name": "Text",
"media_type_group_id": 1,
"uses_sizes": "sometimes"
}
},
{
"id": 10,
"name": "Other Expandable",
"last_modified": "2012-02-01 18:49:36",
"media_type": {
"id": 6,
"name": "Expandable",
"media_type_group_id": 1,
"uses_sizes": "always"
}
},
{
"id": 11,
"name": "MediaMind",
"last_modified": "2012-02-01 18:49:36",
"media_type": {
"id": 6,
"name": "Expandable",
"media_type_group_id": 1,
"uses_sizes": "always"
}
},
{
"id": 12,
"name": "Pointroll",
"last_modified": "2012-02-01 18:49:36",
"media_type": {
"id": 6,
"name": "Expandable",
"media_type_group_id": 1,
"uses_sizes": "always"
}
},
{
"id": 13,
"name": "EyeWonder",
"last_modified": "2012-02-01 18:49:36",
"media_type": {
"id": 6,
"name": "Expandable",
"media_type_group_id": 1,
"uses_sizes": "always"
}
},
{
"id": 14,
"name": "EyeReturn",
"last_modified": "2012-02-01 18:49:36",
"media_type": {
"id": 6,
"name": "Expandable",
"media_type_group_id": 1,
"uses_sizes": "always"
}
},
{
"id": 15,
"name": "Pictela",
"last_modified": "2012-02-01 18:49:36",
"media_type": {
"id": 6,
"name": "Expandable",
"media_type_group_id": 1,
"uses_sizes": "always"
}
},
{
"id": 16,
"name": "Flashtalking",
"last_modified": "2012-02-01 18:49:36",
"media_type": {
"id": 6,
"name": "Expandable",
"media_type_group_id": 1,
"uses_sizes": "always"
}
},
{
"id": 17,
"name": "Doubleclick",
"last_modified": "2012-02-01 18:49:36",
"media_type": {
"id": 6,
"name": "Expandable",
"media_type_group_id": 1,
"uses_sizes": "always"
}
},
{
"id": 18,
"name": "Unicast",
"last_modified": "2012-02-01 18:49:36",
"media_type": {
"id": 6,
"name": "Expandable",
"media_type_group_id": 1,
"uses_sizes": "always"
}
},
{
"id": 19,
"name": "Spongecell",
"last_modified": "2012-02-01 18:49:36",
"media_type": {
"id": 6,
"name": "Expandable",
"media_type_group_id": 1,
"uses_sizes": "always"
}
},
{
"id": 20,
"name": "Adrime",
"last_modified": "2012-02-01 18:49:36",
"media_type": {
"id": 6,
"name": "Expandable",
"media_type_group_id": 1,
"uses_sizes": "always"
}
},
{
"id": 21,
"name": "Layer",
"last_modified": "2012-02-01 18:49:36",
"media_type": {
"id": 3,
"name": "Interstitial",
"media_type_group_id": 1,
"uses_sizes": "never"
}
},
{
"id": 22,
"name": "Slide-in",
"last_modified": "2012-02-01 18:49:37",
"media_type": {
"id": 3,
"name": "Interstitial",
"media_type_group_id": 1,
"uses_sizes": "never"
}
},
{
"id": 23,
"name": "Other VAST",
"last_modified": "2012-02-17 22:58:11",
"media_type": {
"id": 4,
"name": "Video",
"media_type_group_id": 4,
"uses_sizes": "never"
}
},
{
"id": 24,
"name": "Oggifinogi",
"last_modified": "2012-02-20 19:07:46",
"media_type": {
"id": 6,
"name": "Expandable",
"media_type_group_id": 1,
"uses_sizes": "always"
}
},
{
"id": 48,
"name": "IAB",
"last_modified": "2012-04-30 16:39:35",
"media_type": {
"id": 8,
"name": "Skin",
"media_type_group_id": 1,
"uses_sizes": "never"
}
},
{
"id": 49,
"name": "Custom",
"last_modified": "2012-04-30 16:39:35",
"media_type": {
"id": 8,
"name": "Skin",
"media_type_group_id": 1,
"uses_sizes": "never"
}
}
}
]
}
}
メディア サブタイプを表示する "Standard VAST" (ID 64)
$ curl -b cookies -c cookies 'https://api.appnexus.com/media-subtype?id=64'
{
"response": {
"status": "OK",
"count": 1,
"start_element": 0,
"num_elements": 100,
"media-subtype": {
"id": 64,
"name": "Standard VAST",
"last_modified": "2014-09-04 13:06:04",
"media_type": {
"id": 4,
"name": "Video",
"media_type_group_id": 4,
"uses_sizes": "never"
},
"permitted_sizes": null,
"native_assets": null
}
}
}
メディアの種類に属するメディア サブタイプを "Banner" 表示する
$ curl -b cookies -c cookies 'https://api.appnexus.com/media-subtype?media_type.id=1'
{
"response": {
"status": "OK",
"count": 2,
"start_element": 0,
"num_elements": 100,
"media-subtypes": [
{
"id": 1,
"name": "Standard Banner",
"last_modified": "2012-01-27 16:14:43",
"media_type": {
"id": 1,
"name": "Banner",
"media_type_group_id": 1,
"uses_sizes": "always"
},
"permitted_sizes": null
},
{
"id": 3,
"name": "In-Banner Video",
"last_modified": "2012-01-27 16:14:43",
"media_type": {
"id": 1,
"name": "Banner",
"media_type_group_id": 1,
"uses_sizes": "always"
},
"permitted_sizes": null
}
]
}
}