Skip to content

Latest commit

 

History

History
186 lines (169 loc) · 4.91 KB

yieldone.md

File metadata and controls

186 lines (169 loc) · 4.91 KB
Raw
layout title description biddercode media_types userIds pbjs pbs multiformat_supported sidebarType
bidder
YieldOne
Prebid YieldOne Bidder Adaptor
yieldone
banner, video
identityLink, imuid, AudienceOne ID, ID5
true
true
will-bid-on-any
1

Note

THE YieldOne adapter requires setup and approval from the YieldOne team.
Please reach out to your account team or y1s@platform-one.co.jp for more information.

Bid Params

{: .table .table-bordered .table-striped }

Name Scope Description Example Type
placementId required The placement ID "36891" string
playerSize optional Video Resolution Size
(This field is mandatory if mediaTypes.video.playerSize is [1, 1])		 [640, 360] array of number
playerParams optional Video Player Params (see below) {} object
playerParams.wrapperWidth optional Video Player Width "320px" string
playerParams.wrapperHeight optional Video Player Height "180px" string

Multi-Format Ad Units

If you use Multi-Format Ad Units, "video" bid object should be placed before "banner" bid object.
And if Bid Params contains playerParams, it will request a "video" media type ad.
If it does not, it will request a "banner" media type ad.

AdUnit Format Example

AdUnit Format for Banner

var bannerAdUnits = [{
    code: "test-div-banner",
    mediaTypes: {
        banner: {
            sizes: [
                [300, 250],
                [1, 1]
            ]
        },
    },
    bids: [{
        bidder: "yieldone",
        params: {
            placementId: "36891" // required
        }
    }]
}]

AdUnit Format for Video

var videoAdUnits = [{
    code: "test-div-video",
    mediaTypes: {
        video: {
            playerSize: [640, 360],
            context: "outstream"
        }
    },
    bids: [{
        bidder: "yieldone",
        params: {
            placementId: "36892",       // required
            playerParams: {             // optional
                wrapperWidth: "320px",  // optional
                wrapperHeight: "180px"  // optional
            },
        }
    }]
}]

AdUnit Format for Multi Ads

var multiAdUnits = [{
    code: "test-div-multi",
    mediaTypes: {
        banner: {
            sizes: [
                [300, 250],
                [1, 1]
            ]
        },
        video: {
            playerSize: [640, 360],
            context: "outstream"
        }
    },
    bids: [{
        // * "video" bid object should be placed before "banner" bid object.
        // This bid will request a "video" media type ad.
        bidder: "yieldone",
        params: {
            placementId: "36892",       // required
            playerParams: {             // required
                wrapperWidth: "320px",  // optional
                wrapperHeight: "180px"  // optional
            },
        }
    },
    {
        // This bid will request a "banner" media type ad.
        bidder: "yieldone",
        params: {
            placementId: "36891"        // required
        }
    }]
}];

AdUnit Format for Video (mediaTypes.video.playerSize: [1,1])

var videoAdUnits = [{
    code: "test-div-video",
    mediaTypes: {
        video: {
            playerSize: [1, 1],
            context: "outstream"
        }
    },
    bids: [{
        bidder: "yieldone",
        params: {
            placementId: "36892",       // required
            playerSize: [640, 360],     // required
            playerParams: {             // optional
                wrapperWidth: "320px",  // optional
                wrapperHeight: "180px"  // optional
            },
        }
    }]
}]

AdUnit Format for Multi Ads (mediaTypes.video.playerSize: [1,1])

var multiAdUnits = [{
    code: "test-div-multi",
    mediaTypes: {
        banner: {
            sizes: [
                [300, 250],
                [1, 1]
            ]
        },
        video: {
            playerSize: [1, 1],
            context: "outstream"
        }
    },
    bids: [{
        // * "video" bid object should be placed before "banner" bid object.
        // This bid will request a "video" media type ad.
        bidder: "yieldone",
        params: {
            placementId: "36892",       // required
            playerSize: [640, 360],     // required
            playerParams: {             // required
                wrapperWidth: "320px",  // optional
                wrapperHeight: "180px"  // optional
            },
        }
    },
    {
        // This bid will request a "banner" media type ad.
        bidder: "yieldone",
        params: {
            placementId: "36891"        // required
        }
    }]
}];