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

クリエイティブ サービスを使用して、クリエイティブをシステムに追加できます。 すべてのクリエイティブは、広告主またはパブリッシャーに添付されている必要があります。

• 広告主サービスを呼び出すことで、広告主 ID を確認できます。
• パブリッシャー サービスを呼び出すことで、パブリッシャー ID を確認できます。
• クリエイティブをパブリッシャーにアタッチして、配置のデフォルト クリエイティブとして使用できます。 その後、 Placement Service を使用して、クリエイティブをその ID を介してプレースメントに添付します。

監査

Xandr は、ブランドと評判を深く関心を持つメンバーと協力しています。 このため、システムを通過する広告 (クリエイティブ) がすべての関係者が受け入れられるように細心の注意を払っています。 品質保証のため、サードパーティの在庫で配信されるすべてのクリエイティブは、クリエイティブ サービスを使用して事前登録する必要があります。

• クリエイティブは、media_url (サードパーティの広告サーバー URL または Flash、画像、またはビデオ ファイルのコンテンツ配信ネットワーク URL) によって識別されます。
• Xandr は定期的にmedia_urlsをチェックします。 ファイルが消えた場合、そのクリエイティブは未監査として扱われます。
• クリエイティブが Xandr の監査に合格すると、クリエイティブに特定の変更を加えると、そのクリエイティブは監査のために再提出されます。 詳細については、以下の 「再監査の原因となる変更 」を参照してください。

REST API

JSON フィールド

ブランド

brand オブジェクトには以下のフィールドがあります。

キャンペーン

campaigns 配列の各オブジェクトには、次のフィールドが含まれます。 "id" または "code" フィールドの情報を取得するには、キャンペーン サービスを使用できます。

競争力のあるブランド

競合カテゴリ

クリエイティブ テンプレート

クリエイティブ テンプレート サービスを使用すると、クリエイティブに割り当てることができるすべてのレンダリング テンプレートを表示できます。

よく使われるクリエイティブ テンプレート

詳細については、「 クリエイティブに適したテンプレートの選択」を参照してください。

カスタム マクロ

クリエイティブ テンプレートがマクロの既定値を提供している場合、ここでコードと値を渡すことは任意です。 ただし、テンプレートで必要に応じてカスタム マクロを定義する場合は、マクロのコードと値を渡す必要があります。

詳細については、以下の例の例でカスタム レンダリング テンプレートを使用するクリエイティブの追加例を参照してください。

カスタム要求テンプレート

ライン項目

line_items 配列の各オブジェクトには、次のフィールドが含まれます。 "id" または "code" フィールドの情報を取得するには、ライン アイテム サービスを使用できます。

メディア資産

オブジェクトの media_assets 配列には、以下のフィールドが含まれています。

media_assets配列ごとに、次の規則が適用されます。

• 各フィールド値は、クリエイティブごとに 1 回だけ使用できます。 たとえば、"flash_backup_url" アセットを 2 つ持つことはできません。
• 値は有効な値のいずれかである必要があります。
• VAST/HTML5 クリエイティブには、アセットを 1 つだけ含める必要があります。
• 他のすべてのクリエイティブには、0 個以上のメディア アセットを含めることができます。

メディア アセット: 例

"media_assets": [
    {
        "media_asset_id": 22,
        "creative_field": "media_url"
    }, 
    {
        "media_asset_id": 23,
        "creative_field": "flash_backup_url"
    }
]

Mobile

ネイティブ属性

native_attribute オブジェクトには以下のフィールドがあります。 詳細については、以下の 例 の「ネイティブ クリエイティブの追加」を参照してください。

リンク

link オブジェクトには、ネイティブ クリエイティブに関連付けられているランディング ページ URL、フォールバック URL、トラッカーが含まれています。 link オブジェクトはネイティブ属性に必要です。

link オブジェクトには以下のフィールドがあります。

既定では、すべてのネイティブ クリエイティブが secureauditing のために送信されます。

• どのトラッカー (画像トラッカー、javascript トラッカー、クリエイティブ画像アセット トラッカー) に対してセキュリティで保護された URL も指定されていない場合、そのクリエイティブのセキュリティで保護された監査は無効になります。
• セキュリティで保護された URL が指定されておらず、URL の前に https が付きている場合、クリエイティブはセキュリティで保護された監査の対象になります。

リンク トラッカー

link_tracker オブジェクトには以下のフィールドがあります。

画像トラッカー

image_tracker オブジェクトには以下のフィールドがあります。

Javascript トラッカー

javascript_tracker オブジェクトには以下のフィールドがあります。

データ資産

各 data_asset は、ネイティブ クリエイティブのテキスト コンポーネントを表します。 data_assets オブジェクトには以下のフィールドがあります。

画像アセット

各 image_asset は、ネイティブ クリエイティブの画像コンポーネントを表します。 image_asset オブジェクトには以下のフィールドがあります。

クリエイティブ アセット画像

creative_asset_image オブジェクトには以下のフィールドがあります。

画像のサイズ変更の設定

image_resize_setting オブジェクトには以下のフィールドがあります。

ビデオアセット

各 video_asset は、ネイティブ クリエイティブのビデオ コンポーネントを表します。 video_asset オブジェクトには以下のフィールドがあります。

要求ごとに { media_asset_id , vast_url } のうちの 1 つだけを設定する必要があります。

VAST トラッカー

vast_tracker オブジェクトには以下のフィールドがあります。

メディア ファイル

media_file オブジェクトには以下のフィールドがあります。

ネイティブ

次のフィールド (すべて非推奨) を含むために使用されていた native オブジェクト。

メインメディア

カスタム キー値

クリック トラッカー

インプレッション トラッカー

Pixels

この配列を使用して、Xandr が承認したカスタム ピクセルをクリエイティブに追加します。 クリエイティブには最大 5 ピクセルまで追加できます。

Xandr が承認したピクセルは、信頼された一般的に使用されるプロバイダーからのものです。 ほとんどの場合、クリエイティブが監査のために再送信されることはありません。 Xandr 承認済みピクセルをクリエイティブに追加するには、ピクセルに必要なpixel_template_idとパラメーターの数だけを渡す必要があります。 詳細なガイダンスについては、以下の例の「クリエイティブな例に Xandr 承認済みピクセルを追加する」を参照してください。

カスタム ピクセルはユーザーによって定義されるため、クリエイティブが監査のために再送信されます。 カスタム ピクセルを追加するには、書式だけを渡す必要があり、書式に応じてコンテンツまたは URL も渡す必要があります。 詳細なガイダンスについては、以下の例の「クリエイティブへのカスタム ピクセルの追加」の例を参照してください。

政治

次のフィールドを含むために使用される "political" オブジェクト:

POP 値

これらのフィールドは、クリエイティブ JSON 内の "pop_values" 配列に含める必要があります。 例については、以下を参照してください。

セグメント

これらのフィールドは、セグメント配列に含まれます。

状態

サードパーティのピクセル

thirdparty_pixels 配列には、次の表のフィールドが含まれています。 id を除くこれらのフィールドは読み取り専用です。 このサービスを使用して、サードパーティのピクセルの id を更新したり、サードパーティのピクセルを個々のクリエイティブに添付したりできます。

初回実行/最終実行

GET応答に first_run フィールドと last_run フィールドを含めるには、クエリ文字列に flight_info=true を渡します。 また、以下のように、最初と最後に配信された日時に基づいてクリエイティブをフィルター処理することもできます。

配信したことがないクリエイティブのみを取得する

never_run=true をクエリ文字列に渡します。

curl -b cookies -c cookies 'https://api.appnexus.com/creative?advertiser_id=100&flight_info=true&never_run=true'

特定の日付以降に最初に配信されたクリエイティブのみを取得する

min_first_run=YYYY-MM-DD HH:MM:SS をクエリ文字列に渡します。

curl -b cookies -c cookies 'https://api.appnexus.com/creative?advertiser_id=100&flight_info=true&min_first_run=2012-01-01 00:00:00'

特定の日付またはそれより前に最初に配信されたクリエイティブのみを取得する

max_first_run=YYYY-MM-DD HH:MM:SS をクエリ文字列に渡します。

curl -b cookies -c cookies 'https://api.appnexus.com/creative?advertiser_id=100&flight_info=true&max_first_run=2012-08-01 00:00:00'

特定の日付範囲内で最初に配信されたクリエイティブのみを取得する

min_first_run=YYYY-MM-DD HH:MM:SS&max_first_run=YYYY-MM-DD HH:MM:SS をクエリ文字列に渡します。

curl -b cookies -c cookies 'https://api.appnexus.com/creative?advertiser_id=100&flight_info=true&min_first_run=2012-01-01 00:00:00&max_first_run=2012-08-01 00:00:00'

特定の日付以降に最後に配信されたクリエイティブのみを取得する

min_last_run=YYYY-MM-DD HH:MM:SS をクエリ文字列に渡します。

curl -b cookies -c cookies 'https://api.appnexus.com/creative?advertiser_id=100&flight_info=true&min_last_run=2012-01-01 00:00:00'

特定の日付またはそれより前に最後に配信されたクリエイティブのみを取得する

max_last_run=YYYY-MM-DD HH:MM:SS をクエリ文字列に渡します。

curl -b cookies -c cookies 'https://api.appnexus.com/creative?advertiser_id=100&flight_info=true&max_last_run=2012-08-01 00:00:00'

特定の日付範囲内に最後に配信されたクリエイティブのみを取得する

min_last_run=YYYY-MM-DD HH:MM:SS&max_last_run=YYYY-MM-DD HH:MM:SS をクエリ文字列に渡します。

curl -b cookies -c cookies 'https://api.appnexus.com/creative?advertiser_id=100&flight_info=true&min_last_run=2012-01-01 00:00:00&max_last_run=2012-08-01 00:00:00'

統計情報

再監査の原因となる変更

クリエイティブが Xandr 監査に合格すると (audit_status は "audited")、次のいずれかのフィールドを変更すると、クリエイティブが監査のために再送信されます (audit_status は "pending" に設定されます)。

• width
• height
• content
• media_url
• click_url
• template
• custom_macros
• media_subtypes
• language
• categories
• technical_attributes
• brand_id
• pixel_url
• pixels (カスタム ピクセルまたは Xandr 承認ピクセルを追加または削除する場合)
• text_title (テキスト クリエイティブの場合)
• text_description (テキスト クリエイティブの場合)
• text_display_url (テキスト クリエイティブの場合)
• pop_window_maximize (ポップ クリエイティブの場合)
• pop_is_tag_initiated (クリエイティブをポップにしていて、false から true に変更する場合)
• video_attribute
• media_assets
• brand_url (API ユーザーには適用されません)
• alternative_landing_page_url
• native_attribute

また、 audit_status が "no_audit"の場合は、 allow_audit を "false" から "true" に変更すると、クリエイティブは Xandr の監査に再提出されます。

クリエイティブ マクロ

Xandr では、クリエイティブの media_url、 content、 click_url、 pixel_url フィールド内で使用できるマクロがいくつか事前定義されています。

クリック トラッキングの例

"media_url": "https://ad.doubleclick.net/adi/N5364.Ivillage.com/B2965815.5;sz=728x90;click0=$
{CLICK_URL};ord=${CACHEBUSTER}?"
        

例

バナー画像クリエイティブを追加する (ホスト型)

Xandr でホストするための標準バナー画像クリエイティブをアップロードする場合:

クリエイティブが登録されると、コンテンツは CDN に保存され、クリエイティブには https://cdn.adnxs.com/p/29/23/21/a0/292321a0bea05427598914c8bb626032.jpg などのmedia_urlが付けられます。

監査: 既定では、クリエイティブは Xandr による監査のために送信されます。 クリエイティブを監査したくない場合は、 allow_audit を含めて [ false] に設定する必要があります。 または、クリエイティブを自分で監査する場合は、 is_self_audited を含めて true に設定する必要があります。

$ cat creative

{
   "creative": {
      "template": {"id":4},
      "width": 300,
      "height": 250,
      "click_url": "https://www.gothere.com",
      "click_target": "https://www.gothere.com",
      "file_name": "gothere.png",
      "content": "/9j/4AAQSkZJRgABAgAAZABkAAD/7AARRHVja3kAAQAEAAAAPAAA/+4ADkFkb2JlAGTAAAAAAf/b
                 AIQABgQEBAUEBgUFBgkGBQYJCwgGBggLDAoKCwoKDBAMDAwMDAwQDA4PEA8ODBMTFBQTExwbGxsc
                 Hx8fHx8fHx8fHwEHBwcNDA0YEBAYGhURFRofHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8f
                 ...
                 nwj3HrP+oer6/wDPa/tKsOz/AEf8CnxP82z3fTu9VDboP//Z",
       "is_political_and_eu_targeted": false,
       "is_political_and_non_eu_targeted": false
   }
}

$ curl -b cookies -c cookies -X POST -d @creative 'https://api.appnexus.com/creative?advertiser_id=2'

{
   "response": {
      "status": "OK",
      "id": 10,
      ...
      "template": {
          "id": 4,
          "name": "Standard",
          "media_subtype_id": 1,
          "format_id": 4
      },
      "width": 300,
      "height": 250,
      ...
      "click_url": "https://www.gothere.com",
      "click_target": "https://www.gothere.com",
      "media_url": "https://cdn.adnxs.com/p/29/23/21/a0/gothere.png"
      ...
      "audit_status": "pending",
      ...
     "categories":  [
           {
                 "id": 37,
                 "name": "Politics",
                 "self_declared": true
          }],
   }
}

モバイル バナー画像クリエイティブを追加する (ホステッド)

モバイル クリエイティブが Xandr プラットフォームの監査に合格するには、クリエイティブがクリックされたときにデスクトップ ブラウザーに正しく表示される代替 URL を持つ mobile オブジェクトを渡す必要があります。

$ cat creative
 
{
    "creative": {
        "content": "\/9j\/4AAQSkZJRgABAQEASABIAAD\/7QCEUGhvdG9zaG9wIDMuMAA4QklNBAQAAAAAAGccAVoAAxsl...",
        "mobile": {
            "alternative_landing_page_url": "https:\/\/example.com"
        },
        "file_name": "SWEET.png",
        "click_url": "https:\/\/example.com",
        "click_target": "https:\/\/example.com",
        "height": 250,
        "width": 300,
        "template": {
            "id": 4
        }
    }
}

$ curl -b cookies -c cookies -X POST -d @creative 'https://api.appnexus.com/creative?advertiser_id=3141'

{
    "response": {
        "status": "OK",
        "count": 1,
        "id": 700864,
        "start_element": 0,
        "num_elements": 100,
        "creative": {
            "name": null,
            "brand_id": 1,
            "media_url": "https:\/\/cdn.sand-08.adnxs.net\/s\/d3\/d6\/1c\/61\/d3d61c611fd6f98becc8ad6d45c43875.png",
            "id": 700864,
            "code": null,
            "code2": null,
            "member_id": 1309,
            "state": "inactive",
            "click_track_result": "not_tested",
            "advertiser_id": 41798,
            "publisher_id": null,
            "format": null,
            "width": 300,
            "height": 250,
            "click_url": "https:\/\/example.com",
            "click_target": "https:\/\/example.com",
            "flash_click_variable": null,
            "no_iframes": false,
            "content": null,
            "original_content": null,
            "file_name": "OH_YEAH.png",
            "track_clicks": true,
            "audit_status": "pending",
            "macros": null,
            "profile_id": null,
            "audit_feedback": null,
            "is_prohibited": false,
            "is_suspicious": false,
            "created_on": "2013-10-18 15:57:03",
            "flash_backup_url": null,
            "last_modified": "2013-10-18 15:57:03",
            "is_control": false,
            "allow_audit": true,
            "is_expired": false,
            "creative_upload_status": "pending",
            "backup_upload_status": null,
            "use_dynamic_click_url": false,
            "media_subtypes": [
                "banner"
            ],
            "size_in_bytes": 15171,
            "msft_audit_status": "pending",
            "msft_audit_feedback": null,
            "msft_external_audit_status": "pending",
            "msft_external_audit_feedback": null,
            "is_self_audited": false,
            "no_adservers": false,
            "text_title": null,
            "text_description": null,
            "text_display_url": null,
            "click_action": "click-to-web",
            "ssl_status": "disabled",
            "allow_ssl_audit": false,
            "media_url_secure":"https:\/\/a248.e.akamai.net\/appnexus.download.akamai.com\/89298\/sandbox\/s\/d3\/d6\/1c\/61\/d3d61c611fd6f98becc8ad6d45c43875.png",
            "content_secure": null,
            "original_content_secure": null,
            "flash_backup_url_secure": null,
            "is_hosted": true,
            "content_source": "standard",
            "lifetime_budget_imps": null,
            "daily_budget_imps": null,
            "enable_pacing": null,
            "allow_safety_pacing": null,
            "lifetime_budget": null,
            "daily_budget": null,
            "landing_page_url": null,
            "thirdparty_creative_id": null,
            "thirdparty_campaign_id": null,
            "custom_request_template": null,
            "language": {
                "id": 1,
                "name": "English"
            },
            "pop_values": null,
            "brand": {
                "id": 1,
                "name": "Unknown",
                "category_id": 8
            },
            "template": {
                "id": 4,
                "name": "Standard",
                "media_subtype_id": 1,
                "format_id": 4
            },
            "thirdparty_page": null,
            "custom_macros": null,
            "segments": null,
            "folder": null,
            "campaigns": null,
            "competitive_brands": null,
            "competitive_categories": null,
            "pixels": null,
            "mobile": {
                "alternative_landing_page_url":"https:\/\/example.com"
            },
            "sla": null,
            "sla_eta": null,
            "currency": "USD"
        },
        "dbg_info": {
            ...
        }
    }
}

バナー フラッシュ クリエイティブを追加する (ホスト型)

Xandr でホストするための標準バナー フラッシュ クリエイティブをアップロードする場合:

クリエイティブが登録されると、コンテンツは CDN に保存され、クリエイティブには https://cdn.adnxs.com/p/29/23/21/a0/292321a0bea05427598914c8bb626032.jpg などのmedia_urlが付けられます。

監査: 既定では、クリエイティブは Xandr による監査のために送信されます。 クリエイティブを監査したくない場合は、 allow_audit を含めて [ false] に設定する必要があります。 または、クリエイティブを自分で監査する場合は、 is_self_audited を含めて true に設定する必要があります。

$ cat creative

{
   "creative": {
      "template": {"id":3},
      "width": 300,
      "height": 250,
      "click_url": "https://www.gothere.com",
      "click_target": "htpps://www.gothere.com",
      "file_name": "gothere.swf",
      "flash_click_variable": "ClickTag",
      "content": "/9j/4AAQSkZJRgABAgAAZABkAAD/7AARRHVja3kAAQAEAAAAPAAA/+4ADkFkb2JlAGTAAAAAAf/b
                 AIQABgQEBAUEBgUFBgkGBQYJCwgGBggLDAoKCwoKDBAMDAwMDAwQDA4PEA8ODBMTFBQTExwbGxsc
                 Hx8fHx8fHx8fHwEHBwcNDA0YEBAYGhURFRofHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8f
                 ...
                 nwj3HrP+oer6/wDPa/tKsOz/AEf8CnxP82z3fTu9VDboP//Z",
      "flash_backup_content": "AcndgAAZABkAAD/7AARRHVja3kAAQAEAAAAPAAA/+4ADkFkb2JlAGTAAAAAAf/b
                 AIQABgQEBAUEBgUFBgkGBQYJCwgGcdkDCADBdcdDDBAMDAwMDAwQDA4PEA8ODBMTFBQTExwbGxsc
                 Hx8fHx8fHx8fHwEHBwcNDA0YEBAYGhURFRofHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx6smd34
                 ...
                 nwj3HrP+oer6/wDPa/tKsOz/AEf8Cnnd30cddaxcio244adc",
      "flash_backup_file_name": "flash_backup.png"
   }
}

$ curl -b cookies -c cookies -X POST -d @creative 'https://api.appnexus.com/creative?advertiser_id=2'

{
   "response": {
      "status": "OK",
      "id": 11,
      ...
      "template": {
          "id": 3,
          "name": "Standard",
          "media_subtype_id": 1,
          "format_id": 3
      },
      "width": 300,
      "height": 250,
      ...
      "click_url": "https://www.gothere.com",
      "click_target": "https://www.gothere.com",
      "media_url": "https://cdn.adnxs.com/p/29/23/21/a0/gothere.swf"
      "flash_backup_url": "https://cdn.adnxs.com/c/54/f2/d1/v3/flash_backup.png"
      ...
      "audit_status": "pending",
      ...
   }
}

バナー フラッシュ クリエイティブ (サードパーティ URL) を追加する

バナー フラッシュ クリエイティブのサードパーティ URL を追加する場合:

監査: 既定では、クリエイティブは Xandr による監査のために送信されます。 クリエイティブを監査したくない場合は、 allow_audit を含めて [ false] に設定する必要があります。 または、クリエイティブを自分で監査する場合は、 is_self_audited を含めて true に設定する必要があります。

$ cat creative

{
   "creative": {
      "media_url": "https://creative.com/300x250",
      "flash_backup_url": "https://creative.com/backupimage/300x250",
      "template": {"id":2},
      "width": 300,
      "height": 250,
      "campaigns": [
         {"id":58990},
         {"id":58991}
      ]
   }
}

$ curl -b cookies -c cookies -X POST -d @creative 'https://api.appnexus.com/creative?advertiser_id=35'

{
   "response": {
      "status": "OK",
      "id":12,
      ...
      "media_url": "https://creative.com/300x250",
      "flash_backup_url": "https://creative.com/backupimage/300x250",
      ...
      "template": {
          "id": 2,
          "name": "Standard",
          "media_subtype_id": 1,
          "format_id": 2
      },
      ...
      "audit_status": "pending",
      ...
   }
}

MediaMind 拡張クリエイティブ (サードパーティ URL) を追加する

この例では、 media_url フィールドには展開可能クリエイティブのサードパーティ URL が指定されており、テンプレート配列ではテンプレート 108 が指定されていることに注意してください。テンプレート 108 は、 "MediaMind Expandable" メディア サブタイプと "url-js" 形式のクリエイティブの Xandr 標準テンプレートです。

監査: 既定では、クリエイティブは Xandr による監査のために送信されます。 クリエイティブを監査したくない場合は、 allow_audit を含めて [ false] に設定する必要があります。 または、クリエイティブを自分で監査する場合は、 is_self_audited を含めて true に設定する必要があります。

$ cat creative

{
   "creative": {
      "media_url": "https://bs.serving-sys.com/BurstingPipe/adServer.bs?ncu=$$${CLICK_URL_ENC}$$&cn=rsb&c=28&
          pli=2980019&PluID=0&w=300&h=250&ord=${CACHEBUSTER}&ucm=true",
      "template": {"id":108},
      "width": 300,
      "height": 250,
      "campaigns":[
          {"id": 58990},
          {"id": 58991}
      ]
   }
}

$ curl -b cookies -c cookies -X POST -d @creative 'https://api.appnexus.com/creative?advertiser_id=35'

{
   "response":{
      "status":"OK",
      "id":12,
      ...
      "media_url":"https://bs.serving-sys.com/BurstingPipe/adServer.bs?ncu=$$${CLICK_URL_ENC}$$&cn=rsb&c=28&
          pli=2980019&PluID=0&w=300&h=250&ord=${CACHEBUSTER}&ucm=true",
      ...
      "template": {
          "id": 108,
          "name": "Standard",
          "media_subtype_id": 11,
          "format_id": 2
      },
      ...
      "audit_status": "pending",
      ...
   }
}

Pointroll 拡張クリエイティブ (サードパーティの HTML タグ) を追加する

この例では、コンテンツ フィールドには展開可能クリエイティブ用の JavaScript タグが用意されており、テンプレート配列ではテンプレート 159 が指定されていることに注意してください。テンプレート 159 は、 "Pointroll Expandable" メディア サブタイプと "raw-html" 形式のクリエイティブの Xandr 標準テンプレートです。

監査: 既定では、クリエイティブは Xandr による監査のために送信されます。 クリエイティブを監査したくない場合は、 allow_audit を含めて [ false] に設定する必要があります。 または、クリエイティブを自分で監査する場合は、 is_self_audited を含めて true に設定する必要があります。

$ cat creative

{
   "creative": {
      "content":<script type=\"text/javascript\">function pr_swfver(){var osf,osfd,i,axo=1,v=0,nv=navigator;
       if(nv.plugins&&nv.mimeTypes.length){osf=nv.plugins[\"ShockwaveFlash\"];if(osf&&osf.description)
       {osfd=osf.description;v=parseInt(osfd.substring(osfd.indexOf(\".\")-2))}}else{try{for(i=5;axo!=null;i++)
       {axo=new ActiveXObject(\"ShockwaveFlash.ShockwaveFlash.\"+i);v=i}}catch(e){}}return v;}var pr_d=new Date
       ();pr_d=pr_d.getDay()+\"|\"+pr_d.getHours()+\": \"+pr_d.getMinutes()+\"|\"+-pr_d.getTimezoneOffset()/60;
       var pr_postal=\"\";var pr_data=\"\";var pr_redir=\"$CTURL$\";var pr_nua=navigator.userAgent.toLowerCase();
       </script>,
      "template": {"id":159},
      "width": 300,
      "height": 250,
      "campaigns": [
         {"id": 58990},
         {"id": 58991}
      ]
   }
}

$ curl -b cookies -c cookies -X POST -d @creative 'https://api.appnexus.com/creative?advertiser_id=35'

{
   "response": {
      "status": "OK",
      "id": 12
      ...
      "content":"var click = '${CLICK_URL}'; var t = (new Date()).getTime(); var s = document.createElement('script');
                s.setAttribute('src', 'https://pointroll.adserver.org/showad?size=300x250;click=' + click + ';ord=' + t);
                document.getElementsByTagName('body').appendChild(s);https://creative.com/300x250",
      ...
      "template": {
         "id": 159,
         "name": "Standard",
         "media_subtype_id": 12,
         "format_id": 6
      },
      ...
      "audit_status":"pending",
      ...
   }
}

ポップアップ画像クリエイティブ (サードパーティ URL) を追加する

この例では、 media_url フィールドにはポップアップ画像クリエイティブのサードパーティの URL が指定され、テンプレート配列ではテンプレート 10 が指定されていることに注意してください。テンプレート 10 は、 "Popup" メディア サブタイプと "url-js" 形式の標準の Xandr レンダリング テンプレートです。 要求にテンプレートを指定しない場合は、format を "image" として渡し、 media_subtype を "popup" として渡す必要があります。

{
   "creative":
   {
     "media_url": "https://dummyimage.com/728x90",
     "click_url": "https://www.google.com",
     "click_target": "https://www.google.com",
     "template": {"id":10},
     "pop_values": {
       "pop_is_tag_initiated": false,
       "pop_window_maximize": false,
       "pop_window_title": null,
       "pop_statusbar": false,
       "pop_resizable": false,
       "pop_scrollbars": false,
       "pop_toolbar": false,
       "pop_addressbar": false
       },
      "width": 728,
      "height": 90
   }
}

$ curl -b cookies -c cookies -X POST -d @creative 'https://api.appnexus.com/creative?advertiser_id=2'

{
   "response": {
      "status": "OK",
      "id": 14,
      ...
      "template": {
          "id": 10,
          "name": "Standard",
          "media_subtype_id": 2,
          "format_id": 2
      },
      "width": 728,
      "height": 90,
      ...
      "audit_status": "pending",
      ...
   }
}

ポップアンダー画像クリエイティブ (サードパーティ URL) を追加する

この例では、 media_url フィールドにはポップアンダー画像クリエイティブのサードパーティ URL が指定されており、テンプレート配列では、 "Popunder" メディア サブタイプと "url-js" 形式の標準 Xandr レンダリング テンプレートであるテンプレート 17 が指定されていることに注意してください。 要求にテンプレートを含めない場合は、format を "image" として渡し、 media_subtype を "popunder" として渡す必要があります。

{
   "creative" :
   {
     "media_url": "https://dummyimage.com/728x90",
     "click_url": "https://www.google.com",
     "click_target": "https://www.google.com",
     "template": {"id":17},
     "pop_values": {
       "pop_is_tag_initiated": false,
       "pop_window_maximize": false,
       "pop_window_title": null,
       "pop_statusbar": false,
       "pop_resizable": false,
       "pop_scrollbars": false,
       "pop_toolbar": false,
       "pop_addressbar": false
       },
      "width": 728,
      "height": 90
   }
}

$ curl -b cookies -c cookies -X POST -d @creative 'https://api.appnexus.com/creative?advertiser_id=2'

{
   "response": {
      "status": "OK",
      "id":14,
      ...
      "template": {
          "id": 17,
          "name": "Standard",
          "media_subtype_id": 2,
          "format_id": 2
      },
      "width": 728,
      "height": 90,
      ...
      "audit_status": "pending",
      ...
   }
}

バナー内ビデオ (サードパーティのビデオ ファイル) を追加する

サードパーティ製のインバナー動画ファイルを追加する場合:

監査: 既定では、クリエイティブは Xandr による監査のために送信されます。 クリエイティブを監査したくない場合は、 allow_audit を含めて [ false] に設定する必要があります。 または、クリエイティブを自分で監査する場合は、 is_self_audited を含めて true に設定する必要があります。

$ cat inbanner

{
   "creative": {
      "media_url": "https://example.com/inbanner.flv",
      "template": {"id":219},
      "click_url": "https://www.example.com",
      "click_target": "https://www.example.com",
      "width": 300,
      "height": 250,
      "flash_backup_url": "https://www.example.com/poster_image.png"
      "custom_macros": [
          {
              "code": "FLV_URL",
              "value": "https:www.example.com/inbanner.flv"
          },
          {
              "code": "MP4_URL",
              "value": "https:www.example.com/inbanner.mp4"
          },
          {
              "code": "WEBM_URL",
              "value": "https:www.example.com/inbanner.webm"
          }
      ],
   }
}


$ curl -b cookies -c cookies -X POST -d @inbanner 'https://api.appnexus.com/creative?advertiser_id=2'
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": 510242,
        "start_element": 0,
        "num_elements": 100,
        "creative": {
            "name": null,
            "brand_id": 1,
            "media_url": "https://example.com/inbanner.flv",
            "id": 510244,
            "code": null,
            "code2": null,
            "state": "inactive",
            "click_track_result": "not_tested",
            "advertiser_id": 2,
            "publisher_id": null,
            "format": null,
            "width": 300,
            "height": 250,
            "click_url": "https://www.example.com",
            "flash_click_variable": null,
            "pixel_url": null,
            "pixel_type": "image",
            "no_iframes": false,
            "content": null,
            "original_content": null,
            "file_name": "inbanner.flv",
            "track_clicks": true,
            "audit_status": "pending",
            "macros": null,
            "profile_id": null,
            "audit_feedback": null,
            "is_prohibited": false,
            "created_on": "2012-04-13 14:47:46",
            "flash_backup_url": "https://example.com/poster_image.png",
            "last_modified": "2012-04-13 14:47:46",
            "is_control": false,
            "allow_audit": true,
            "is_expired": false,
            "creative_upload_status": "pending",
            "backup_upload_status": null,
            "use_dynamic_click_url": false,
            "media_subtypes": [
                "banner"
            ],
            "size_in_bytes": 0,
            "msft_audit_status": "pending",
            "msft_audit_feedback": null,
            "msft_external_audit_status": "pending",
            "msft_external_audit_feedback": null,
            "is_self_audited": false,
            "no_adservers": false,
            "text_title": null,
            "text_description": null,
            "text_display_url": null,
            "click_action": "click-to-web",
            "click_target": "https://www.example.com",
            "ssl_status": "disabled",
            "allow_ssl_audit": false,
            "media_url_secure": "https://example.com/inbanner.flv",
            "content_secure": null,
            "original_content_secure": null,
            "pixel_url_secure": null,
            "flash_backup_url_secure": null,
            "is_hosted": true,
            "lifetime_budget_imps": null,
            "daily_budget_imps": null,
            "enable_pacing": null,
            "lifetime_budget": null,
            "daily_budget": null,
            "language": {
                "id": 1,
                "name": "English"
            },
            "pop_values": null,
            "brand": {
                "id": 1,
                "name": "Unknown",
                "category_id": 8
            },
            "template": {
                "id": 219,
                "name": "Standard",
                "media_subtype_id": 3,
                "format_id": 11
            },
            "custom_macros": [
                {
                    "code": "AUTOPLAY",
                    "value": "0"
                },
                {
                    "code": "CONTROLS",
                    "value": "1"
                },
               {
                    "code": "FLV_URL",
                    "value": "https:www.example.com/inbanner.flv"
                },
                {
                    "code": "MP4_URL",
                    "value": "https:www.example.com/inbanner.mp4"
                },
                {
                    "code": "WEBM_URL",
                    "value": "https:www.example.com/inbanner.webm"
                }
            ],
            "segments": null,
            "folder": null,
            "campaigns": null,
            "competitive_brands": null,
            "competitive_categories": null,
            "pixels": null,
            "sla": null,
            "sla_eta": null,
            "currency": "USD"
        },
        "dbg_info": {
            ... 
        }
    }
}

バナー内ビデオ (サードパーティ製 XML ファイル) を追加する

サードパーティのバナー内 XML ファイルを追加する場合:

監査: 既定では、クリエイティブは Xandr による監査のために送信されます。 クリエイティブを監査したくない場合は、 allow_audit を含めて [ false] に設定する必要があります。 または、クリエイティブを自分で監査する場合は、 is_self_audited を含めて true に設定する必要があります。

$ cat inbanner

{
   "creative": {
      "media_url": "https://example.com/inbanner.xml",
      "template": {"id":8},
      "click_url": "https://www.example.com",
      "click_target": "https://www.example.com",
      "width": 300,
      "height": 250,
      "flash_backup_url": "https://example.com/poster_image.png"
   }
}


$ curl -b cookies -c cookies -X POST -d @inbanner 'https://api.appnexus.com/creative?advertiser_id=2'
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": 510242,
        "start_element": 0,
        "num_elements": 100,
        "creative": {
            "name": null,
            "brand_id": 1,
            "media_url": "https://example.com/inbanner.xml",
            "id": 510245,
            "code": null,
            "code2": null,
            "state": "inactive",
            "click_track_result": "not_tested",
            "advertiser_id": 2,
            "publisher_id": null,
            "format": null,
            "width": 300,
            "height": 250,
            "click_url": "https://www.example.com",
            "flash_click_variable": null,
            "pixel_url": null,
            "pixel_type": "image",
            "no_iframes": false,
            "content": null,
            "original_content": null,
            "file_name": "inbanner.xml",
            "track_clicks": true,
            "audit_status": "pending",
            "macros": null,
            "profile_id": null,
            "audit_feedback": null,
            "is_prohibited": false,
            "created_on": "2012-04-13 14:47:46",
            "flash_backup_url": "https://example.com/poster_image.png",
            "last_modified": "2012-04-13 14:47:46",
            "is_control": false,
            "allow_audit": true,
            "is_expired": false,
            "creative_upload_status": "pending",
            "backup_upload_status": null,
            "use_dynamic_click_url": false,
            "media_subtypes": [
                "banner"
            ],
            "size_in_bytes": 0,
            "msft_audit_status": "pending",
            "msft_audit_feedback": null,
            "msft_external_audit_status": "pending",
            "msft_external_audit_feedback": null,
            "is_self_audited": false,
            "no_adservers": false,
            "text_title": null,
            "text_description": null,
            "text_display_url": null,
            "click_action": "click-to-web",
            "click_target": "https://www.example.com",
            "ssl_status": "disabled",
            "allow_ssl_audit": false,
            "media_url_secure": "https://example.com/inbanner.xml",
            "content_secure": null,
            "original_content_secure": null,
            "pixel_url_secure": null,
            "flash_backup_url_secure": null,
            "is_hosted": true,
            "lifetime_budget_imps": null,
            "daily_budget_imps": null,
            "enable_pacing": null,
            "lifetime_budget": null,
            "daily_budget": null,
            "language": {
                "id": 1,
                "name": "English"
            },
            "pop_values": null,
            "brand": {
                "id": 1,
                "name": "Unknown",
                "category_id": 8
            },
            "template": {
                "id": 8,
                "name": "Standard",
                "media_subtype_id": 3,
                "format_id": 10
            },
            "custom_macros": null,
            "segments": null,
            "folder": null,
            "campaigns": null,
            "competitive_brands": null,
            "competitive_categories": null,
            "pixels": null,
            "sla": null,
            "sla_eta": null,
            "currency": "USD"
        },
        "dbg_info": {
           ...
        }
    }
}

カスタム レンダリング テンプレートを使用するクリエイティブを追加する

この例では、 POST 要求によってホストされたフラッシュ バナー クリエイティブが Xandr に追加されます。 クリエイティブではカスタム クリエイティブ テンプレートを使用しています。これは、提供時に罫線付きでクリエイティブをレンダリングするようにデザインされています。 テンプレートのカスタム マクロを使用すると、トラッカーは HTML のカラー コードとサイズ (ピクセル単位) または境界線を指定できます。

$ cat creative

{
   "creative": {
      "template": {"id":252},
      "width": 300,
      "height": 250,
      "custom_macros": [
         {
            "code": "BORDER_COLOR",
            "value": "#000000"
         },
         {
            "code": "BORDER_SIZE",
            "value": 1
         }
      ],
      "click_url": "https://www.gothere.com",
      "click_target": "https://www.gothere.com",
      "file_name": "gothere.swf",
      "flash_click_variable": "ClickTag",
      "content": "/9j/4AAQSkZJRgABAgAAZABkAAD/7AARRHVja3kAAQAEAAAAPAAA/+4ADkFkb2JlAGTAAAAAAf/b
                 AIQABgQEBAUEBgUFBgkGBQYJCwgGBggLDAoKCwoKDBAMDAwMDAwQDA4PEA8ODBMTFBQTExwbGxsc
                 Hx8fHx8fHx8fHwEHBwcNDA0YEBAYGhURFRofHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8f
                 ...
                 nwj3HrP+oer6/wDPa/tKsOz/AEf8CnxP82z3fTu9VDboP//Z",
      "flash_backup_content": "AcndgAAZABkAAD/7AARRHVja3kAAQAEAAAAPAAA/+4ADkFkb2JlAGTAAAAAAf/b
                 AIQABgQEBAUEBgUFBgkGBQYJCwgGcdkDCADBdcdDDBAMDAwMDAwQDA4PEA8ODBMTFBQTExwbGxsc
                 Hx8fHx8fHx8fHwEHBwcNDA0YEBAYGhURFRofHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx6smd34
                 ...
                 nwj3HrP+oer6/wDPa/tKsOz/AEf8Cnnd30cddaxcio244adc",
      "flash_backup_file_name": "flash_backup.png"
   }
}

$ curl -b cookies -c cookies -X POST -d @creative 'https://api.appnexus.com/creative?advertiser_id=2'

{
   "response": {
      "status": "OK",
      "id": 11,
      ...
      "template": {
          "id": 252,
          "name": "Flash Banner with Border",
          "media_subtype_id": 1,
          "format_id": 3
      },
      "width": 300,
      "height": 250,
      ...
      "click_url": "https://www.gothere.com",
      "click_target": "https://www.gothere.com",
      "media_url": "https://cdn.adnxs.com/p/29/23/21/a0/gothere.swf"
      "flash_backup_url": "https://cdn.adnxs.com/c/54/f2/d1/v3/flash_backup.png"
      ...
      "audit_status": "pending",
      ...
      "custom_macros": [
         {
            "code": "BORDER_COLOR",
            "value": "#000000"
         },
         {
            "code": "BORDER_SIZE",
            "value": 1
         }
      ],
      ...
   }
}

セキュア クリエイティブを追加する

セキュリティで保護されていないクリエイティブをアップロードする際に、次のように SSL インベントリで配信するバージョンをアップロードすることもできます。

$ cat creative

{
   "creative": {
      "media_url": "https://creative.com/123",
      "media_url_secure": "https://creative.com/123",
      "template": {"id":2},
      "allow_ssl_audit": true
      "format": "image",
      "width": 300,
      "height": 250,
      "campaigns": [
         {"id":58990},
         {"id":58991}
      ]
   }
}

$ curl -b cookies -c cookies -X POST -d @creative 'https://api.appnexus.com/creative?advertiser_id=35'

{
   "response": {
      "status":"OK",
      "id":13
      ...
      "audit_status":"pending",
      ...
      "ssl_status":"pending",
      ...
   }
}

クリエイティブを優先審査のために提出する

優先監査に関して Xandr と補足サービス契約を結んでいる場合は、 sla フィールドを 2 に設定することで、優先監査 (営業時間内の 2 時間以内の監査) の対象となるクリエイティブを提出できます。 応答の [ sla_eta ] フィールドには、監査の推定完了時間が表示されます。

$ cat creative

{
   "creative": {
      "media_url": "https://creative.com/456",
      "template": {"id":2},
      "width": 300,
      "height": 250,
      "campaigns": [
         {"id":58990},
         {"id":58991}
      ],
      "sla": 2
   }
}

$ curl -b cookies -c cookies -X POST -d @creative 'https://api.appnexus.com/creative?advertiser_id=35'

{
   "response": {
      "status": "OK",
      "id": 469340,
      ...
      "audit_status": "pending",
      ...
      "sla": "2",
      "sla_eta": "2012-01-13 22:43:33",
      ...
   }
}

クリエイティブの監査をキャンセルする

Xandr の監査のためにクリエイティブを提出し、audit_statusが"pending"である場合は、allow_audit を false に設定してPUTリクエストを行うことで、監査をキャンセルし、監査料金が請求されない可能性があります。 audit_status フィールドは応答で"no_audit"されます。

$ cat creative

{
   "creative": {
      "allow_audit":false
   }
}

$ curl -b cookies -c cookies -X PUT -d @creative 'https://api.appnexus.com/creative?id=469340&advertiser_id=35'

{
   "response": {
      "status": "OK",
      "id": 469340,
      ...
      "audit_status":"no_audit",
      ...
   }
}

すべてのクリエイティブの監査統計を表示する

この例では、GET呼び出しのクエリ文字列で"audit_stats=true"が渡されます。 これにより、Xandr、Microsoft、および Google の監査ステータスごとに含まれているクリエイティブの数が返されます。

$ curl -b cookies -c cookies 'https://api.appnexus.com/creative?audit_stats=true'

{
    "response": {
        "status": "OK",
        "count": 30,
        "start_element": 0,
        "num_elements": 100,
        "creatives": [
            {
                "total": 30,
                "appnexus_audit": {
                    "no_audit": 10,
                    "pending": 18,
                    "approved": 0,
                    "rejected": 1
                },
                "microsoft_audit": {
                    "no_audit": 10,
                    "pending": 18,
                    "approved": 1,
                    "rejected": 1
                }
            }
        ],
        "dbg_info": {
            ...
        }
    }
}

Xandr 承認済みのピクセルをクリエイティブに追加する

この例では、Xandr 承認の Evidon AdChoices アイコン ピクセルをクリエイティブに追加するプロセスについて説明します。

1. まず、ピクセルに定義する必要があるパラメータの pixel_template_id と数を確認する必要があります。 この情報を取得するには、 ピクセル テンプレート サービス を使用します。

   $ curl -b cookies -c cookies 'https://api.appnexus.com/pixel-template'
   
   {
       "response": {
           "status": "OK",
           "count": 3,
           "start_element": 0,
           "num_elements": 100,
           "pixel-templates": [
               {
                   "id": 1,
                   "name": "Evidon AdChoices Icon",
                   "format": "raw-js",
                   "content": "(function() {document.write('<sc'+'ript type=\"text/javascript\"' + ((\"https:\"
                    == document.location.protocol) ? \"https://c.betrad.com\" : \"https://c.betrad.com\") +
                    '/surly.js?;ad_wxh=${CREATIVE_SIZE};coid=${P1};nid=${P2};${P3}\"></scr'+'ipt>');}());",
                   "num_required_params": 2,
                   "require_reaudit": false
               },
               {
                   "id": 2,
                   "name": "Brilig Impression Tracker",
                   "format": "url-image",
                   "num_required_params": 1,
                   "require_reaudit": false,
                   "url": "https://p.brilig.com/contact/bct?pid=${P1}&_ct=pixel&adid=${CP_ID}&action=1"
               },
               ...
           ],
           "dbg_info": {
               ...
           }
       }
   }
   

2. Evidon AdChoices アイコン ピクセルは、応答の最初の部分です。 id が 1 であることに注目します。 また、 num_required_params が 2であることにも注意してください。 つまり、クリエイティブにピクセルを追加するときには、ピクセル コンテンツの {P1} と {P2} の値を指定する必要があります。

3. クリエイティブにピクセルを追加するための JSON 形式のファイルを作成します。 このファイルでは、 pixel_template_id を 2 に設定し、 param_1 と param_2 をピクセル コンテンツの {P1} と {P2} の値に設定します。

   注意

   ピクセル配列は、JSON で完全に上書きされます。 そのため、クリエイティブのピクセル配列に既にピクセルが含まれている場合は、JSON 配列でもそれらを指定してください。 詳細については、「 クリエイティブ サービス」を参照してください。

   $ cat creative_update
   
   {
       "creative": {
           "pixels": [
               {
                   "pixel_template_id": 1,
                   "param_1":"12",
                   "param_2":"34"
               }
           ]
       }
   }
   

4. 最後に、 PUT 呼び出しを行い、クリエイティブを更新します。 応答の pixels 配列は、ピクセルが追加されたことを示します。 2 つのパラメーターは定義されており、ピクセル コンテンツに入力されています。

   注:

   Evidon AdChoices アイコン ピクセルにより、クリエイティブの再監査が必要audit_status"pending"に戻されていません。

   $ curl -b cookies -c cookies -X PUT -d @creative_update 'https://api.appnexus.com/creative?id=503577&advertiser_id=35081'
   
   {
       "response": {
           "status": "OK",
           "count": 1,
           "id": "503577",
           "start_element": 0,
           "num_elements": 100,
           "creative": {
               "name": null,
               "brand_id": 1,
               "media_url": "https://creative.com/300x250",
               "id": 503577,
               "code": null,
               "code2": null,
               "state": "active",
               "click_track_result": "not_tested",
               "advertiser_id": 35081,
               ...
               "audit_status": "audited",
               ...
               "pixels": [
                   {
                       "id": 163,
                       "pixel_template_id": 1,
                       "param_1": "12",
                       "param_2": "34",
                       "param_3": null,
                       "param_4": null,
                       "param_5": null,
                       "format": "url-image",
                       "content": "(function() {document.write('<sc'+'ript type=\"text/javascript\"' +
                        ((\"https:\" == document.location.protocol) ? \"https://c.betrad.com\" :
                        \"https://c.betrad.com\") + '/surly.js?;ad_wxh=${CREATIVE_SIZE};coid=12;nid=34;
                        \"></scr'+'ipt>');}());"
                   }
               ],
               ...
           },
           "dbg_info": {
               ...
           }
       }
   }
   

クリエイティブにカスタム ピクセルを追加する

この例では、 PUT 要求によってカスタム URL-js ピクセルがクリエイティブ 503577に追加されます。 JSON 形式のファイルでは、形式は "url-js" に設定され、URL はクリエイティブで配信する JavaScript の場所に設定されます。

$ cat creative_update

{
    "creative": {
        "pixels": [
            {
                "format": "url-js",
                "url": "https://50.16.221.228/render_js?cb=${CACHEBUSTER}&uid=${USER_ID}&ref=${REFERER_URL}
                 &campaign_id=147"
            }
        ]
    }
}

$ curl -b cookies -c cookies -X PUT -d @creative_update 'https://api.appnexus.com/creative?id=503577&advertiser_id=35081'

{
    "response": {
        "status": "OK",
        "count": 1,
        "id": "503577",
        "start_element": 0,
        "num_elements": 100,
        "creative": {
            "name": null,
            "brand_id": 1,
            "media_url": "https://creative.com/300x250",
            "id": 503577,
            "code": null,
            "code2": null,
            "state": "active",
            "click_track_result": "not_tested",
            "advertiser_id": 35081,
            ...
            "audit_status": "pending",
            ...
            "pixels": [
                {
                    "id": 196,
                    "pixel_template_id": null,
                    "param_1": null,
                    "param_2": null,
                    "param_3": null,
                    "param_4": null,
                    "param_5": null,
                    "format": "url-js",
                    "url": "https://50.16.221.228/render_js?cb=${CACHEBUSTER}&uid=${USER_ID}
                     &ref=${REFERER_URL}&campaign_id=147"
                }
            ],
            ...
        },
        "dbg_info": {
            ...
        }
    }
}

クリエイティブにサードパーティのピクセルを追加する

この例では、 PUT 要求によってクリエイティブの "503577" に 2 つのサードパーティのピクセルが追加されます。

$ cat creative_update

{
    "creative": {
        "thirdparty_pixels": [
          {
            "id": 145
          },
          {
            "id": 314
          }
        ]
    }
}

$ curl -b cookies -c cookies -X PUT -d @creative_update 'https://api.appnexus.com/creative?id=503577&advertiser_id=35081'

{
    "response": {
        "status": "OK",
        "count": 1,
        "id": "503577",
        "start_element": 0,
        "num_elements": 100,
        "creative": {
            "name": null,
            "brand_id": 1,
            "media_url": "https://creative.com/300x250",
            "id": 503577,
            "code": null,
            "code2": null,
            "state": "active",
            "click_track_result": "not_tested",
            "advertiser_id": 35081,
            ...
            "audit_status": "pending",  ??remove this, confirm with UTSAV
            ...
            "thirdparty_pixels": [

                {
                  "id": 145,
                  "name": "sample pixel",
                  "audit_status": "pending",
                  "active": true
                },
                {
                  "id": 314,
                  "name": "another sample pixel",
                  "audit_status": "pending",
                  "active": true
                }
            ],
            ...
        },
        "dbg_info": {
            ...
        }
    }
}

クリエイティブ (サードパーティの HTML タグ) を追加する

書式フィールドが "raw-html" に設定されている場合、 content フィールドのコンテンツは document.write() で折り返され、 escapedも折り返される必要があります。

$ cat creative 
{
    "creative": {
        "adservers": [
            {
                "id": 79,
                "use_type": "adserver"
            }
        ],
        "name": "Test Creative",
        "original_content": "<script language=\"javascript\"src=\"https://track.adform.net/adfscript/?bn=2342059;click=${CLICK_URL}\"></script><noscript><a href=\"{CLICK_URL}https://track.adform.net/C/?bn=2342059;C=0\"  target=\"_blank\"><img  src=\"https://track.adform.net/adfserve/?bn=2342059;srctype=4;ord=${CACHEBUSTER}\"  border=\"0\"  width=\"300\"  height=\"250\"  alt=\"\"/></a></noscript>",
        "track_clicks": "true",
        "width": 300,
        "height": 250,
        "is_self_audited": "false",
        "content": "document.write('<scr' + 'ipt language=\\\"javascript\\\"src=\\\"https://track.adform.net/adfscript/?bn=2342059;click=${CLICK_URL}\\\"></scr' + 'ipt><noscript><a href=\\\"{CLICK_URL}https://track.adform.net/C/?bn=2342059;C=0\\\"  target=\\\"_blank\\\"><img  src=\\\"https://track.adform.net/adfserve/?bn=2342059;srctype=4;ord=${CACHEBUSTER}\\\"  border=\\\"0\\\"  width=\\\"300\\\"  height=\\\"250\\\"  alt=\\\"\\\"/></a></noscript>');",
        "template": {
            "id": "6"
        }
    }
}

$ curl -b cookies -c cookies -X POST -d @creative 'https://api.appnexus.com/creative?advertiser_id=1'

{
   "response": {
      "status": "OK",
      "id": 20,
      ...
      "template": {
          "id": 6,
          "name": "Standard"
      },
      "width": 300,
      "height": 250,
      "audit_status": "pending",
   }
}

ネイティブ クリエイティブを追加する

これは新しいネイティブ属性です。 新しい属性を持つネイティブ クリエイティブを追加する場合は、テンプレート ID 39461 を使用します。

ステップ 1: アセットを クリエイティブ アップロード サービスにアップロードします。

curl -X POST -H 'Authorization:hbapi:21816:58f909dfa3405:nym2' --form "type=image" --form "file=@./NATIVE.JPG" 'https://api.appnexus.com/creative-upload?member_id=123'

media_asset_idが返されます。

{  
   "response": {  
      "status": "OK",
      "count": 0,
      "start_element": 0,
      "num_elements": 0,
      "dbg_info": {  
         "instance": "05.media-asset-pipeline.prod.nym2",
         "db":"",
         "warnings": [  
         ],
         "start_microtime": 1492716035.805,
         "time": 5,
         "version": "",
         "output_term": "media-asset"
      },
      "media-asset":[  
         {  
            "id": 1536691,
            "parent_media_asset_id": null,
            "member_id": 123,
            "advertiser_id": null,
            "publisher_id": null,
            "file_name": "NATIVE.JPG",
            "size_in_bytes": 79400,
            "cdn_uploaded_on": null,
            "cdn_url": "https://vcdn.adnxs.com/p/creative-image/1b/ee/3d/95/1bee3d95-7042-4e10-b0bf-7f43e2e4322a.JPG",
            "cdn_secure_url": "https://vcdn.adnxs.com/p/creative-image/1b/ee/3d/95/1bee3d95-7042-4e10-b0bf-7f43e2e4322a.JPG",
            "created_on": "2017-04-20 19:20:35",
            "last_modified": "2017-04-20 19:20:35",
            "deleted": false,
            "media_asset_status": [  
               {  
                  "id": 1536687,
                  "media_asset_id": 1536691,
                  "error_message": null,
                  "local_path": "1b/ee/3d/95/1bee3d95-7042-4e10-b0bf-7f43e2e4322a.JPG",
                  "cdn_upload_attempt_count": 0,
                  "created_on": "2017-04-20 19:20:35",
                  "last_modified": "2017-04-20 19:20:35",
                  "deleted": false,
                  "status": "on_shared_storage"
               }
            ],
            "media_asset_image": {  
               "id": 1005450,
               "media_asset_id": 1536691,
               "height": 480,
               "width": 640,
               "created_on": "2017-04-20 19:20:35",
               "last_activity": "2017-04-20 19:20:35",
               "deleted": false
-            },
            "media_asset_video": null,
            "media_asset_html5": null,
            "asset_type": "image",
            "mime_type": "image/jpeg"
         }
      ]
   }
}

ステップ 2: media_asset_id を使用してクリエイティブをアップロードします。

cat native
{
    "creative": {
        "name": null,
        "brand_id": 1,
        "media_url": "https://mediaurl.com",
        "code": "test",
        "code2": null,
        "member_id": 4,
        "state": "active",
        "advertiser_id": 7,
        "publisher_id": null,
    "template": {
        "id": 39461
    },
        "native_attribute": {
            "link": {
                "url": "https://url.com",
                "fallback_url": "https://fallback.com",
                "trackers": [
                    {
                        "url": "http://url.com",
                        "url_secure": "https://secureurl.com"
                    }
                ]
            },
            "data_assets": [
                {
                    "data_type": "sponsored_by",
                    "value": "a value"
                },
                {
                    "data_type": "rating",
                    "value": "8"
                }
            ],
            "image_assets": [
                {
                    "image_type": "main_image",
                    "media_asset_id": 1536691,
                    "image_resize_setting": {
                        "resize_enabled": true,
                        "crop_enabled": true,
                        "aspect_ratio_upper_bound": 1.2,
                        "aspect_ratio_lower_bound": 0.8,
                        "max_scale_factor": 1.41
                    }
                }
            ],
            "image_trackers": [
                {
                    "url": "http://url.com",
                    "url_secure": "https://secureurl.com"
                }
            ],
            "javascript_trackers": [
                {
                    "url": "http://url.com",
                    "url_secure": "https://secureurl.com"
                }
            ]
        },
        "thirdparty_viewability_providers": null,
        "status": {
            "user_ready": true
        },
        "sla_eta": null,
        "currency": "USD",
        "type": "native"
    }
}
 

$ curl -b cookies -c cookies -X POST -d @native 'https://api.appnexus.com/creative/1751'
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": 411,
        "start_element": 0,
        "num_elements": 100,
        "dbg_info": {
            ...
            },
            "proxy": true
        },
        "creative": {
            "name": null,
            "brand_id": 1,
            "media_url": "https://mediaurl.com",
            "id": 411,
            "code": "test",
            "code2": null,
            "member_id": 4,
            "state": "active",
            "click_track_result": "not_tested",
            "advertiser_id": 3,
            "publisher_id": null,
            "format": "url-file",
            "width": null,
            "height": null,
            "click_url": null,
            "flash_click_variable": null,
            "no_iframes": false,
            "content": null,
            "original_content": null,
            "file_name": null,
            "track_clicks": true,
            "audit_status": "pending",
            "macros": null,
            "profile_id": null,
            "audit_feedback": null,
            "is_prohibited": false,
            "is_suspicious": false,
            "created_on": "2017-03-09 21:54:11",
            "flash_backup_url": null,
            "last_modified": "2017-03-09 21:54:11",
            "is_control": false,
            "allow_audit": true,
            "is_expired": false,
            "creative_upload_status": null,
            "backup_upload_status": null,
            "use_dynamic_click_url": false,
            "media_subtypes": [
                "popunder",
                "popup",
                "banner"
            ],
            "size_in_bytes": 0,
            "is_self_audited": false,
            "no_adservers": false,
            "text_title": null,
            "text_description": null,
            "text_display_url": null,
            "click_action": "click-to-web",
            "click_target": null,
            "ssl_status": "pending",
            "allow_ssl_audit": true,
            "media_url_secure": "https://MEDIAURL.appnexus.com",
            "content_secure": "document.write(\\\"\\\")",
            "original_content_secure": null,
            "flash_backup_url_secure": null,
            "is_hosted": false,
            "content_source": "standard",
            "lifetime_budget": null,
            "lifetime_budget_imps": null,
            "daily_budget": null,
            "daily_budget_imps": null,
            "enable_pacing": null,
            "allow_safety_pacing": null,
            "landing_page_url": null,
            "thirdparty_creative_id": null,
            "thirdparty_campaign_id": null,
            "facebook_audit_status": null,
            "facebook_audit_feedback": null,
            "custom_request_template": null,
            "language": {
                "id": 1,
                "name": "English"
            },
            "pop_values": null,
            "brand": {
                "id": 1,
                "name": "Unknown",
                "category_id": null
            },
            "template": {
                "id": 39461,
                "name": "native ad",
                "media_subtype_id": 17,
                "format_id": 11
            },
            "ios_ssl_audit": null,
            "adx_audit": null,
            "thirdparty_page": null,
            "custom_macros": null,
            "segments": null,
            "folder": null,
            "campaigns": null,
            "line_items": null,
            "competitive_brands": null,
            "competitive_categories": null,
            "pixels": null,
            "mobile": null,
            "video_attribute": null,
            "media_assets": null,
            "sla": null,
            "thirdparty_pixels": null,
            "native": null,
            "native_attribute": {
                "link": {
                    "url": "https://url.com",
                    "fallback_url": "https://fallback.com",
                    "trackers": [
                        {
                            "url": "http://url.com",
                            "url_secure": "https://secureurl.com"
                        }
                    ]
                },
                "data_assets": [
                    {
                        "data_type": "sponsored_by",
                        "value": "a value"
                    },
                    {
                        "data_type": "rating",
                        "value": "8"
                    }
                ],
                "image_assets": [
                    {
                        "image_type": "main_image",
                        "media_asset_id": 1536691,
                        "creative_asset_image": {
                            "url": "http://url.com",
                            "url_secure": "https://secureurl.com",
                            "height": 12,
                            "width": 34
                        }
                        "image_resize_setting": {
                            "resize_enabled": true,
                            "crop_enabled": true,
                            "aspect_ratio_upper_bound": 1.2,
                            "aspect_ratio_lower_bound": 0.8,
                            "max_scale_factor": 1.41
                        }
                    }
                ],
                "image_trackers": [
                    {
                        "url": "http://url.com",
                        "url_secure": "https://secureurl.com"
                    }
                ],
                "javascript_trackers": [
                    {
                        "url": "http://url.com",
                        "url_secure": "https://secureurl.com"
                    }
                ]
            },
            "thirdparty_viewability_providers": null,
            "status": {
                "user_ready": true
            },
            "sla_eta": null,
            "currency": "USD",
            "type": "standard"
        }
    }
    }

関連トピック

• クリエイティブ アップロード サービス - ファイル形式
• API のベスト プラクティス
• API セマンティクス