入札リクエスト
デマンドパートナーがオークション信号を効果的に解釈して対応できるようにします。
読み終わるまでの所要時間 49 分最終更新 7日前
Unity が広告リクエストを受信すると、SDK は、ユーザーが使用を制限していない場合にパーソナライズ広告に使用されるデータを含む、すべての入札者候補に入札リクエストを送信します (データプライバシーに関するドキュメントを参照)。
Unity は、入札リクエストデータの JSON 形式をサポートしています。標準 JSON 表現の MIME 型は で、HTTP ヘッダーフィールドで以下のように指定します。
application/jsoncontentType: application/jsonAccept-エンコード: gzip
Unity はリクエストで承諾エンコード GZIP 圧縮を送信し、反応を圧縮することを強く推奨します。詳細については、OpenRTB 仕様のセクション 2.4 を参照してください。
request objects
最上位の入札リクエスト オブジェクトには、広告リクエストのグローバルな一意の ID が含まれます。
Attribute | 型 | 例 | 説明 |
|---|---|---|---|
| string | | Unity によって生成された ID。このIDは入札反応オブジェクトで返す必要があります。 |
| object | 詳細については、 | Unityは、入札リクエストごとに1つの |
| object | 詳細については、 | インプレッションに関連する可能性のある、買い手と売り手の間の直接取引のためのプライベートマーケットプレイスコンテナ。実際の取引は、 |
| object | 詳細については、 | プロジェクトまたはアプリケーションを記述するオブジェクト。 |
| object | 詳細については、 | ユーザーのデバイスを示すオブジェクト。 |
| object | 詳細については、データプライバシーに関するドキュメントを参照してください。 | デバイスのユーザー、または広告のオーディエンスを表すオブジェクト。 |
| int | | 使用されるオークションタイプ。Unity Exchange オークションはすべてファースト プライス オークションであるため、値は常に |
| int | | タイムアウト値 (ミリ秒)。 |
| string array | | IAB 分類 ID を使用して、ブロックされた広告主カテゴリ。 |
| string array | | ブロックされたアプリケーションのリスト。特定のプラットフォームで表されます。Android では、これらはバンドル名またはパッケージ名です。iOS では、これらは数値 ID です。 |
| object | 詳細については、 | インベントリソースに関するデータを提供し、どのエンティティが最終決定を行うかを示すオブジェクト。 |
| object | 詳細については、データプライバシー に関するドキュメントを参照してください。 | このリクエストに適用される業界、法律、または政府の規制を指定するオブジェクト。 |
ソースオブジェクト
エクスチェンジからアップストリームの入札リクエストのソースであるエンティティの性質と動作を記述するオブジェクトクラス。このオブジェクトの主な目的は、オークション後または上流の意思決定を定義し、エクスチェンジ自体が最終決定をコントロールしない場合に使用します。詳細については、OpenRTB ガイドラインの「 オブジェクト: ソース 」セクションを参照してください。
Attribute | 型 | 例 | 説明 |
|---|---|---|---|
| string | | タグ支払い ID プロトコル v1.0 で説明されている埋め込み構文を含む支払いチェーン ID 文字列。 |
| object | 詳細は、チェーンオブジェクト のセクションを参照してください。 | このオブジェクトは、サプライチェーンのリンクと、サプライチェーンが完了したかどうかを示すインジケータの両方を表します。 |
| string | | Open Measurement SDK インテグレーションの識別子。これはOMID Partnerオブジェクトの |
| string | | Open Measurement SDK インテグレーションのバージョン。これはOMID Partnerオブジェクトの |
| int | | オークションの種類を示します。1 は入札、0 はウォーターフォールです。 |
| int | | インプレッション販売の最終決定を担当するエンティティ。0 = エクスチェンジ、1 = アップストリームソース。 |
schain オブジェクト
このオブジェクトは、サプライチェーン内のリンクと、サプライチェーンが完了したかどうかを示すインジケータの両方を表します。
Attribute | 型 | 例 | 説明 |
|---|---|---|---|
| int | | サイト、アプリケーション、またはインベントリの他の媒体の所有者につながるトランザクションに関連するすべてのノードがチェーンに含まれているかどうかを示すフラグ。
|
| オブジェクト配列 | 例が必要 | チェーンの順に並べた |
| string | | 使用されているサプライチェーン仕様のバージョン。 |
ノード オブジェクト
トランザクションサプライチェーンに関与するエンティティを表すオブジェクト。
Attribute | 型 | 例 | 説明 |
|---|---|---|---|
| string | | 入札者が接続するシステムのドメイン名。これは、システムの運用ドメインである可能性があります (親企業ドメインと異なる場合)。これは、 |
| string | | 広告システム内の売り手またはリセラーアカウントに紐づけられた ID。これは OpenRTB トランザクションで使用される値と同じ値を含む必要があります。これは通常、 |
| string | | この売り手によって発行されたリクエストの OpenRTB |
| int | | このノードがインベントリの支払いフローに関与しているかどうかを示します。
|
imp objects
オークションに出品されるアドインプレッションを記述するオブジェクトクラス。
Attribute | 型 | 例 | 説明 |
|---|---|---|---|
| object | 詳細については、 | バナーディスプレイインプレッションを記述するオブジェクト。 |
| float | | このインプレッションを獲得するために必要な最小 CPM 入札額。米ドルで表されます。 |
| string | | 広告のレンダリングを担当する広告メディエーションパートナー、SDK テクノロジー、またはプレイヤーの名前。 |
| string | | 広告のレンダリングを担当する広告メディエーションパートナー、SDK テクノロジー、またはプレイヤーのバージョン。 |
| string | | Unity は入札リクエストごとに 1 つの |
| int | | バナー広告リクエストの値は |
| int | | Unity では、インプレッションに安全な |
| string | | Unity は識別子として |
| object | 詳細は、ビデオオブジェクト のセクションを参照してください。 | 動画インプレッションを記述するオブジェクト。 |
| object | 詳細については、iOS 14 のサポート に関するドキュメントを参照してください。 | DSP がパブリッシャーアプリ |
| 整数 | | SKOverlay 特徴の適格性を示します。
|
| 整数 | | カスタムプロダクトページ特徴の適格性を示します。
|
| 整数 | | 自動ストアキット特徴の適格性を示します。
|
video objects
動画アドインプレッションを記述する オブジェクト クラスのサブセット。詳細については、OpenRTB 仕様のセクション 3.2.7 を参照してください。
impressionAttribute | 型 | 例 | 説明 |
|---|---|---|---|
| int 配列 | | このインプレッションでサポートされる API フレームワーク。値 |
| int 配列 | | ブロックされたクリエイティブ属性の配列。サポートされている値の完全なリストについては、OpenRTB 仕様 の 表 5.3 を参照してください。 |
| int | | ビデオプレイヤーの高さ。単位はデバイス非依存ピクセル (DIPS)。 |
| int | | 動画広告の最大継続時間(秒単位)。この値は常に |
| string array | | サポートされているコンテンツ MIME タイプ ( |
| int | | 動画広告の最小継続時間(秒単位)。この値は常に |
| int | | Unity でサポートされているビデオ配置タイプは次のとおりです。
|
| int | | ビデオ広告の位置。Unity Ads インベントリは常に全画面( |
| int 配列 | | サポートされているビデオ プロトコルの配列。サポートされている値の完全なリストは、OpenRTB 仕様 の 表 5.8 を参照してください。 |
| int | | ビデオプレイヤーの幅 (デバイス非依存ピクセル、DIPS)。 |
| int 配列 | | ( |
| int | | インプレッションがリニアかどうかを示します。Unity Exchange の場合、この値は常に です |
| int | | 動画をスキップできるかどうかを示します。
Unity Exchange の場合、この値は常に です |
| int | | 同じ入札リクエストで複数の広告インプレッションが提供される場合は、シーケンス番号を使用して複数のクリエイティブを連携して配信できます。Unity Exchange の場合、この値は常に です |
バナー objectsバナー
バナーアドインプレッションを記述する オブジェクト クラスのサブセット。詳細については、OpenRTB 仕様のセクション 3.2.6 を参照してください。
impressionAttribute | 型 | 例 | 説明 |
|---|---|---|---|
| int 配列 | | パブリッシャーがサポートするバナー API フレームワーク。UnityはMRAID 3.0( |
| int 配列 | | ブロックされたバナー属性の配列。サポートされている値の完全なリストについては、OpenRTB 仕様 の 表 5.3 を参照してください。
|
| object array | | サポートされているバナーディスプレイサイズを表すオブジェクトの配列 バナークリエイティブ形式対応サイズ:
ディスプレイリエイティブ形式がサポートするサイズ:
|
| int | | バナー ディスプレイの高さ(デバイス非依存ピクセル(DIPS)単位)。 |
| int | | バナー広告の位置。サポートされている値の完全なリストについては、OpenRTB 仕様 の 表 5.4 を参照してください。 |
| int | | バナーディスプレイの幅(デバイス非依存ピクセル(DIPS)単位)。 |
pmp objects
インプレッションに関連する可能性のある買い手と売り手間の直接取引のプライベートマーケットプレイス属性を記述するオブジェクトクラス。詳細については、OpenRTB 仕様のセクション 3.2.11 を参照してください。
Attribute | 型 | 例 | 説明 |
|---|---|---|---|
| object array | 詳細については、 | このインプレッションに適用される特定の取引を示す |
| int | |
|
deal オブジェクト
買い手と売り手の間に確立された特定の取引を示すオブジェクトクラス。そのインプレッションの存在は、その取引の条件の下でインプレッションが利用可能であることを示します。詳細については、OpenRTB 仕様のセクション 3.2.12 を参照してください。
Attribute | 型 | 例 | 説明 |
|---|---|---|---|
| int | | 入札リクエストのオークション タイプの任意のオーバーライド:
|
| string | | 直接取引の一意の識別子。 |
アプリケーションオブジェクト
広告リクエストを行うアプリケーションを記述するオブジェクトクラス。詳細については、OpenRTB 仕様のセクション 3.2.14 を参照してください。
Attribute | 型 | 例 | 説明 |
|---|---|---|---|
| string | Google の例: Apple の例: | アプリケーション バンドルまたはパッケージ名。Exchange 全体で一意の名前です。
|
| string | | 取引所固有のアプリケーション ID。 |
| string | | アプリケーション名。 |
| object | | エクスチェンジ固有のパブリッシャー ID。 |
| string | | インストールされたアプリケーションのストア URL(QAG 1.5 準拠の場合)。 この属性は、パブリッシャーとの契約上の合意によって禁止されている状況では渡されません。 |
パブリッシャーオブジェクト
広告リクエストを行うパブリッシャーを記述するオブジェクトクラス。詳細については、OpenRTB 仕様のセクション 3.2.15 を参照してください。
Attribute | 型 | 例 | 説明 |
|---|---|---|---|
| string | | エクスチェンジ固有のパブリッシャー ID。 |
デバイス objects#デバイス
終了ユーザーのデバイスを示すオブジェクトクラス。詳細については、OpenRTB 仕様のセクション 3.2.18 を参照してください。
Attribute | 型 | 例 | 説明 |
|---|---|---|---|
| int | | ネットワーク接続タイプ。サポートされている値の完全なリストについては、OpenRTB 仕様の表 5.22を参照してください。 |
| int | | デバイスの一般的なタイプ。サポートされている値の完全なリストについては、OpenRTB 仕様 の 表 5.21 を参照してください。 携帯電話とタブレットの分離は OpenRTB バージョン 2.2 で導入されました。
|
| object |
| デバイスの位置データ (ユーザーの現在位置を想定):
|
| string | | デバイスのハードウェアバージョン。 |
| string | | 消去の状態で広告主による使用が認められている Android Advertising ID(AID)または iOS Identifier for Advertisers(IFA/IDFA)。 |
| string | | デバイスの IP アドレス。 |
| string | | ブラウザー言語。ISO-639-1-アルファ-2 コードを使用します。 |
| int | | 商業的に認められている「追跡型広告制限」信号。
Unity は |
| string | | デバイスのメーカー |
| string | | デバイスのモデル |
| string | | デバイスのオペレーティングシステム |
| string | | デバイスのオペレーティングシステムのバージョン。 |
| string | | ウェブブラウザーのユーザーエージェント文字列 |
| string | | デバイスのサービスプロバイダー。 |
入札リクエストの例
VAST 入札リクエスト
{ "id": "bcaIDT1Nbv0zU8mn9tXQ6j", "at":1, "tmax":200, "source": { "pchain":"12abcd3456789:12345" "omidpn":"Unity3d", "omidpv":"1.3.0" }, "imp": [{ "id": "1", "secure":1, "instl":1, "tagid": "com.unity3d.ads.example-vast", "bidfloor":3.95, "video": { "mimes": [ "video/mp4","application/javascript" ], 「minduration」:5, "maxduration":30, "placement":5 "protocols": [2, 3, 5, 6], "pos":7, "battr": [1, 3, 5, 8, 9, 13], "w":1024, "h":600, "api": [7], "companiontype": [1,2,3] } "displaymanager": "unity sdk", "displaymanagerver":"4001", "ext": { "skadn": { "ext": { "ask":1 }, "skoverlay":1, "productpage":1 } } }], "app": { "id": "d01234idnfld234ier6c70930a", "name": "ビルド A タウン:すべてのゲーム", "publisher": { "id": "11972001l" }, "bundle":"12312312399", "storeurl": "https://apps.apple.com/us/app/build-a-town/id12312312399" }, "device": { "ifa": "ab12c456-78de-90f1-ghi2-j3kl4567890m", "make":"Apple", "model": "iPhone", "ua":"Mozilla/5.0 (iPhone、Mac OS X のような CPU iPhone OS 10_0) AppleWebKit/602.1.50 (Gecko のような KHTML) モバイル/14A345" "os": "ios", "ip": "12.34.5.6", "devicetype":4, "carrier":"Apple", "osv":"10.1", "hwv": "iphone6", "geo": { "lat":55.5492, "lon":59.0456, "country": "USA", "city":"サンフランシスコ", "type":2, "utcoffset":180 }, "connectiontype":3, "language": "en", "h":1184, "w":768 }, "regs": { "coppa":0 }}
バナー入札リクエスト
{ "id": "bcda7938-14eb-4a46-8dcb-bcd7587a964f", "imp": [ { "id": "1", "banner": { "w":320, "h":50, "battr": [ 1, 3, 5, 6, 8, 9, 13 ] }, "pmp": {}, "displaymanager": "unity sdk", "displaymanagerver":"3200", "tagid": "com.unity3d.ads.opstool-banner", "bidfloor":3.95, "secure":1 } ], "app": { "id": "2aa377f91oo12398465d6af383", "name": "ゲームの例:第二章」 "publisher": { "id": "189857700" }, "bundle": "com.devexample.thegamebundlename", "storeurl": "https://play.google.com/store/apps/details?id=com.devexample.thegamebundlename\u0026hl=en" }, "device": { "ua":"Mozilla/5.0 (Linux; Android 9; ピクセル ビルド/PQ3A.190705.001; wv) AppleWebKit/537.36 (Gecko のような KHTML) Version/4.0 Chrome/75.0.3770.101 モバイル Safari/537.36", "geo": { "lat":37.7958, "lon": -122.4203, "type":2, "country": "USA", "region":"CA", "city":"サンフランシスコ", "utcoffset": -480 }, "ip": "4.14.109.3", "devicetype":4, "make":"Google", "model":"Pixel", "os": "android", "osv":"9.0", "hwv":"Google Pixel", "w":320, "h":50, "language": "en", "connectiontype":2, "ifa": "d0a77d1b-e974-41f3-84c5-8fe75718ef2d" }, "at":1, "tmax":500, "regs": { "ext": {} }, "ext": { "sessionDepth":1 }}
Playable bidリクエスト
{ "id": "abcIDT1Def0zU8mn9gHI6j", "source": { "pchain":"12abcd3456789:12345" }, "imp": [{ "id": "1", "banner": { "w":1024, "h":768, "battr": [1, 3, 5, 6, 8, 9], "pos":7, "api": [5] }, "displaymanager": "unity sdk", "displaymanagerver":"4000", "instl":1, "tagid": "com.unity-game.trashdash-m3-ios-display", "bidfloor":3.95, "secure":1 }], "app": { "id": "d01234idnfld234ier6c70930a", "name": "ビルド A タウン:すべてのゲーム", "publisher": { "id": "11972001l" }, "bundle":"12312312399", "storeurl": "https://apps.apple.com/us/app/build-a-town/id12312312399" }, "device": { "ifa": "ab12c456-78de-90f1-ghi2-j3kl4567890m", "ua":"Mozilla/5.0 (iPad、Mac OS X のような CPU OS 11_2_2) AppleWebKit/604.4.7 (Gecko のような KHTML) モバイル/15C202" "geo": { "lat":55.5492, "lon":59.0456, "country": "USA", "city":"サンフランシスコ", "type":2, "utcoffset":180 }, "ip": "12.34.5.6", "devicetype":5, "model": "iPad5,3", "os": "ios", "osv":"11.2.2", "hwv": "iPad Air 2 (Wi-Fi)", "h":768, "w":1024, "language": "en", "connectiontype":2 }, "at":1, "tmax":200, "regs": {}, "ext": {} }
インタースティシャルディスプレイ入札リクエスト
{ "id": "ApJv9QAmN3FJjEcTtFDtW3", "imp": [{ "id": "1", "banner": { "w":480, "h":320, "format": [ {"w":250,"h":300}, {"w":300,"h":250}, {"w":480,"h":320}, {"w":320,"h":480} ], "battr": [1, 3, 5, 6, 8, 9, 13], "pos":7, "api": [5] }, "displaymanager": "unity sdk", "displaymanagerver":"3750", "instl":1, "tagid": "com.unity3d.ads.example-display", "bidfloor":3.95, "secure":1 }], "app": { "id": "2aa377f91oo12398465d6af383", "name": "ゲームの例:第二章」 "publisher": { "id": "189857700" }, "bundle": "com.devexample.thegamebundlename", "storeurl": "https://play.google.com/store/apps/details?id=com.devexample.thegamebundlename\u0026hl=en" }, "device": { "ua":"Mozilla/5.0 (Linux、Android 5.1.1、SM-J200H ビルド/LMY48B、wv) AppleWebKit/537.36 (Gecko などの KHTML) バージョン/4.0 Chrome/64.0.3282.137 モバイル Safari/537.36" "geo": { "lat":55.5492, "lon":59.0456, "country": "USA", "city":"サンフランシスコ", "type":2, "utcoffset":180 }, "source": { "pchain":"12abcd3456789:12345" }, "ip": "12.34.5.6", "devicetype":4, "make": "samsung", "model":"SM-J200H", "os": "android", "osv":"5.1", "hwv": "samsung SM-J200H", "h":540, "w":960, "language": "ru", "carrier":"Tele2", "connectiontype":2, "ifa": "dd92e219-68ae-43b9-bcb7-e6fb7557806e" }, "at":1, "tmax":200, "regs": {}, "ext": { "placementType":"nonrewarded", "Mute":false, "gameCategory":"Applications", "subGameCategory":"Tools", "sessionDepth":0 }}