タグの定義

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

この関数は、広告配置のパラメーターを定義します。ページごとに 12 個以下の配置を指定する必要があることに注意してください。定義後に使用できる Tagobject を返します。

defineTag({params})

パラメーター

次に示すパラメーターは、関数内の引数として送信できます。

パラメーター	型	説明
`member`	番号	配置のメンバー ID ( `setPageOpts()`からのグローバル設定をオーバーライドします)。
`invCode`	String	この配置の配置コード。
`tagId`	番号	配置の配置 ID。
`sizes`	数値の配列	1 つのサイズに `[300,250]` 形式の 1 つ以上の配置サイズ ({{height, width}})、複数のサイズの場合は `[[300,250],[728,90]]` 。複数のサイズを指定した場合、1 つ目は配置サイズで、残りはプロモーションサイズです。手記：`sizes`または`sizeMapping`は、両方ではなく、広告スロットごとに許可されます。
`sizeMapping`	オブジェクトの配列	ビューポートの最小サイズに基づいてサイズのセットを指定します。これにより、販売者はビューポートのサイズに基づいて使用するサイズを設定できます。ビューポートのサイズが指定された最小の `minWidth` よりも小さい場合、広告スロットに対する広告は要求されません。サイズは、1 つのサイズに `[300,250]` 形式で渡され、複数のサイズの場合は `[[300,250],[728,90]]` されます。配列内の各オブジェクトには、2 つのパラメーターが含まれています。 - `minWidth`: ビューポートの最小幅を指定します。たとえば、「 `minWidth: 1024` 」のように入力します。 - `sizes`: 広告のサイズを指定します。たとえば、 `sizes:[[300,250],[300,600]]`。手記：`sizes`または`sizeMapping`は、両方ではなく、広告スロットごとに許可されます。
`targetId`	String	発行元/販売者によって作成された特定の広告スロットの一意識別子。広告が表示されるページ本文の `div` タグに対応します。 `div` タグの`id`は、`targetId`と同じ値に設定する必要があります。
`forceCreativeId`	番号	この配置に強制的に表示するクリエイティブの ID を指定します。クリエイティブを強制すると、サイトで広告をプレビューしたり、テストや認定を実行したり、ティアシートを作成することができます。先端：クリエイティブは、 `ast_override_[parameter]=[value]:[creative_id]`形式の Web サイト URL のクエリ文字列で強制的に実行することもできます。ここで、必要に応じて `parameter`、 `value`、 `creative_id` を置き換えます。複数の `[value]:[creative_id]` の組み合わせをコンマで区切って渡すことができます (例: `https://test.example.com/demo.html?ast_override_ index = 2 : 40611315 , 3 : 40611316`)。 `parameter`には、次のいずれかのオプションを選択できます。 div オーバーライドする広告スロットのターゲット div ID を指定します。 `value`で、強制的に`creative_id`する div ID を入力します。クリエイティブ `40611315`で div を ID `apn_ad_slot_1`でオーバーライドするには: `https://test.example.com/demo.html?ast_override_div=apn_ad_slot_1:40611315` index `0`から始まる、オーバーライドする広告スロットのインデックス番号を指定します。 [ `value` に、強制的に `creative_id` するインデックス番号を入力します。 3 番目に定義された配置をクリエイティブ `40611315`でオーバーライドするには: `https://test.example.com/demo.html?ast_override_index=2:40611315` tag_id オーバーライドする広告スロットのタグ ID を指定します。 `value`に、強制的に`creative_id`するtag_idを入力します。広告スロットとクリエイティブのサイズが一致しない場合、クリエイティブはレンダリングされますが、警告メッセージが表示されます。クリエイティブは、ライブオークションでこの広告スロットに配信されません。クリエイティブ `40611315`で`tag_id 8011968`をオーバーライドするには: `https://test.example.com/demo.html?ast_override_tag_id=8011968:40611315` inv_code オーバーライドする広告スロットのインベントリコードを指定します。 [ `value` に、強制的に `creative_id` するインベントリコードを入力します。広告スロットとクリエイティブのサイズが一致しない場合、クリエイティブはレンダリングされますが、警告メッセージが表示されます。クリエイティブは、ライブオークションでこの広告スロットに配信されません。 `40611315`をオーバーライドするには: クリエイティブ `40611315`を使用します。 `https://test.example.com/demo.html?ast_override_inv_code=9123450:40611315` 先端：上記のクエリ文字列パラメーターは、広告タグの `forceCreativeId` パラメーターで指定された値をオーバーライドします。
`allowSmallerSizes`	ブール型	`sizes`で定義されている広告サイズよりも小さい広告サイズを許可するかどうかを示します。
`allowedFormats`	文字列の配列	目的の形式を示します。オプションには、['video'、'banner'、'native,'audio'] が含まれます。 `allowedFormats`が呼び出されると、Microsoft 収益化のプレースメントの設定に割り当てられているメディアの種類がオーバーライドされます。 `allowedFormats`を呼び出して、定義済みのオプションに含まれていない`interstitials`などの広告形式を使用しないでください。
`rendererOptions`	オブジェクト	カスタムレンダリングのためにレンダラーに渡すことができる 1 つ以上のオプションを指定します。
`position`	String	フォールドの上または下のように配置を識別します。使用可能な値: `above` または `below`。
`disablePsa`	ブール型	この配置で PSA が表示されないようにするかどうかを示します。
`nobidIfUnsold`	ブール型	配置が既定の広告または PSA ではなく販売されていない場合は、空白の広告を返す必要があることを示します。
`keywords`	オブジェクト	この配置に適用できるキーと値のペアのセット。クエリ文字列セグメントは、このオブジェクトのキーと値のペアによって定義されます。ハイフンを含むキーワードは、単一引用符で囲む必要があります。キーワードは常に単一引用符で囲むのがベストプラクティスです。タグごとに最大 100 個のキーと値のペアを定義できます。カスタムデータを渡すには、 `pt1, pt2, pt3, pt4, pt5, pt6, pt7, pt8, pt9`のいずれかのキーワードを使用します。これらのキーワードを使用して、マネージドプレースメントを通じてカスタムデータをマネージドサードパーティのクリエイティブ (たとえば、 `pt1=products:ipad,ios,iphone`) に渡すことができます。
`trafficSourceCode`	String	このインプレッションのサードパーティのソースを指定します。
`alwaysUseXDomainIframe`	ブール型	クロスドメイン iframe に広告クリエイティブを読み込むかどうかを示します。これにより、データ漏洩を防ぎ、クリエイティブが親ページに直接アクセスできなくなります。手記：このパラメーターは、 `enableSafeFrame`を優先して非推奨になりました。
`privateSizes`	数値の配列	カスタム取引またはパッケージに対してのみ提供できる追加のサイズ (取引またはパッケージでプライベートサイズが許可されている場合)。形式では、1 つのサイズに `[300,250]` し、複数のサイズに `[[300,250],[728,90]]` します。
`supplyType`	String	この配置の供給の種類を示します。使用可能な値は、 `mobile_web`、 `mobile_app`、または `web`です。
`pubClick`	String	サードパーティのクリック追跡の発行元が指定した URL を指定します。これは、パブリッシャーが独自のクリックトラッカーを挿入できるプレースホルダーにすぎません。このパラメーターは、エンコードされていないトラッカーに使用する必要があります。このパラメーターは、URL の最後のパラメーターであると予想されます。このパラメーターに配置されたクリックトラッカーは、オークションに勝ったクリエイティブが Xandr クリックトラッキングを適切に使用している場合にのみ発生します。たとえば、「 `pubClick=https://click.adserver.com/` 」のように入力します。
`reserve`	番号	この在庫の予約価格を指定します。このパラメーターは、事前設定された価格をオーバーライドし、Yield Management が使用されていない場合はハードフロアを設定します。価格は発行元の通貨と見なされます。たとえば、「 `reserve=5.00` 」のように入力します。手記：このオプションは Microsoft 収益化では使用できません。また、配置タグに手動で追加する必要があります。
`extInvCode`	String	レポートで使用できる要求本文の `ext_inv_code` フィールドを介して渡される定義済みの値を指定します。この値は、ログに記録される前にシステムに入力する必要があります。詳細については、「外部インベントリコードサービス」を参照してください。たとえば、「 `ext_inv_code='10039'` 」のように入力します。
`native`	オブジェクト	ネイティブ広告は、個々のアセットのコレクションです。タイトル、説明、または画像を指定できます。このパラメーターは省略可能です。 `defineTag`でこれを指定する必要はありません。 `{required:true}`として構成された`native` オブジェクト内のフィールドは、入札応答オブジェクトに必要です。存在しない場合、入札はオークションに追加されません。ネイティブ広告リソースを次に示します。
`externalImpId`	String	外部で生成されたオークションの一意識別子を指定します。たとえば、「 `externalImpId:'bacbab02626452b097f6030b3c89ac05'` 」のように入力します。
`enableSafeFrame`	ブール型	この配置を SafeFrame コンテナーで提供するかどうかを指定します。詳細については、「 SafeFrame API リファレンス」を参照してください。
`setSafeFrameConfig`	ブール型	標準 iframe によって提供される以外の追加のコンシューマー保護と発行元制御を提供するマネージド iframe である SafeFrame の構成を許可します。詳細については、「 SafeFrame API リファレンス」を参照してください。
`initCollapsed`	オブジェクト	広告 iframe を 0 サイズで初期化します。 `expandBy`フィールドの唯一のオプションはクリエイティブです。この設定は、resizeAd 関数を呼び出して広告スロットを拡張する責任をクリエイティブに与えます。
`prebid`	ブール型	要求されるタグがヘッダー入札または事前入札オークション用であることを示します。これにより、adObj `adObj.cpm`の cpm が返されます。ただし、広告はレンダリングされません。この入札が成功した場合、別の広告サーバーが広告をレンダリングすると想定されます。
`usePmtRule`	ブール型	広告サーバーに入札を送信する前に、支払いルールを入札に適用するかどうかを示します。既定値は False です。
`resizeAdParentDiv`	ブール型	このプロパティを true に設定すると、広告クリエイティブの Parent Div コンテナーのサイズが強制的に変更されます。これは、環境によっては親 div のサイズが変更されない場合に、バナーセーフフレームクリエイティブのサイズを変更する場合に特に便利です。既定では、このオプションはオフになっています。手記：ここで設定した値は、resizeAd 呼び出し中にオーバーライドできます。詳細については、「resizeAd ページ」を参照してください。
`globalPlacementId`	String	パブリッシャーが独自のグローバルパブリッシャー識別子を指定して配置を表す方法を提供します。
`renderingManagement`	オブジェクト	広告を Web ページに表示する方法に影響を与える、関連する機能のレンダリングの値を指定するオブジェクト。これらのオプションは setPageOpts レベルで設定して、ページ上のすべての広告スロットに適用することもできます。 - `insertWrapperDiv`: 有効にすると、AST は、メイン AST `utif` div とすべての広告スロットの AST iframe (またはセーフフレーム) コンテナーの間に追加の div 要素を追加します。このオプションは、メイン div コンテナーを変更せずに、広告コンテナーの内容をさらにカスタマイズまたは制御するパブリッシャーに役立ちます。既定値: false - `sandboxAdIframe`: 有効にすると、AST は、適切な `sandboxAttributes` パラメーターの値を使用して、すべての広告スロットの AST iframe (またはセーフフレーム) コンテナーの HTML サンドボックス属性を追加して設定します。既定値: false - `sandboxAttributes`: 適切な `andboxAdIframe` 設定が true に設定されている場合、これらの属性の値は、AST iframe (またはセーフフレーム) 広告コンテナーの HTML サンドボックス属性に適用されます。この配列に含める適切な値については、HTML サンドボックスのドキュメントを参照してください。有効にした場合は、iframe の内容が正しく機能するように、少なくとも `allow-same-origin` と `allow-scripts` を含めておくことをお勧めします (これらの値を省略すると、ブラウザーコンソールで警告が表示されることがあります)。
`rewardedAds`	ブール型	ユーザーが広告を表示するための報酬を受け取るかどうかを示します。既定値は false です。ユーザーが報酬を受け取る場合は true に設定し、それ以外の場合は false に設定します。
`msft_tag`	オブジェクト	Microsoft 固有のデータポイントの一意のフィールドを指定するオブジェクト。サポートされているフィールドの一覧を次に示します。 - `msan_kv`: MSAN に直接渡されるデータの文字列を受け入れます。

ネイティブ広告リソース

習慣

データとイメージという名前の 2 つのサブオブジェクトを含めることができます。これらのプロパティの詳細については、以下を参照してください。

data

次の使用可能なフィールドを持つオブジェクトの配列。

type: <integer> note - 500 を超える必要があります。
required: <true | false>
max_length: <integer>

image

次の使用可能なフィールドを持つオブジェクトの配列。

type: <integer> - 500 を超える必要があります
required: <true | false>
size: {width: <integer>, height: <integer>}
min_size: {width: <integer>, height: <integer>}
mimes: [<string>, <string2>, ...]

title

required: <true | false>

max_length: <number>

入札応答オブジェクトに required: true マークされたフィールドが必要です。 max_lengthが指定されている場合、このフィールドの応答がmax_length数を超えてはなりません。

body

required: <true | false>

max_length: <number>

image

required: <true | false>
sizes: [
{ width: <number>, height: <number> }
]
aspect_ratios: [
{min_width: <number>, min_height: <number>, ratio_width: <number>, ratio_height: <number>}
]

入札応答オブジェクトに required: true マークされたフィールドが必要です。

sizesが指定されている場合、画像応答は指定された幅と高さの寸法と完全に一致する必要があります。

サイズの代わりに aspect_ratios を指定する場合、イメージは少なくとも、定義されている最小の高さ/幅の寸法と aspect_ratios 一致する必要があります。

アイコン

required: <true | false>
sizes: [
{ width: <number>, height: <number> }
]
aspect_ratios: [
{min_width: <number>, min_height: <number>, ratio_width: <number>, ratio_height: <number>}
]

入札応答オブジェクトに required: true マークされたフィールドが必要です。

sizesが指定されている場合、画像応答は指定された幅と高さの寸法と完全に一致する必要があります。

sizesの代替としてaspect_ratiosが指定されている場合、イメージは少なくとも、定義されている最小の高さ/幅の寸法とaspect_ratios値と一致する必要があります。

sponsoredBy

required: <true | false>

max_length: <number>

入札応答オブジェクトに required: true マークされたこのフィールドが必要です。 max_lengthが指定されている場合、このフィールドの応答がmax_length数を超えてはなりません。

cta

required: <true | false>

このフィールドが required: trueマークされている場合は、入札応答オブジェクトにパラメーターが必要です。

clickUrl

required: <true | false>

このフィールドが required: trueマークされている場合は、入札応答オブジェクトにパラメーターが必要です。

privacySupported

<true | false>

true の場合、パブリッシャーはプライバシーリンクをサポートします。プライバシーリンクは、入札応答で発行元に送信されます。

video

required: <true | false>

min_duration: <number>

max_duration: <number>

入札応答オブジェクトに required: true マークされたフィールドが必要です。 min_duration と max_duration の値はミリ秒単位で指定されます。

min_duration default = 0

desc2

required: <true | false>

格付け

required: <true | false>

displayUrl

required: <true | false>

好き

required: <true | false>

ダウンロード

required: <true | false>

価格

required: <true | false>

salePrice

required: <true | false>

格付け

required: <true | false>

phone

required: <true | false>

address

required: <true | false>

例 1

形式：

    
native: {
title: {required: true},
body: {required: false, max_length: 300},
image: {required: true},
icon: {
required: false,
sizes: [{ width: 50, height: 50 }]
},
sponsoredBy: {required: true},
cta: {required: true},
clickUrl: {required: true},
privacySupported: true,
desc2: {required: true},
rating: {required: false},
displayUrl: {required: false},
likes: {required: true},
downloads: {required: false},
price: {required: false},
salePrice: {required: false},
rating: {required: true},
phone: {required: false},
address: {required: false},
    custom: {
        data: [{
            type: 501,
            required: false
        }],
        images: [{
            type: 505,
            required: false
        }]
    }
}

例 2

apntag.defineTag({
        member: 958,
        invCode: 'ABC1234',
    alwaysUseXDomainIframe: true,
    tagId: 123456,
        sizes: [[300,250]],     // only 1 of sizes or sizeMapping is allowed
        sizeMapping: [          // only 1 of sizes or sizeMapping is allowed
        {
            "minWidth": 1024,
                "sizes": [[300,250],[300,600]]
        },
        {
                "minWidth": 400,
                "sizes": [[320,50]]
        }
        ],
        targetId: 'apn_ad_slot_1',
    forceCreativeId: 23456786,
    allowSmallerSizes : true,
        allowedFormats : ['banner', 'video'],
    initCollapsed: { expandBy: 'creative' },
        position : 'above',
        disablePsa : true,
    noBidIfUnsold: true,
    keywords: {
                'genre': ['rock', 'pop']
    },
        trafficSourceCode: 'ssp1', 
    privateSizes : [[300,600]],                          // coming soon
        supplyType : 'mobile_web',
        pubClick : 'http://pubc1.com',           // coming soon
        pubClickEnc : 'http%3A%2F%2Fpubcl.com',  // coming soon
        reserve : 5.01,
        extInvCode : 'extcode1',
    externalImpId: 'bacbab02626452b097f6030b3c89ac05',
    enableSafeFrame: true,
        safeframeConfig: {
                allowExpansionByPush:true,
        allowExpansionByOverlay:true
    },
    rendererOptions: {
                playerTechnology: [
                        "html5",
                        "flash"
                ],
                adText: "Ad",
                showMute: true,
                showVolume: true,
                showProgressBar: true,
                allowFullscreen: true,
                skippable: {
                        videoThreshold: 15,
                        videoOffset: 5,
                        skipLocation: "top-left",
                        skipText: "Video can be skipped in %%TIME%% seconds",
                        skipButtonText: "SKIP"
                }
        },
      
      usePmtRule : false,
      resizeAdParentDiv: true,
      globalPlacementId: 'testId123',
      renderingManagement: {
               insertWrapperDiv: true,
               sandboxAdIframe: true,
               sandboxAttributes: ['allow-same-origin', 'allow-scripts', 'allow-presentation']
              }
        });

次の方法で共有

タグの定義

パラメーター

ネイティブ広告リソース

習慣

data

image

title

body

image

アイコン

sponsoredBy

cta

clickUrl

privacySupported

video

desc2

格付け

displayUrl

好き

ダウンロード

価格

salePrice

格付け

phone

address

例 1

例 2

その他のリソース