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

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

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

広告主サービスを呼び出すことで、広告主 ID を表示できます。
パブリッシャーサービスを呼び出すことで、発行元 ID を表示できます。
クリエイティブをパブリッシャーにアタッチして、プレースメントの既定のクリエイティブとして使用できます。その後、プレースメントサービスを使用して、その ID を使用してクリエイティブをプレースメントにアタッチします。

注:

ホスト型およびサードパーティ製のビデオおよびオーディオサービスには、 Creative Vast サービスのみを使用してアクセスできます。ホスト型およびサードパーティ製の HTML クリエイティブには、 Creative HTML サービスを使用してのみアクセスできます。

監査

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

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

REST API

HTTP メソッド	エンドポイント	説明
`POST`	https://api.appnexus.com/creative?advertiser_id=ADVERTISER_ID (クリエイティブ JSON)	広告主のいずれかに新しいクリエイティブを追加します。
`POST`	https://api.appnexus.com/creative?publisher_id=PUBLISHER_ID (クリエイティブ JSON)	いずれかのパブリッシャーに新しいクリエイティブを追加します。
`PUT`	- https://api.appnexus.com/creative?id=CREATIVE_ID&advertiser_id=ADVERTISER_ID - https://api.appnexus.com/creative?id=CREATIVE_ID&p ublisher_id=PUBLISHER_ID (クリエイティブ JSON)	既存のクリエイティブを変更します。
`GET`	https://api.appnexus.com/creative	すべてのクリエイティブを表示します。
`GET`	- https://api.appnexus.com/creative?advertiser_id=ADVERTISER_ID - https://api.appnexus.com/creative?advertiser_code=ADVERTISER_CODE - https://api.appnexus.com/creative?publisher_id=PUBLISHER_ID - https://api.appnexus.com/creative?publisher_code=PUBLISHER_CODE	広告主またはパブリッシャーのすべてのクリエイティブを表示します。注: クリエイティブの最初と最後の配信日に基づいてフィルター処理できます。これは、オブジェクトの制限に近づき、システムから削除できるクリエイティブを特定する必要がある場合に特に便利です。詳細については、以下の「最初の実行/最後の実行」を参照してください。
`GET`	- https://api.appnexus.com/creative?id=CREATIVE_ID - https://api.appnexus.com/creative?code=CREATIVE_CODE	特定のクリエイティブを表示します。
`GET`	https://api.appnexus.com/creative?id=1,2,3	コンマ区切りリストを使用して、ID で複数のクリエイティブを表示します。
`GET`	https://api.appnexus.com/creative?audit_stats=true	クリエイティブ監査統計を表示します。注: 応答では、Xandr、Microsoft、Google の各監査ステータスを持つクリエイティブの数が示されます。応答形式については、以下の例を参照してください。
`DELETE`	- https://api.appnexus.com/creative?id=CREATIVE_ID&advertiser_id=ADVERTISER_ID - https://api.appnexus.com/creative?id=CREATIVE_ID&p ublisher_id=PUBLISHER_ID	クリエイティブを削除します。手記：メンバーまたはプレースメントの既定のクリエイティブとして使用されているクリエイティブは削除できません。既定のクリエイティブは、プレースメントとの関連付けを解除した後に削除できます。
`GET`	https://api.appnexus.com/creative/meta	フィルター処理および並べ替えの対象となるフィールドを確認します。

JSON フィールド

フィールド	種類	説明
`id`	int	クリエイティブに関連付けられている内部 ID。デフォルト：自動生成された数値。クエリ文字列で必要な On:`PUT`。
`code`	string (100)	クリエイティブのカスタムコード。注: このコードは一意であることが重要です。
`code2`	string (100)	クリエイティブの追加のカスタムコード。注: このコードは一意であることが重要です。
`name`	string (400)	クリエイティブの名前。
`type`	列挙	クリエイティブの種類。使用可能な値: - `"standard"` `"html"` - `"video"` 注: アルファベータに関する通知このフィールドまたは機能は、現在アルファフェーズまたはベータフェーズの機能の一部です。そのため、変更される可能性があります。読み取り専用。
`advertiser_id`	int	クリエイティブがアタッチされている広告主の ID。クリエイティブが広告主にアタッチされている場合は、クエリ文字列で[オン]:[`POST`/`PUT`が必要です。
`political`	object	読み取り専用です。このクリエイティブが "政治的" であり、米国でサービスを提供する場合、このオブジェクトには米国の政治クリエイティブに必要な要素が設定されます。詳細については、以下の Political オブジェクトの説明を参照してください。デフォルト：`null`
`publisher_id`	int	クリエイティブがアタッチされている発行元/メディア購入の ID。クリエイティブがパブリッシャーにアタッチされている場合は、クエリ文字列で On:`POST`/`PUT` が必要です。
`brand_id`	int	クリエイティブを宣伝する会社のブランドの ID。含まれている場合は、Xandr 監査チームによって検証されます。含まれていない場合は、監査チームによって割り当てられます。ブランドの完全な一覧を取得するには、ブランドサービスに関するページを参照してください。
`state`	列挙	クリエイティブの状態。使用可能な値: `"active"` または `"inactive"`。読み取り専用。
`status`	object	クリエイティブが配信する準備ができているかどうかを説明するクリエイティブの状態。詳細については、以下の「状態」を参照してください。
`click_track_result`	列挙	クリックトラックテストの結果。ユーザーインターフェイスでのみ使用できる機能です。使用可能な値: `"not_tested"`、 `"passed"`、または `"failed"`。デフォルト：`"not_tested"`
`campaigns`	オブジェクトの配列	クリエイティブが関連付けられているキャンペーンの一覧。詳細については、以下の「キャンペーン」を参照してください。手記：このフィールドは、クエリ文字列に `advertiser_id` が指定されている場合にのみ返されます。
`format`	列挙	廃止。
`template`	object	クリエイティブの形式とメディアの種類 (フラッシュと展開可能) のクリエイティブテンプレート (例: `template_id6`)。テンプレートには、クリエイティブが Web ページでどのようにレンダリングされるかを制御するコードが含まれています。詳細については、以下の「クリエイティブテンプレート」を参照してください。手記：`"raw-html"`形式 (iFrame では提供されない HTML) にテンプレートを使用する場合、`content` フィールド内のすべての内容を`escaped` (引用符、スラッシュなど) にし、`document.write();` ステートメントでラップする必要があります。これは、コンテンツをページに配信するために必要です。必須:`POST`
`thirdparty_page`	object	手記：このフィールドは使用されなくなりました。
`custom_macros`	オブジェクトの配列	クリエイティブテンプレートで使用されるカスタムマクロの値。詳細については、以下の「カスタムマクロ」を参照してください。テンプレートに必要なカスタムマクロが含まれている場合は、必須の On:`POST`。
`width`	Int	クリエイティブの幅。文字列には int が含まれている必要があります。テンプレートが `"Banner"` または `"Expandable"` メディアの種類用の場合は、On:`POST` 必須。
`height`	Int	テンプレートが `"Banner"` または `"Expandable"` メディアの種類用の場合は、On:`POST` 必須。クリエイティブの高さ。文字列には int が含まれている必要があります。クリエイティブのテンプレートにポップメディアの種類がある場合は、クリエイティブの`height`を設定するか、または ([`pop_values`] フィールドの) `pop_window_maximize`を`true`する必要があります (両方を設定することはできません)。手記： Xandr 監査では、受け入れられたサイズのポップクリエイティブのみを送信できます。 `template`配列内の`media_subtype_id`が 4 (popunder) で、`audit_status`が`"pending"`されている場合は、`height`を 300 に設定し、`width` 720 に設定する必要があります。 `template`配列内の`media_subtype_id`が 2 (ポップアップ) で、`audit_status`が`"pending"`されている場合、`width`と`height`は、250x250、300x250、550x480 のいずれかである必要があります。テンプレートが `"Banner"` または `"Expandable"` メディアの種類用の場合は、On:`POST` 必須。
`media_url`	string (1000)	クリエイティブの URL - 画像、フラッシュ、HTML、javascript (形式を参照) を指定できます。 URL は存在する必要があり、CDN または同等の URL に存在する必要があります。コンテンツを使用していない場合は、On:`POST` 必須。
`media_url_secure`	string (1000)	セキュア (HTTPS) クリエイティブの URL - イメージ、フラッシュ、HTML、javascript (形式を参照) を使用して、セキュリティで保護された広告通話で配信できます。 URL は存在する必要があり、CDN または同等の URL に存在する必要があります。
`click_url`	string (2000)	`click_url` は、 `click_target`を優先して非推奨になっています。注: この値は、"http://" または "https://" で始まる必要がありますテンプレートが "image" 形式の場合は、必須の On:`POST`。
`file_name`	string (1000)	ホストされているクリエイティブのファイル名と拡張子。許可されるファイルの種類: jpg、gif、png、png、gif、flv、mp4、wmv、f4v、avi、m4v、mov、mpg。ホスト型クリエイティブを追加する場合は、On:`POST` が必要です。
`flash_click_variable`	string (255)	Flash クリエイティブの ClickTag 変数。 Xandr は、ファイルに正確な変数 (clickTAG、ClickTag、Clicktag など) を指定した場合にのみ、Flash クリエイティブのユーザークリックを実行および追跡できます。 ClickTags Service を使用して、この変数を識別できます。 1 つのクリエイティブに複数の ClickTag 変数を指定する必要がある場合は、サポートにお問い合わせください。手記：このフィールドは、Flash クリエイティブの ( `POST` または `PUT`を介してのみ) 更新できます。
`content`	string	`"format"`が`"raw-js"`または`"iframe-html"`されている場合の Javascript または HTML コンテンツ。ホスト型クリエイティブの場合、ファイルのコンテンツは base64 でエンコードされ、コンテンツフィールド内の文字列として送信される必要があります。先端：`"raw-html"`形式 (iFrame で提供されない HTML) にテンプレート (例: `template_id6`) を使用する場合、`content` フィールド内のすべての内容を`escaped` (引用符、スラッシュなど) にして、`document.write();` ステートメントでラップする必要があります。これは、コンテンツをページに配信するために必要です。先端：コンテンツフィールドの最大長は 65535 文字です。 `media_url`を使用していない場合は、On:`POST` が必要です。既定値: サードパーティのタグホルダー。
`content_secure`	string	`"format"`がセキュリティで保護された広告呼び出しで`"raw-js"`または`"iframe-html"`された場合の Javascript または HTML コンテンツ。
`original_content`	string	UI を介して `"content"` フィールドに渡す値は、このフィールドに変更されずに返されます。 [ `"content"` ] フィールドには、Xandr によって適切に提供されるように変更されたコンテンツが含まれます。このフィールドは、API を介して直接アップロードすることもできます。この場合、このフィールドにアップロードされた値は、UI のコンテンツセクション ([クリエイティブコンテンツ] > [タグ] フィールド) で参照されます。必須のオン:`POST` 型 `raw-html`として送信する場合。
`original_content_secure`	string	`original_content` を参照してください。これは、このコンテンツのセキュリティで保護されたバージョンです。
`macros`	string	API はマクロをプルし、このフィールドに配置して、入札者が予想するマクロを認識できるようにします。読み取り専用。
`audit_status`	列挙	クリエイティブの監査状態。使用可能な値: `"no_audit"`、 `"pending"`、 `"rejected"`、または `"audited"`。注: - `allow_audit` が `false`されている場合は、このフィールドを `"no_audit"`する必要があります。 - クリエイティブの有効期限が切れている場合は、このフィールドを変更して再アニメーション化できます。 `"pending"`に設定すると、監査のために再送信されます。また、期限切れのクリエイティブを再アクティブ化するには、[user_ready] フィールドも true に設定する必要があります。監査のためにクリエイティブを自動的に再送信する変更については、以下の「再監査の原因となる変更」を参照してください。 - Xandr 監査では、受け入れられたサイズのポップクリエイティブのみを送信できます。 `template`配列内の`media_subtype_id`が 4 (popunder) の場合、`width`が 720 で、`height`が 300 でない限り、`audit_status`を `"pending"` に設定することはできません。 `template`配列内の`media_subtype_id`が 2 (ポップアップ) の場合、`audit_status`は、`width`および`height`が 250x250、300x250、550x480 のいずれかである場合を除き、保留中に設定できません。デフォルト：`"pending"`
`audit_feedback`	string	クリエイティブ監査チームは、このフィールドでクリエイティブに関するメッセージを渡すことができます。読み取り専用。
`allow_audit`	ブール型	`true`場合、クリエイティブは監査のために送信されます。 `false`場合、クリエイティブは送信されません。監査されていないクリエイティブは、ネットワークのマネージドインベントリでのみ実行できます。注: - `audit_status` が `"no_audit"`されている場合は、このフィールドを `"false"`する必要があります。 - メンバーがまだアクティブでない場合は、クリエイティブを追加できますが、監査のために送信されません (`allow_audit` は `false`)。メンバーがアクティブ化されたら、これらのクリエイティブを監査する場合は、クリエイティブを更新し、 `allow_audit` を `true`に設定する必要があります。 - Xandr 監査では、受け入れられたサイズのポップクリエイティブのみを送信できます。 `template`配列内の`media_subtype_id`が 4 (popunder) の場合、`width`が 720 で`height`が 300 でない限り、`allow_audit` を 1 に設定することはできません。 `template`配列内の`media_subtype_id`が 2 (ポップアップ) の場合、`width`と`height`が 250x250、300x250、550x480 のいずれかである場合を除き、`allow_audit` を 1 に設定することはできません。デフォルト：`true`
`ssl_status`	列挙	クリエイティブの ssl (HTTPS) の状態。 ssl_status = 承認済みのクリエイティブのみが、安全な在庫で配信できます。注: クリエイティブが ssl Sherlock 監査に失敗した場合は、このフィールドを `"pending"` に変更することで、(ダウンストリームのセキュリティで保護されていないコンテンツを修正したら) 再テスト用に送信できます。有効な値は次のとおりです。 - `"disabled"` - `"pending"` - `"approved"` - `"failed"` デフォルト：`"disabled"`
`allow_ssl_audit`	ブール型	`true`場合、クリエイティブはセキュリティで保護された (HTTPS) 監査のために送信されます。 `false`場合、クリエイティブは送信されません。 `true`場合は、`media_url_secure`または`content_secure`も必要です。 default:`true`( `media_url_secure` または `content_secure` が指定されている場合)。それ以外の場合は、 `false` が既定値になります。
`msft_audit_status`	列挙	廃止。
`msft_audit_feedback`	string	廃止。
`facebook_audit_status`	列挙	手記：このフィールドは使用されなくなりました。
`facebook_audit_feedback`	string	手記：このフィールドは使用されなくなりました。
`is_self_audited`	ブール型	`true`場合、クリエイティブは自己監査されるため、Xandr プラットフォーム監査は行われません。クリエイティブは、自己分類クリエイティブを受け入れるインベントリ、または監査されていないクリエイティブを受け入れるインベントリでのみ配信できます。デフォルト：`false`
`is_expired`	ブール型	クリエイティブ (1) が実行されておらず、(2) が 45 日以内に変更されていない場合、自動的に期限切れとマークされ、インベントリに配信されません。 - サードパーティのインベントリで実行するには、期限切れのクリエイティブを再監査する必要があります。サードパーティのインベントリのクリエイティブの展開を解除するには、[ `audit_status` ] を [ `"pending"`] に設定します。 - 期限切れのクリエイティブは、直接在庫で実行するために再監査する必要はありません。直接在庫のクリエイティブの展開を解除するには、 `audit_status` を [ `"no_audit"`] に設定します。デフォルト：`false` 読み取り専用。
`is_prohibited`	ブール型	Sherlock は、マルウェアを持っているか、ブロックされたドメインを読み込むためのクリエイティブにフラグを設定する場合は、クリエイティブが配信されないように true に設定されます。デフォルト：`false` 読み取り専用。
`is_hosted`	ブール型	`true`場合、クリエイティブは Xandr によってホストされます。読み取り専用。
`lifetime_budget`	double	ドル単位の生涯予算。手記：このフィールドを `GET` 応答に含めるには、クエリ文字列に `attributes=1` を渡します。デフォルト：`unlimited`
`lifetime_budget_imps`	int	インプレッション数の有効期間制限。注: このフィールドを `GET` 応答に含めるには、クエリ文字列に `attributes=1` を渡します。デフォルト：`unlimited`
`daily_budget`	double	ドル単位の 1 日の予算。注: このフィールドを `GET` 応答に含めるには、クエリ文字列に `attributes=1` を渡します。デフォルト：`unlimited`
`daily_budget_imps`	int	インプレッション数の 1 日あたりの制限。注: このフィールドを `GET` 応答に含めるには、クエリ文字列に `attributes=1` を渡します。デフォルト：`unlimited`
`enable_pacing`	ブール型	`true`場合、1 日の予算支出は 1 日を通じて均等に分散されます。注: このフィールドを `GET` 応答に含めるには、クエリ文字列に `attributes=1` を渡します。デフォルト：`true`
`allow_safety_pacing`	ブール型	管理者専用。 `true`場合、1 分あたりの支出は、生涯予算の最大 1% と 1 日の予算の 5% に制限されます。
`profile_id`	int	性別や地域などのターゲット設定をクリエイティブにアタッチするには、プロファイルを作成し、ここで関連付けます。
`folder`	object	便利なフォルダー (通常は UI) でクリエイティブを配置するには、 Creative Folder Service を使用してフォルダーを作成し、フォルダー ID またはクリエイティブ ID を使用してクリエイティブフォルダーサービスに関連付けます。出力は次のとおりです。 `{"id": "41", "name": "MyFolder"}`
`line_items`	オブジェクトの配列	クリエイティブに関連付けられている広告申込情報。詳細については、以下の「行項目」を参照してください。
`pixels`	オブジェクトの配列	クリエイティブで提供するピクセル。これらは、外部インプレッショントラッキング、外部クリックトラッキング、または広告の広告のアイコンをクリエイティブに追加するなどの目的で使用できます。詳細については、以下の「ピクセル」を参照してください。
`pixel_url`	string (100)	非推奨。代わりにピクセル配列を使用します。メディア URL またはコンテンツと共に配信するインプレッションピクセルの URL。
`pixel_url_secure`	string (100)	非推奨。代わりにピクセル配列を使用します。セキュリティで保護された広告通話でメディア URL コンテンツと共に配信するセキュア (HTTPS) インプレッションピクセルの URL。
`pixel_type`	列挙	非推奨。代わりにピクセル配列を使用します。インプレッションピクセルの種類。 pixel_urlを使用する場合は、このフィールドを設定する必要があります。使用可能な値: `"javascript"` または `"image"`。
`no_iframes`	ブール型	非推奨。 `true`場合、広告呼び出しで iframe が検出された場合、入札者はこのクリエイティブを配信しません。デフォルト：`false`
`track_clicks`	ブール型	廃止。デフォルト：`true`
`flash_backup_content`	string	フラッシュクリエイティブの場合、これは、ユーザーのブラウザーがフラッシュをサポートしていない場合に提供されるバックアップクリエイティブのコンテンツです。バナー内のビデオクリエイティブの場合、これは、ユーザーが [再生] をクリックする前とビデオの再生が完了した後に表示されるポスター画像のコンテンツです。このフィールドは、 `flash_backup_file_name`と組み合わせて使用する必要があります。バックアップクリエイティブがアップロードされると、コンテンツは CDN に保存され、場所は [flash_backup_url] フィールドに設定されます。 `GET`では、flash_backup_contentも`flash_backup_file_name`も取得できません。 `flash_backup_file_name`を使用している場合は、On:`POST`/`PUT` が必要です。書き込み専用。
`flash_backup_file_name`	string	このフィールドは、 `flash_backup_content`と組み合わせて使用する必要があります。これは、バックアップクリエイティブのファイル名と拡張子です。 `flash_backup_content`を使用している場合は、On:`POST`/`PUT` が必要です。書き込み専用。
`flash_backup_url`	string (100)	フラッシュクリエイティブの場合は、ユーザーのブラウザーがフラッシュをサポートしていない場合に配信されるサードパーティのクリエイティブの URL です。バナー内ビデオクリエイティブの場合、これは、ユーザーが [再生] をクリックする前とビデオの再生が完了した後に表示されるポスター画像の URL です。
`is_control`	ブール型	これは、このクリエイティブを A/B テストのコントロール/テストグループの一部としてマークするために使用されるフラグです。デフォルト：`false`
`segments`	配列	このクリエイティブを表示またはクリックしたときにユーザーが追加するセグメントの一覧。詳細については、以下の「セグメント」を参照してください。
`created_on`	timestamp	このクリエイティブが作成された日時。 2010 年 1 月より前に作成された場合、これは 0 になります。読み取り専用。
`last_activity`	timestamp	クリエイティブが最後に変更された日時。タイムゾーンは UTC です。読み取り専用。
`media_subtypes`	文字列の配列	廃止。
`creative_upload_status`	列挙	廃止。
`backup_upload_status`	列挙	廃止。
`use_dynamic_click_url`	ブール型	`true`場合、サードパーティ以外の画像とフラッシュクリエイティブの (省略可能) ランディングページ URL は、キャンペーンレベルまたは広告申込情報レベルで設定されます。デフォルト：`false`
`size_in_bytes`	int	アップロードされたクリエイティブのサイズ (バイト単位)。読み取り専用。
`text_title`	string (25)	テキストクリエイティブに表示されるテキストの一番上の行。テンプレートが`"text"`形式の場合は、On:`POST` 必須。
`text_description`	string (70)	テキストクリエイティブに表示されるテキストの下の行。テンプレートが`"text"`形式の場合は、On:`POST` 必須。
`text_display_url`	string (35)	テキストクリエイティブに表示される読み取り可能な URL。テンプレートが`"text"`形式の場合は、On:`POST` 必須。
`click_action`	列挙	クリエイティブがクリックされたときにデバイスが実行するアクション。現在、このフィールドは、サポートされている唯一のクリックアクション ( `"click-to-web"`) に設定されます。デフォルト：`"click-to-web"`
`click_target`	string (2000)	`click_action`のターゲット。クリックから Web への場合、これはクリエイティブの `click_url` です。 `click_url` 最終的には、このフィールドを優先して非推奨になります。その間、 `click_url` または `click_target` を設定すると、同じ効果が得られます。
`categories`	オブジェクトの配列	クリエイティブとオファーの種類を表すカテゴリ。注: `GET`応答にカテゴリを含める場合は、クエリ文字列に`attributes=1`を渡します。カテゴリの完全な一覧を取得するには、カテゴリサービスに関するページを参照してください。
`adservers`	オブジェクトの配列	クリエイティブを配信する広告サーバー、またはクリエイティブの配信中にデータ収集のために呼び出される広告サーバー。手記：`GET`応答に adservers を含める場合は、クエリ文字列に`attributes=1`を渡します。広告サーバーの完全な一覧を取得するには、 Ad Server サービスに関するページを参照してください。読み取り専用。
`technical_attributes`	オブジェクトの配列	`"Expandable"`や`"Video"`など、クリエイティブの技術的特性を表す属性。注: `GET`応答に技術属性を含めるには、クエリ文字列に`attributes=1`を渡します。技術属性の完全な一覧を取得するには、技術属性サービスに関するページを参照してください。
`language`	object	クリエイティブの言語。言語の完全な一覧を取得するには、言語サービスに関するページを参照してください。
`brand`	object	クリエイティブを宣伝する会社のブランドと、ブランドに関連するカテゴリ。詳細については、以下の「ブランド」を参照してください。読み取り専用。
`pop_values`	配列	廃止。
`sla`	int	[ `0` ] に設定されているクリエイティブは、標準 SLA で監査のために送信されます。注意：`0`以外の番号で送信されたクリエイティブは、優先監査 (有効な場合) と料金が発生します。優先監査のために Xandr と補助サービス契約を結んだ場合は、このフィールドを `2` に設定することで、優先度監査 (営業時間中に 2 時間以内に監査) 用のクリエイティブを送信できます。
`sla_eta`	timestamp	優先度監査の完了の見積もり時間。読み取り専用。
`currency`	string	読み取り専用です。広告主の主通貨 (USD など) を定義するコード。使用できる通貨の種類の詳細については、「 Currency Service」を参照してください。デフォルト：メンバーの既定の通貨。
`first_run`	timestamp	クリエイティブが最初に配信された日時を、1 時間ごとに更新します。この値は UTC タイムゾーンを反映します。この情報を `GET` 応答に含めるには、クエリ文字列に `flight_info=true` を渡します。クリエイティブの配信時期に基づいてクリエイティブをフィルター処理する方法の詳細については、以下の「初回実行/最終実行」を参照してください。読み取り専用。
`last_run`	timestamp	クリエイティブが最後に配信された日時。1 時間ごとに更新されます。この値は UTC タイムゾーンを反映します。この情報を `GET` 応答に含めるには、クエリ文字列に `flight_info=true` を渡します。クリエイティブが最後に配信されたタイミングに基づく方法の詳細については、以下の「初回実行/最終実行」を参照してください。読み取り専用。
`mobile`	object	モバイルクリエイティブがクリエイティブ監査に合格するために必要な情報。以下の「モバイル」を参照してください。
`video_attribute`	object	サードパーティのインストリーム (VAST) およびホストされているビデオクリエイティブの属性。注: 膨大なクリエイティブ & 更新するには、 `/creative-vast` サービスを使用します。詳細については、「 Creative Vast Service」を参照してください。デフォルト：`null`
`stats`	object	`stats` オブジェクトは非推奨になりました (2016 年 10 月 17 日現在)。代わりに Report Service を使用して統計情報を取得します。
`content_source`	string	このクリエイティブのコンテンツのソース。デフォルト：`"standard"` 有効な値は次のとおりです。 - `"standard"`: このクリエイティブは、広告サーバーでホストされているコンテンツで構成され、通常は 1 つの HTTP 要求で取得されます。 - `"mediation"`: このクリエイティブは、仲介のために別の広告サーバーからコンテンツをフェッチするために使用されるコンテナーです。仲介の実行方法により、複数の HTTP 要求を順番に行う必要があります。詳細については、「 Creative Custom Request Template Service」を参照してください。手記：このフィールドが `"mediation"` に設定されている場合、次のアクションが実行されます。 - `"mediation"` 技術属性がクリエイティブの `technical_attributes` 配列に追加されます。さらに、次の検証が実行されます。 - `"audit_status"` を `"pending"` に設定することはできません。代わりに、常に `"no_audit"` に設定されます。 - `allow_audit` を `true` に設定することはできません。代わりに、常に `false` に設定されます。 - `custom_request_template` マルチオブジェクトは、クリエイティブに対して定義する必要があります。 - `custom_macros` 配列には、カスタム要求テンプレートに関連付けられているテンプレートパラメーターによって定義されたマクロが設定されている必要があります。次のフィールドは不要になります。 - `content` - `media_url` - `template`
`custom_request_template`	multi-object	このクリエイティブの [ `content_source` ] フィールドの値が [ `"mediation"`] に設定されている場合、このオブジェクトは、このクリエイティブと、クリエイティブにコンテンツを設定するために使用されるカスタム要求テンプレートとの関連付けを記述します。詳細については、「カスタム要求テンプレート」を参照してください。デフォルト：`null` `content_source`が `"mediation"` に設定されている場合は、必須の On:`PUT`。
`competitive_brands`	オブジェクトの配列	この配列のブランドに関連付けられているクリエイティブは、 `/mtj` オークションでは一緒に配信されません。競合ブランドの典型的な例は、コーラとペプシです。以下の「競合ブランド」を参照してください。システム内のブランドの詳細については、ブランドサービスに関するページを参照してください。
`competitive_categories`	オブジェクトの配列	この配列のカテゴリに関連付けられているクリエイティブは、 `/mtj` オークション (例: "デート" や "教育") で一緒に配信されることはありません。以下の「競合カテゴリ」を参照してください。クリエイティブ (およびブランド) に適用されるカテゴリの詳細については、カテゴリサービスに関するページを参照してください。
`thirdparty_pixels`	オブジェクトの配列	クリエイティブに関連付けられているサードパーティ製ピクセルの配列。これらのピクセルは、サードパーティのピクセルサービスを使用して広告主またはメンバーが所有するすべてのクリエイティブに自動的にアタッチすることも、クリエイティブサービスを使用してクリエイティブレベルで個別にアタッチすることもできます。デフォルト：`null` 必須:`PUT`
`native`	object	非推奨。このクリエイティブがネイティブ広告の場合、このオブジェクトにはネイティブ広告に必要な要素が設定されます。詳細については、以下の Native オブジェクトの説明を参照してください。デフォルト：`null` 必須のオン:`POST` ネイティブ広告の `PUT` 。技術的には、ネイティブ広告は、`native`として識別する`12`の`creative_format_id`を持つ`template`を持つクリエイティブとして当社のシステムによって識別されます。
`native_attribute`	object	これは、ネイティブ広告に必要な要素を含む新しいネイティブオブジェクトです。詳細については、以下の Native Attribute オブジェクトの説明を参照してください。デフォルト：`null` 必須: テンプレート 39461 のネイティブ広告に必要です。
`click_trackers`	オブジェクトの配列	ネイティブクリエイティブで使用することを目的としたサードパーティのクリックトラッキング URL の一覧。詳細については、以下の「クリックトラッカー」を参照してください。
`impression_trackers`	オブジェクトの配列	ネイティブクリエイティブで使用することを目的としたサードパーティのインプレッショントラッキング URL の一覧。詳細については、以下の「インプレッショントラッカー」を参照してください。
`adx_audit`	object	このオブジェクトには、クリエイティブの Google AdExchange 監査に関連する状態とフィードバックに関する情報が含まれています。クリエイティブが承認されたかどうかに関する情報は、[ `audit_status` ] フィールドに返されます。読み取り専用。
`flash_backup_url_secure`	string	これは、セキュリティで保護された `flash_backup_url`のセキュリティで保護されたバージョンであり、セキュリティで保護された広告通話で提供されます。
`msft_external_audit_feedback`	string	廃止。
`msft_external_audit_status`	列挙	廃止。
`member_id`	int	クリエイティブを所有するメンバーの ID。
`media_assets`	オブジェクトの配列	元のファイルの資産 ID と、資産を使用する必要がある内容を記述するフィールド。 Xandr でホストされているファイルをクリエイティブに関連付けるために使用されます。この配列は、API 経由でファイルをアップロードするときに自動的に設定されます。詳細については、以下の「Media Assets 」を参照してください。
`ad_type`	string	先端：このフィールドは、クリエイティブを拡張広告申込情報に関連付ける場合にのみ適用されます。使用されるクリエイティブの種類。使用可能な値: - `banner` - `video` (オーディオの種類を含む) - `native` この値は、広告申込情報の購入戦略、支払い戦略、最適化オプション、クリエイティブの関連付け、ターゲット設定オプションのオークションアイテムの追跡方法を決定します。手記：広告申込情報に関連付けられているすべてのクリエイティブは、広告の種類が同じである必要があります。これは、[広告申込情報サービス - ALI] で選択した`ad_type`と一致する必要があります。

ブランド

brand オブジェクトには、次のフィールドが含まれています。

注:

このオブジェクトは読み取り専用です。クリエイティブのブランドを設定するには、このオブジェクトの外部にある [ brand_id ] フィールドを使用します。

フィールド	種類	説明
`id`	int	クリエイティブを宣伝する会社のブランドの ID。読み取り専用。
`name`	string	クリエイティブを宣伝する会社のブランドの名前。読み取り専用。
`category_id`	int	ブランドに関連付けられているカテゴリの ID。読み取り専用。
`category_name`	string	ブランドに関連付けられているカテゴリの名前。注: category_name フィールドは、呼び出しのクエリ文字列に `show_category_name=true` を渡した場合にのみ返されます。読み取り専用。

キャンペーン

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

フィールド	型 (長さ)	説明
`id`	int	キャンペーンの ID。キャンペーンの関連付けを更新する場合は、 `"id"` または `"code"` が必要です。必須:`PUT`
`campaign_id`	int	キャンペーンの ID。
`creative_id`	int	クリエイティブの ID。
`name`	string	キャンペーンの名前。読み取り専用。
`state`	列挙	キャンペーンの状態。使用可能な値: `"active"`、 `"inactive"`、または `"parent_inactive"`。読み取り専用。
`code`	string	キャンペーンのカスタムコード。行項目の関連付けを更新する場合は、 `"id"` または `"code"` が必要です。必須:`PUT`

競争力のあるブランド

注:

ブランドの詳細については、ブランドサービスに関するページを参照してください。

名前	種類	説明
`id`	int	ブランドの ID。
`name`	string	ブランドの名前。

競合カテゴリ

注:

カテゴリの詳細については、カテゴリサービスに関するページを参照してください。

名前	種類	説明
`id`	int	カテゴリの ID。
`name`	string	カテゴリの名前。

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

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

フィールド	種類	説明
`id`	int	クリエイティブテンプレートの ID。
`name`	string	クリエイティブテンプレートの名前。読み取り専用。
`media_subtype_id`	int	テンプレートに割り当てられたメディアサブタイプの ID。 Media サブタイプサービスを使用すると、サポートされているすべてのメディアサブタイプを表示できます。読み取り専用。
`format_id`	string	テンプレートに割り当てられた形式の名前。 Creative Format Service を使用すると、サポートされているすべての形式を表示できます。読み取り専用。

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

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

テンプレート ID	クリエイティブの種類	要件
`1`	HTML コードの一部を指す 1 つの URL。	`media_url` フィールドに URL を渡し、テンプレートオブジェクトに ID を 1 に設定する必要があります。
`2`	Javascript コードの一部を指す単一の URL。	`media_url` フィールドに URL を渡し、テンプレートオブジェクトで ID を 2 に設定する必要があります。
`5`	Javascript コードが HTML を記述した場合でも、Javascript コンポーネントで開始および終了するクリエイティブ。	`content` フィールドに Javascript コードを渡し、テンプレートオブジェクトで ID を 5 に設定する必要があります。
`6`	これらの HTML コンポーネントがタグ `<script>` 場合でも、HTML コンポーネントで始まり、終わるクリエイティブ。	`content` フィールドに html コードを渡し、テンプレートオブジェクトで ID を 6 に設定する必要があります。

カスタムマクロ

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

フィールド	種類	説明
`code`	string	クリエイティブテンプレートのコードで使用されるマクロの正確な名前 (例: `"BORDER_COLOR"`)。
`value`	string	マクロの値。手記：この値は、テンプレートで定義されているマクロの型と一致する必要があります。たとえば、マクロの型が "integer" の場合、値は整数である必要があります。使用可能なマクロの種類は、 `"true/false"`、 `"string"`、 `"url"`、 `"integer"`、 `"decimal"`、および `"select_from_list"`です。

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

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

フィールド	種類	説明
`id`	int	このクリエイティブに関連付けられているクリエイティブカスタムリクエストテンプレート (その `content_source` が `"mediation"`に設定されている場合)。詳細については、「 Creative Custom Request Template Service」を参照してください。
`timeout_ms`	int	これが "仲介" クリエイティブの場合、外部広告サーバーに対して少なくとも 1 つの HTTP 要求が行われます。これにより、1 つ以上の追加要求が行われる可能性があります。このクリエイティブにコンテンツが表示されるまで待つ時間はこれ以上ありません。詳細については、「 Creative Custom Request Template Service」を参照してください。
`last_activity`	timestamp	クリエイティブが最後に変更された日時。タイムゾーンは UTC です。読み取り専用。

行項目

line_items配列内の各オブジェクトには、次のフィールドが含まれます。 "id"または"code"フィールドの情報を取得するには、明細サービスを使用します。

フィールド	型 (長さ)	説明
`name`	string	行項目の名前。読み取り専用。
`state`	列挙	クリエイティブの状態。使用可能な値: `"active"` または `"inactive"`。読み取り専用。
`id`	int	明細の ID。行項目の関連付けを更新する場合は、 `"id"` または `"code"` が必要です。必須:`PUT`
`code`	string	行項目のカスタムコード。行項目の関連付けを更新する場合は、 `"id"` または `"code"` が必要です。必須:`PUT`

メディア資産

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

フィールド	種類	説明
`media_asset_id`	int	クリエイティブアセットの一意の ID。
`creative_field`	string	このフィールドは、特定のクリエイティブアセットを使用する必要がある内容を示します。有効な値は次のとおりです。 - `null` (資産が VAST または HTML5 の場合) - `media_url` - `flash_backup_url` - `native_icon_img_url` - `native_main_media` - `macro_CODE_FOR_MACRO`: これは、選択したテンプレートのマクロに基づいて動的に生成されます。

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

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

メディア資産: 例

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

Mobile

フィールド	種類	説明
`alternative_landing_page_url`	string	特定のデバイス、オペレーティングシステム、または通信事業者を対象とするランディングページを持つクリエイティブのデスクトップブラウザーで表示できる代替ランディングページ URL。クリエイティブが監査に合格するには、監査可能な URL を指定する必要があります。

ネイティブ属性

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

フィールド	種類	説明
`link`	object	ネイティブクリエイティブに関連付けられている URL。詳細については、以下の「リンク」を参照してください。
`image_trackers`	オブジェクトの配列	ネイティブクリエイティブで使用することを目的としたサードパーティのインプレッショントラッキング URL の一覧。
`javascript_trackers`	オブジェクトの配列	サードパーティのインプレッショントラッキング URL の一覧。
`data_assets`	オブジェクトの配列	ネイティブクリエイティブの属性。詳細については、以下の「データ資産」を参照してください。
`image_assets`	オブジェクトの配列	個々のイメージの属性。詳細については、以下の「イメージアセット」を参照してください。
`privacy_url`	string	要求でサポートが示された場合は、購入者のターゲティングアクティビティについてユーザーに通知するページの URL。 Xandr では、既定のプライバシーリンクは提供されません。
`video_assets`	オブジェクトの配列	video_asset オブジェクトの一覧。詳細については、以下の「ビデオアセット」を参照してください。

リンク

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

link オブジェクトには、次のフィールドが含まれます。

フィールド	種類	説明
`url`	string	ネイティブクリエイティブのランディングページ。必須 On:`PUT`、 `POST`
`fallback_url`	string	メインのディープリンク URL がサポートされていない場合のバックアップ URL。
`trackers`	オブジェクトの配列	ネイティブクリエイティブで使用することを目的としたサードパーティの追跡 URL の一覧。

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

トラッカー (イメージトラッカー、javascript トラッカー、クリエイティブイメージアセットトラッカー) に対してセキュリティで保護された URL が指定されていない場合、そのクリエイティブのセキュリティで保護された監査は無効になります。
セキュリティで保護された URL が指定されていないが、URL のプレフィックスに https が付いている場合、クリエイティブは安全な監査のために送信されます。

リンクトラッカー

link_tracker オブジェクトには、次のフィールドが含まれます。

フィールド	種類	説明
`url`	string	サードパーティの追跡 URL。
`url_secure`	string	(省略可能)セキュリティで保護されたサードパーティの追跡 URL。

画像トラッカー

image_tracker オブジェクトには、次のフィールドが含まれます。

名前	種類	説明
`url`	string	サードパーティのインプレッショントラッキング URL。
`url_secure`	string	サードパーティのインプレッショントラッキング URL (SSL を使用)。

Javascript トラッカー

javascript_tracker オブジェクトには、次のフィールドが含まれます。

名前	種類	説明
`url`	string	サードパーティの javascript 追跡 URL。
`url_secure`	string	サードパーティの javascript 追跡 URL (SSL を使用)。

データ資産

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

フィールド	種類	説明
`data_type`	string	ネイティブクリエイティブのアセットの種類。使用可能な値: - `title` - `description` - `sponsored_by` - `call_to_action` - `display_url` - `price` - `sale_price` - `rating` - `likes` - `downloads` - `phone` - `address` - `additional_description` - `custom_title_1` - `custom_title_5` - `custom_body_1` - `custom_body_5` - `custom_call_to_action_1` - `custom_call_to_action_5` - `custom_social_url_1` - `custom_social_url_5` - `custom_display_url_1` - `custom_display_url_5` `data_type`文字列の周囲には二重引用符が必要です。
`value`	string	指定した `data_type` 資産の内容。次の値を指定できます。 - `title`: クリエイティブのタイトル。 - `description`: アドバタイズされる製品またはサービスの説明。 - `sponsored_by`:スポンサーのブランド名。 - `call_to_action`: 次の手順で推奨されるアクション。 - `display_url`: 表示する URL。 - `price`: 製品/アプリ/アプリ内購入の価格。 - `sale_price`: 割引価格を示すために価格と共に使用できる販売価格。 - `rating`: 提供されている製品の評価。 - `likes`: ソーシャルメディアのいいね。 - `downloads`: この製品のダウンロード/インストール数。 - `phone`: 電話番号。 - `address`：住所。 - `additional_description`: 広告の説明の長いバージョン。 - `custom_title_1` - `custom_title_5`: ネイティブクリエイティブに表示されるその他のタイトル。 - `custom_body_1` - `custom_body_5`: ネイティブクリエイティブに表示される追加の本文テキスト。 - `custom_call_to_action_1` - `custom_call_to_action_5`: ネイティブクリエイティブを表示した後に必要なアクションを実行するようユーザーに促す追加の行動の呼び出し (メーリングリストへの署名など)。 - `custom_social_url_1` - `custom_social_url_5`: ユーザーを対応するソーシャルメディアプラットフォームに移動させるソーシャル URL。 - `custom_display_url_1` - `custom_display_url_5`: 表示される可能性がある追加のパブリック URL や、ランディングページのドメインに接続されている Web ページにユーザーが自動的にリダイレクトされる可能性があります。 `value`文字列の周囲には二重引用符が必要です。

イメージアセット

各 image_asset は、ネイティブクリエイティブのイメージコンポーネントを表します。 image_asset オブジェクトには、次のフィールドが含まれます。

フィールド	種類	説明
`image_type`	string	イメージの形式。次の値を指定できます。 - `main_image`: ネイティブクリエイティブのレンダリング時に表示されるプライマリイメージ。 - `icon_image`: ネイティブクリエイティブのレンダリング時に表示されるプライマリアイコン。 - `custom_image_1` - `custom_image_5`: ネイティブクリエイティブのレンダリング時に表示される追加の画像。 - `custom_icon_1` - `custom_Icon_5`: ネイティブクリエイティブのレンダリング時に表示される追加のアイコン。 - `custom_social_icon_1` - `custom_social_icon_5`: ネイティブクリエイティブのレンダリング時に表示される対応するソーシャルメディアアイコン。
`media_asset_id`	int	メディア資産の ID。ホストされているネイティブクリエイティブには必須です。 `media_asset_id`を取得できる場合は、`creative_asset_image` オブジェクトが自動的に設定されます。
`creative_asset_image`	object	クリエイティブアセットの詳細を含むオブジェクト。サードパーティのネイティブクリエイティブには必須です。詳細については、以下の「クリエイティブアセットイメージ」を参照してください。
`image_resize_setting`	object	イメージのサイズ変更設定を含むオブジェクト。詳細については、以下の「イメージサイズ変更設定」を参照してください。

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

creative_asset_image オブジェクトには、次のフィールドが含まれます。

フィールド	種類	説明
`url`	string	イメージのランディングページ URL。
`url_secure`	string	イメージの安全なランディングページ URL。
`width`	int	イメージの幅。値は 0 > する必要があります。
`height`	int	イメージの高さ。値は 0 > する必要があります。

画像のサイズ変更設定

image_resize_setting オブジェクトには、次のフィールドが含まれます。

フィールド	種類	説明
`resize_enabled`	ブール値	クリエイティブのサイズを変更するかどうかを示します。次の値を指定できます。 - `True` - `False`
`crop_enabled`	ブール値	クリエイティブをトリミングして配置を埋めるかどうかを示します。次の値を指定できます。 - `True` - `False`
`aspect_ratio_upper_bound`	double	クリエイティブに許可される最大縦横比。
`aspect_ratio_lower_bound`	double	クリエイティブに許可される最小縦横比。
`max_scale_factor`	double	クリエイティブの幅と高さをスケーリングできる最大値。

ビデオアセット

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

フィールド	種類	説明
`media_asset_id`	int	ホストされているビデオメディアアセットの ID。必須 On:`PUT`、 `POST`
`vast_url`	string	VAST ドキュメントへの URL。セキュリティで保護されている必要があります。必須 On:`PUT`、 `POST`
`trackers`	配列	オプションの VAST イベントトラッカー。
`media_files`	配列	使用可能なメディアファイルの配列。詳細については、「メディアファイル」を参照してください。読み取り専用。
`duration`	int	ビデオメディアアセットまたは VAST ドキュメントから抽出されたビデオの期間 (ミリ秒)。読み取り専用。
`minimum_vast_version`	string	ビデオを再生するために必要な最小 VAST バージョン。使用可能な値: - `2.0` - `3.0` - `4.0` 読み取り専用。

要求ごとに設定する必要がある { media_asset_id , vast_url } は 1 つだけです。

広大なトラッカー

vast_tracker オブジェクトには、次のフィールドが含まれます。

フィールド	種類	説明
`vast_event_type`	string	追跡イベントの種類。次の値を指定できます。 - `service` - `start` - `skip` - `error` - `first_quartile` - `completion` - `impression` - `click`
`url`	string	VAST ドキュメントへの URL。セキュリティで保護されている必要があります。

メディアファイル

media_file オブジェクトには、次のフィールドが含まれます。

フィールド	種類	説明
`bitrate_kbps`	int	メディアファイルのビットレート。
`mime_type`	string	メディアファイルの MIME の種類。
`width`	int	メディアファイルの幅。
`height`	int	メディアファイルの高さ。

ネイティブ

次のフィールドを格納するために使用される native オブジェクト。これらはすべて非推奨になりました。

フィールド	種類	説明
`title`	テキスト	廃止。
`description`	テキスト	廃止。
`full_text`	テキスト	廃止。
`context`	string	廃止。
`icon_img_url`	string	廃止。
`main_media`	オブジェクトの配列	廃止。
`sponsored`	string	廃止。
`cta`	string	廃止。
`rating`	object	廃止。
`click_url`	string	廃止。
`click_fallback_url`	string	廃止。
`custom_key_values`	オブジェクトの配列	廃止。

メインメディア

名前	種類	説明
`width`	int	廃止。
`height`	int	廃止。
`media_url`	string	廃止。
`media_url_secure`	string	廃止。

注:

ネイティブクリエイティブに関連付けられている main_media オブジェクトは 1 つだけです。

カスタムキー値

名前	種類	説明
`custom_key`	string	廃止。
`custom_value`	string	廃止。

クリックトラッカー

名前	種類	説明
`click_tracker_url`	string	廃止。

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

名前	種類	説明
`impression_tracker_url`	string	廃止。
`impression_tracker_url_secure`	string	廃止。

Pixels

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

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

注:

ピクセルテンプレートサービスを使用して、再監査をトリガーするかどうかなど、これらのピクセルに関する情報を取得できます。

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

注意

ピクセル配列を更新する PUT 呼び出しを行うと、配列は JSON 形式のファイル内の情報で完全に上書きされます。したがって、配列に既にピクセルが含まれている場合は、JSON 形式のファイルにもこれらのピクセルを含める必要があります。

フィールド	種類	説明
`id`	int	ピクセル配列の Xandr 割り当て ID。ピクセルは、以下に示す `pixel_template_id`、 `content`、または `URL` フィールドを介して関連付けます。読み取り専用。
`pixel_template_id`	int	Xandr 承認済みピクセルの ID。 Pixel Template Service を使用して、この ID を取得できます。
`param_1`	string	Xandr 承認済みピクセルの場合: ピクセルコンテンツまたは URL の最初のパラメーターの値。 Xandr 承認ピクセルに必要なパラメーターの数を確認するには、ピクセルテンプレートサービスを使用します。
`param_2`	string	Xandr 承認済みピクセルの場合: ピクセルコンテンツまたは URL 内の 2 番目のパラメーターの値。
`param_3`	string	Xandr 承認済みピクセルの場合: ピクセルコンテンツまたは URL 内の 3 番目のパラメーターの値。
`param_4`	string	Xandr 承認済みピクセルの場合: ピクセルコンテンツまたは URL の 4 番目のパラメーターの値。
`param_5`	string	Xandr 承認済みピクセルの場合: ピクセルコンテンツまたは URL の 5 番目のパラメーターの値。
`format`	列挙	ピクセルの形式。使用可能な値: `"raw-js"`、 `"url-html"`、 `"url-js"`、または `"url-image"`。
`content`	string (255)	ピクセル形式が `"raw-js"`されている場合は、クリエイティブで配信する HTML または JavaScript コンテンツ。
`secure_content`	string (255)	ピクセル形式が `"raw-js"`されている場合は、セキュリティで保護された (HTTPS) 広告呼び出しでクリエイティブと共に配信する HTML または JavaScript コンテンツ。
`url`	string (255)	ピクセル形式が `"url-html"`、 `"url-js"`、 `"url-image"`、または `"raw-url"`の場合は、クリエイティブで配信する HTML、JavaScript、または Image ピクセルの URL。
`secure_url`	string (255)	ピクセル形式が `"url-html"`、 `"url-js"`、 `"url-image"`、または `"raw-url"`の場合、セキュリティで保護された (HTTPS) 呼び出しでクリエイティブと共に配信する HTML、JavaScript、または Image ピクセルの URL。

政治

次のフィールドを格納するために使用される "political" オブジェクト。

フィールド	種類	説明
`in_scope`	ブール値	米国の政治的クリエイティブが規制対象の範囲にあるかどうかを判断します。はいの場合は、必要なすべての政治的買い手情報を挿入レベルで提供する必要があります。詳細については、UI を使用した挿入順序の作成に関するドキュメントを参照してください (ログインが必要です)。

ポップ値

注:

pop_valuesフィールドは非推奨であり、システムでは無視/使用されません。

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

フィールド	型 (長さ)	説明
`pop_window_maximize`	ブール型	`true`場合、パブリッシャーのタグによってウィンドウが最大化されます。フォーマット `"url-html"` と `"url-js"`を持つクリエイティブにのみ関連します。 `pop_window_maximize`が`true`に設定されている場合は、クリエイティブに`"height"`も`"width"`も設定しないでください。デフォルト：`false`
`pop_is_tag_initiated`	ブール型	`true`すると、クリエイティブのタグによってポップが開始されます。 `false`場合、インプレッションバスによってポップが開始されます。デフォルト：`false`
`pop_window_title`	string (255)	ポップされたウィンドウのタイトル。 `pop_is_tag_initiated`が`false`に設定されているポップにのみ適用されます。すべてのブラウザーでサポートされる保証はありません。デフォルト：`Network name`
`pop_statusbar`	ブール型	`true`場合は、ポップされたウィンドウにステータスバーが表示されます。 `pop_is_tag_initiated`が`false`に設定されているポップにのみ適用されます。すべてのブラウザーでサポートされる保証はありません。デフォルト：`true`
`pop_menubar`	ブール型	`true`場合は、ポップされたウィンドウにメニューバーが表示されます。 `pop_is_tag_initiated`が`false`に設定されているポップにのみ適用されます。すべてのブラウザーでサポートされる保証はありません。デフォルト：`true`
`pop_resizable`	ブール型	`true`場合、ポップされたウィンドウのサイズを変更できます。 `pop_is_tag_initiated`が false に設定されているポップにのみ適用されます。すべてのブラウザーでサポートされる保証はありません。デフォルト：`true`
`pop_scrollbars`	ブール型	`true`場合は、ポップされたウィンドウにスクロールバーが表示されます。 `pop_is_tag_initiated`が`false`に設定されているポップにのみ適用されます。すべてのブラウザーでサポートされる保証はありません。デフォルト：`true`
`pop_toolbar`	ブール型	`true`場合は、ポップウィンドウにツールバーが表示されます。 `pop_is_tag_initiated`が`false`に設定されているポップにのみ適用されます。すべてのブラウザーでサポートされる保証はありません。デフォルト：`true`
`pop_addressbar`	ブール型	`true`場合は、ポップされたウィンドウにアドレスバーが表示されます。 `pop_is_tag_initiated`が`false`に設定されているポップにのみ適用されます。すべてのブラウザーでサポートされる保証はありません。デフォルト：`true`

セグメント

これらのフィールドは、Segments 配列に含まれます。

フィールド	種類	説明
`id`	int	セグメントの ID。必須 On:`POST`、 `PUT`
`segment_id`	int	セグメントの ID。このフィールドには、 `id` フィールドと同じ情報が含まれています。
`action`	列挙	ユーザーがセグメントに追加するアクション。使用可能な値: `"add on view"` または `"add on click"`。必須 On:`POST`、 `PUT`
`name`	string	セグメントの名前。

状態

名前	種類	説明
`user_ready`	ブール値	クリエイティブが配信の準備ができているかどうかを説明する、ユーザーが設定したクリエイティブの状態。使用可能な値: `"true"` または `"false"`。期限切れのクリエイティブとそのaudit_status を再アクティブ化するには、user_readyの値が true である必要があります。デフォルト：`true`
`hosted_assets_association_complete`	boolean/null	Xandr の内部システムによってアップロードされたクリエイティブの状態。使用可能な値: ホストされているクリエイティブの `"true"` または `"false"` 、サードパーティのクリエイティブの場合は "null" です。読み取り専用。

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

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

フィールド	種類	説明
`id`	int	ピクセルの ID。必須:`PUT`
`name`	string	ピクセルの完全な名前。読み取り専用。
`active`	ブール型	ピクセルの現在の状態 (true = アクティブ)。読み取り専用。
`audit_status`	string	ピクセルの監査状態。読み取り専用。

注:

サードパーティのピクセルを更新または作成したり、広告主またはネットワークメンバーが所有するすべてのクリエイティブにサードパーティのピクセルをアタッチしたりするには、サードパーティの Pixel サービスを使用します。

最初の実行/最後の実行

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'

注:

never_run=trueは他のフィルターと組み合わせて使用できますが、常に OR リレーションシップであることに注意してください。たとえば、クエリ文字列に never_run=trueと min_first_run=2012-01-01 00:00:00 の両方を渡すと、2012-01-01 以降に配信された広告申込情報や広告申込情報を配信したことがないクリエイティブが検索されます。

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

クエリ文字列に 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'

統計

注:

stats オブジェクトは非推奨になりました (2016 年 10 月 17 日現在)。代わりに Report Service を使用して統計情報を取得します。

再監査の原因となる変更

クリエイティブが Xandr 監査に合格すると (audit_status が "audited")、次のいずれかのフィールドを変更すると、クリエイティブは監査のために再送信されます (allow_audit は "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}?"

例

注意

PUT呼び出しでaudit_statusとno_auditを除外して、エラーを回避します。

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"
   }
}

$ 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",
      ...
   }
}

モバイルクリエイティブが 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 を使用してホスティングするための標準バナーフラッシュクリエイティブをアップロードする場合:

$ 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 を追加する場合:

$ 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 が指定されていることに注意してください。これは、 "MediaMind Expandable" メディアサブタイプと "url-js" 形式のクリエイティブの Xandr 標準テンプレートです。

$ 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",
      ...
   }
}

ポイントロール展開可能なクリエイティブ (サードパーティ製 HTML タグ) を追加する

この例では、コンテンツフィールドが展開可能なクリエイティブの JavaScript タグを提供し、テンプレート配列はテンプレート 159 を指定します。これは、 "Pointroll Expandable" メディアサブタイプと "raw-html" 形式のクリエイティブの Xandr 標準テンプレートです。

$ 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",
      ...
   }
}

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

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

{
   "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",
      ...
   }
}

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

$ 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 ファイルを追加する場合:

$ 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 インベントリで配信するバージョンをアップロードすることもできます。

注:

簡単な GET 要求を行うことで、クリエイティブの ssl 監査状態を確認できます。応答の [ ssl_status ] フィールドに監査状態が表示されます。クリエイティブは、監査に合格し、 ssl_status が "approved"された後にのみ、安全な在庫を提供する資格があります。サードパーティのクリエイティブは、広告チェーン内のすべての呼び出しがセキュリティで保護されたサーバーを経由する場合にのみ監査に合格します。クリエイティブが ssl 監査に失敗した場合は、 ssl_status フィールドを "pending" に変更することで、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 アイコンピクセルをクリエイティブに追加するプロセスについて説明します。

まず、ピクセルに対して定義する必要がある pixel_template_id とパラメーターの数を調べる必要があります。この情報を取得するには、 Pixel Template Service を使用します。

$ 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": {
            ...
        }
    }
}

Evidon AdChoices アイコンピクセルは、応答の最初のピクセルです。 id は 1 であることに注意してください。また、 num_required_params が 2されていることにも注意してください。つまり、クリエイティブにピクセルを追加するときは、ピクセルコンテンツ内の {P1} と {P2} の値を指定する必要があります。
ピクセルをクリエイティブに追加するための JSON 形式のファイルを作成します。ファイルでは、pixel_template_idを2に設定し、ピクセルコンテンツの{P1}と{P2}の値にparam_1とparam_2を設定します。

注意

ピクセル配列は JSON で完全に上書きされます。したがって、クリエイティブのピクセル配列に既にピクセルが含まれている場合は、JSON 配列にもピクセルを指定してください。詳細については、「 Creative Service」を参照してください。
```
$ cat creative_update

{
    "creative": {
        "pixels": [
            {
                "pixel_template_id": 1,
                "param_1":"12",
                "param_2":"34"
            }
        ]
    }
}
```

最後に、クリエイティブを更新するために PUT 呼び出しを行います。応答のピクセル配列は、ピクセルが追加されたことを示します。 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 の場所に設定されます。

注:

audit_statusが"pending"という応答では、クリエイティブにカスタムピクセルを追加すると、クリエイティブが監査のために再送信されるためです。

注意

ピクセル配列は、このファイル内の情報で完全に上書きされます。そのため、クリエイティブに既にピクセルが含まれている場合は、必ずファイル内で指定してください。

$ 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 つのサードパーティ製ピクセルが追加されます。

注:

audit_statusが"pending"という応答では、クリエイティブにサードパーティのピクセルを追加すると、クリエイティブが監査のために再送信されるためです。

$ 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 - クリエイティブ サービス

監査

REST API

JSON フィールド

ブランド

キャンペーン

競争力のあるブランド

競合カテゴリ

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

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

カスタム マクロ

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

行項目

メディア資産

メディア資産: 例

Mobile

ネイティブ属性

リンク

リンク トラッカー

画像トラッカー

Javascript トラッカー

データ資産

イメージアセット

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

画像のサイズ変更設定

ビデオアセット

広大なトラッカー

メディア ファイル

ネイティブ

メイン メディア

カスタム キー値

クリック トラッカー

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

Pixels

政治

ポップ値

セグメント

状態

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

最初の実行/最後の実行

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

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

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

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

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

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

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

統計

再監査の原因となる変更

クリエイティブ マクロ

クリック追跡の例

例

バナー イメージ クリエイティブを追加する (ホステッド)

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

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

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

MediaMind 展開可能なクリエイティブを追加する (サード パーティの URL)

ポイントロール展開可能なクリエイティブ (サード パーティ製 HTML タグ) を追加する

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

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

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

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

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

セキュリティで保護されたクリエイティブを追加する

優先度の高い監査のためにクリエイティブを送信する

クリエイティブ監査を取り消す

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

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

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

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

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

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

関連項目

その他のリソース