--- metadata: - name: generator content: Diplodoc Platform v5.50.3 alternate: - https://yandex.com/dev/rtb/doc/en/api/mobile/response.md - https://yandex.com/dev/rtb/doc/ru/api/mobile/response.md --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/rtb/doc/en/llms.txt # Mobile advertising. DSP Response The proposal to participate in an auction is sent using the POST method in JSON format (Content-Type: application/json). ## Response body The response body contains the `Bid Response` object shown below. {% note alert %} Tracking pixels must support HTTPS. {% endnote %} ```json { "id": "(string)", "cur": "(string)", "seatbid": [ { "seat": "(string)", "bid": [ { "impid": "(string)", "id": "(string)", "price": "(float)", "adid": "(string)", "adomain": [ "(array of strings)" ], "bundle": "(string)", "payload": "(string)", "cid": "(string)", "crid": "(string)", "lurl": "(string)", "nurl": "(string)", "burl": "(string)", "attr": [ "(array of strings)" ], "adm": "(string)", "w": "(int)", "h": "(int)" "ext": { "nroa": { "erid": "(string)", "has_nroa_markup": "(int)", "client": { "inn": "(string)", "legal_form": "(string)", "name": "(string)" "mobile_phone": "(string)", "epay_number": "(string)", "reg_number": "(string)", "alternative_inn": "(string)", "oksm_number": "(string)" } }, "skadn": { "campaign": "(string)", "fidelities": [ { "fidelity": "(int)", "nonce": "(string)", "signature": "(string)", "timestamp": "(string)" } ], "itunesitem": "(string)", "network": "(string)", "sourceapp": "(string)", "version": "(string)" }, "storeurl": "(string)" } } ] } ] } ``` ## Response parameters ### Bid Response object #| || **Parameter** | **Description** | **Required** || || id | Auction ID obtained from the RTB host. | yes || || cur | Currency that the bid is shown in: `Seatbid.Bid.price` parameter. Acceptable values: - RUB — Russian ruble; - USD — United States dollar; - EUR — Euro; - CHF — Swiss franc; - TRY — Turkish lira; - KZT — Kazakhstani tenge. | yes || || seatbid | Array of `Seatbid` objects. Contains bids for impressions. | yes || |# ### Seatbid object #| || **Parameter** | **Description** | **Required** || || seat | ID of the auction participant making a bid. | yes || || bid | Array of `Seatbid.Bid` objects. Each object contains banner parameters and a bid for impressions. | yes || |# ### Seatbid.Bid object #| || **Parameter** | **Description** | **Required** || || impid | ID of the `Imp.id` object of the ORTB host request. | yes || || id | ID of the ad unit on the HTML page, obtained from the ORTB host. | yes || || price | Bid — The price for impressions that the DSP agrees to. Specified per 1000 impressions. | yes || || adid | The banner ID in the DSP. | yes || || adomain | The domain of the advertiser whose ad is contained in the DSP response. Only one value is allowed in the array. | yes || || bundle | App ID in the App Store or Google Play. | no || || payload | JSON received from the DSP. Up to 1024 characters. Can be transferred in a [Bid Loss Notification](https://yandex.com/dev/rtb/doc/en/api/bid-loss-notification.md). | no || || cid | Ad campaign ID on the DSP side. | yes || || crid | ID of the ad unit on the HTML page, obtained from the ORTB host. | no || || nurl | URL called when winning an auction. | no || || burl | URL called when debiting funds for a paid event. | no || || attr | A set of creative parameters. | no || || adm | In banner ads: HTML code of the creative to be directly embedded on the page. May contain [macros](https://yandex.com/dev/rtb/doc/en/api/macros.md) that will be replaced when rendering a creative. In native advertising: contains an encoded string with the `Seatbid.Bid.Adm.Native` object. See [Response example](#native-example). In video ads: XML code to be embedded in the player. May contain [macros](https://yandex.com/dev/rtb/doc/en/api/macros.md) that will be replaced when rendering a creative. Contains an object in VAST format. | no || || w | Width of the block in pixels. | yes || || h | Height of the block in pixels. | yes || || ext | Object with additional parameters. | no || || lurl | URL called when losing an auction. | no || || cat | IAB content categories for creative. | no || || iurl | Link to an image from the campaign content to check the quality and safety of the ad. | no || || protocol | Supported video protocol. | no || |# ### Seatbid.Bid.Adm.Native object #| || **Parameter** | **Description** | **Required** || || ver | Native Markup version. | no || || assets | The `Seatbid.Bid.Adm.Native.Assets` object with asset parameters. | no || || eventtrackers | The `Seatbid.Bid.Adm.Native.Eventtrackers` object with event tracking parameters. | no || || link | The `Seatbid.Bid.Adm.Native.Link` object with a link in the ad. | yes || || privacy | Privacy terms. 1 — Native advertising contains a privacy notice for the user; 0 — No privacy notice. | no || || ext | The `Seatbid.Bid.Adm.Native.Ext` object with additional parameters. | no || |# ### Seatbid.Bid.Adm.Native.Assets object #| || **Parameter** | **Description** | **Required** || || id | Asset ID. | yes || || required | Flag indicating whether the asset is mandatory. 1 — Required asset; 0 - Optional asset. | no || || title | The `Seatbid.Bid.Adm.Native.Assets.Title` object with asset title parameters. | yes || || img | The Seatbid.Bid.Adm.Native.Assets.Img object with asset image parameters. | no || || data | The Seatbid.Bid.Adm.Native.Assets.Data object with asset content parameters. | no || |# ### Seatbid.Bid.Adm.Native.Assets.Title object #| || **Parameter** | **Description** | **Required** || || text | Ad title text. | yes || |# ### Seatbid.Bid.Adm.Native.Assets.Img object #| || **Parameter** | **Description** | **Required** || || w | Image width. | yes || || url | A link to an image. | yes || || h | Image height. | yes || |# ### Seatbid.Bid.Adm.Native.Assets.Data object #| || **Parameter** | **Description** | **Required** || || value | Ad text. | yes || |# ### Seatbid.Bid.Adm.Native.Link object #| || **Parameter** | **Description** | **Required** || || url | A link in the ad. | yes || |# ### Seatbid.Bid.Adm.Native.Eventtrackers object #| || **Parameter** | **Description** | **Required** || || event | The event being tracked. | yes || || method | Event tracking method. | yes || || url | Event link. | no || |# ### Bid.ext object #| || **Parameter** | **Description** | **Required** || || nroa | The parent object for the extension | no || || skadn | The parent object for the SKAdNetwork. | no || || storeurl | Initial app store url for the app to which a transition will be made. | no || |# ### nroa object #| || **Parameter** | **Description** | **Required** || || erid | ERID | no || || has_nroa_markup | Whether the creative includes labeling according to the legislation. Possible values: `0` or `1`. | no || || client | Information about the customer under the original contract. | no || || initial_contract | Information about the customer under the original contract. | no || || contractor | Information about the contractor under the original contract. | no || || parent_contracts | List of “parent” contracts. If the client's original contract has the “additional agreement” type, information about the corresponding source contract must be transmitted | Mandatory for additional agreements || |# ### Client object #| || **Parameter** | **Description** | **Required** || || inn | TIN of an individual or a legal entity. | no || || legal_form | Organization type from the “List of organization types”. | no || || name | Legal form and name. | no || || mobile_phone | Phone number. Filled in for foreign individuals and legal entities in accordance with the requirements of the state register. | no || || epay_number | Bank account number or electronic wallet number or similar, except bank card number. | no || || reg_number | Registration number or its equivalent. Filled in for foreign individuals and legal entities in accordance with the requirements of the state register. | no || || alternative_inn | Taxpayer's number or its equivalent in the country of registration. Filled in for foreign individuals and legal entities in accordance with the requirements of the state register. | no || || oksm_number | The code of the legal entity's country of registration under the Russian classifier of world countries (OKSM). Filled in for foreign legal entities in accordance with the requirements of the state register. | no || |# ### skadn object #| || **Parameter** | **Description** | **Required** || || campaign | Campaign ID compatible with Apple’s spec. As of version 2.0, this must be an integer between 1 and 100, formatted as a string. | no || || fidelities | Supports multiple fidelity types introduced in SKAdNetwork v2.2. | no || || itunesitem | Advertiser app ID in Apple’s App Store. This must match `Bid.bundle` in the `Bid Response`. | no || || network | Ad network identifier used in signature. This must match one of the items in the `skadnetids` array in the request. | no || || sourceapp | ID of publisher app in Apple’s App Store. This must match `Imp.Ext.Skadn.Sourceapp` in the bid request. | no || || version | Version of desired SKAdNetwork. | no || || ext.ask | Scenario ID for AutoStoreKit. | нет || |# ### fidelities object #| || **Parameter** | **Description** | **Required** || || fidelity | The fidelity-type of the attribution to track. | no || || nonce | An ID that is unique to each ad response. Refer to Apple's documentation for the proper [UUID](https://developer.apple.com/documentation/storekit/skstoreproductparameteradnetworknonce) format requirements. | no || || signature | SKAdNetwork signature specified by Apple. | no || || timestamp | Unix time in milliseconds at the time the signature was generated. | no || |# ### Asset parameters for native advertising #| || **Asset ID** | **Asset Name** | **Description** | **Data Type** | **Asset Type** | **Restriction** || || 1 | Title | A title with a description related to the advertised product or service | String | Mandatory | up to 140 characters || || 2 | Main image | The primary banner to be displayed | Img | Mandatory | minimum 150x150 || || 5 | Description | Additional text related to the advertised product or service | String | Recommended | up to 140 characters || || 9 | display_url | The display domain or bundle to which a transition will be made. | String | Recommended | up to 50 characters || || 10 | CTA | Call to Action placed on a clickable button | String | Recommended | up to 15 characters || || 11 | Icon | An additional icon (favicon) for the advertisement of mobile applications. Often matches the icon from the app store. | Img | Recommended | minimum 50x50 || |# ## Response example banner — ads ```json { "id": "5834842956793170835", "cur": "RUB", "units": 1, "seatbid": [ { "seat": "dsp-partner-global", "bid": [ { "impid": "10", "id": "615b146ecf3275146cde449d4b3eb400", "traceid": "615b146ecf3275146cde449d4b3eb400", "price": 4.82, "adid": "36124_", "adomain": [ "farfetch.com" ], "bundle": "906698760", "payload": "S-W20CMRLJqbBxuJp5nDf4scTFpFmUejZDcxNc_lEAhP4FBLi1-DOr4b2WIPPnVLEEU8ecbxIyGuMqyAAZMCnEmGz970qCCZb87fFc6CpFdG5wXVjGcymKgImpgfNYUS-f0A9uSSvk1GYWt_Ya_2_DoVlnp26CI5_hTBEvKqRHb6jNhkK_N9N0GaoC9u-nSW998Yq7HbnsrrhcdHXcyuBGqAUlIE52NQT-UR_I12QFvJ7_CPrjyZiiYgmjeosnSy0dlBV7cL5cysMHlNKiNZB77GcfZaQamE7c4DdbdDf_9FQXZeujvbua5EXdkK0Nsh2lamig04JOnrBpILg-NJepHavjIHAhw3YhCKnWyTDygmXKWv3MVse3VyvuUarLOeDqhUSyAN3aX5Xqo2SzE9V1088glfO3e7RtH5Dugv-pQc0Wvkqq1dkg", "cid": "185338", "crid": "36124_", "lurl": "http://rtb.nl.eu.dsp-partner.com/yandexortb/auction/notify?profile=270&imp=S-W20CMRLJqbBxuJp5nDf4scTFpFmUejZDcxNc_lEAhP4FBLi1-DOr4b2WIPPnVLEEU8ecbxIyGuMqyAAZMCnEmGz970qCCZb87fFc6CpFdG5wXVjGcymKgImpgfNYUS-f0A9uSSvk1GYWt_Ya_2_DoVlnp26CI5_hTBEvKqRHb6jNhkK_N9N0GaoC9u-nSW998Yq7HbnsrrhcdHXcyuBGqAUlIE52NQT-UR_I12QFvJ7_CPrjyZiiYgmjeosnSy0dlBV7cL5cysMHlNKiNZB77GcfZaQamE7c4DdbdDf_9FQXZeujvbua5EXdkK0Nsh2lamig04JOnrBpILg-NJepHavjIHAhw3YhCKnWyTDygmXKWv3MVse3VyvuUarLOeDqhUSyAN3aX5Xqo2SzE9V1088glfO3e7RtH5Dugv-pQc0Wvkqq1dkg&st=${AUCTION_LOSS}", "nurl": "http://rtb.nl.eu.dsp-partner.com/yandexortb/auction/notify?profile=270&imp=W1g6Zz8k8fjYsF8C2ymvB1GoWyc3csS1z9KYruC7_YZH5gP5mTxeH2ufjxoAIqCgBs7ZQS4ALh2rXGarcrrm6OAALRdhsCRx5QBiN99rLMqXkTBrG3KwOOHalRN0NSoJkJwXOANLLnpwWNkoWzD41vy_HmJvOBdWbo0VExtzMSteNYmOf8D4YIUhUbgQhpS3xArd593WM5a8ls3Qwxa60hHzETu4zx12dzzujI1QQOpyyQph4KrXb_PUBCcgUlE4Kept1fPqQ0f9zibVv5GudzFdw70UUMW3B3O5HQSIhlQuB5uIUYdnjoXIORzKBP1YQSIxGGA-uFY_1igRWXEkgRpgG_IBOFmBHxA9SkMR9P-k3Ta0-MWzpONYDBXARmA9a6eW-xWVJchKlWk2eDNWMvMoa43xEtIUM05jKX5sU6OUsZQNtg78Ww", "burl": "https://rtb.nl.eu.dsp-partner.com/yandexortb/auction/notify?profile=270&imp=yYeYv3VyrghjGRIW8gfr_a-PhH6wlEbGFj31O6wZJkxwzp7pa32MVoEsUqGI5nBbOm7ClCNF5yDLshDuDt2cF_sSZY3LCxizheTizCFYgf3eL_AJ397DdkrA3qq9QrPRJH4boFyVDJVGGfQ26vfKfDDMMUxkuW2fHKOyo2toeBkO7CjveZB7iB9P4IgMlnSO6psgLG8KUKtk8HIQHeNFdKG5SBMvm1vhZ2Y4nGBqyXbHYDCWfFjF0qImeCEKrL2pvWM3VXojYU5CuS-svs3h3vLnghHCOWhST0Cn3mnmM_5aLjfsJ0C_T0gNX6QCf7N4LPfxIcFQtBiZsJ13w0aocjVw83KAWcPUSlVfwRZm-Lixe0LDtkdU_Ujo4_GaAM3vPME5XSCahRpLjjFQon9ypdwlXUXMXDmZg-Uo8zbnxA6A2GWLdkBbtw", "attr": [], "adm": "", "w": 300, "h": 300, "ext": { "nroa": { "erid":"efr23i", "has_nroa_markup":0, "client":{ "inn":"71445203", "name":"Company", "legal_form":"ul" } }, "skadn": { "campaign": "11", "fidelities": [ { "fidelity": 0, "nonce": "f9f8be1b-a396-4ff6-95e5-b50508caa18", "signature": "MDUCGQD4bhRqyMk2lcz3/mi0943580485038Owgcz9tcS8acHhxMxqJ0K6P968spxQ==", "timestamp": "1730704281000" }, { "fidelity": 1, "nonce": "a5914e5b-4f06-4278-bc39-d0550678ff72", "signature": "MDUCGH9mfWRIErBnitWx2/Vsx809485034858340VSXgsVCh2BHUXXvq54XcT/2qyaBYkw==", "timestamp": "1730704280000" } ], "itunesitem": "911804296", "network": "w9q455wk68.skadnetwork", "sourceapp": "6471572249", "version": "3.0" }, "storeurl": "https://apps.apple.com/app/id1579364157" } } ] } ] } ``` ## Response example — native advertising ```json { "bidid": "353776", "cur": "USD", "id": "4413312110307915961", "seatbid": [ { "bid": [ { "adid": "native_123", "adm": "{\"native\":{\"ver\":\"1.2\",\"link\":{\"url\":\"https://app.name.com/somepath\"},\"assets\":[{\"id\":1,\"title\":{\"text\":\"Покупай только у нас!\"}},{\"id\":2,\"img\":{\"url\":\"https://content.com/somepath.png\",\"w\":150,\"h\":150}},{\"id\":5,\"data\":{\"value\":\"Скидка 450 ₽ на первый заказ от 1 500 ₽ по промо «PROMO»\"}},{\"id\":9,\"data\":{\"value\":\"play.google.com\"}},{\"id\":10,\"data\":{\"value\":\"Установить\"}},{\"id\":11,\"img\":{\"url\":\"https://content.com/somepath/icon.png\",\"w\":50,\"h\":50}}],\"eventtrackers\":[{\"event\":1,\"method\":1,\"url\":\"https://dspname.com/imp/somepath\"},{\"event\":1,\"method\":1,\"url\":\"https://impression.appsflyer.com/somepath\"}]}}", "adomain": [ "sbermarket.ru" ], "bundle": "ru.instamart", "cat": [ "IAB8" ], "cid": "native_1", "crid": "native_123", "id": "353776", "impid": "178", "iurl": "https://content.com/somepath.png", "price": 0.27445, "ext": { "nroa": { "erid":"efr23i", "has_nroa_markup":0, "client":{ "inn":"71445203", "name":"ООО Неваляшка", "legal_form":"ul" } }, "skadn": { "campaign": "11", "fidelities": [ { "fidelity": 0, "nonce": "f9f8be1b-a396-4ff6-95e5-b50508caa18", "signature": "MDUCGQD4bhRqyMk2lcz3/mi0943580485038Owgcz9tcS8acHhxMxqJ0K6P968spxQ==", "timestamp": "1730704281000" }, { "fidelity": 1, "nonce": "a5914e5b-4f06-4278-bc39-d0550678ff72", "signature": "MDUCGH9mfWRIErBnitWx2/Vsx809485034858340VSXgsVCh2BHUXXvq54XcT/2qyaBYkw==", "timestamp": "1730704280000" } ], "itunesitem": "911804296", "network": "w9q455wk68.skadnetwork", "sourceapp": "6471572249", "version": "3.0" }, "storeurl": "https://apps.apple.com/app/id1579364157" } } ] } ] } ``` ## Response example — video ads ```json { "bidid": "9218750a64d68fb3ae3b8d5d849c9d63", "cur": "RUB", "id": "2071435468055052649", "seatbid": [ { "bid": [ { "adid": "6256ab117bc72f01b40e8af5", "adm": "dspname00:00:13", "adomain": [ "kontur.ru" ], "burl": "https://dssa.dspname.ai/openrtb/bil/182/?r=9547351836376329&sid=__33_6hb3sm9y5hrusrs1d8u8tcbnanpjo589b4ytsazxhofsdt8cys6d4dbgxj4bx1kidt947484roits&adid=__33_p4dcrkpsgddfbr4ssyjbtjspp6u5y5yxnot9gmd8yb9cbice99qm1k6y61hw7qdteek9xzr3hur6q&p=${AUCTION_PRICE}", "cat": [ "IAB3" ], "cid": "6256aae67bc72f01b40e8ae8", "crid": "6256ab117bc72f01b40e8af5", "exp": 7200, "ext": {}, "id": "1e66c5dda15e8ae37bbb2f8f62d87575", "impid": "14", "iurl": "https://content.dspname.ai/dspname/BB/48/BB486A4504ED516F956E78DBAFFED661.mp4", "nurl": "https://dssa.dspname.ai/openrtb/video2/182/?r=9547351836376329&sid=__33_6hb3sm9y5hrusrs1d8u8tcbnanpjo589b4ytsazxhofsdt8cys6d4dbgxj4bx1kidt947484roits&adid=__33_p4dcrkpsgddfbr4ssyjbtjspp6u5y5yxnot9gmd8yb9cbice99qm1k6y61hw7qdteek9xzr3hur6q&p=${AUCTION_PRICE}&adm=False", "payload": "1e66c5dda15e8ae37bbb2f8f62d87575", "price": 55, "protocol": 7, "ext": { "nroa": { "erid":"efr23i", "has_nroa_markup":0, "client":{ "inn":"71445203", "name":"Company", "legal_form":"ul" } }, "skadn": { "campaign": "11", "fidelities": [ { "fidelity": 0, "nonce": "f9f8be1b-a396-4ff6-95e5-b50508caa18", "signature": "MDUCGQD4bhRqyMk2lcz3/mi0943580485038Owgcz9tcS8acHhxMxqJ0K6P968spxQ==", "timestamp": "1730704281000" }, { "fidelity": 1, "nonce": "a5914e5b-4f06-4278-bc39-d0550678ff72", "signature": "MDUCGH9mfWRIErBnitWx2/Vsx809485034858340VSXgsVCh2BHUXXvq54XcT/2qyaBYkw==", "timestamp": "1730704280000" } ], "itunesitem": "911804296", "network": "w9q455wk68.skadnetwork", "sourceapp": "6471572249", "version": "3.0" }, "storeurl": "https://apps.apple.com/app/id1579364157" } } ] } ] } ``` ## Example of an attribute for marking ad. The attribute is added to the XML code from `seatbid.bid.adm`: ```json ... https://example.com/... ```