次の方法で共有

Bidders - クリエイティブ テンプレート サービス

  • [アーティクル]

Xandr は、形式、メディアの種類、およびメディア サブタイプによってクリエイティブを分類します。 形式は、クリエイティブのリソースの種類 (フラッシュ、画像など) を定義します。メディアの種類は、クリエイティブの一般的な表示スタイル (バナー、展開可能、ビデオなど) を定義します。メディア サブタイプは、クリエイティブの特定の表示スタイル (標準バナー、MediaMind 展開可能、または Standard VAST) を定義します。

標準テンプレート

Xandr には、形式、メディアの種類、およびメディア サブタイプの組み合わせごとに、クリエイティブが配信されるときに Web ページで適切なレンダリングが保証される標準のクリエイティブ テンプレートが用意されています。 これらのテンプレートは編集できませんが、クリエイティブ テンプレート サービスを使用すると、テンプレートを表示し、レンダリング コードを確認できます。

カスタム テンプレート

特定の種類のクリエイティブのレンダリング方法をカスタマイズする場合は、独自のテンプレートを作成できます。 カスタム テンプレートを使用すると、JavaScript、HTML、または XML レンダリング コードを完全に制御でき、マクロを定義して、入稿者に情報の入力を求め、クリエイティブのアップロード時の動作に関する決定を行うことができます。

注:

最大 100 個のカスタム テンプレートを使用できます。 ただし、Xandr では、カスタム テンプレート コードでエラーが発生した結果、正しくレンダリングされないクリエイティブはサポートされません。

REST API

HTTP メソッド 終点 説明
GET https://api.adnxs.com/template すべてのテンプレート (標準とカスタム) を表示するには。
GET https://api.adnxs.com/template?member_id=null 標準テンプレートのみを表示するには。
GET https://api.adnxs.com/template?id=TEMPLATE_ID 特定のテンプレートを表示するには。
POST https://api.adnxs.com/template
(テンプレート JSON)		 新しいカスタム テンプレートを追加するには。
PUT https://api.adnxs.com/template?id=TEMPLATE_ID
(テンプレート JSON)		 カスタム テンプレートを変更するには。

ヒント: カスタム テンプレートを変更するには、bidder ユーザーではなくメンバー ユーザーを使用する必要があります。

警告: カスタム テンプレートを変更すると、そのテンプレートを既に使用しているクリエイティブに変更が直ちに影響します。 変更によってこれらのクリエイティブのレンダリングが正常に停止した場合、監査状態は "拒否" に変更され、ほとんどのサード パーティのインベントリでの配信が停止されます。
DELETE https://api.adnxs.com/template?id=TEMPLATE_ID カスタム テンプレートを削除するには。

ヒント: 1 つ以上のクリエイティブで使用されているカスタム テンプレートは削除できませんが、テンプレートをアーカイブして、今後のクリエイティブでテンプレートを使用できないようにすることはできます。 詳細については、以下 のカスタム テンプレートのアーカイブ の例を参照してください。

JSON フィールド

フィールド 型 (長さ) 説明
id int クリエイティブ テンプレートの ID。
必須:PUT/DELETE クエリ文字列内の 、
name string (30) クリエイティブ テンプレートの名前。

必須:POST
description string クリエイティブ テンプレートの説明。
member_id int 読み取り専用。 テンプレートを所有するメンバーの ID。 標準の Xandr テンプレートの場合、これは です null。
media_subtype object このテンプレートを使用できるクリエイティブの表示スタイル。 各メディア サブタイプは、スーパーオーディネート メディアの種類に属します。たとえば、 "Standard Banner" メディア サブタイプはメディアの種類に "Banner" 属します。

必須:POST
format object このテンプレートを使用できるクリエイティブの形式 (例: "image" または "flash")。

必須:POST
is_default Boolean の場合 true、テンプレートはテンプレートのメディアタイプ、メディアサブタイプ、フォーマットに一致するクリエイティブに自動的に割り当てられます。 クリエイティブがアップロードされると、必要に応じて、この既定の割り当てをオーバーライドできます。

注: メディアの種類、メディア サブタイプ、および形式の組み合わせごとに、既定のクリエイティブ テンプレートは 1 つだけ存在できます。

既定値: false
is_archived Boolean の場合 true、テンプレートはアーカイブされます。 テンプレートをアーカイブすると、将来のクリエイティブでテンプレートを使用できなくなりますが、テンプレートを既に使用しているクリエイティブには影響しません。

既定値: false
content_js string JavaScript でのテンプレートのレンダリング コード。 このコードには、Xandr 標準マクロと独自のカスタム マクロの両方を含めることができます。 Xandr マクロは $ 記号で始まり、カスタム マクロは # 記号で始まる必要があります。 各カスタム マクロは、マクロ配列で定義する必要があります。

必須:POST 、 と が指定されていない場合content_htmlcontent_xml
content_html string HTML でのテンプレートのレンダリング コード。 このコードには、Xandr 標準マクロと独自のカスタム マクロの両方を含めることができます。 Xandr マクロは $ 記号で始まり、カスタム マクロは # 記号で始まる必要があります。 各カスタム マクロは、マクロ配列で定義する必要があります。

必須:POST 、 と が指定されていない場合content_jscontent_xml
content_xml string 非推奨。
callback_content_html string が "Popup" または "Popunder"のcontent_js場合media_subtype、ポップ ウィンドウのレンダリング コードが定義され、このフィールドはポップ ウィンドウ内のコンテンツのレンダリング コードを定義します。
macros オブジェクトの配列 、、または content_xml フィールドでcontent_jscontent_html使用されるカスタム マクロ。 テンプレートには、最大 20 個のカスタム マクロを含めることができます。
last_modified timestamp 読み取り専用。 クリエイティブ テンプレートが最後に変更された日時。

メディア サブタイプ

フィールド 種類 説明
id int メディア サブタイプの ID。

必須:POST
name string 読み取り専用。 メディア サブタイプの名前。
mediatype_id int 読み取り専用。 サブタイプが属するメディアタイプの ID。
media_type_name string 読み取り専用。 サブタイプが属するメディアタイプの名前。

フォーマット

Creative Format Service を使用すると、サポートされているすべてのクリエイティブ形式を表示できます。

フィールド 種類 説明
id int クリエイティブ形式の ID。

必須:POST
name string 読み取り専用。 クリエイティブ形式の名前。

カスタム マクロ

、、または フィールドで使用される各カスタム マクロをcontent_jscontent_html定義するcontent_xml必要があります。

フィールド 型 (長さ) 説明
code string (30) マクロ名は、または content_xml フィールドでcontent_jscontent_html使用されるとおりです。 たとえば、フィールド内content_jsのマクロの場合#{BORDER_SIZE}は、ここで渡します"BORDER_SIZE"。

必須:POST
name string (50) クリエイティブ サービスまたは UI を使用してこのテンプレートを使用するクリエイティブを追加すると、人身売買者に表示されるこのマクロのわかりやすい名前。

必須:POST
type 列挙 クリエイティブ サービスまたは UI を介してこのテンプレートを使用するクリエイティブを追加するときに、このマクロに対して入稿者が提供する値の種類。 使用可能な値: "true/false"、 "string"、、 "url"、 "integer"、 "decimal"、 "string_list"、 "select_from_list"です。 たとえば、これを に"true/false"設定すると、入稿者はマクロ名の後にチェックボックスが表示されます。

必須:POST
is_required ブール値 の場合 true、このテンプレートを使用するクリエイティブを追加するときに、マクロの値を指定する必要があります。

必須:POST
default_value string が のfalse場合is_required、これは、このテンプレートを使用するクリエイティブを追加するときに、入稿者がマクロの値を指定しない場合に使用される既定値です。

必須:POST が の場合is_requiredは 。false
other_data string 型 "string_list" が または "select_from_list"の場合、マクロで受け入れられる値。

例

すべてのクリエイティブ テンプレートを表示する

{code}
$ curl -b cookies -c cookies 'https:api.adnxs.com/template'
{
    "response": {
        "status": "OK",
        "count": 74,
        "start_element": 0,
        "num_elements": 100,
        "templates": [
            {
                "id": 1,
                "name": "Standard",
                "description": null,
                "last_modified": "2012-02-20 21:36:13",
                "is_archived": false,
                "member_id": null,
                "is_default": true,
                "content_html": "<iframe frameborder=\"0\" width=\"${CREATIVE_WIDTH}\" height=\"
                 ${CREATIVE_HEIGHT}\"marginheight=\"0\" marginwidth=\"0\" target=\"_blank\"
                 scrolling=\"no\" src=\"${MEDIA_URL}\"></iframe>",
                "content_js": "document.write('<iframe frameborder=\"0\" width=\"${CREATIVE_WIDTH}\"
                 height=\"${CREATIVE_HEIGHT}\" marginheight=\"0\" marginwidth=\"0\" target=\"_blank\"
                 scrolling=\"no\" src=\"${MEDIA_URL}\"> </iframe>');",
                "content_xml": null,
                "callback_content_html": null,
                "media_subtype": {
                    "id": 1,
                    "name": "Standard Banner",
                    "media_type_name": "Banner",
                    "media_type_id": 1
                },
                "format": {
                    "id": 1,
                    "name": "url-html"
                },
                "macros": null
            },
            {
                "id": 2,
                "name": "Standard",
                "description": null,
                "last_modified": "2012-01-31 14:33:37",
                "is_archived": false,
                "member_id": null,
                "is_default": true,
                "content_html": "<html><body style=\"margin-left: 0%; margin-right: 0%; margin-top:
                 0%; margin-bottom: 0%\"><script type=\"text/javascript\" src=\"${MEDIA_URL}\">
                 </script></body></html>",
                "content_js": "document.write('<script type=\"text/javascript\" src=\"${MEDIA_URL}\">
                 </scr'+'ipt>');",
                "content_xml": null,
                "callback_content_html": null,
                "media_subtype": {
                    "id": 1,
                    "name": "Standard Banner",
                    "media_type_name": "Banner",
                    "media_type_id": 1
                },
                "format": {
                    "id": 2,
                    "name": "url-js"
                },
                "macros": null
            },
            {
                "id": 3,
                "name": "Standard",
                "description": null,
                "last_modified": "2012-01-31 14:33:37",
                "is_archived": false,
                "member_id": null,
                "is_default": true,
                "content_html": "\u000a<html><body style=\"margin-left: 0%; margin-right: 0%; margin-top:
                 0%;margin-bottom: 0%\"><script type=\"text/javascript\">\u000a<!--\u000a(function()\u000a\
                 u0009{\u000a\u0009var flashAd='<OBJECT id=\"${AUCTION_ID}\" data=\"${MEDIA_URL}\" classid=
                 \"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000\" WIDTH=\"${CREATIVE_WIDTH}\" HEIGHT=\
                 "${CREATIVE_HEIGHT}\"flashvars=\"${FLASHVARS}\"><PARAM NAME=movie VALUE=\"${MEDIA_URL}\">
                 <PARAM NAME=loop VALUE=true><PARAM NAME=menu VALUE=false><PARAM NAME=quality VALUE=high>
                 <PARAM NAME=wmode VALUE=\"opaque\"><PARAM NAME=bgcolor VALUE=#FFFFFF><PARAM NAME=
                 allowscriptaccess VALUE=always><PARAM NAME=flashvarsVALUE=\"${FLASHVARS}\"><OBJECT TYPE=\
                 "application/x-shockwave-flash\" data=\"${MEDIA_URL}?${FLASHVARS}\"
                 ..."
                "content_js": "(function()\u000a\u0009{\u000a\u0009var flashAd='<OBJECT id=\"${AUCTION_ID}\"
                 data=\"${MEDIA_URL}\" classid=\"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000\" WIDTH=
                 \"${CREATIVE_WIDTH}\"HEIGHT=\"${CREATIVE_HEIGHT}\" flashvars=\"${FLASHVARS}\"><PARAM NAME=movie
                 VALUE=\"${MEDIA_URL}\"><PARAM NAME=loop VALUE=true><PARAM NAME=menu VALUE=false><PARAM NAME=
                 quality VALUE=high><PARAM NAME=wmode VALUE=\"opaque\"><PARAM NAME=bgcolor VALUE=#FFFFFF>
                 <PARAM NAME=allowscriptaccess VALUE=always><PARAM NAME=flashvars VALUE=\"${FLASHVARS}\">
                 <OBJECT TYPE=\"application/x-shockwave-flash\" data=\"${MEDIA_URL}? ${FLASHVARS}\" width=\
                 "${CREATIVE_WIDTH}\" height=\"${CREATIVE_HEIGHT}\" wmode=\"opaque\" allowscriptaccess=
                 \"always\"></OBJECT></OBJECT>';\u000a\u0009var flashBackupUrl='${FLASH_BACKUP_URL}';\u000a\
                 u0009varalternate = '';\u000a\u0009if (flashBackupUrl)\u000a\u0009{\u000a\u0009\u0009alternate=
                 '<a href=\"${CLICK_URL}\" target=\"_blank\">\"<img width=\"${CREATIVE_WIDTH}\" height=
                 ..."
                "content_xml": null,
                "callback_content_html": null,
                "media_subtype": {
                    "id": 1,
                    "name": "Standard Banner",
                    "media_type_name": "Banner",
                    "media_type_id": 1
                },
                "format": {
                    "id": 3,
                    "name": "flash"
                },
                "macros": null
            },
            {
                "id": 4,
                "name": "Standard",
                "description": null,
                "last_modified": "2012-01-31 14:33:37",
                "is_archived": false,
                "member_id": null,
                "is_default": true,
                "content_html": "<a href=\"${CLICK_URL}\" target=\"_blank\"><img width=\"${CREATIVE_WIDTH}
                 \" height=\"${CREATIVE_HEIGHT}\" style=\"border-style: none\" src=\"${MEDIA_URL}\"/></a>",
                "content_js": "document.write('<a href=\"${CLICK_URL}\" target=\"_blank\"><img width=
                 \"${CREATIVE_WIDTH}\" height=\"${CREATIVE_HEIGHT}\" style=\"border-style: none\" src=
                 \"${MEDIA_URL}\"/></a>');",
                "content_xml": null,
                "callback_content_html": null,
                "media_subtype": {
                    "id": 1,
                    "name": "Standard Banner",
                    "media_type_name": "Banner",
                    "media_type_id": 1
                },
                "format": {
                    "id": 4,
                    "name": "image"
                },
                "macros": null
            },
            ...
        ],
        "dbg_info": {
            "instance": "02.hbapi.sand-08.nym2",
            "s1ave_hit": true,
            "db": "06.mysql.sand-08.nym2",
            "reads": 2,
            "read_limit": 100,
            "read_limit_seconds": 60,
            "writes": 0,
            "write_limit": 60,
            "write_limit_seconds": 60,
            "time": 71.73490524292,
            "start_microtime": 1329952251.6778,
            "version": "1.11.12",
            "s1ave_lag": 0,
            "member_last_modified_age": 2979
        }
    }
}
{code}

特定のクリエイティブ テンプレートを表示する

この例では、要求は、メディアタイプ "バナー"、メディアサブタイプ "Standard Banner"、およびフォーマット "flash" のクリエイティブをレンダリングするための Xandr 標準テンプレートに関する詳細を取得します。

{code}
$ curl -b cookies -c cookies 'https:api.adnxs.com/template?id=3'
{
    "response": {
        "status": "OK",
        "count": 1,
        "start_element": null,
        "num_elements": null,
        "template": {
            "id": 3,
            "name": "Standard",
            "description": null,
            "last_modified": "2012-01-31 14:33:37",
            "is_archived": false,
            "member_id": null,
            "is_default": true,
            "content_html": "\u000a<html><body style=\"margin-left: 0%; margin-right: 0%; margin-top:
             0%;margin-bottom: 0%\"><script type=\"text/javascript\">\u000a<!--\u000a(function()\u000a\
             u0009{\u000a\u0009var flashAd='<OBJECT id=\"${AUCTION_ID}\" data=\"${MEDIA_URL}\" classid=
             \"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000\" WIDTH=\"${CREATIVE_WIDTH}\" HEIGHT=\
             "${CREATIVE_HEIGHT}\"flashvars=\"${FLASHVARS}\"><PARAM NAME=movie VALUE=\"${MEDIA_URL}\">
             <PARAM NAME=loop VALUE=true><PARAM NAME=menu VALUE=false><PARAM NAME=quality VALUE=high>
             <PARAM NAME=wmode VALUE=\"opaque\"><PARAM NAME=bgcolor VALUE=#FFFFFF><PARAM NAME=
             allowscriptaccess VALUE=always><PARAM NAME=flashvarsVALUE=\"${FLASHVARS}\"><OBJECT TYPE=\
             "application/x-shockwave-flash\" data=\"${MEDIA_URL}?${FLASHVARS}\"
             ..."
            "content_js": "(function()\u000a\u0009{\u000a\u0009var flashAd='<OBJECT id=\"${AUCTION_ID}\"
             data=\"${MEDIA_URL}\" classid=\"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000\" WIDTH=
             \"${CREATIVE_WIDTH}\"HEIGHT=\"${CREATIVE_HEIGHT}\" flashvars=\"${FLASHVARS}\"><PARAM NAME=movie
             VALUE=\"${MEDIA_URL}\"><PARAM NAME=loop VALUE=true><PARAM NAME=menu VALUE=false><PARAM NAME=
             quality VALUE=high><PARAM NAME=wmode VALUE=\"opaque\"><PARAM NAME=bgcolor VALUE=#FFFFFF>
             <PARAM NAME=allowscriptaccess VALUE=always><PARAM NAME=flashvars VALUE=\"${FLASHVARS}\">
             <OBJECT TYPE=\"application/x-shockwave-flash\" data=\"${MEDIA_URL}? ${FLASHVARS}\" width=\
             "${CREATIVE_WIDTH}\" height=\"${CREATIVE_HEIGHT}\" wmode=\"opaque\" allowscriptaccess=
             \"always\"></OBJECT></OBJECT>';\u000a\u0009var flashBackupUrl='${FLASH_BACKUP_URL}';\u000a\
             u0009varalternate = '';\u000a\u0009if (flashBackupUrl)\u000a\u0009{\u000a\u0009\u0009alternate=
             '<a href=\"${CLICK_URL}\" target=\"_blank\">\"<img width=\"${CREATIVE_WIDTH}\" height=
             ..."
            "content_xml": null,
            "callback_content_html": null,
            "media_subtype": {
                "id": 1,
                "name": "Standard Banner",
                "media_type_name": "Banner",
                "media_type_id": 1
            },
            "format": {
                "id": 3,
                "name": "flash"
            },
            "macros": null
        },
        "dbg_info": {
            "instance": "02.hbapi.sand-08.nym2",
            "s1ave_hit": false,
            "db": "master",
            "time": 684.47399139404,
            "start_microtime": 1329858928.9459,
            "version": "1.11.11.2",
            "s1ave_miss": "no_service_index"
        }
    }
}
{code}

カスタム テンプレートの追加

この例では、要求によって POST 、標準のバナー イメージ クリエイティブを境界線でレンダリングするためのカスタム クリエイティブ テンプレートが作成されます。 テンプレートには、罫線のサイズと罫線の色を定義するための 2 つのカスタム マクロが含まれています。

{code}$ cat template
{
    "template": {
        "name": "Image with border",
        "media_subtype":
            {
                "id": 1
            },
        "format":
            {
                "id": 4
            },
        "content_js": "document.write('<a href=${CLICK_URL}><img src=${MEDIA_URL} border=#{BORDER_SIZE}
         border_color=#{BORDER_COLOR}></img></a>');",
        "macros":[
            {
                "code": "BORDER_SIZE",
                "name": "Image Border Size",
                "type": "integer",
                "is_required": false,
                "default_value": "4"
            },
            {
                "code": "BORDER_COLOR",
                "name": "Image Border Color",
                "type": "string",
                "is_required": false
                "default_value": "black"
            }
        ]
    }
}{code}
{code}
$ curl -b cookies -c cookies -X POST -d @template 'https://api.adnxs.com/template'
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": 222,
        "start_element": 0,
        "num_elements": 100,
        "template": {
            "id": 222,
            "name": "Image with border",
            "description": null,
            "last_modified": "2012-02-22 23:20:05",
            "is_archived": false,
            "member_id": 1066,
            "is_default": false,
            "content_html": null,
            "content_js": "document.write('<a href=${CLICK_URL}><img src=${MEDIA_URL} border=#{BORDER_SIZE}
             border_color=#{BORDER_COLOR}></img></a>');",
            "content_xml": null,
            "callback_content_html": null,
            "media_subtype": {
                "id": 1,
                "name": "Standard Banner",
                "media_type_name": "Banner",
                "media_type_id": 1
            },
            "format": {
                "id": 4,
                "name": "image"
            },
            "macros": [
                {
                    "code": "BORDER_COLOR",
                    "name": "Image Border Color",
                    "is_required": false,
                    "type": "string",
                    "default_value": "black",
                    "other_data": null
                },
                {
                    "code": "BORDER_SIZE",
                    "name": "Image Border Size",
                    "is_required": false,
                    "type": "integer",
                    "default_value": "4",
                    "other_data": null
                }
            ]
        },
        "dbg_info": {
            "instance": "02.hbapi.sand-08.nym2",
            "s1ave_hit": false,
            "db": "master",
            "reads": 0,
            "read_limit": 100,
            "read_limit_seconds": 60,
            "writes": 1,
            "write_limit": 60,
            "write_limit_seconds": 60,
            "time": 1270.6458568573,
            "start_microtime": 1329952805.2524,
            "version": "1.11.12",
            "master_instance": "04.hbapi.sand-08.lax1",
            "proxy": true,
            "master_time": 1084.1600894928
        }
    }
}
{code}

カスタム テンプレートの変更

この例では、要求によって PUT カスタム テンプレート 222のカスタム マクロの既定値が更新されます。

{code}$ cat template_update
{
    "template": {
        "macros":[
            {
                "code": "BORDER_SIZE",
                "name": "Image Border Size",
                "type": "integer",
                "is_required": false,
                "default_value": "6"
            },
            {
                "code": "BORDER_COLOR",
                "name": "Image Border Color",
                "type": "string",
                "is_required": false,
                "default_value": "blue"
            }
        ]
    }
}{code}
{code}
$ curl -b cookies -c cookies -X PUT -d @template_update 'https://api.adnxs.com/template?id=222'
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": "222",
        "start_element": 0,
        "num_elements": 100,
        "template": {
            "id": 222,
            "name": "Image with border",
            "description": null,
            "last_modified": "2012-02-22 23:49:39",
            "is_archived": false,
            "member_id": 1066,
            "is_default": false,
            "content_html": null,
            "content_js": "document.write('<a href=${CLICK_URL}><img src=${MEDIA_URL} border=#{BORDER_SIZE}
             border_color=#{BORDER_COLOR}></img></a>');",
            "content_xml": null,
            "callback_content_html": null,
            "media_subtype": {
                "id": 1,
                "name": "Standard Banner",
                "media_type_name": "Banner",
                "media_type_id": 1
            },
            "format": {
                "id": 4,
                "name": "image"
            },
            "macros": [
                {
                    "code": "BORDER_COLOR",
                    "name": "Image Border Color",
                    "is_required": false,
                    "type": "string",
                    "default_value": "blue",
                    "other_data": null
                },
                {
                    "code": "BORDER_SIZE",
                    "name": "Image Border Size",
                    "is_required": false,
                    "type": "integer",
                    "default_value": "6",
                    "other_data": null
                }
            ]
        },
        "dbg_info": {
            "instance": "02.hbapi.sand-08.nym2",
            "s1ave_hit": false,
            "db": "master",
            "reads": 0,
            "read_limit": 100,
            "read_limit_seconds": 60,
            "writes": 1,
            "write_limit": 60,
            "write_limit_seconds": 60,
            "time": 1860.7339859009,
            "start_microtime": 1329954578.4409,
            "version": "1.11.12",
            "master_instance": "05.hbapi.sand-08.lax1",
            "proxy": true,
            "master_time": 1082.7260017395
        }
    }
}
{code}

カスタム テンプレートのアーカイブ

この例では、要求によって PUT フィールドが is_archived に true設定されるため、テンプレートがアーカイブされ、将来のクリエイティブで使用できなくなります。

{code}$ cat template_archive
{
    "template": {
         "is_archived": true
    }
}{code}
{code}
$ curl -b cookies -c cookies -X PUT -d @template_archive 'https://api.adnxs.com/template?id=222'
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": "222",
        "start_element": 0,
        "num_elements": 100,
        "template": {
            "id": 222,
            "name": "Image with border",
            "description": null,
            "last_modified": "2012-02-22 23:57:52",
            "is_archived": true,
            "member_id": 1066,
            "is_default": false,
            "content_html": null,
            "content_js": "document.write('<a href=${CLICK_URL}><img src=${MEDIA_URL} border=#{BORDER_SIZE}
             border_color=#{BORDER_COLOR}></img></a>');",
            "content_xml": null,
            "callback_content_html": null,
            "media_subtype": {
                "id": 1,
                "name": "Standard Banner",
                "media_type_name": "Banner",
                "media_type_id": 1
            },
            "format": {
                "id": 4,
                "name": "image"
            },
            "macros": [
                {
                    "code": "BORDER_COLOR",
                    "name": "Image Border Color",
                    "is_required": false,
                    "type": "string",
                    "default_value": "blue",
                    "other_data": null
                },
                {
                    "code": "BORDER_SIZE",
                    "name": "Image Border Size",
                    "is_required": false,
                    "type": "integer",
                    "default_value": "6",
                    "other_data": null
                }
            ]
        },
        "dbg_info": {
            "instance": "02.hbapi.sand-08.nym2",
            "s1ave_hit": false,
            "db": "master",
            "reads": 0,
            "read_limit": 100,
            "read_limit_seconds": 60,
            "writes": 1,
            "write_limit": 60,
            "write_limit_seconds": 60,
            "time": 1709.9781036377,
            "start_microtime": 1329955072.2898,
            "version": "1.11.12",
            "master_instance": "05.hbapi.sand-08.lax1",
            "proxy": true,
            "master_time": 890.67912101746
        }
    }
}
{code}

アーカイブされたカスタム テンプレートの再アクティブ化

この例では、PUT 要求によって is_archived フィールドが false に設定されるため、テンプレートを再アクティブ化し、新しいクリエイティブがテンプレートを使用できるようにします。

{code}$ cat template_activate
{
    "template": {
         "is_archived": false
    }
}{code}
{code}
$ curl -b cookies -c cookies -X PUT -d @template_activate 'https://api.adnxs.com/template?id=222'
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": "222",
        "start_element": 0,
        "num_elements": 100,
        "template": {
            "id": 222,
            "name": "Image with border",
            "description": null,
            "last_modified": "2012-02-22 23:57:52",
            "is_archived": false,
            "member_id": 1066,
            "is_default": false,
            "content_html": null,
            "content_js": "document.write('<a href=${CLICK_URL}><img src=${MEDIA_URL} border=#{BORDER_SIZE}
             border_color=#{BORDER_COLOR}></img></a>');",
            "content_xml": null,
            "callback_content_html": null,
            "media_subtype": {
                "id": 1,
                "name": "Standard Banner",
                "media_type_name": "Banner",
                "media_type_id": 1
            },
            "format": {
                "id": 4,
                "name": "image"
            },
            "macros": [
                {
                    "code": "BORDER_COLOR",
                    "name": "Image Border Color",
                    "is_required": false,
                    "type": "string",
                    "default_value": "blue",
                    "other_data": null
                },
                {
                    "code": "BORDER_SIZE",
                    "name": "Image Border Size",
                    "is_required": false,
                    "type": "integer",
                    "default_value": "6",
                    "other_data": null
                }
            ]
        },
        "dbg_info": {
            "instance": "02.hbapi.sand-08.nym2",
            "s1ave_hit": false,
            "db": "master",
            "reads": 0,
            "read_limit": 100,
            "read_limit_seconds": 60,
            "writes": 1,
            "write_limit": 60,
            "write_limit_seconds": 60,
            "time": 1709.9781036377,
            "start_microtime": 1329955072.2898,
            "version": "1.11.12",
            "master_instance": "05.hbapi.sand-08.lax1",
            "proxy": true,
            "master_time": 890.67912101746
        }
    }
}
{code}

カスタム テンプレートの削除

この例では、DELETE 要求によってカスタム テンプレートがシステムから完全に削除されます。

{code}$ $ curl -b cookies -c cookies -X DELETE 'https://api.adnxs.com/template?id=222'
{
    "response": {
        "status": "OK",
        "dbg_info": {
            "instance": "02.hbapi.sand-08.nym2",
            "s1ave_hit": false,
            "db": "master",
            "reads": 0,
            "read_limit": 100,
            "read_limit_seconds": 60,
            "writes": 1,
            "write_limit": 60,
            "write_limit_seconds": 60,
            "time": 1454.5428752899,
            "start_microtime": 1329955347.807,
            "version": "1.11.12",
            "master_instance": "05.hbapi.sand-08.lax1",
            "proxy": true,
            "master_time": 1018.196105957
        }
    }
}
{code}