デジタルプラットフォーム API - クリエイティブテンプレートサービス

[アーティクル]
07/05/2024

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

標準テンプレート

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

カスタムテンプレート

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

注:

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

REST API

HTTP メソッド	エンドポイント	説明
`GET`	https://api.appnexus.com/template	すべてのテンプレート (標準とカスタム) を表示します。
`GET`	https://api.appnexus.com/template?member_id=null	標準テンプレートのみを表示します。
`GET`	https://api.appnexus.com/template?id=TEMPLATE_ID	特定のテンプレートを表示します。
`POST`	https://api.appnexus.com/template (テンプレート JSON)	新しいカスタムテンプレートを追加します。
`PUT`	https://api.appnexus.com/template?id=TEMPLATE_ID (テンプレート JSON) 警告: カスタムテンプレートを変更すると、そのテンプレートを既に使用しているクリエイティブにすぐに変更が反映されます。変更によってこれらのクリエイティブのレンダリングが正常に停止した場合、監査状態は "拒否" に変更され、ほとんどのサードパーティのインベントリでの配信が停止されます。	カスタムテンプレートを変更します。
`DELETE`	https://api.appnexus.com/template?id=TEMPLATE_ID 注: 1 つ以上のクリエイティブで使用されているカスタムテンプレートを削除することはできませんが、テンプレートをアーカイブして、今後のクリエイティブで使用できないようにすることはできます。詳細については、以下の「カスタムテンプレートのアーカイブ」の例を参照してください。	カスタムテンプレートを削除します。

カスタムテンプレートの作成 (iPhone のみ)

この機能は、広告が iTunes から特定のアプリをダウンロードするための機能です。「ダイレクトリンク」は、セキュリティのためにiPhoneでは機能しません。そのため、販売者タグ (AST) ライブラリに直接アクセスすることはできません。その代わりに、イベントを発生させます。

警告

ユーザーには、カスタムテンプレートとマクロの作成に関する以前の知識が必要です。

これを行うには:

テンプレートを使用する既定のクリエイティブを含む配置を作成します。これにより、メンバーがアクセスできるテンプレートが一覧表示されます。標準テンプレートではない Xandr クリエイティブテンプレートのセットがあります。この状況では、カスタムテンプレートが必要になります。

テンプレートは、既定のクリエイティブに関連付けられている必要があります。そのクリエイティブが選択されると、このテンプレートが見つかります。クリエイティブと共に追加の JavaScript 関数を送信します。その関数を呼び出し、そのイベントを Seller Tag ライブラリに送信します。これにより、販売者タグライブラリが実行されているメインページフレームから iTunes アプリストアが開きます。

要約：

テンプレートは urI を受け取ります。
販売者タグライブラリにイベントを送信します。
Seller Tag Core には、このカスタムイベントのリスナーがあり、iTunes が起動します。
このイベント名と、開くアプリストアの URL を渡します。 URL を使用すると、iTunes アプリストア内の特定のリソースに移動します。

テンプレートの例

function iTunesClick(url)
{window.parent.document.dispatchEvent(new CustomEvent('apntag_iTunesLaunch', {
detail: { url: url }})); }
document.write('<a
href="#"
onclick="iTunesClick(\\\'${CLICK_URL}\\\');"><img
width="${CREATIVE_WIDTH}" height="${CREATIVE_HEIGHT}"
style="border-style: none" src="${MEDIA_URL}"/></a>');

JSON フィールド

フィールド	種類	説明
`id`	int	クリエイティブテンプレートの ID。クエリ文字列で必要な On:`PUT`/`DELETE`。
`name`	string (30)	クリエイティブテンプレートの名前。必須:`POST`
`description`	string	クリエイティブテンプレートの説明。
`member_id`	int	テンプレートを所有するメンバーの ID。標準の Xandr テンプレートの場合、これは null です。読み取り専用。
`ad_type`	string	注: このフィールドは、クリエイティブを拡張広告申込情報に関連付ける場合にのみ適用されます。使用されるクリエイティブの種類。使用可能な値: - `"banner"` - `"video"` (オーディオの種類を含む) - `"native"` この値は、広告申込情報の購入戦略、支払い戦略、最適化オプション、クリエイティブの関連付け、ターゲット設定オプションのオークションアイテムの追跡方法を決定します。注: 広告申込情報に関連付けられているすべてのクリエイティブは、広告の種類が同じである必要があります。これは、[広告申込情報サービス - ALI] で選択した`ad_type`と一致する必要があります。
`media_subtype`	object	このテンプレートを使用できるクリエイティブの表示スタイル。各メディアサブタイプは、スーパーオーディネートメディアタイプに属します。たとえば、 `"Standard Banner"` メディアサブタイプは `"Banner"` メディアタイプに属します。詳細については、以下の「メディアサブタイプ」を参照してください。必須:`POST`
`format`	object	このテンプレートを使用できるクリエイティブの形式 ( `"image"` や `"flash"`など)。詳細については、以下の「書式」を参照してください。必須:`POST`
`is_default`	ブール値	`true`場合、テンプレートは、テンプレートのメディアの種類、メディアサブタイプ、および形式に一致するクリエイティブに自動的に割り当てられます。クリエイティブがアップロードされると、必要に応じて、この既定の割り当てをオーバーライドできます。メディアの種類、メディアサブタイプ、および形式の組み合わせごとに、既定のクリエイティブテンプレートは 1 つだけ存在できることに注意してください。デフォルト：`false`
`is_archived`	ブール値	`true`場合、テンプレートはアーカイブされます。テンプレートをアーカイブすると、将来のクリエイティブでテンプレートを使用できなくなりますが、テンプレートを既に使用しているクリエイティブには影響しません。デフォルト：`false`
`content_js`	string	JavaScript でのテンプレートのレンダリングコード。このコードには、Xandr 標準マクロと独自のカスタムマクロの両方を含めることができます。 Xandr マクロは $ 記号で始まり、カスタムマクロは # 記号で始まる必要があります。各カスタムマクロは、 `macros` 配列で定義する必要があります。 `content_html`と`content_xml`が指定されていない場合は、On:`POST` 必須。
`content_html`	string	HTML でのテンプレートのレンダリングコード。このコードには、Xandr 標準マクロと独自のカスタムマクロの両方を含めることができます。 Xandr マクロは $ 記号で始まり、カスタムマクロは # 記号で始まる必要があります。各カスタムマクロは、 `macros` 配列で定義する必要があります。 `content_js`と`content_xml`が指定されていない場合は、On:`POST` 必須。
`content_xml`	string	非推奨 (2016 年 10 月 17 日現在)。
`callback_content_html`	string	`media_subtype`が`"Popup"`または`"Popunder"`されている場合、`content_js`はポップウィンドウのレンダリングコードを定義し、このフィールドはポップウィンドウ内のコンテンツのレンダリングコードを定義します。
`macros`	オブジェクトの配列	`content_js`、`content_html`、または `content_xml` フィールドで使用されるカスタムマクロ。テンプレートには、最大 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_js、content_html、または content_xml フィールドで使用される各カスタムマクロを定義する必要があります。

フィールド	型 (長さ)	説明
`code`	string (30)	マクロ名は、 `content_js`、 `content_html`、または `content_xml` フィールドで使用されるとおりです。たとえば、 `#{BORDER_SIZE}` が `content_js` フィールドのマクロである場合は、ここで "BORDER_SIZE" を渡します。必須:`POST`
`name`	string (50)	このテンプレートを使用するクリエイティブを UI 経由で追加すると、人身売買者に表示されるこのマクロのわかりやすい名前。必須:`POST`
`type`	列挙	クリエイティブサービスまたは UI を介してこのテンプレートを使用するクリエイティブを追加するときに、このマクロに対して入稿者が提供する値の種類。使用可能な値: `"true/false"`、 `"string"`、 `"url"`、 `"integer"`、 `"decimal"`、 `"string_list"`、 `"select_from_list"` 、 `"file"`。たとえば、UI でこれを `"true/false"` に設定すると、入稿者にはマクロ名の後にチェックボックスが表示されます。必須:`POST`
`is_required`	ブール値	`true`場合、このテンプレートを使用するクリエイティブを追加するときに、入稿者はマクロの値を指定する必要があります。必須:`POST`
`default_value`	string	`is_required`が`false`されている場合、これは、このテンプレートを使用するクリエイティブを追加するときに、入稿者がマクロの値を指定しない場合に使用される既定値です。 `is_required`が`false`の場合は、On:`POST` 必須。
`other_data`	string	マクロで受け入れられる値 ( `type` が `"string_list"` または `"select_from_list"`の場合)。

例

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

{code}
$ curl -b cookies -c cookies 'https://api.appnexus.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
            },
            ...
        ]
    }
}
{code}

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

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

{code}
$ curl -b cookies -c cookies 'https://api.appnexus.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
        }
    }
}
{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.appnexus.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
                }
            ]
        }
    }
}
{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.appnexus.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
                }
            ]
        }
    }
}
{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.appnexus.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
                }
            ]
        }
    }
}
{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.appnexus.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
                }
            ]
        }
    }
}
{code}

カスタムテンプレートを削除する

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

{code}$ curl -b cookies -c cookies -X DELETE 'https://api.appnexus.com/template?id=222'

{
    "response": {
        "status": "OK"
    }
}
{code}

次の方法で共有

デジタルプラットフォーム API - クリエイティブテンプレートサービス

標準テンプレート

カスタムテンプレート

REST API

カスタムテンプレートの作成 (iPhone のみ)

テンプレートの例

JSON フィールド

メディアサブタイプ

フォーマット

カスタムマクロ

例

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

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

カスタムテンプレートを追加する

カスタムテンプレートを変更する

カスタムテンプレートをアーカイブする

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

カスタムテンプレートを削除する

その他のリソース

次の方法で共有

デジタル プラットフォーム API - クリエイティブ テンプレート サービス

標準テンプレート

カスタム テンプレート

REST API

カスタム テンプレートの作成 (iPhone のみ)

テンプレートの例

JSON フィールド

メディア サブタイプ

フォーマット

カスタム マクロ

例

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

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

カスタム テンプレートを追加する

カスタム テンプレートを変更する

カスタム テンプレートをアーカイブする

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

カスタム テンプレートを削除する

その他のリソース

デジタルプラットフォーム API - クリエイティブテンプレートサービス

カスタムテンプレート

カスタムテンプレートの作成 (iPhone のみ)

メディアサブタイプ

カスタムマクロ

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

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

カスタムテンプレートを追加する

カスタムテンプレートを変更する

カスタムテンプレートをアーカイブする

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

カスタムテンプレートを削除する