-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Native Agents adapter: update bidder doc for accuracy (video support, GDPR) #6681
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
teqblaze
wants to merge
8
commits into
prebid:master
Choose a base branch
from
teqblaze:update-ntvagents-docs
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+240
−8
Open
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
a9fa4e3
updated ntvagents.md according to code
pavlosamonin-a11y ffa9dff
fix(docs): resolve markdownlint MD060/MD047 issues in ntvagents.md
pavlosamonin-a11y 4330496
address review feedback on ntvagents.md
pavlosamonin-a11y f6d412f
Update dev-docs/bidders/ntvagents.md
muuki88 e1aa956
Update dev-docs/bidders/ntvagents.md
muuki88 7501b6b
Update dev-docs/bidders/ntvagents.md
muuki88 5fa24c5
Merge branch 'master' into update-ntvagents-docs
muuki88 6a1c1d4
fix(docs): fix blank-line lint error and complete overview sentence
pavlosamonin-a11y File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,35 +1,276 @@ | ||
| --- | ||
| layout: bidder | ||
| title: Native Agents | ||
| description: Prebid Native Agents Bidder Adapter | ||
| description: Native Agents Prebid Bidder Adapter | ||
| biddercode: ntvagents | ||
| gpp_supported: true | ||
| gpp_sids: usstate_all | ||
| tcfeu_supported: false | ||
| dsa_supported: false | ||
| usp_supported: true | ||
| coppa_supported: true | ||
| schain_supported: true | ||
| deals_supported: false | ||
| floors_supported: true | ||
| fpd_supported: false | ||
| ortb_blocking_supported: false | ||
| schain_supported:true | ||
| dchain_supported:false | ||
| deals_supported:false | ||
| floors_supported:true | ||
| fpd_supported:false | ||
| ortb_blocking_supported:false | ||
|
muuki88 marked this conversation as resolved.
Outdated
|
||
| media_types: banner, video, native | ||
| multiformat_supported: will-bid-on-one | ||
| userIds: all | ||
| pbjs: true | ||
| pbs: true | ||
| pbs_app_supported: true | ||
| prebid_member: false | ||
| safeframes_ok: true | ||
| sidebarType: 1 | ||
| --- | ||
|
|
||
| ## Bid Params | ||
| # Native Agents Bidder Adapter | ||
|
|
||
| The Native Agents bidder enables publishers to monetize their inventory through the Native Agents advertising platform using either **Prebid.js** or **Prebid Server**. | ||
|
|
||
| The adapter supports: | ||
|
|
||
| - Banner | ||
| - Native (OpenRTB Native) | ||
| - Video (Instream & Outstream) | ||
|
|
||
| Native Agents receives bid requests from Prebid, converts them into OpenRTB requests, executes an auction across eligible demand partners, and returns the highest qualifying bid to Prebid. | ||
|
muuki88 marked this conversation as resolved.
Outdated
|
||
|
|
||
| # Registration | ||
|
|
||
| Before integrating the Native Agents bidder, your inventory must be configured within the Native Agents platform. | ||
|
|
||
| During onboarding, Native Agents creates: | ||
|
|
||
| - A **Supply Source** representing your website or mobile application. | ||
| - One or more **Placements** representing individual ad locations on your inventory. | ||
|
|
||
| Each Placement receives a unique **placementId**, which is used by the bidder to identify the inventory during bidding. | ||
|
|
||
| Depending on your account configuration, Native Agents may instead provide an **endpointId**. | ||
|
|
||
| Only **one** identifier is required when configuring the bidder. | ||
|
|
||
| For onboarding and production credentials, contact your Native Agents account representative. | ||
|
|
||
| # Bid Parameters | ||
|
|
||
| Specify **either** `placementId` **or** `endpointId`. | ||
|
|
||
| Do **not** provide both. | ||
|
|
||
| {: .table .table-bordered .table-striped } | ||
| | Name | Scope | Description | Example | Type | | ||
| |---------------|----------|--------------|---------------------------------|------------| | ||
| | `placementId` | optional | Placement Id | `'0'` | `'string'` | | ||
| | `endpointId` | optional | Endpoint Id | `'0'` | `'string'` | | ||
|
|
||
| ## Note | ||
| | Name | Required | Description | Type | Example | | ||
| |-------------|----------|---------------------------------------------------------------------------------|--------|------------| | ||
| | placementId | No* | Unique identifier for a Placement configured within the Native Agents platform. | String | `"100001"` | | ||
| | endpointId | No* | Unique identifier for an Endpoint configured for your account. | String | `"200001"` | | ||
|
|
||
| \*One of `placementId` or `endpointId` is required. | ||
|
|
||
| # Banner Example | ||
|
|
||
| ```javascript | ||
| var adUnits = [{ | ||
| code: "banner-div", | ||
|
|
||
| mediaTypes: { | ||
| banner: { | ||
| sizes: [ | ||
| [300,250], | ||
| [300,600] | ||
| ] | ||
| } | ||
| }, | ||
|
|
||
| bids: [{ | ||
| bidder: "ntvagents", | ||
|
|
||
| params: { | ||
| placementId: "100001" | ||
| } | ||
| }] | ||
| }]; | ||
| ``` | ||
|
|
||
| # Native Example | ||
|
|
||
| ```javascript | ||
| var adUnits = [{ | ||
| code: "native-div", | ||
|
|
||
| mediaTypes: { | ||
| native: { | ||
| ortb: { | ||
| assets: [ | ||
| { | ||
| id: 1, | ||
| required: 1, | ||
| title: { | ||
| len: 100 | ||
| } | ||
| }, | ||
| { | ||
| id: 2, | ||
| required: 1, | ||
| img: { | ||
| type: 3, | ||
| w: 300, | ||
| h: 250 | ||
| } | ||
| }, | ||
| { | ||
| id: 3, | ||
| required: 1, | ||
| data: { | ||
| type: 1 | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| }, | ||
|
|
||
| bids: [{ | ||
| bidder: "ntvagents", | ||
|
|
||
| params: { | ||
| placementId: "100001" | ||
| } | ||
| }] | ||
| }]; | ||
| ``` | ||
|
|
||
| # Video Example | ||
|
|
||
| Both **Instream** and **Outstream** video contexts are supported. | ||
|
|
||
| ```javascript | ||
| var adUnits = [{ | ||
| code: "video-div-instream", | ||
|
|
||
| mediaTypes: { | ||
| video: { | ||
| context: "instream", | ||
| playerSize: [640,480], | ||
| mimes: ["video/mp4"], | ||
| protocols: [2,3,5,6], | ||
| api: [2], | ||
| minduration: 5, | ||
| maxduration: 30, | ||
| linearity: 1 | ||
| } | ||
| }, | ||
|
|
||
| bids: [{ | ||
| bidder: "ntvagents", | ||
|
|
||
| params: { | ||
| placementId: "100001" | ||
| } | ||
| }] | ||
| }]; | ||
| ``` | ||
|
|
||
| ```javascript | ||
| var adUnits = [{ | ||
| code: "video-div-outstream", | ||
|
|
||
| mediaTypes: { | ||
| video: { | ||
| context: "outstream", | ||
| playerSize: [640,480], | ||
| mimes: ["video/mp4"], | ||
| protocols: [2,3,5,6], | ||
| api: [2], | ||
| maxduration: 30, | ||
| linearity: 1 | ||
| } | ||
| }, | ||
|
|
||
| bids: [{ | ||
| bidder: "ntvagents", | ||
|
|
||
| params: { | ||
| placementId: "100001" | ||
| } | ||
| }] | ||
| }]; | ||
| ``` | ||
|
|
||
| # OpenRTB Support | ||
|
|
||
| The Native Agents bidder converts Prebid bid requests into OpenRTB bid requests before forwarding them to the Native Agents bidding platform. | ||
|
|
||
| The adapter supports OpenRTB requests for: | ||
|
|
||
| - Banner | ||
| - Native | ||
| - Video (Instream & Outstream) | ||
|
|
||
| using the corresponding OpenRTB object definitions. | ||
|
|
||
| # Creative Rendering | ||
|
|
||
| The Native Agents bidder returns creatives compatible with standard Prebid rendering workflows. | ||
|
|
||
| Supported creative formats include: | ||
|
|
||
| | Media Type | Response | | ||
| |------------------------------|-----------------------| | ||
| | Banner | HTML Markup | | ||
| | Native | OpenRTB Native Assets | | ||
| | Video (Instream & Outstream) | VAST XML / VAST URL | | ||
|
|
||
| Banner and Native creatives are rendered using Prebid's standard rendering pipeline. | ||
|
|
||
| Video responses return VAST-compatible creatives suitable for both instream video players and supported outstream video players. | ||
|
|
||
| # User Sync | ||
|
|
||
| Native Agents supports both iframe and image user synchronization. | ||
|
|
||
| ```javascript | ||
| pbjs.setConfig({ | ||
| userSync: { | ||
| filterSettings: { | ||
| iframe: { | ||
| bidders: ["ntvagents"], | ||
| filter: "include" | ||
| }, | ||
| image: { | ||
| bidders: ["ntvagents"], | ||
| filter: "include" | ||
| } | ||
| } | ||
| } | ||
| }); | ||
| ``` | ||
|
|
||
| User synchronization is performed only when permitted by applicable privacy regulations. | ||
|
|
||
| # Test Parameters | ||
|
|
||
| Native Agents provides test placements during onboarding. | ||
|
|
||
| Replace the example values below with the test identifiers supplied by your Native Agents account representative. | ||
|
|
||
| ```javascript | ||
| { | ||
| bidder: "ntvagents", | ||
|
|
||
| params: { | ||
| placementId: "100001" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| # Notes | ||
|
|
||
| For the prebid server and prebid.js you only need to use one parameter: either placementId or endpointId | ||
| - Configure **either** `placementId` **or** `endpointId`. | ||
| - Banner, Native, and Video (Instream & Outstream) are supported. | ||
| - Compatible with both **Prebid.js** and **Prebid Server**. | ||
| - Inventory must be configured within the Native Agents platform before bid requests can be made. | ||
| - Native Agents also supports Direct Tag and JavaScript tag integrations outside of Prebid. Refer to the Native Agents integration documentation for those integration methods. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.