public static final class OpenRtbProtobuf.Bid extends com.google.protobuf.GeneratedMessageV3 implements OpenRtbProtobuf.BidOrBuilder
4.3.3 Bid Object For each bid, the “nurl” attribute contains the win notice URL. If the bidder wins the impression, the exchange calls this notice URL a) to inform the bidder of the win and b) to convey certain information using substitution macros (see Section 4.6 Substitution Macros). The “adomain” attribute can be used to check advertiser block list compliance. The “iurl” attribute can provide a link to an image that is representative of the campaign’s content (irrespective of whether the campaign may have multiple creatives). This enables human review for spotting inappropriate content. The “cid” attribute can be used to block ads that were previously identified as inappropriate; essentially a safety net beyond the block lists. The “crid” attribute can be helpful in reporting creative issues back to bidders. Finally, the “attr” array indicates the creative attributes that describe the ad to be served. BEST PRACTICE: Substitution macros may allow a bidder to use a static notice URL for all of its bids. Thus, exchanges should offer the option of a default notice URL that can be pre- configured per bidder to reduce redundant data transfer.Protobuf type
open_rtb.Bid| Modifier and Type | Class and Description |
|---|---|
static class |
OpenRtbProtobuf.Bid.Builder
4.3.3 Bid Object
For each bid, the “nurl” attribute contains the win notice URL.
|
com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable| Modifier and Type | Field and Description |
|---|---|
static int |
ADID_FIELD_NUMBER |
static int |
ADM_FIELD_NUMBER |
static int |
ADOMAIN_FIELD_NUMBER |
static int |
ATTR_FIELD_NUMBER |
static int |
CID_FIELD_NUMBER |
static int |
CRID_FIELD_NUMBER |
static int |
DEALID_FIELD_NUMBER |
static int |
H_FIELD_NUMBER |
static int |
ID_FIELD_NUMBER |
static int |
IMPID_FIELD_NUMBER |
static int |
LURL_FIELD_NUMBER |
static int |
NURL_FIELD_NUMBER |
static com.google.protobuf.Parser<OpenRtbProtobuf.Bid> |
PARSER
Deprecated.
|
static int |
PRICE_FIELD_NUMBER |
static int |
W_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
String |
getAdid()
ID that references the ad to be served if the bid wins.
|
com.google.protobuf.ByteString |
getAdidBytes()
ID that references the ad to be served if the bid wins.
|
String |
getAdm()
Actual ad markup.
|
com.google.protobuf.ByteString |
getAdmBytes()
Actual ad markup.
|
String |
getAdomain(int index)
Advertiser’s primary or top-level domain for advertiser checking.
|
com.google.protobuf.ByteString |
getAdomainBytes(int index)
Advertiser’s primary or top-level domain for advertiser checking.
|
int |
getAdomainCount()
Advertiser’s primary or top-level domain for advertiser checking.
|
com.google.protobuf.ProtocolStringList |
getAdomainList()
Advertiser’s primary or top-level domain for advertiser checking.
|
int |
getAttr(int index)
Array of creative attributes.
|
int |
getAttrCount()
Array of creative attributes.
|
List<Integer> |
getAttrList()
Array of creative attributes.
|
String |
getCid()
Campaign ID or similar that appears within the ad markup.
|
com.google.protobuf.ByteString |
getCidBytes()
Campaign ID or similar that appears within the ad markup.
|
String |
getCrid()
Creative ID for reporting content issues or defects.
|
com.google.protobuf.ByteString |
getCridBytes()
Creative ID for reporting content issues or defects.
|
String |
getDealid()
A unique identifier for the direct deal associated with the bid.
|
com.google.protobuf.ByteString |
getDealidBytes()
A unique identifier for the direct deal associated with the bid.
|
static OpenRtbProtobuf.Bid |
getDefaultInstance() |
OpenRtbProtobuf.Bid |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
int |
getH()
Height of the ad in pixels.
|
String |
getId()
ID for the bid object chosen by the bidder for tracking and debugging purposes.
|
com.google.protobuf.ByteString |
getIdBytes()
ID for the bid object chosen by the bidder for tracking and debugging purposes.
|
String |
getImpid()
ID of the impression object to which this bid applies.
|
com.google.protobuf.ByteString |
getImpidBytes()
ID of the impression object to which this bid applies.
|
String |
getLurl()
Sample image URL (without cache busting) for content checking.
|
com.google.protobuf.ByteString |
getLurlBytes()
Sample image URL (without cache busting) for content checking.
|
String |
getNurl()
Win notice URL.
|
com.google.protobuf.ByteString |
getNurlBytes()
Win notice URL.
|
com.google.protobuf.Parser<OpenRtbProtobuf.Bid> |
getParserForType() |
double |
getPrice()
Bid price in CPM.
|
int |
getSerializedSize() |
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
int |
getW()
Width of the ad in pixels.
|
boolean |
hasAdid()
ID that references the ad to be served if the bid wins.
|
boolean |
hasAdm()
Actual ad markup.
|
boolean |
hasCid()
Campaign ID or similar that appears within the ad markup.
|
boolean |
hasCrid()
Creative ID for reporting content issues or defects.
|
boolean |
hasDealid()
A unique identifier for the direct deal associated with the bid.
|
boolean |
hasH()
Height of the ad in pixels.
|
int |
hashCode() |
boolean |
hasId()
ID for the bid object chosen by the bidder for tracking and debugging purposes.
|
boolean |
hasImpid()
ID of the impression object to which this bid applies.
|
boolean |
hasLurl()
Sample image URL (without cache busting) for content checking.
|
boolean |
hasNurl()
Win notice URL.
|
boolean |
hasPrice()
Bid price in CPM.
|
boolean |
hasW()
Width of the ad in pixels.
|
boolean |
isInitialized() |
static OpenRtbProtobuf.Bid.Builder |
newBuilder() |
static OpenRtbProtobuf.Bid.Builder |
newBuilder(OpenRtbProtobuf.Bid prototype) |
OpenRtbProtobuf.Bid.Builder |
newBuilderForType() |
static OpenRtbProtobuf.Bid |
parseDelimitedFrom(InputStream input) |
static OpenRtbProtobuf.Bid |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static OpenRtbProtobuf.Bid |
parseFrom(byte[] data) |
static OpenRtbProtobuf.Bid |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static OpenRtbProtobuf.Bid |
parseFrom(com.google.protobuf.ByteString data) |
static OpenRtbProtobuf.Bid |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static OpenRtbProtobuf.Bid |
parseFrom(com.google.protobuf.CodedInputStream input) |
static OpenRtbProtobuf.Bid |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static OpenRtbProtobuf.Bid |
parseFrom(InputStream input) |
static OpenRtbProtobuf.Bid |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<OpenRtbProtobuf.Bid> |
parser() |
OpenRtbProtobuf.Bid.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneoffindInitializationErrors, getInitializationErrorString, toStringtoByteArray, toByteString, writeDelimitedTo, writeTopublic static final int ID_FIELD_NUMBER
public static final int IMPID_FIELD_NUMBER
public static final int PRICE_FIELD_NUMBER
public static final int ADID_FIELD_NUMBER
public static final int NURL_FIELD_NUMBER
public static final int ADM_FIELD_NUMBER
public static final int ADOMAIN_FIELD_NUMBER
public static final int LURL_FIELD_NUMBER
public static final int CID_FIELD_NUMBER
public static final int CRID_FIELD_NUMBER
public static final int ATTR_FIELD_NUMBER
public static final int DEALID_FIELD_NUMBER
public static final int W_FIELD_NUMBER
public static final int H_FIELD_NUMBER
@Deprecated public static final com.google.protobuf.Parser<OpenRtbProtobuf.Bid> PARSER
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
public boolean hasId()
ID for the bid object chosen by the bidder for tracking and debugging purposes. Useful when multiple bids are submitted for a single impression for a given seat.
optional string id = 1;hasId in interface OpenRtbProtobuf.BidOrBuilderpublic String getId()
ID for the bid object chosen by the bidder for tracking and debugging purposes. Useful when multiple bids are submitted for a single impression for a given seat.
optional string id = 1;getId in interface OpenRtbProtobuf.BidOrBuilderpublic com.google.protobuf.ByteString getIdBytes()
ID for the bid object chosen by the bidder for tracking and debugging purposes. Useful when multiple bids are submitted for a single impression for a given seat.
optional string id = 1;getIdBytes in interface OpenRtbProtobuf.BidOrBuilderpublic boolean hasImpid()
ID of the impression object to which this bid applies.
optional string impid = 2;hasImpid in interface OpenRtbProtobuf.BidOrBuilderpublic String getImpid()
ID of the impression object to which this bid applies.
optional string impid = 2;getImpid in interface OpenRtbProtobuf.BidOrBuilderpublic com.google.protobuf.ByteString getImpidBytes()
ID of the impression object to which this bid applies.
optional string impid = 2;getImpidBytes in interface OpenRtbProtobuf.BidOrBuilderpublic boolean hasPrice()
Bid price in CPM. WARNING/Best Practice Note: Although this value is a float, OpenRTB strongly suggests using integer math for accounting to avoid rounding errors.
optional double price = 3;hasPrice in interface OpenRtbProtobuf.BidOrBuilderpublic double getPrice()
Bid price in CPM. WARNING/Best Practice Note: Although this value is a float, OpenRTB strongly suggests using integer math for accounting to avoid rounding errors.
optional double price = 3;getPrice in interface OpenRtbProtobuf.BidOrBuilderpublic boolean hasAdid()
ID that references the ad to be served if the bid wins.
optional string adid = 4;hasAdid in interface OpenRtbProtobuf.BidOrBuilderpublic String getAdid()
ID that references the ad to be served if the bid wins.
optional string adid = 4;getAdid in interface OpenRtbProtobuf.BidOrBuilderpublic com.google.protobuf.ByteString getAdidBytes()
ID that references the ad to be served if the bid wins.
optional string adid = 4;getAdidBytes in interface OpenRtbProtobuf.BidOrBuilderpublic boolean hasNurl()
Win notice URL. Note that ad markup is also typically, but not necessarily, returned via this URL.
optional string nurl = 5;hasNurl in interface OpenRtbProtobuf.BidOrBuilderpublic String getNurl()
Win notice URL. Note that ad markup is also typically, but not necessarily, returned via this URL.
optional string nurl = 5;getNurl in interface OpenRtbProtobuf.BidOrBuilderpublic com.google.protobuf.ByteString getNurlBytes()
Win notice URL. Note that ad markup is also typically, but not necessarily, returned via this URL.
optional string nurl = 5;getNurlBytes in interface OpenRtbProtobuf.BidOrBuilderpublic boolean hasAdm()
Actual ad markup. XHTML if a response to a banner object, or VAST XML if a response to a video object.
optional string adm = 6;hasAdm in interface OpenRtbProtobuf.BidOrBuilderpublic String getAdm()
Actual ad markup. XHTML if a response to a banner object, or VAST XML if a response to a video object.
optional string adm = 6;getAdm in interface OpenRtbProtobuf.BidOrBuilderpublic com.google.protobuf.ByteString getAdmBytes()
Actual ad markup. XHTML if a response to a banner object, or VAST XML if a response to a video object.
optional string adm = 6;getAdmBytes in interface OpenRtbProtobuf.BidOrBuilderpublic com.google.protobuf.ProtocolStringList getAdomainList()
Advertiser’s primary or top-level domain for advertiser checking. This can be a list of domains if there is a rotating creative. However, exchanges may mandate that only one landing domain is allowed.
repeated string adomain = 7;getAdomainList in interface OpenRtbProtobuf.BidOrBuilderpublic int getAdomainCount()
Advertiser’s primary or top-level domain for advertiser checking. This can be a list of domains if there is a rotating creative. However, exchanges may mandate that only one landing domain is allowed.
repeated string adomain = 7;getAdomainCount in interface OpenRtbProtobuf.BidOrBuilderpublic String getAdomain(int index)
Advertiser’s primary or top-level domain for advertiser checking. This can be a list of domains if there is a rotating creative. However, exchanges may mandate that only one landing domain is allowed.
repeated string adomain = 7;getAdomain in interface OpenRtbProtobuf.BidOrBuilderpublic com.google.protobuf.ByteString getAdomainBytes(int index)
Advertiser’s primary or top-level domain for advertiser checking. This can be a list of domains if there is a rotating creative. However, exchanges may mandate that only one landing domain is allowed.
repeated string adomain = 7;getAdomainBytes in interface OpenRtbProtobuf.BidOrBuilderpublic boolean hasLurl()
Sample image URL (without cache busting) for content checking.
optional string lurl = 8;hasLurl in interface OpenRtbProtobuf.BidOrBuilderpublic String getLurl()
Sample image URL (without cache busting) for content checking.
optional string lurl = 8;getLurl in interface OpenRtbProtobuf.BidOrBuilderpublic com.google.protobuf.ByteString getLurlBytes()
Sample image URL (without cache busting) for content checking.
optional string lurl = 8;getLurlBytes in interface OpenRtbProtobuf.BidOrBuilderpublic boolean hasCid()
Campaign ID or similar that appears within the ad markup.
optional string cid = 9;hasCid in interface OpenRtbProtobuf.BidOrBuilderpublic String getCid()
Campaign ID or similar that appears within the ad markup.
optional string cid = 9;getCid in interface OpenRtbProtobuf.BidOrBuilderpublic com.google.protobuf.ByteString getCidBytes()
Campaign ID or similar that appears within the ad markup.
optional string cid = 9;getCidBytes in interface OpenRtbProtobuf.BidOrBuilderpublic boolean hasCrid()
Creative ID for reporting content issues or defects. This could also be used as a reference to a creative ID that is posted with an exchange.
optional string crid = 10;hasCrid in interface OpenRtbProtobuf.BidOrBuilderpublic String getCrid()
Creative ID for reporting content issues or defects. This could also be used as a reference to a creative ID that is posted with an exchange.
optional string crid = 10;getCrid in interface OpenRtbProtobuf.BidOrBuilderpublic com.google.protobuf.ByteString getCridBytes()
Creative ID for reporting content issues or defects. This could also be used as a reference to a creative ID that is posted with an exchange.
optional string crid = 10;getCridBytes in interface OpenRtbProtobuf.BidOrBuilderpublic List<Integer> getAttrList()
Array of creative attributes. See Table 6.3 Creative Attributes.
repeated uint32 attr = 11 [packed = true];getAttrList in interface OpenRtbProtobuf.BidOrBuilderpublic int getAttrCount()
Array of creative attributes. See Table 6.3 Creative Attributes.
repeated uint32 attr = 11 [packed = true];getAttrCount in interface OpenRtbProtobuf.BidOrBuilderpublic int getAttr(int index)
Array of creative attributes. See Table 6.3 Creative Attributes.
repeated uint32 attr = 11 [packed = true];getAttr in interface OpenRtbProtobuf.BidOrBuilderpublic boolean hasDealid()
A unique identifier for the direct deal associated with the bid. If the bid is associated and in response to a dealid in the request object it is _required_ in the response object.
optional string dealid = 12;hasDealid in interface OpenRtbProtobuf.BidOrBuilderpublic String getDealid()
A unique identifier for the direct deal associated with the bid. If the bid is associated and in response to a dealid in the request object it is _required_ in the response object.
optional string dealid = 12;getDealid in interface OpenRtbProtobuf.BidOrBuilderpublic com.google.protobuf.ByteString getDealidBytes()
A unique identifier for the direct deal associated with the bid. If the bid is associated and in response to a dealid in the request object it is _required_ in the response object.
optional string dealid = 12;getDealidBytes in interface OpenRtbProtobuf.BidOrBuilderpublic boolean hasW()
Width of the ad in pixels. If the bid request contained the wmax/hmax and wmin/hmin optional fields it is recommended that the response bid contains this field to signal the size of ad chosen.
optional uint32 w = 13;hasW in interface OpenRtbProtobuf.BidOrBuilderpublic int getW()
Width of the ad in pixels. If the bid request contained the wmax/hmax and wmin/hmin optional fields it is recommended that the response bid contains this field to signal the size of ad chosen.
optional uint32 w = 13;getW in interface OpenRtbProtobuf.BidOrBuilderpublic boolean hasH()
Height of the ad in pixels. If the bid request contained the wmax/hmax and wmin/hmin optional fields it is recommended that the response bid contains this field to signal the size of ad chosen.
optional uint32 h = 14;hasH in interface OpenRtbProtobuf.BidOrBuilderpublic int getH()
Height of the ad in pixels. If the bid request contained the wmax/hmax and wmin/hmin optional fields it is recommended that the response bid contains this field to signal the size of ad chosen.
optional uint32 h = 14;getH in interface OpenRtbProtobuf.BidOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static OpenRtbProtobuf.Bid parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static OpenRtbProtobuf.Bid parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static OpenRtbProtobuf.Bid parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static OpenRtbProtobuf.Bid parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static OpenRtbProtobuf.Bid parseFrom(InputStream input) throws IOException
IOExceptionpublic static OpenRtbProtobuf.Bid parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static OpenRtbProtobuf.Bid parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static OpenRtbProtobuf.Bid parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static OpenRtbProtobuf.Bid parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static OpenRtbProtobuf.Bid parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic OpenRtbProtobuf.Bid.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static OpenRtbProtobuf.Bid.Builder newBuilder()
public static OpenRtbProtobuf.Bid.Builder newBuilder(OpenRtbProtobuf.Bid prototype)
public OpenRtbProtobuf.Bid.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLitepublic static OpenRtbProtobuf.Bid getDefaultInstance()
public static com.google.protobuf.Parser<OpenRtbProtobuf.Bid> parser()
public com.google.protobuf.Parser<OpenRtbProtobuf.Bid> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public OpenRtbProtobuf.Bid getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2013–2016 AdGear Technologies Inc.. All rights reserved.