デジタル プラットフォーム API - クリエイティブ マクロ チェック サービス
サード パーティのクリエイティブを実行している場合は、このサービスを使用して、Xandr がサード パーティのタグを確認し、クエリ文字列にパラメーターを追加したり、ドメインを置き換えたり、Xandr クリック追跡マクロを適切な場所に挿入したりできます。 現在、MediaMind、Atlas、Fetchback、DoubleClick の広告サーバーがサポートされています。
Xandr マクロを挿入できる場合は、応答で新しいタグまたは URL が返されます。 適切なマクロが挿入されたことを確認できない場合 ( existing_other_macros
または unmatched
フィールドの値が応答内で 0 ではない場合)、 new_content
または new_media_url
フィールド内の値は UI に表示されません。
REST API
HTTP メソッド | エンドポイント | 説明 |
---|---|---|
PUT |
https://api.appnexus.com/creative-macro-check (replace_pattern_in_content_url JSON) |
定義済みのパターンに基づいて、URL 内のコンテンツを置き換えます。 |
PUT |
https://api.appnexus.com/creative-macro-check?include_tests=1 (replace_pattern_in_content_url JSON) |
定義済みのパターンとテスト パターンに基づいて、URL 内のコンテンツを置き換えます。 |
JSON フィールド
フィールド | 種類 | 説明 |
---|---|---|
content |
string | フィールドは、コンテンツを変更するときに使用されます。 Xandr マクロを含むように変更されているコンテンツ。 コンテンツの変換時に必要な On: PUT 。 |
new_content |
string | フィールドは、コンテンツを変更するときに設定されます。 セキュリティで保護されていないすべてのマクロが評価された更新されたコンテンツ。 このフィールドには、すべての Xandr マクロが正常に挿入されない限り、 content と同じ値が含まれます。 |
new_content_secure |
string | フィールドは、コンテンツを変更するときに設定されます。 セキュリティで保護されたマクロとセキュリティ保護されていないマクロの両方が評価された更新されたコンテンツ。 このフィールドには、すべての Xandr マクロが正常に挿入されない限り、 content と同じ値が含まれます。 |
media_url |
string | フィールドは、メディア URL を変更するときに使用されます。 Xandr マクロを含むように変更されているメディア URL。 メディア URL を変換するときに必要な On: PUT 。 |
new_media_url |
string | メディア URL を変更するときにフィールドが設定されます。 セキュリティで保護されていないすべてのマクロが評価された更新されたメディア URL。 このフィールドには、すべての Xandr マクロが正常に挿入されない限り、 media_url と同じ値が含まれます。 |
new_media_url_secure |
string | メディア URL を変更するときにフィールドが設定されます。 セキュリティで保護され、セキュリティで保護されていないすべてのマクロが評価された更新されたメディア URL。 このフィールドには、すべての Xandr マクロが正常に挿入されない限り、 media_url と同じ値が含まれます。 |
recognized_servers |
文字列の配列 |
content または media_url フィールド内の値に一致する URL パターンを含む広告サーバーの名前。 詳細については、以下の 「マクロ置換 」を参照してください。 |
found_urls |
int | クリエイティブ コンテンツで見つかった 'src=' または 'href=' URL の数。 |
matched_urls |
int | 認識された広告サーバーからの found_urls の数。 |
macro_replacements |
配列 | 実行された置換に関する情報を含む配列 。マクロの種類 (例: cachebuster) 別に一覧表示されます。 詳細については、以下の 「マクロ置換 」を参照してください。 |
warning |
string | このフィールドは、 new_content_secure または new_media_url_secure 内の値がセキュリティで保護されていない場合に警告メッセージを表示します。 |
マクロ置換
フィールド | 種類 | 説明 |
---|---|---|
type |
string | オブジェクトにキャッシュバスターまたは click_url に関する情報があるかどうかを指定します。 |
replaced |
int | そのマクロが正常に挿入された URL の数 type 。 |
existing_other_macro |
int | マクロを挿入する場所を決定できた URL の数ですが、既に何かが存在していたため、そのままにしておきます。 この値が 0 でない場合、 new_content または new_media_url フィールド内の値は UI に表示されません。 |
existing_appnexus_macro |
int | マクロを挿入する場所を決定できた URL の数。 |
unmatched |
int | マクロの挿入方法を決定できなかった URL の数。 この値が 0 でない場合、 new_content または new_media_url フィールド内の値は UI に表示されません。 |
認識されたサーバー
フィールド | 種類 | 説明 |
---|---|---|
adserver_name |
string | 広告サーバーの名前。 |
例
サード パーティのタグ (コンテンツ) 内のマクロを置き換える
コンテンツ フィールドには複数の URL を含めることができますが、この例ではコンテンツ フィールドに含まれる URL は 1 つだけです。
{code}
$ cat /tmp/replace-macros-in-tag.json
{
"creative-macro-check": {
"content": "<a href=\"https://clk.atdmt.com/CCC/go/329458985/direct/01">test</a>"
}
}
$ curl -b cookies -X PUT -d '@/tmp/replace-macros-in-tag.json' "https://api.appnexus.com/creative-macro-check"
{
"response": {
"status": "OK",
"creative-macro-check": {
"new_content": "<a href=\"${CLICK_URL}https:\/\/clk.atdmt.com\/CCC\/go\/329458985\/direct\/01\">test<\/a>",
"new_content_secure": "<a href=\"${CLICK_URL}https:\/\/clk.atdmt.com\/CCC\/go\/329458985\/direct\/01\">test<\/a>",
"content": "<a href=\"https:\/\/clk.atdmt.com\/CCC\/go\/329458985\/direct\/01\">test<\/a>",
"media_url": null,
"new_media_url": null,
"new_media_url_secure": null,
"recognized_servers": [
"Atlas"
],
"recognized_server": "Atlas",
"found_urls": 1,
"matched_urls": 1,
"macro_replacements": [
{
"type": "click",
"replaced": 1,
"existing_other_macro": 0,
"existing_appnexus_macro": 0,
"unmatched": 0
}
],
"warning": "new_content_secure contains some non secure urls"
},
"count": 1,
"start_element": null,
"num_elements": null
}
}
{code}
サードパーティ URL (メディア URL) 内のマクロを置き換える
{code}
$ cat /tmp/replace-macros-in-url.json
{
"creative-macro-check": {
"media_url": "https://clk.atdmt.com/CCC/go/329458985/direct/01"
}
}
$ curl -b cookies -c cookies -X PUT -d '@/tmp/replace-macros-in-url.json' 'https://api.appnexus.com/creative-macro-check'
{
"response": {
"status": "OK",
"creative-macro-check": {
"content": null,
"new_content": null,
"new_content_secure": null,
"media_url": "https:\/\/clk.atdmt.com\/CCC\/go\/329458985\/direct\/01",
"new_media_url": "${CLICK_URL}https:\/\/clk.atdmt.com\/CCC\/go\/329458985\/direct\/01",
"matched_urls": 1,
"new_media_url_secure": "${CLICK_URL}https:\/\/clk.atdmt.com\/CCC\/go\/329458985\/direct\/01",
"recognized_servers": [
"Atlas"
],
"recognized_server": "Atlas",
"found_urls": 1,
"macro_replacements": [
{
"type": "click",
"replaced": 1,
"existing_other_macro": 0,
"existing_appnexus_macro": 0,
"unmatched": 0
}
],
"warning": "new_media_url_secure is not secure"
},
"count": 1,
"start_element": null,
"num_elements": null
}
}
{code}