ironSource Exchange OpenRTB 2.5 specs
OpenRTB 2.5の仕様に従って、DSPまたは広告プラットフォームをIronsource Exchangeに接続し、プログラマティック広告を購入します。
読み終わるまでの所要時間 26 分最終更新 8日前
入札リクエスト
リクエストオブジェクト
パラメーター | Type (タイプ) | 常にパス | 説明 |
|---|
| String | はい | 入札リクエストの一意の ID。この ID は入札反応オブジェクトで返す必要があります。 |
| オブジェクト | はい | ironsource は、入札リクエストごとに 1 つのインプレッションオブジェクトをサポートします。インプレッション を参照してください。 |
| integer | はい | 使用されるオークションの種類。Ironsource はファーストプライスオークションのみをサポートします。 |
| オブジェクト | はい | アプリケーション説明。アプリケーション を参照してください。 |
| オブジェクト | はい | デバイス説明。デバイス を参照してください。 |
| オブジェクト | はい | ユーザー説明。ユーザー を参照してください。 |
| integer | はい | ironsource で入札を受信できる最大時間(ミリ秒)。 |
| 文字列配列 | はい | IAB コンテンツカテゴリを使用してブロックされた広告主カテゴリ。 |
| 文字列配列 | いいえ | ドメインごとの広告主のブロックリスト |
| 文字列配列 | いいえ | アプリケーションのブロックリスト。Android では、バンドル名またはパッケージ名 (例えば com.foo.mygame) にする必要があります。iOS では、これらは数値 ID です。 |
| オブジェクト | はい | インベントリソースに関するデータを提供し、どのエンティティが最終決定を行うかを示すソースオブジェクト。 |
| オブジェクト | はい | このリクエストに適用される業界、法律、または政府の規制を指定する Regs オブジェクト。 |
| オブジェクト | いいえ | OpenRTB に対する Ironsource 固有の拡張のプレースホルダー。 |
インプレッションオブジェクト
パラメーター | Type (タイプ) | 常にパス | 説明 |
|---|
| String | はい | ironsource は、入札リクエストごとに 1 つのインプレッションオブジェクトをサポートします。 |
| オブジェクト | ビデオのみ | オブジェクトは、動画インプレッションを記述するために使用されます。ビデオ を参照してください。 |
| オブジェクト | ディスプレイ専用 | オブジェクトは、ディスディスプレイインプレッションを記述するために使用されます。バナー を参照してください。 |
| integer | いいえ | 1 = 広告はインタースティシャルまたは全画面、0 = 非インタースティシャル。 |
| integer | はい | ironsource では、インプレッションに安全な HTTPS URL クリエイティブアセットとマークアップが必要です。 |
| オブジェクト | はい | プライベートマーケットプレイス取引を含む Pmp オブジェクトは、このインプレッションに効果を発揮します。 |
| Float | はい | CPM で表されたこのインプレッションの最小入札額。 |
| String | はい | ironsource は米ドルのみを受け入れます |
| オブジェクト | いいえ | OpenRTB に対する Ironsource 固有の拡張のプレースホルダー。 |
Video オブジェクト
パラメーター | Type (タイプ) | 常にパス | 説明 |
|---|
| 文字列配列 | はい | コンテンツ MIME タイプがサポートされています。 |
| integer | はい | 動画広告の最小継続時間(秒単位)。 |
| integer | はい | 動画広告の最大継続時間(秒単位)。 |
| int 配列 | はい | サポートされているビデオ プロトコルの配列 |
| integer | はい | ビデオプレイヤーの幅 (デバイス非依存ピクセル、DIPS)。 |
| integer | はい | ビデオプレイヤーの高ささ (デバイス非依存ピクセル、DIPS)。 |
| integer | はい | インプレッションの配置タイプ。 |
| integer | はい | プレイヤーがビデオのスキップを許可するかどうかを示します。 |
| int 配列 | はい | ブロックされたクリエイティブ属性。 |
| integer | はい | 使用されている再生方法 |
| integer | はい | 画面上の広告位置。 |
| int 配列 | はい | このインプレッションでサポートされる API フレームワークのリスト |
| integer | はい | リクエストが動画リワード広告単位に対するものであるかどうかを示します。1 = はい、0 = いいえ |
バナーオブジェクト
パラメーター | Type (タイプ) | 常にパス | 説明 |
|---|
| integer | はい | ビデオプレイヤーの幅 (デバイス非依存ピクセル、DIPS)。 |
| integer | はい | ビデオプレイヤーの高ささ (デバイス非依存ピクセル、DIPS)。 |
| integer | はい | 画面上の広告位置。 |
| int 配列 | はい | ブロックされたバナー広告タイプ。 |
| int 配列 | はい | ブロックされたクリエイティブ属性。 |
| int 配列 | はい | このインプレッションでサポートされる API フレームワークのリスト |
複数のサイズが許可されている場合に使用します。
パラメーター | Type (タイプ) | 常にパス | 説明 |
|---|
| integer | はい | ビデオプレイヤーの幅 (デバイス非依存ピクセル、DIPS)。 |
| integer | はい | ビデオプレイヤーの高ささ (デバイス非依存ピクセル、DIPS)。 |
アプリケーション オブジェクト
パラメーター | Type (タイプ) | 常にパス | 説明 |
|---|
| String | はい | ironsource 固有のアプリケーション ID |
| String | はい | プラットプラットフォーム固有のアプリケーション識別子。Android では、これはバンドル名またはパッケージ名である必要があります (例えば、com.foo.mygame)。iOS では通常、数値 ID です。 |
| String | はい | アプリケーション名 |
| String | はい | アプリストア URL |
| 文字列配列 | はい | アプリケーションの IAB コンテンツカテゴリ |
デバイス オブジェクト
パラメーター | Type (タイプ) | 常にパス | 説明 |
|---|
| String | はい | ブラウザーユーザーエージェント文字列。 |
| オブジェクト | はい | Geo オブジェクトで定義されたユーザーの現在の場所と仮定されたデバイスの場所/ |
| integer | はい | 「追跡型広告制限」信号。0 = 追跡は制限なし、1 = 商用ガイドラインごとに追跡を制限する必要があります。 |
| String | はい | デバイスに最も近い IPv4 アドレス。 |
| integer | はい | デバイスの一般的なタイプ。 |
| String | はい | デバイス make。 |
| String | はい | デバイス モデル。 |
| String | はい | 操作システム |
| String | はい | オペレーティングシステムのバージョン |
| String | はい | language 文字列 ISO-639-1-アルファ-2 を使用するブラウザー言語。 |
| integer | はい | ネットワーク接続タイプ |
| String | はい | 広告主による消去での使用が許可された ID (例えばハッシュ化されていないなど) |
| String | はい | (iOS のみ)1 人の開発者によってすべてのアプリケーションに割り当てられるベンダーの識別子。ifa フィールド形式に一致する ifv としてリストされます。 |
| integer | はい | (iOS のみ)アプリケーションのトラッキング承認状態を表します。0 = 未確定 1 = 制限 2 = 拒否 3 = 承認済み |
ユーザーオブジェクト
パラメーター | Type (タイプ) | 常にパス | 説明 |
|---|
| String | はい | ユーザーの Ironsource 固有の ID |
| Float | はい | 特定のアプリケーションセッションにおける特定の配置のインプレッション数。インプレッション深度はセッションの終了時にリセットされます。 |
ソースオブジェクト
パラメーター | Type (タイプ) | 常にパス | 説明 |
|---|
| オブジェクト | はい | Sellers.json 情報を含む Schain オブジェクト |
| オブジェクト配列 | はい | パブリッシャーのアプリケーション Sellers.json 情報 |
| 整数 | はい | ウォーターフォールのタイプを示します。1 = 入札、0 = インスタンス |
Regs オブジェクト
パラメーター | Type (タイプ) | 常にパス | 説明 |
|---|
| String | はい | リクエストがGDPR規制の対象となるかどうかを指定します。 |
Geo オブジェクト
パラメーター | Type (タイプ) | 常にパス | 説明 |
|---|
| Float | はい | -90.0 ~ +90.0 の緯度。負の値は南緯です。 |
| Float | はい | -180.0 から +180.0 までの経度 (負の値は西) |
| 整数 | はい | 場所データのソース |
| 整数 | はい | IPアドレスからジオロケーションを判別するために使用するサービスまたはプロバイダー(該当する場合) |
| String | はい | ISO-3166-1-アルファ-3.3166-1-アルファ-3 を使用する ISO-Country コードを使用する国コード |
| String | はい | ISO-3166-2 を使用する地域コード。米国の場合は 2 文字の状態コード。 |
| String | はい | Google Metro コード。 |
| String | はい | 貿易および輸送場所の国連コードを使用する市。 |
| String | はい | zip 文字列 ZIP または郵便コード |
入札反応
入札反応オブジェクト
パラメーター | Type (タイプ) | 要件 | 説明 |
|---|
| String | 必須 | ironsource リクエスト ID は入札反応で返す必要があります。 |
| String | 必須 | ironsource は米ドルのみをサポートします。その他の ISO 通貨コードでは、入札反応は無視されます。 |
| String | 推奨 | 入札者が生成した反応 ID で、ロギング/トラッキングに役立ちます。 |
| 整数 | 推奨 | 入札しなかった理由。OpenRTB 2.3 仕様のリスト 5.22 を参照してください。 |
| オブジェクト配列 | 推奨 | 反応では複数の seatbid オブジェクトを使用できますが、Ironsource は現在 1 つの seatbid オブジェクトのみを使用します。選択された seatbid オブジェクトには、bid.id = インプレッション.id が含まれます。 |
シート入札オブジェクト
パラメーター | Type (タイプ) | 要件 | 説明 |
|---|
| オブジェクト配列 | 必須 | ironsource は少なくとも 1 つの入札を期待しました。 |
Bid オブジェクト
パラメーター | Type (タイプ) | 要件 | 説明 |
|---|
| String | 必須 | 入札者がログ/トラッキングに役立つ入札 ID を生成しました。 |
| String | 推奨 | この入札が適用されるインプレッションの ID。この値は、入札リクエストで指定されたインプレッション ID と一致します。 |
| Float | 必須 | CPM での入札価格。0 以下の値は無視されます。 |
| String | 推奨 | 入札がオークションに落札したときに Ironsource によって呼び出される落札通知 URL(配信された広告、視聴された広告、請求可能な広告であるとは限りません)。burl が存在しない場合は、nurl によって置き換えられ、課金通知がレポートされます。 |
| String | 必須 | 落札時に ironsource によって呼び出される課金通知 URL。 |
| String | 推奨 | 入札が失われたことがわかっている場合に、Ironsource によって呼び出される落札通知 URL。Ironsource は、最終オークションに落札するために必要な最低入札額を示す マクロをサポートしています。 |
| String | 推奨 | 広告品質チェックに役立つキャンペーン ID。 |
| String | 推奨 | 広告品質チェックに役立つクリエイティブ ID。 |
| String | 必須 | 入札が落札された場合に必要な広告マークアップの伝達手段。 |
| 文字列配列 | 必須(bid.bundle=nullの場合) | ブラックリストチェック用の広告主ドメイン |
| String | 必須(bid.adomain=nullの場合) | プラットプラットフォーム固有のアプリケーション識別子。Android では、これはバンドル名またはパッケージ名である必要があります (例えば、"com.foo.mygame")。iOS では通常、数値 ID です。 |
| 文字列配列 | 推奨 | クリエイティブの IAB コンテンツカテゴリ。 |
| 整数配列 | 推奨 | クリエイティブを説明する属性のセット。 |
| 整数 | 必須 | デバイス非依存ピクセル(DIPS)でのクリエイティブの幅。 |
| 整数 | 必須 | クリエイティブの高ささ (デバイス非依存ピクセル、DIPS)。 |
入札反応なし
入札者は、Ironsource内で「入札なし」と見なされる以下のいずれかで応答できます。以下のいずれかの反応を使用して、インプレッションに入札しない信号を明示的に送信することが重要です。そうしないと、反応がタイムアウトエラーとして解釈される可能性があります。
入札なし(例えば、需要なし、インプレッションの購入に関心なし):
- HTTP 204 コンテンツなし
- 空の JSON オブジェクト:"{}"
- 適切な形式の入札拒否反応(NBR):
{"id": "1234567890", "seatbid": \[\]}
No bid due to a issue (問題による入札なし)
- 適切な形式の入札拒否反応:
{"id": "1234567890", "seatbid": \[\], "nbr": 2}
- nbr に使用できる問題コードのリストは次のとおりです。
値 | 説明 |
|---|
| 0 | 不明なエラー |
| 1 | 技術的なエラー |
| 2 | 無効なリクエスト |
| 3 | 既知のウェブクモ |
| 4 | 人以外の交通の疑い |
| 5 | 負荷、データセンター、またはプロキシ IP |
| 6 | サポートされていないデバイス |
| 7 | ブロックパブリッシャー |
| 8 | 一致しないユーザー |
入札リクエストとレスポンスの例
ビデオ入札リクエスト
{ id: "1627786837177779624\_a5850b20-f274-11eb-947b-0ded24f22667\_237775956\_client\_name", imp: \[ { id: "1", video: { MIME: \[ "video/mp4", "video/3gpp", "application/x-mpegURL" \], まゆ:1, maxduration:120, protocols: \[ 2, 5, 3, 6 \], w:480, h:320, 配置 (プレースメント):5, skip: 0, playbackmethod: \[ 5 \], pos:7, api: \[ 7 \], companiontype: \[ 1, 2 \], ext: { リワード:1 } }, pmp: { deals: \[ { id: "104v4ahb53bb5800016dqa9a", bidfloor:8, bidfloorcur:"USD" } \] }, displaymanager: "ironsource", bidfloor:8, bidfloorcur:"USD", セキュリティ:1 } \], app: { id: "113551", name: "ジェットパックジョイライド", bundle:"457446957", storeurl: "https://itunes.apple.com/app/id457446957", cat: \[ "IAB9" \], publisher: { id: "146249", name: "Halfbrick Studios Pty Ltd" } }, デバイス: { ua:"Mozilla/5.0 (iPhone; CPU iPhone OS 14\_7\_1 Mac OS X など) AppleWebKit/605.1.15 (KHTML、Gecko など) モバイル/15E148" geo: { lat:41.7405, lon: \-87.6587, type (タイプ):2, ipservice:3, 国:"USA", region (地域):"IL", メトロ:"602", 市:"シカゴ", zip:"60620" }, lmt:0, ip:"74.93.69.246", devicetype:4, make:"Apple", model: "iPhone13,2", os: "ios", osv:"14.7.1", language: "es", connectiontype:2, ifa:"01234567-89ABCDEF-01234567-89ABCDEF", ext: { acceptLang: "es-xl", atts:3 } }, user: { id: "01234567-89ABCDEF-01234567-89ABCDEF" }, 場所:1, tmax:996, bcat: \[ "IAB23", "IAB25", "IAB26", IAB8-18 IAB8-5 "IAB9-9", IAB11-4 IAB14-1 IAB14-3 IAB17-16 IAB9-7 "IAB7-39", IAB3-7 IAB18-5 \], badv: \[ "bigo.tv" \], ソース: { ext: { omidpn:"Ironsrc", omidpv:"7", schain: { ver:"1.0", complete (完了):1, nodes: \[ { asi: "ironsrc.com", sid:"146249", hp:1, rid:"1627786837177779624\_a5850b20-f274-11eb-947b-0ded24f22667\_237775956\_client\_name", name: "Halfbrick Studios Pty Ltd", domain: "halfbrick.com" } \] } } }, "regs": {}}
ディスプレイ入札リクエスト
{ id: "1627791578182182085\_af5e8df0-f27f-11eb-9a60-f72fd6932f89\_1452093813\_client\_name\_b", imp: \[ { id: "1", banner: { w:320, h:480, btype: \[ 1, 4 \], battr: \[ 3, 6, 7, 8, 9, 14, 10 \], pos:7, api: \[ 5, 3, 7 \] }, displaymanager: "ironsource", instl:1, bidfloor:1.6, bidfloorcur:"USD", セキュリティ:1 } \], app: { id: "318613", name: "地下鉄サーファー (非 COPPA)", bundle: "com.kiloo.subwaysurf", storeurl: "https://play.google.com/store/apps/details?id=com.kiloo.subwaysurf", cat: \[ "IAB9" \], publisher: { id: "235297", name: "SYBO Games" } }, デバイス: { ua:"Mozilla/5.0 (Linux、Android 6.0.1、SM-G532M ビルド/MMB29T、wv) AppleWebKit/537.36 (Gecko などの KHTML) バージョン/4.0 Chrome/92.0.4515.115 モバイル Safari/537.36" geo: { lat:19.3617, lon: \-98.2338, type (タイプ):2, ipservice:3, 国:MEX region (地域):"TLA", メトロ:"0", 市:"Tlaxcala City", zip:"90000" }, lmt:0, ip:"189.167.5.112", devicetype:4, make: "samsung", モデル:"SM-G532M", os: "android", osv:"6.0.1", js:1, language: "es", connectiontype:2, ifa:"01234567-89ABCDEF-01234567-89ABCDEF" }, user: { id: "01234567-89ABCDEF-01234567-89ABCDEF" }, 場所:1, tmax:998, bcat: \[ "IAB23", "IAB25", "IAB26", IAB8-18 IAB8-5 "IAB9-9", IAB11-4 IAB14-1 IAB14-3 IAB17-16 IAB9-7 "IAB7-39", IAB3-7 IAB18-5 \], badv: \[ "caliente.mx", "yoox.com" "wine.com.br" \], ソース: { ext: { omidpn:"Ironsrc", omidpv:"7", schain: { ver:"1.0", complete (完了):1, nodes: \[ { asi: "ironsrc.com", sid:"235297", hp:1, rid:"1627791578182182085\_af5e8df0-f27f-11eb-9a60-f72fd6932f89\_1452093813\_client\_name\_b", name: "SYBO Games", domain: "sybogames.com" } \] } } }, "regs": {}}
{ id: "1627783392367073418\_a03b6950-f26c-11eb-a9af-31ac778e44a2\_1539835153\_client\_name", imp: \[ { id: "1", banner: { 形式: \[ { w:320, h:50 }, { w:300, h:50 } \], w:320, h:50, pos:5, api: \[ 5, 3 \] }, displaymanager: "ironsource", tagid:"2708683", bidfloor:0.0128, bidfloorcur:"USD", セキュリティ:1 } \], app: { id: "353553", name: "タイル Connect - クラシック一致ゲーム", bundle:"1529839083", storeurl: "https://itunes.apple.com/app/id1529839083", cat: \[ "IAB9" \], publisher: { id: "249491", name: 株式会社ヒッグステクノロジー } }, デバイス: { ua:"Mozilla/5.0 (iPhone、Mac OS X のような CPU iPhone OS 14\_6) AppleWebKit/605.1.15 (Gecko のような KHTML) モバイル/15E148" geo: { lat:39.9357, lon: \-75.1832, type (タイプ):2, ipservice:3, 国:"USA", region (地域):「PA」 メトロ:"504", 市:"Philadelphia" zip:"19146" }, lmt:0, ip:"76.98.251.72", devicetype:4, make:"Apple", model: "iPhone9,2", os: "ios", osv:"14.6.0", language: "en", connectiontype:2, ifa:"01234567-89ABCDEF-01234567-89ABCDEF", ext: { acceptLang: "en-us", atts:3 } }, user: { id: "01234567-89ABCDEF-01234567-89ABCDEF" }, 場所:1, tmax:996, bcat: \[ "IAB23", "IAB25", "IAB26", IAB8-18 IAB8-5 "IAB9-9", IAB11-4 IAB14-1 IAB14-3 IAB17-16 IAB9-7 "IAB7-39", IAB3-7 IAB18-5 \], badv: \[ "gratonresortcasino.com" \], ソース: { ext: { schain: { ver:"1.0", complete (完了):1, nodes: \[ { asi: "ironsrc.com", sid:"249491", hp:1, rid:"1627783392367073418\_a03b6950-f26c-11eb-a9af-31ac778e44a2\_1539835153\_client\_name", name: "株式会社ヒッグステクノロジー", domain: "higgsgamestudio.com" } \] } } }, "regs": {}}
大規模な入札反応
{ id: "1543190416705343377\_ip-172-31-13-147\_41965ed0-f10e-11e8-b7cd-fd40aa7b8b5f", seatbid: \[ { bid: \[ { id: "opp\_100", impid: "opp\_100", price:15, adm:"VAST\_XML", adomain: \[ "AD\_DOMAIN" \], cid:"6b3gxrn", crid: "aqgwb3x7" } \], シート:"2821" } \], cur:"USD"}
ディスプレイ インタースティシャル入札反応
{ id: "1543190412223390473\_ip-172-31-13-147\_3eea9fc0-f10e-11e8-9915-1beb61037050", seatbid: \[ { bid: \[ { id: "46-45347979-4f8b-4547-8376-2cea2c3ac12a-1", impid: "opp\_100", price:9.9906, nurl:"NURL\_PIXEL", adm:クリエイティブ、 adomain: \[ "" \], cid:"143354", crid:"46\_10304614", dealid:"20135c3f564b7bd7dd138a480427a69f", w:320, h:480, ext: { agency\_name:"NAME": } } \], シート:"6" } \], cur:"USD"}
{ id: "1617285225335329365\_ad0f3240-92f1-11eb-9667-c36f23277c0b\_client-banner", seatbid: \[ { bid: \[ { id: "b0f43c8b-d009-4cb2-adb5-1c2782400b35", impid: "opp\_100", price:0.51, nurl:"NURL\_PIXEL", burl:"BURL\_PIXEL", adm:"CREATIVE\_ADM", adomain: \[ "" \], crid:"123456789", w:320, h:50 } \] } \], cur:"USD"}