ページ オプションを設定する
この関数は、ページ レベルのオプションの配置を設定します。
setPageOpts ({parameters})
次に示すパラメーターは、関数内の引数として送信できます。
パラメーター
パラメーター | 型 | 説明 |
---|---|---|
dsa |
object | デジタル サービス法 (DSA) と組み合わせて設定を指定する オブジェクト。 以下の詳細については、「DSA オブジェクト」を参照してください。 |
msft |
object | Microsoft に固有の要求値を含む オブジェクト。 以下の「MSFT オブジェクトの詳細」を参照してください。 |
member |
番号 | メンバー ID。 |
publisherId |
番号 |
publisherId は、インベントリ コードを使用するときに使用できます。 これにより、適切な発行元を使用して、正しい既定の配置を選択できます。 |
user |
object | 外部ユーザーに関する情報を指定する オブジェクト。 以下の 「ユーザー オブジェクト の詳細」を参照してください。 |
keywords |
object | このページのすべての広告スロットに適用できるキーと値のペアのセット。 クエリ文字列セグメントは、このオブジェクトのキーと値のペアによって定義されます。 ハイフンを含むキーワードは、単一引用符で囲む必要があります。 キーワードは常に単一引用符で囲むのがベスト プラクティスです。 最大 100 個のキーと値のペアをページ レベルで定義できます。 各タグには、最大 100 個の追加のキーと値のペアを定義できます。 |
disablePsa |
ブール型 | すべての配置で PSA の表示を無効にするかどうかを示します。
true の値を指定すると、すべての PSA がグローバルに無効になります。 |
device |
object | Xandr 入札要求に入力されたデバイスの種類を宣言してオーバーライドする複合オブジェクト。 以下の 「デバイス オブジェクト の詳細」を参照してください。 |
enableSafeFrame |
ブール型 | すべての広告を SafeFrame コンテナーに配信するかどうかを指定します。 詳細については、「 SafeFrame API リファレンス」を参照してください。 |
app |
object | アプリ情報を設定する複雑なオブジェクト。 アプリケーションに関連する情報を保持するオブジェクトです。 以下の 「アプリ オブジェクトの詳細」を 参照してください。 |
consentManagement |
object | グローバル プライバシー プラットフォーム、GDPR、ePrivacy ディレクティブを使用して、米国の州のプライバシー法に基づく透明性、通知、選択/同意の要件に準拠するために同意管理を有効にするかどうかを指定します。 同意管理は既定で有効になっています。 以下の「 同意管理オブジェクトの 詳細」を参照してください。 |
auctionTimeout |
番号 | 入札者が入札要求に応答するまで待機する時間 (ミリ秒単位)。 |
geoOverride |
object | IP ベースの地理的位置をオーバーライドする機能を提供します。 以下の 「Geo オーバーライド オブジェクト の詳細」を参照してください。 |
schain |
object | パブリッシャーが広告サーバーに対して行った要求に対してサプライ チェーン オブジェクトを指定できるようにします。 サプライ チェーン オブジェクト スペックとその構造の詳細については、次のリンクを参照してください。 - https://iabtechlab.com/sellers-json/ - https://github.com/InteractiveAdvertisingBureau/openrtb/blob/master/supplychainobject.md |
us_privacy |
string |
IAB CCPA コンプライアンス フレームワークの要件に準拠する文字列。 以下のこのフィールドのコード サンプルを参照してください。 警告: このパラメーターは、将来非推奨になる予定です。 |
pageUrl |
string | このフィールドは、AST を使用してアプリに広告を表示するプログレッシブ Web アプリをサポートするように設定されています。 開発フレームワークでは無効な参照元が生成され、IQ ルールによってブロックされます。 iOS アプリで AST を使用する発行元は、既定のページ URL 参照元情報 (通常は AST によって派生) を、ページを最もよく表していると思われる HTTP 値にオーバーライドするには、このフィールドを設定する必要があります。 この機能は、主に、参照元情報に一般的な HTTP ページ URL が反映されていない可能性があるモバイル環境向けに設計されています。 この機能は、AST タグが iOS アプリ Web ビュー内に読み込まれたときにのみアクティブになります。 |
trackingManagement |
object | オークションやクリエイティブに関連する関連機能 (視認性、ユーザー同期など) を追跡するための値を指定するオブジェクト。 以下の 「TrackingManagement オブジェクトの 詳細」を参照してください。 |
renderingManagement |
object | 広告を Web ページに表示する方法に影響を与える、関連する機能のレンダリングの値を指定するオブジェクト。 以下の「 RenderingManagement オブジェクトの 詳細」を参照してください。 |
content |
object | 広告が表示されるコンテンツに関する情報を指定する オブジェクト。 以下の詳細については、「 コンテンツ オブジェクト 」を参照してください。 |
オブジェクト
アプリ オブジェクト
アプリケーションに関する情報を指定します。
パラメーター | 型 | 説明 |
---|---|---|
appid |
object | アプリケーション識別情報を定義する オブジェクト。 |
次に例を示します:
apntag.setPageOpts({
app: {
appid: 'com.mypackage.myapp'
}
});
DSA オブジェクト
デジタル サービス法に関連する情報を指定します。各フィールドで使用する理想的な値については、IAB 仕様を参照してください。
パラメーター | 型 | 説明 |
---|---|---|
dsarequired |
番号 | DSA 情報を使用可能にする必要があるかどうかを示すフラグ。 |
pubrender |
番号 | パブリッシャーが DSA 透過性情報をレンダリングするかどうかを示すフラグ。 |
transparency |
オブジェクトの配列 | ユーザー パラメーターと、適用したパラメーターを適用したエンティティのオブジェクトの配列。 |
MSFT オブジェクト
Microsoft に固有の情報と設定を指定します。
パラメーター | 型 | 説明 |
---|---|---|
toptout |
番号 | エンド ユーザーの MSFT オプトアウトの選択の状態を表す数値 (例: 0 、 1 など) |
Schain オブジェクト
AST の機能を使用すると、パブリッシャーは config パラメーターで指定したチェーンに対してオプションの構文チェックを実行できます。 構文の条件は、schain オブジェクトの IAB 仕様に基づいています。
- 発行元が strict オプションを有効にした場合、構成の schain オブジェクトが正確にチェックされ、構造体にエラーがある場合、AST からのエラー メッセージがコンソールにスローされ、schain オブジェクトは広告サーバーへの要求に含まれません。
- パブリッシャーがリラックス オプションを有効にすると、config schain オブジェクトがチェックされます。 問題が発生した場合は、ブラウザー コンソールに警告メッセージが表示されますが、schain オブジェクトは引き続き広告サーバーへの要求に含まれます。
- パブリッシャーが off オプションを有効にした場合、config schain オブジェクトはまったくチェックされません。 正しく書式設定されているかどうかに関係なく、広告サーバーへの要求に含まれるだけです。
注:
コンソールでメッセージを表示するには、AST デバッグ フラグを有効にする必要があります。
次に例を示します:
schain: {
validation: 'strict', // strict, relaxed, or off - strict is default
config: {
ver: '1.0',
complete: 0,
nodes: [{
asi: 'testasi.com',
sid: 'test123sid',
hp: 1
}]
}
}
User オブジェクト
広告を表示する外部ユーザーに関する情報を指定します。
パラメーター | 型 | 説明 |
---|---|---|
age |
番号 | ユーザーの年齢。 |
dnt |
ブール型 | フラグを追跡しないでください。 このオークションで追跡 Cookie を無効にする必要があるかどうかを示します。 - true (Cookie を無効にする)- false (既定値)注: dnt:true すると、外部 UID または Xandr UUID の送信に関係なく、ユーザー データはオークション全体で使用できなくなります。 ID は LLD で -1 として表示され、オプトアウトが表されます。 |
externalUid |
string | このユーザーの外部ユーザー ID に対応する文字列を指定します。 警告: externalUid は、Cookie レス環境でのみ使用する必要があります。 それ以外のアプリケーションでは、ユーザーの一致率が低下し (リターゲットに影響を与える)、および/または時間の経過と同時にユーザー ブロックリストが増加する可能性があります。 |
gender |
string | ユーザーの性別を指定します。 - 0 :不明- 1 :男性- 2 :女性 |
language |
文字列 | このユーザーの言語の 2 文字の ANSI コード。たとえば、 EN 。 |
segments |
数値の配列 | ユーザーがメンバーであるセグメントを指定します。 |
userIds |
オブジェクトの配列 | userId パラメーターを保持するオブジェクトを含む配列。 定義については、以下の 「ユーザー ID オブジェクト の詳細」を参照してください。 |
coppa |
ブール値 | 有効にすると、オークション要求に対する coppa フラグが含まれます。 |
ユーザー ID オブジェクト
パラメーター | 型 | 説明 |
---|---|---|
id |
string | Cookie またはプラットフォームのネイティブ識別子 |
type |
string | 含まれている ID を提供するプロバイダーのソース値。 サポートされている ID ソリューション: - criteo : criteo の ID ソリューション。- liveramp : Liveramp の ID ソリューション。- netid : ヨーロッパのクロスデバイス対応広告識別子。- ttd : トレード デスク 1.0 ID ソリューション。- uid2 : uid2 ID ソリューション。 |
extendedIDs |
type | 発行元が定義したファースト パーティ ID。 |
eids |
オブジェクトの配列 | eids 値は extendedIDs 型にのみ準拠しています (他のすべての定義済み型では、上記で定義した既存の ID 文字列を使用する必要があります)。 この eids 配列内のオブジェクトには、id と source という 2 つのパラメーターがあります。 - id : 目的と説明の既存の ID 値と同じです。 - source : 発行元がファースト パーティ ID を処理するために使用するソースまたはテクノロジ プロバイダー。一般にドメインとして表現されます。 以下の例を参照してください。 |
収益化でユニバーサル ID を渡す
マップされた識別子メソッド (古い) または extendedIDs
メソッド (新しい) のいずれかを使用して、AST.js
を通じてユニバーサル ID を収益化に渡すことができます。
マップされた識別子メソッド
このメソッドを使用すると、限られた数の ユニバーサル ID を渡すことができます。 サポートされている ID の一覧は、 AST.js
コードでハードコーディングされます。
ユニバーサル ID がサポートされている型の中にある場合は、このメソッドを使用します。
JSON の例
{
"type": "liveramp",
"id": "0d7e95c7-4783-4278-acf9-99809d0c5a61"
}
ExtendedIDs
方式
extendedIDs
メソッドは柔軟性が高く、すべてのユニバーサル ID とパブリッシャー提供識別子 (PPID) をサポートします。 識別子を動的に渡すには、このメソッドを使用します。
JSON の例
{
"type": "extendedIDs",
"eids": [
{
"source": "liveramp.com",
"id": "2d7e95c7-4783-4278-acf9-99809d0c5a62"
}
]
}
この例では次のようになっています。
-
source
は、ユニバーサル ID を管理するドメインまたはプロバイダーです。 -
id
は、ソースによって提供される識別子です。
extendedIDs
メソッドは、現在および将来のすべてのユニバーサル ID 形式に推奨されます。 さまざまなファースト パーティ ID ソリューションを処理するパブリッシャーに柔軟性を提供します。
適切な方法を選択する
- マップされた識別子メソッドは、ユニバーサル ID がレガシ
AST.js
マッピングでサポートされている場合にのみ使用します。 - より広範な互換性と将来の証明のために、
extendedIDs
メソッドを使用します。
注:
現在および将来のすべての ID ソリューションとの互換性を確保するために、 extendedIDs
メソッドへの移行を計画できます。
Device オブジェクト
広告を表示するモバイル デバイスを指定します。
パラメーター | 型 | 説明 |
---|---|---|
deviceId |
object | デバイス識別情報を定義する オブジェクト。には、次のパラメーターが含まれています。 - idfa : iOS 6 以降を実行している iOS デバイスの Apple アドバタイズ識別子。- aaid : Google Play サービスから取得した Android デバイスの Google 広告識別子。- sha1udid : ANDROID_ID の SHA1 ハッシュ。- md5udid : ANDROID_ID の MD5 ハッシュ。- windowsadid - Windows デバイスの Microsoft アドバタイズ識別子。 |
deviceType |
string | 広告を表示するデバイスの種類 ( phone や tablet など) を指定します。 |
useragent |
文字列 | デバイス ブラウザーからのユーザー エージェント文字列。 |
geo |
object | デバイスの場所を定義する オブジェクト。には、次のパラメーターが含まれています。 - lat : デバイスの緯度 ( 45.5 などの数値)。- lng : デバイスの経度 ( -122.7 などの数値)。- country : デバイスの国。 3 文字の ISO 3166-1 アルファ 3 コードを 使用します。- region : デバイスリージョン。- city : デバイスの市区町村。- zip : デバイスの郵便番号。 |
ip |
string | デバイスの IP アドレス。 |
make |
string | デバイス モデル。たとえば、 Apple 。 |
model |
string | デバイスが作成します。たとえば、 iPhone 。 |
os |
string | デバイス オペレーティング システム。 |
osVersion |
文字列 | デバイス オペレーティング システムのバージョン。 |
carrier |
string | デバイスのキャリア。 |
connectionType |
番号 | 接続の種類: - 0 :不明- 1 : WiFi- 2 : WAN |
mcc |
文字列 | ITU で指定されたモバイル国コード。 |
mnc |
string | ITU によって指定されたモバイル ネットワーク コード。 |
devTime |
番号 | デバイス上の時刻 (UNIX 時刻)。 |
Content オブジェクト
パラメーター | 型 | 説明 |
---|---|---|
language |
string | このユーザーの言語の 2 文字の ANSI コード。 たとえば、「 'EN' 」のように入力します。 |
TrackingManagement オブジェクト
パラメーター | 型 | 説明 |
---|---|---|
native |
object | ネイティブ型に関連する設定を特に含む オブジェクト。 |
native.loadViewabilityScriptAt |
string | 許可される値: - impression - adresponse 既定値: adresponse 広告応答時間は、AST が広告を受信したときに記録されます。 歴史的な設定です。 新しいインプレッション時間は、インプレッション イベントに近づいて記録されます。 これは、ネイティブのビュービリティ メトリックに依存する特定のパブリッシャーにとってより望ましい場合があります。 |
userSync |
object | AST userSync 機能に関連する設定を含む オブジェクト。 |
RenderingManagement オブジェクト
パラメーター | 型 | 説明 |
---|---|---|
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 を含めておくことをお勧めします (これらの値を省略すると、ブラウザー コンソールで警告が表示されることがあります)。 |
userSync オブジェクト
注:
userSync
オブジェクトの詳細については、「ユーザー同期」ページを参照してください。
パラメーター | 型 | 説明 |
---|---|---|
syncEnabled |
ブール値 | オークション終了後に userSync スクリプトを読み込む AST のロジックを有効または無効にします。既定値: true |
syncDelay |
番号 |
userSync スクリプトを読み込む前に、オークション終了後に AST が待機する時間 (ミリ秒単位) を指定します。既定値: 3000 |
publisherId |
番号 | このページのオークションに使用される発行元エンティティの数値識別子。 これには、 userSync スクリプトに渡される値が含まれています。この値は、ダウンストリームの詳細情報を提供します。 |
sellerId |
番号 | このページのオークションで使用される販売者エンティティの数値識別子。 これには、 userSync スクリプトに渡される値が含まれています。この値は、ダウンストリームの詳細情報を提供します。 |
例を次に示します
apntag.setPageOpts({
member: 958,
user: {
age: 25,
externalUid: '10',
userIds: [{ "type": "criteo", "id": "_fl7bV96WjZsbiUyQnJlQ3g4ckh5a1N", }, // Criteo Identifier
{ "type": "ttd", "id": "00000111-91b1-49b2-ae37-17a8173dc36f" }, // Trade Desk Identifier
{ "type": "netid", "id": "999888777" }, // NetID Identifier
{ "type": "liveramp", "id": "AjfowMv4ZHZQJFM8TpiUnYEyA81Vdgg" }, //Liveramps's Identifier
{ "type": "uid2", "id": "234123424" }, //UID2's Identifier
{ "type": "extendedIDs", "eids": [{ "id": "abc123def345", "source": "mySampleDomain.com" }] }, // publisher first party IDs
],
segments: [1, 2],
gender: 0,
dnt: true,
language: 'EN'
}
keywords: {
genre: ['rock', 'pop']
},
disablePsa : true,
enableSafeFrame : true,
device : {
deviceId : {
idfa : 'String',
aaid : 'String',
md5udid : 'String',
sha1udid : 'String'
},
deviceType : 'String',
useragent : 'String',
geo : {
lat : 0.4,
lng : 0.5,
country : 'USA',
region : 'String',
city : 'String',
zip : 'String'
},
ip : 'String',
make : 'String',
model : 'String',
os : 'String',
osVersion : 'String',
carrier : 'String',
connectionType : 0,
mcc : 'String',
mnc : 'String',
devTime : 12345
},
auctionTimeout: 3000,
pageUrl: 'http://www.samplesite.com/testpage.html',
trackingManagement: {
native: {
loadViewabilityScriptAt: 'impression'
},
renderingManagement: {
insertWrapperDiv: true,
sandboxAdIframe: true,
sandboxAttributes: ['allow-same-origin', 'allow-scripts', 'allow-presentation']
},
userSync: {
syncEnabled: true,
syncDelay: 4000,
publisherId: 12345,
sellerId: 123
}
}
});
Geo オーバーライド オブジェクト
このオブジェクトを使用して、オークションの地理情報をオーバーライドします。 指定された国コードと郵便番号を使用して、すべての地理的属性を検索して場所を決定します。
フィールド | 種類 | 説明 |
---|---|---|
countryCode |
string | 必須です。 2 文字の国コード。 |
zip |
string | 必須です。 郵便番号は少なくとも 1 文字にする必要があります。 |
例を次に示します
apntag.setPageOpts({
... // other settings
geoOverride: {
countryCode: 'US',
zip: '10000'
}
})
同意管理オブジェクト
このオブジェクトを使用して、米国の州のプライバシー法、GDPR、ePrivacy ディレクティブ、 IAB の米国プライバシー ユーザー シグナル メカニズム (USP) に基づく透明性、通知、選択/同意の要件に準拠するための同意管理を有効にするかどうかを指定します。これは、現在 、カリフォルニア州消費者プライバシー法 (CCPA) を対象としています。 同意管理は既定で有効になっています。
警告
Xandrは、米国の州のプライバシー法、GDPR、既存のePrivacyディレクティブに基づく透明性、通知、選択/同意の要件を満たすために、グローバルプライバシープラットフォーム(GPP)とIABヨーロッパ透明性同意フレームワーム(IABの米国プライバシーユーザーシグナルメカニズム(USP)を2023年に廃止する予定です。
これは、AST を使用して、上記のポリシーの対象となるリージョン内にあるエンド ユーザーに通知、透明性、選択を行い、必要に応じて同意を Xandr と需要ソースとそのベンダーに Xandr のプラットフォームを通じて通知、透明性、選択を行うパブリッシャー向けのリファレンスです。
このリソースは法的アドバイスとして解釈されるべきではありません。Xandr は、法律や規制の遵守について保証しません。 すべての企業とその個人データの収集、使用、保管が異なるため、GDPR や既存の ePrivacy ディレクティブなど、欧州の規制に基づく義務に関連する独立した法的アドバイスも求める必要があることに注意してください。 あなたの状況に合わせて特別に調整された法的アドバイスを提供できるのは弁護士だけです。 このガイドでは、ビジネスに合わせて調整された法的アドバイスを提供することを目的としたものではありません。または、代替として使用する必要があります。
サービス ポリシーの一部 (購入、販売、およびデータ プロバイダー向け) には、お客様が注意する必要があるプライバシー固有の義務が含まれています。
パラメーター | 型 | 説明 | 既定値 |
---|---|---|---|
disabled |
ブール型 | 同意管理機能を無効にするには、true に設定します。 | False |
timeout |
整数 | CMP が応答するまで待機する時間 (ミリ秒単位)。 | 10000 |
同意管理を無効にする
Xandr には、ユーザーのニーズに応じて、すべての同意管理または個々の同意管理を無効にするオプションが用意されています。
オプション | 例 |
---|---|
すべての同意管理を無効にする | //disables all consent management apntag.setPageOpts({ ... // other settings consentManagement: { disabled: true, timeout: 10000 } }) |
GDPR のみを無効にする | apntag.setPageOpts({ consentManagement: { timeout: 5000, tcf : { disabled: true } } }); |
GPP のみを無効にする | apntag.setPageOpts({ consentManagement: { timeout: 5000, gpp : { disabled: true } } }); |
次に、 consentManagement
が有効になっている場合の GPP と GDPR コンプライアンスをサポートする AST の機能について説明します。
- Load Tags 関数呼び出し中に、AST タグは IAB 準拠の同意管理プラットフォーム (CMP) から同意データのフェッチを試みます。
- AST タグが ImpBus を呼び出す時間になると、同意情報が
/ut
POST
要求に含まれます。 具体的には、同意情報はPOST
のデータ オブジェクトの下に次のように格納されます。
注:
要求作成プロセスは、新しいユーザーが同意情報を完了できるようにするために、上記の実行中に一時停止されます。 プロセスは、指定されたタイムアウト期間 (既定の 10 秒) 後に待機を停止し、要求のビルドを完了します。
gdpr_consent : {
consent_string: 'abc123',
consent_required: true|false
},
us_privacy: "1YNY"
CMP フェッチが失敗するか、タイムアウト期間が経過すると、 consentManagement
コードはブラウザー コンソールに警告メッセージをログに記録し、同意オブジェクトを次の方法でパッケージ化し、説明に従って AST 要求に含めます。
gdpr_consent : {
consent_string: undefined,
consent_required: undefined
},
gpp_sid: [5]
AST が TCF 2.0 を検出すると、CMP によって生成されたイベントに依存します。 同意文字列は、次のいずれかの条件が満たされると取得されます。
生成されたイベントは、
useractioncomplete
またはtcloaded
。生成されたイベントは
cmpuishown
され、purposeOneTreatment
フラグは使用可能な TCF 文字列でtrue
に設定されます。生成される唯一のイベントは
cmpuishown
であり、タイムアウトが発生します。TCF v2.0 では、
gdprApplies
フラグがtrue
に設定され、Purpose One の同意が付与されていない場合、AST は/ut
POST
要求に Cookie を含めなくなります。
グローバル プライバシー プラットフォーム
Xandr は、米国の複数の州のプライバシー法に準拠するために、グローバル プライバシー プラットフォームをサポートしています。 AST が GPP を検出すると、CMP によって生成されたイベントに依存します。 次のいずれかの条件が満たされると、GPP 文字列が取得されます。
- イベント
sectionChange
が発生しました - このイベントは、セクションの状態または内容が変更されるたびに呼び出されます (同意が取得された場合など)。 -
cmpStatus
が読み込まれ、cmpDisplayStatus
が表示されない - これは、CMP コードの読み込みが完了し (スタブ フェーズ外)、CMP がエンド ユーザーに表示されないことを意味します (通常、CMP に事前の同意情報が使用可能であることを意味します)。