-
public final class NativeAdRequestThe Native Object defines the native advertising opportunity available for bid via this bid request. It will be included as a JSON-encoded string in the bid request’s imp.native field or as a direct JSON object, depending on the choice of the exchange.
-
-
Field Summary
Fields Modifier and Type Field Description private Stringversionprivate IntegercontextTypeIDprivate IntegercontextSubTypeIDprivate IntegerplacementTypeIDprivate IntegernumOfPlacementIDprivate Integersequenceprivate IntegerassetUrlSupportprivate IntegerdcoUrlSupportprivate Array<EventTracker>eventTrackersprivate Integerprivacyprivate Objectextension
-
Constructor Summary
Constructors Constructor Description NativeAdRequest(Array<Asset.Request> assets)
-
Method Summary
Modifier and Type Method Description final StringgetVersion()Version of the Native Markup version in use. final UnitsetVersion(@SerializedName(value = ver) String version)Version of the Native Markup version in use. final IntegergetContextTypeID()The context in which the ad appears. final UnitsetContextTypeID(@SerializedName(value = context) Integer contextTypeID)The context in which the ad appears. final IntegergetContextSubTypeID()A more detailed context in which the ad appears. final UnitsetContextSubTypeID(@SerializedName(value = contextsubtype) Integer contextSubTypeID)A more detailed context in which the ad appears. final IntegergetPlacementTypeID()The design/format/layout of the ad unit being offered. final UnitsetPlacementTypeID(@SerializedName(value = plcmttype) Integer placementTypeID)The design/format/layout of the ad unit being offered. final IntegergetNumOfPlacementID()The number of identical placements in this Layout. final UnitsetNumOfPlacementID(@SerializedName(value = plcmtcnt) Integer numOfPlacementID)The number of identical placements in this Layout. final IntegergetSequence()0 for the first ad, 1 for the second ad, and so on. final UnitsetSequence(@SerializedName(value = seq) Integer sequence)0 for the first ad, 1 for the second ad, and so on. final IntegergetAssetUrlSupport()Whether the supply source / impression supports returning an assets url instead of an asset object. final UnitsetAssetUrlSupport(@SerializedName(value = aurlsupport) Integer assetUrlSupport)Whether the supply source / impression supports returning an assets url instead of an asset object. final IntegergetDcoUrlSupport()Whether the supply source / impression supports returning a dco url instead of an asset object. final UnitsetDcoUrlSupport(@SerializedName(value = durlsupport) Integer dcoUrlSupport)Whether the supply source / impression supports returning a dco url instead of an asset object. final Array<EventTracker>getEventTrackers()Specifies what type of event tracking is supported final UnitsetEventTrackers(@SerializedName(value = eventtrackers) Array<EventTracker> eventTrackers)Specifies what type of event tracking is supported final IntegergetPrivacy()Set to 1 when the native ad supports buyer-specific privacy notice. final UnitsetPrivacy(@SerializedName(value = privacy) Integer privacy)Set to 1 when the native ad supports buyer-specific privacy notice. final ObjectgetExtension()Placeholder for exchange-specific extensions to OpenRTB. final UnitsetExtension(@SerializedName(value = ext) Object extension)Placeholder for exchange-specific extensions to OpenRTB. -
-
Constructor Detail
-
NativeAdRequest
NativeAdRequest(Array<Asset.Request> assets)
-
-
Method Detail
-
getVersion
final String getVersion()
Version of the Native Markup version in use.
-
setVersion
final Unit setVersion(@SerializedName(value = ver) String version)
Version of the Native Markup version in use.
-
getContextTypeID
final Integer getContextTypeID()
The context in which the ad appears.
-
setContextTypeID
final Unit setContextTypeID(@SerializedName(value = context) Integer contextTypeID)
The context in which the ad appears.
-
getContextSubTypeID
final Integer getContextSubTypeID()
A more detailed context in which the ad appears.
-
setContextSubTypeID
final Unit setContextSubTypeID(@SerializedName(value = contextsubtype) Integer contextSubTypeID)
A more detailed context in which the ad appears.
-
getPlacementTypeID
final Integer getPlacementTypeID()
The design/format/layout of the ad unit being offered.
-
setPlacementTypeID
final Unit setPlacementTypeID(@SerializedName(value = plcmttype) Integer placementTypeID)
The design/format/layout of the ad unit being offered.
-
getNumOfPlacementID
final Integer getNumOfPlacementID()
The number of identical placements in this Layout.
-
setNumOfPlacementID
final Unit setNumOfPlacementID(@SerializedName(value = plcmtcnt) Integer numOfPlacementID)
The number of identical placements in this Layout.
-
getSequence
final Integer getSequence()
0 for the first ad, 1 for the second ad, and so on. Note this would generally NOT be used in combination with numOfPlacementID - either you are auctioning multiple identical placements (in which case numOfPlacementID>1, sequence=0) or you are holding separate auctions for distinct items in the feed (in which case numOfPlacementID=1, sequence=>=1)
-
setSequence
final Unit setSequence(@SerializedName(value = seq) Integer sequence)
0 for the first ad, 1 for the second ad, and so on. Note this would generally NOT be used in combination with numOfPlacementID - either you are auctioning multiple identical placements (in which case numOfPlacementID>1, sequence=0) or you are holding separate auctions for distinct items in the feed (in which case numOfPlacementID=1, sequence=>=1)
-
getAssetUrlSupport
final Integer getAssetUrlSupport()
Whether the supply source / impression supports returning an assets url instead of an asset object. 0 or the absence of the field indicates no such support.
-
setAssetUrlSupport
final Unit setAssetUrlSupport(@SerializedName(value = aurlsupport) Integer assetUrlSupport)
Whether the supply source / impression supports returning an assets url instead of an asset object. 0 or the absence of the field indicates no such support.
-
getDcoUrlSupport
final Integer getDcoUrlSupport()
Whether the supply source / impression supports returning a dco url instead of an asset object. 0 or the absence of the field indicates no such support. Beta feature.
-
setDcoUrlSupport
final Unit setDcoUrlSupport(@SerializedName(value = durlsupport) Integer dcoUrlSupport)
Whether the supply source / impression supports returning a dco url instead of an asset object. 0 or the absence of the field indicates no such support. Beta feature.
-
getEventTrackers
final Array<EventTracker> getEventTrackers()
Specifies what type of event tracking is supported
-
setEventTrackers
final Unit setEventTrackers(@SerializedName(value = eventtrackers) Array<EventTracker> eventTrackers)
Specifies what type of event tracking is supported
-
getPrivacy
final Integer getPrivacy()
Set to 1 when the native ad supports buyer-specific privacy notice. Set to 0 (or field absent) when the native ad doesn't support custom privacy links or if support is unknown.
-
setPrivacy
final Unit setPrivacy(@SerializedName(value = privacy) Integer privacy)
Set to 1 when the native ad supports buyer-specific privacy notice. Set to 0 (or field absent) when the native ad doesn't support custom privacy links or if support is unknown.
-
getExtension
final Object getExtension()
Placeholder for exchange-specific extensions to OpenRTB.
-
setExtension
final Unit setExtension(@SerializedName(value = ext) Object extension)
Placeholder for exchange-specific extensions to OpenRTB.
-
-
-
-