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

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

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

注:

2025 年 9 月より有効: 広告が政治的なものであり、[ is_political_and_eu_targeted ] フィールドと [ is_political_and_non_eu_targeted ] フィールドを通じて EU 内で配信されることを意図しているかどうかを宣言します。 詳細については、 政治広告に関する Monetize Creative Standard の今後の更新プログラムを参照してください。

監査

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

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

REST API

HTTP メソッド	エンドポイント	説明
POST	https://api.appnexus.com/creative?advertiser_id=ADVERTISER_ID (creative JSON)	いずれかの広告主に新しいクリエイティブを追加します。
POST	https://api.appnexus.com/creative?publisher_id=PUBLISHER_ID (creative 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 (creative 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。 既定値: 自動生成された数値。 Required On:PUT, in query string.
code	string (100)	クリエイティブのカスタム コード。 注: このコードは一意であることが重要です。
code2	string (100)	クリエイティブの追加のカスタム コード。 注: このコードは一意であることが重要です。
name	string (400)	クリエイティブの名前。
type	列挙	クリエイティブのタイプ。 使用可能な値: - "standard" "html" - "video" 注: アルファ ベータ版に関する通知 このフィールドまたは機能は、現在アルファ フェーズまたはベータ フェーズにある機能の一部です。 そのため、変更される可能性があります。 読み取り専用。
advertiser_id	int	クリエイティブが添付されている広告主の ID。 必須 On:POST/PUT、クリエイティブが広告主にアタッチされている場合は、クエリ文字列内。
political	object	読み取り専用です。 このクリエイティブが "政治的" であり、米国で機能する場合、このオブジェクトには米国の政治クリエイティブに必要な要素が設定されます。 詳細については、以下の Political オブジェクト の説明を参照してください。 既定値:null
publisher_id	int	クリエイティブが添付されているパブリッシャー/メディア購入の ID。 必須 On:POST/PUT, in query string (クリエイティブがパブリッシャーにアタッチされている場合)。
brand_id	int	クリエイティブを宣伝する会社のブランドの ID。 含まれる場合は、Xandr 監査チームによって検証されます。 含まれない場合は、監査チームによって割り当てられます。 ブランドの完全なリストを取得するには、 Brand Service を参照してください。
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 を含める必要があります。 必須:POST、テンプレートが "Banner" または "Expandable" メディア タイプ用の場合。
height	Int	必須:POST、テンプレートが "Banner" または "Expandable" メディア タイプ用の場合。 クリエイティブの高さ。文字列には int を含める必要があります。クリエイティブのテンプレートに Pop メディア タイプがある場合は、クリエイティブのheightを設定するか、(pop_values フィールドで) pop_window_maximizeをtrueする必要があります (両方ではありません)。 メモ: Xandr 監査には、承認されたサイズのポップ クリエイティブのみを提出できます。 template 配列内のmedia_subtype_idが 4 (ポップアンダー) で、audit_status が "pending" の場合、height を 300 に設定し、width を 720 に設定する必要があります。 template配列内のmedia_subtype_idが 2 (ポップアップ) で、audit_status が "pending" の場合、width と height は、250x250、300x250、550x480 のいずれかである必要があります。 必須:POST、テンプレートが "Banner" または "Expandable" メディア タイプ用の場合。
media_url	string (1000)	クリエイティブの URL - 画像、フラッシュ、HTML、javascript (形式を参照) にすることができます。 URL は存在する必要があり、CDN またはそれに相当するものである必要があります。 必須 On:POST、コンテンツを使用しない場合。
media_url_secure	string (1000)	セキュアな (HTTPS) クリエイティブの URL - セキュアな広告呼び出しで配信される画像、フラッシュ、HTML、javascript (形式を参照) にすることができます。 URL は存在する必要があり、CDN またはそれに相当するものである必要があります。
click_url	string (2000)	click_url click_target の優先に向けて非推奨になりました。 注: この値は、"http://" または "https://" で始まる必要があります 必須 On:POST、テンプレートが "image" 形式用の場合。
file_name	string (1000)	ホストされているクリエイティブのファイル名と拡張子。 使用できるファイルの種類: jpg、gif、png、swf、flv、mp4、wmv、f4v、avi、m4v、mov、mpg。 必須 On:POST、ホストされたクリエイティブを追加する場合。
flash_click_variable	string (255)	Flash クリエイティブの ClickTag 変数。 Xandr が Flash クリエイティブでのユーザーのクリックを実行および追跡できるのは、ファイル内に正確な変数 (clickTAG、ClickTag、Clicktag など) を指定した場合のみです。 この変数は、ClickTags サービスを使用して識別できます。 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(); ステートメントでラップする必要があります。 これは、ページにコンテンツを配信するために必要です。 ヒント: コンテンツ フィールドの最大文字数は 65,535 文字です。 必須 On:POST ( media_url を使用しない場合)。 既定: サード パーティのタグ所有者。
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 (ポップアンダー) の場合、width が 720 で height が 300 でない限り、audit_status を "pending" に設定できません。 template配列内のmedia_subtype_idが 2 (ポップアップ) の場合、widthと height が 250x250、300x250、550x480 のいずれかでない限り、audit_statusを保留に設定できません。 既定値:"pending"
audit_feedback	string	クリエイティブ監査チームは、この分野のクリエイティブに関するメッセージを渡すことができます。 読み取り専用。
allow_audit	ブール型	trueの場合、クリエイティブは監査のために提出されます。 falseの場合、クリエイティブは送信されません。 監査されていないクリエイティブは、ネットワークの管理されたインベントリでのみ実行できます。 注: - audit_status が "no_audit"の場合、このフィールドは "false"にする必要があります。 - メンバーがまだアクティブでない場合は、クリエイティブを追加できますが、監査に送信されません (allow_auditfalseされます)。 メンバーをアクティブ化した後、これらのクリエイティブを監査する場合は、クリエイティブを更新し、 allow_audit を true に設定する必要があります。 - Xandr 監査には、許容サイズのポップ クリエイティブのみを送信できます。 template配列内のmedia_subtype_idが 4 (ポップアンダー) の場合、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 も必要です。 既定値: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	ブール型	マルウェアが存在する、またはブロックされたドメインを読み込んでいるとしてシャーロックがクリエイティブにフラグを付けた場合、これは 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	オブジェクトの配列	クリエイティブで提供するピクセル。 外部インプレッション トラッキング、外部クリック トラッキング、またはクリエイティブへの AdChoices アイコンの追加などの他の目的に使用できます。 詳細については、以下の 「ピクセル 」を参照してください。
pixel_url	string (100)	非推奨。 代わりに pixels 配列を使用してください。 メディア URL またはコンテンツとともに配信するインプレッション ピクセルの URL。
pixel_url_secure	string (100)	非推奨。 代わりに pixels 配列を使用してください。 セキュアな広告呼び出しでメディア URL コンテンツとともに配信されるセキュア (HTTPS) インプレッション ピクセルの URL。
pixel_type	列挙	非推奨。 代わりに pixels 配列を使用してください。 インプレッション ピクセルのタイプ。 pixel_urlを使用する場合は、このフィールドを設定する必要があります。 使用可能な値: "javascript" または "image"。
no_iframes	ブール型	非推奨。 trueの場合、広告呼び出しで iframe が検出されても、入札者はこのクリエイティブを配信しません。 既定値:false
track_clicks	ブール型	非推奨です。 既定値:true
flash_backup_content	string	フラッシュ クリエイティブの場合、これは、ユーザーのブラウザーでフラッシュがサポートされていない場合に提供されるバックアップ クリエイティブのコンテンツです。 バナー内動画クリエイティブの場合、ユーザーが再生をクリックする前、動画の再生が終了した後に表示されるポスター画像のコンテンツです。 このフィールドは flash_backup_file_name と組み合わせて使用する必要があります。 バックアップ クリエイティブがアップロードされると、コンテンツは CDN に保存され、[flash_backup_url] フィールドに場所が設定されます。 flash_backup_content も flash_backup_file_name も GET で取得できません。 必須 On:POST/PUT、 flash_backup_file_name を使用している場合。 書き込み専用。
flash_backup_file_name	string	このフィールドは flash_backup_content と組み合わせて使用する必要があります。 これは、バックアップ クリエイティブのファイル名と拡張子です。 必須 On:POST/PUT、 flash_backup_content を使用している場合。 書き込み専用。
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)	テキスト クリエイティブに表示されるテキストの一番上の行。 必須 On:POST、テンプレートが "text" 形式用の場合。
text_description	文字列 (70)	テキスト クリエイティブに表示されるテキストの下行。 必須 On:POST、テンプレートが "text" 形式用の場合。
text_display_url	文字列 (35)	テキスト クリエイティブに表示される読み取り可能な URL。 必須 On:POST、テンプレートが "text" 形式用の場合。
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応答に広告サーバーを含めるには、クエリ文字列に attributes=1 を渡します。 広告サーバーの完全な一覧を取得するには、 広告サーバー サービスを参照してください。 読み取り専用。
technical_attributes	オブジェクトの配列	クリエイティブの技術的特性を表す属性 ( "Expandable" や "Video"など)。 注: GET応答に技術属性を含めるには、クエリ文字列に attributes=1 を渡します。 技術属性の完全なリストを取得するには、 技術属性サービスを参照してください。
language	object	クリエイティブの言語。 言語の完全な一覧を取得するには、 Language Service を参照してください。
brand	object	クリエイティブを宣伝する会社のブランドと、ブランドに関連付けられているカテゴリ。 詳細については、以下の ブランドを参照してください 。 読み取り専用。
pop_values	配列	非推奨です。
sla	int	0に設定されたクリエイティブは、標準の SLA で監査のために送信されます。 注意:0 以外の番号で提出されたクリエイティブには、優先監査 (有効な場合) とその結果の料金が発生します。 Xandr と優先監査に関する補足サービス契約を結んでいる場合は、このフィールドを 2 に設定することで、優先監査 (営業時間内の 2 時間以内の監査) の対象となるクリエイティブを提出できます。
sla_eta	timestamp	優先監査の推定完了時間。 読み取り専用。
currency	string	読み取り専用です。 広告主の主要通貨 (米国ドルなど) を定義するコード。 利用可能な通貨の種類の詳細については、「 通貨サービス」を参照してください。 既定値: メンバーの既定の通貨。
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 日現在)。 代わりに、統計情報を取得するためにレポート サービス を使用します。
content_source	string	このクリエイティブのコンテンツのソース。 既定値:"standard" 有効な値は次のとおりです。 - "standard": このクリエイティブは、広告サーバーでホストされているコンテンツで構成され、通常は 1 回の HTTP 要求で取得されます。 - "mediation": このクリエイティブは、メディエーション目的で別の広告サーバーからコンテンツを取得するために使用されるコンテナーです。 メディエーションの実行方法により、これには複数の HTTP 要求が順番に実行される必要がある場合があります。 詳細については、「 クリエイティブ カスタム要求テンプレート サービス」を参照してください。 メモ: このフィールドが "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	マルチ オブジェクト	このクリエイティブの content_source フィールドの値が "mediation" に設定されている場合、このオブジェクトは、このクリエイティブと、クリエイティブにコンテンツを設定するために使用されるカスタム リクエスト テンプレートとの関連付けを記述します。 詳細については、 カスタム要求テンプレートを参照してください。 既定値:null 必須 On:PUTcontent_source が "mediation" に設定されている場合。
competitive_brands	オブジェクトの配列	この配列のブランドに関連付けられたクリエイティブは、 /mtj オークションで一緒に提供されません。 競合ブランドの典型的な例は、コーラ対ペプシです。 以下の 競争力のあるブランド を参照してください。 システム内のブランドの詳細については、 ブランドサービスを参照してください。
competitive_categories	オブジェクトの配列	この配列のカテゴリに関連付けられているクリエイティブは、たとえば "デート" や "教育" など、 /mtj オークションで一緒に機能しません。 以下の 競合カテゴリ を参照してください。 クリエイティブ (およびブランド) に適用されるカテゴリの詳細については、 カテゴリ サービスを参照してください。
thirdparty_pixels	オブジェクトの配列	クリエイティブに関連付けられているサードパーティのピクセルの配列。 これらのピクセルは、 サードパーティのピクセル サービス を使用して広告主またはメンバーが所有するすべてのクリエイティブに自動的にアタッチすることも、クリエイティブ サービスを使用してクリエイティブ レベルで個別にアタッチすることもできます。 既定値:null 必須:PUT
native	object	非推奨。 このクリエイティブがネイティブ広告の場合、このオブジェクトにはネイティブ広告に必要な要素が設定されます。 詳細については、以下の ネイティブ オブジェクトの説明を参照してください。 既定値:null 必須:POST およびネイティブ広告の PUT 。 技術的には、ネイティブ広告は、nativeとして識別するcreative_format_idの12を持つtemplateを持つクリエイティブとしてシステムによって識別されます。
native_attribute	object	これは、ネイティブ広告に必要な要素を含む新しいネイティブ オブジェクトです。 詳細については、以下の ネイティブ属性 オブジェクトの説明を参照してください。 既定値: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 経由でファイルをアップロードするときに自動的に設定されます。 詳細については、以下の 「メディア アセット」 を参照してください。
ad_type	string	ヒント: このフィールドは、 クリエイティブを拡張品目に関連付ける場合にのみ適用されます。 使用されたクリエイティブのタイプ。 使用可能な値: - banner - video (オーディオ タイプを含む) - native この値により、オークション項目の購入戦略、支払い戦略、最適化オプション、クリエイティブの関連付け、ターゲティング オプションでどのようにオークション項目を追跡するかが決まります。 メモ:広告申込情報に関連付けられているすべてのクリエイティブは、広告申込情報サービス - ALI で選択されているad_typeと一致する同じ広告タイプである必要があります。
is_political_and_eu_targeted	ブール型	クリエイティブに政治的コンテンツが含まれており、EU 内で掲載する場合は true に設定します。 フィールドが送信されない場合、想定される既定値は false です。 注: 政治的広告は EU ではサポートされていません。
is_political_and_non_eu_targeted	ブール型	クリエイティブに政治的なコンテンツが含まれており、EU 内で掲載する予定がない場合は、true に設定します。 フィールドが送信されない場合、想定される既定値は false です。 注: 政治広告は EU 以外の国で、Microsoft Monetize Adserver クライアントでのみサポートされています。

ブランド

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 Subtype Service を使用すると、サポートされているすべてのメディア サブタイプを表示できます。 読み取り専用。
format_id	string	テンプレートに割り当てられている書式の名前。 Creative Format Service を使用すると、サポートされているすべての形式を表示できます。 読み取り専用。

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

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

テンプレート ID	クリエイティブ タイプ	要件
1	HTML コードの一部を指す単一の URL。	media_url フィールドに URL を渡し、テンプレート オブジェクトに ID を 1 に設定する必要があります。
2	Javascript コードの一部を指す単一の URL。	media_url フィールドに URL を渡し、テンプレート オブジェクトに 2 の ID を設定する必要があります。
5	Javascript コードが HTML を書き込む場合でも、JavaScript コンポーネントで始まり終わるクリエイティブ。	content フィールドに Javascript コードを渡し、テンプレート オブジェクトに 5 の ID を設定する必要があります。
6	HTML コンポーネントがタグ <script> であっても、HTML コンポーネントで始まり終わるクリエイティブ。	content フィールドに html コードを渡し、テンプレート オブジェクトに 6 の ID を設定する必要があります。

カスタム マクロ

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

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

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

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

フィールド	種類	説明
id	int	このクリエイティブに関連付けられているクリエイティブ カスタム リクエスト テンプレート ( content_source が "mediation" に設定されている場合)。 詳細については、「 クリエイティブ カスタム要求テンプレート サービス」を参照してください。
timeout_ms	int	これが "メディエーション" クリエイティブの場合、外部広告サーバーに対して少なくとも 1 つの HTTP 要求を行い、さらに 1 つ以上の追加要求を行う場合があります。 この時期は、このクリエイティブにコンテンツが埋め込まれるのをもう待つことはありません。 詳細については、「 クリエイティブ カスタム要求テンプレート サービス」を参照してください。
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 回だけ使用できます。 たとえば、"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

フィールド	種類	説明
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	ネイティブ クリエイティブのランディング ページ。 必須: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: ランディング ページのドメインに接続されている Web ページにユーザーを表示したり、自動的にリダイレクトしたりすることができる追加のパブリック URL。 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。 必須:PUT、 POST
vast_url	string	VAST ドキュメントの URL。 セキュリティで保護されている必要があります。 必須: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 トラッカー

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。 ピクセル テンプレート サービスを使用すると、この 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、または画像ピクセルの URL。
secure_url	string (255)	ピクセル形式が "url-html"、 "url-js"、 "url-image"、 "raw-url" の場合、安全な (HTTPS) 呼び出しでクリエイティブと共に提供する HTML、JavaScript、または画像ピクセルの URL。

政治

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

フィールド	種類	説明
in_scope	ブール値	米国の政治的クリエイティブが規制対象内にあるかどうかを判断します。 「はい」の場合、必要なすべての政治的購入者情報を挿入レベルで提供する必要があります。 詳しくは、UI で広告掲載オーダーを作成するドキュメントを参照してください (ログインが必要です)。

POP 値

注:

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 に設定されている pop にのみ適用されます。 すべてのブラウザーでサポートされる保証はありません。 既定値: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

セグメント

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

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

状態

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

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

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

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

注:

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

初回実行/最終実行

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 以降に最初に配信された OR ライン アイテムを送信したことがないクリエイティブを検索することになります。

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

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 日現在)。 代わりに、統計情報を取得するためにレポート サービス を使用します。

再監査の原因となる変更

クリエイティブが 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}?"
        

例

注意

エラーを回避するために、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",
       "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 インベントリで配信するバージョンをアップロードすることもできます。

注:

シンプルな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 アイコン ピクセルをクリエイティブに追加するプロセスについて説明します。

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 の場所に設定されます。

注:

その回答では、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 のベスト プラクティス
• API セマンティクス