com.beeswax.bid

Class Request.BidAgentResponse.Creative

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.beeswax.bid.Request.BidAgentResponse.Creative

All Implemented Interfaces:

Request.BidAgentResponse.CreativeOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

Request.BidAgentResponse

public static final class Request.BidAgentResponse.Creative
extends com.google.protobuf.GeneratedMessageV3
implements Request.BidAgentResponse.CreativeOrBuilder

 Next Id: 5
 Creative represents the creative to be rendered in the openrtb bid
 response.
 

Protobuf type bid.BidAgentResponse.Creative

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Request.BidAgentResponse.Creative.Builder Next Id: 5 Creative represents the creative to be rendered in the openrtb bid response.
static class	Request.BidAgentResponse.Creative.Macro The creative's macros {{DYNAMIC:<name>:STRING}} in the value of a creative content or creative template, will be replaced with the content of `value`.
static interface	Request.BidAgentResponse.Creative.MacroOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, 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

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLICK_URL_OVERRIDE_FIELD_NUMBER
static int	DYNAMIC_MACROS_FIELD_NUMBER
static int	ID_FIELD_NUMBER
static com.google.protobuf.Parser<Request.BidAgentResponse.Creative>	PARSER Deprecated.
static int	PIXELS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getClickUrlOverride() The `creative` object's `click_url` field, which is set from buzz, will be replaced with this value if it is present.
com.google.protobuf.ByteString	getClickUrlOverrideBytes() The `creative` object's `click_url` field, which is set from buzz, will be replaced with this value if it is present.
static Request.BidAgentResponse.Creative	getDefaultInstance()
Request.BidAgentResponse.Creative	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Request.BidAgentResponse.Creative.Macro	getDynamicMacros(int index) repeated .bid.BidAgentResponse.Creative.Macro dynamic_macros = 4;
int	getDynamicMacrosCount() repeated .bid.BidAgentResponse.Creative.Macro dynamic_macros = 4;
List<Request.BidAgentResponse.Creative.Macro>	getDynamicMacrosList() repeated .bid.BidAgentResponse.Creative.Macro dynamic_macros = 4;
Request.BidAgentResponse.Creative.MacroOrBuilder	getDynamicMacrosOrBuilder(int index) repeated .bid.BidAgentResponse.Creative.Macro dynamic_macros = 4;
List<? extends Request.BidAgentResponse.Creative.MacroOrBuilder>	getDynamicMacrosOrBuilderList() repeated .bid.BidAgentResponse.Creative.Macro dynamic_macros = 4;
long	getId() The id of the chosen creative.
com.google.protobuf.Parser<Request.BidAgentResponse.Creative>	getParserForType()
String	getPixels(int index) Pixels that will be fired when the creative is served in addition to the `pixels` field, which is set in `creative` object from buzz.
com.google.protobuf.ByteString	getPixelsBytes(int index) Pixels that will be fired when the creative is served in addition to the `pixels` field, which is set in `creative` object from buzz.
int	getPixelsCount() Pixels that will be fired when the creative is served in addition to the `pixels` field, which is set in `creative` object from buzz.
com.google.protobuf.ProtocolStringList	getPixelsList() Pixels that will be fired when the creative is served in addition to the `pixels` field, which is set in `creative` object from buzz.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasClickUrlOverride() The `creative` object's `click_url` field, which is set from buzz, will be replaced with this value if it is present.
int	hashCode()
boolean	hasId() The id of the chosen creative.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Request.BidAgentResponse.Creative.Builder	newBuilder()
static Request.BidAgentResponse.Creative.Builder	newBuilder(Request.BidAgentResponse.Creative prototype)
Request.BidAgentResponse.Creative.Builder	newBuilderForType()
protected Request.BidAgentResponse.Creative.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static Request.BidAgentResponse.Creative	parseDelimitedFrom(InputStream input)
static Request.BidAgentResponse.Creative	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Request.BidAgentResponse.Creative	parseFrom(byte[] data)
static Request.BidAgentResponse.Creative	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Request.BidAgentResponse.Creative	parseFrom(com.google.protobuf.ByteString data)
static Request.BidAgentResponse.Creative	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Request.BidAgentResponse.Creative	parseFrom(com.google.protobuf.CodedInputStream input)
static Request.BidAgentResponse.Creative	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Request.BidAgentResponse.Creative	parseFrom(InputStream input)
static Request.BidAgentResponse.Creative	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Request.BidAgentResponse.Creative>	parser()
Request.BidAgentResponse.Creative.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

See Also:

Constant Field Values

PIXELS_FIELD_NUMBER

public static final int PIXELS_FIELD_NUMBER

See Also:

Constant Field Values

CLICK_URL_OVERRIDE_FIELD_NUMBER

public static final int CLICK_URL_OVERRIDE_FIELD_NUMBER

See Also:

Constant Field Values

DYNAMIC_MACROS_FIELD_NUMBER

public static final int DYNAMIC_MACROS_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

@Deprecated
public static final com.google.protobuf.Parser<Request.BidAgentResponse.Creative> PARSER

Deprecated.

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasId

public boolean hasId()

 The id of the chosen creative. It should be one of the ids in
 Adcandidate.creative_ids where the Adcandidate's line_item_id ==
 Bid.line_item_id for the Bid containing this Creative message,
 otherwise the bid will not be processed.
 

optional uint64 id = 1;

Specified by:

hasId in interface Request.BidAgentResponse.CreativeOrBuilder

getId

public long getId()

 The id of the chosen creative. It should be one of the ids in
 Adcandidate.creative_ids where the Adcandidate's line_item_id ==
 Bid.line_item_id for the Bid containing this Creative message,
 otherwise the bid will not be processed.
 

optional uint64 id = 1;

Specified by:

getId in interface Request.BidAgentResponse.CreativeOrBuilder

getPixelsList

public com.google.protobuf.ProtocolStringList getPixelsList()

 Pixels that will be fired when the creative is served in addition
 to the `pixels` field, which is set in `creative` object from buzz.
 (see http://docs.beeswax.com/docs/creative)
 This field should not be populated when the battr field has
 AD_SUPPORTS_DYNAMIC_PIXELS(108), otherwise this bid will not be
 processed.
 battr field is under BidAgentRequest.bid_request.imp.(banner/video).battr
 ; whether it is banner or video corresponds to the type of this creative.
 

repeated string pixels = 2;

Specified by:

getPixelsList in interface Request.BidAgentResponse.CreativeOrBuilder

getPixelsCount

public int getPixelsCount()

 Pixels that will be fired when the creative is served in addition
 to the `pixels` field, which is set in `creative` object from buzz.
 (see http://docs.beeswax.com/docs/creative)
 This field should not be populated when the battr field has
 AD_SUPPORTS_DYNAMIC_PIXELS(108), otherwise this bid will not be
 processed.
 battr field is under BidAgentRequest.bid_request.imp.(banner/video).battr
 ; whether it is banner or video corresponds to the type of this creative.
 

repeated string pixels = 2;

Specified by:

getPixelsCount in interface Request.BidAgentResponse.CreativeOrBuilder

getPixels

public String getPixels(int index)

 Pixels that will be fired when the creative is served in addition
 to the `pixels` field, which is set in `creative` object from buzz.
 (see http://docs.beeswax.com/docs/creative)
 This field should not be populated when the battr field has
 AD_SUPPORTS_DYNAMIC_PIXELS(108), otherwise this bid will not be
 processed.
 battr field is under BidAgentRequest.bid_request.imp.(banner/video).battr
 ; whether it is banner or video corresponds to the type of this creative.
 

repeated string pixels = 2;

Specified by:

getPixels in interface Request.BidAgentResponse.CreativeOrBuilder

getPixelsBytes

public com.google.protobuf.ByteString getPixelsBytes(int index)

 Pixels that will be fired when the creative is served in addition
 to the `pixels` field, which is set in `creative` object from buzz.
 (see http://docs.beeswax.com/docs/creative)
 This field should not be populated when the battr field has
 AD_SUPPORTS_DYNAMIC_PIXELS(108), otherwise this bid will not be
 processed.
 battr field is under BidAgentRequest.bid_request.imp.(banner/video).battr
 ; whether it is banner or video corresponds to the type of this creative.
 

repeated string pixels = 2;

Specified by:

getPixelsBytes in interface Request.BidAgentResponse.CreativeOrBuilder

hasClickUrlOverride

public boolean hasClickUrlOverride()

 The `creative` object's `click_url` field, which is set from buzz,
 will be replaced with this value if it is present.
 (see http://docs.beeswax.com/docs/creative)
 This field should not be populated when the battr field has
 AD_SUPPORTS_DYNAMIC_CLICK_URL(109), otherwise this bid will not be
 processed.
 battr field is under BidAgentRequest.bid_request.imp.(banner/video).battr
 ; whether it is banner or video corresponds to the type of this creative.
 

optional string click_url_override = 3;

Specified by:

hasClickUrlOverride in interface Request.BidAgentResponse.CreativeOrBuilder

getClickUrlOverride

public String getClickUrlOverride()

 The `creative` object's `click_url` field, which is set from buzz,
 will be replaced with this value if it is present.
 (see http://docs.beeswax.com/docs/creative)
 This field should not be populated when the battr field has
 AD_SUPPORTS_DYNAMIC_CLICK_URL(109), otherwise this bid will not be
 processed.
 battr field is under BidAgentRequest.bid_request.imp.(banner/video).battr
 ; whether it is banner or video corresponds to the type of this creative.
 

optional string click_url_override = 3;

Specified by:

getClickUrlOverride in interface Request.BidAgentResponse.CreativeOrBuilder

getClickUrlOverrideBytes

public com.google.protobuf.ByteString getClickUrlOverrideBytes()

 The `creative` object's `click_url` field, which is set from buzz,
 will be replaced with this value if it is present.
 (see http://docs.beeswax.com/docs/creative)
 This field should not be populated when the battr field has
 AD_SUPPORTS_DYNAMIC_CLICK_URL(109), otherwise this bid will not be
 processed.
 battr field is under BidAgentRequest.bid_request.imp.(banner/video).battr
 ; whether it is banner or video corresponds to the type of this creative.
 

optional string click_url_override = 3;

Specified by:

getClickUrlOverrideBytes in interface Request.BidAgentResponse.CreativeOrBuilder

getDynamicMacrosList

public List<Request.BidAgentResponse.Creative.Macro> getDynamicMacrosList()

repeated .bid.BidAgentResponse.Creative.Macro dynamic_macros = 4;

Specified by:

getDynamicMacrosList in interface Request.BidAgentResponse.CreativeOrBuilder

getDynamicMacrosOrBuilderList

public List<? extends Request.BidAgentResponse.Creative.MacroOrBuilder> getDynamicMacrosOrBuilderList()

repeated .bid.BidAgentResponse.Creative.Macro dynamic_macros = 4;

Specified by:

getDynamicMacrosOrBuilderList in interface Request.BidAgentResponse.CreativeOrBuilder

getDynamicMacrosCount

public int getDynamicMacrosCount()

repeated .bid.BidAgentResponse.Creative.Macro dynamic_macros = 4;

Specified by:

getDynamicMacrosCount in interface Request.BidAgentResponse.CreativeOrBuilder

getDynamicMacros

public Request.BidAgentResponse.Creative.Macro getDynamicMacros(int index)

repeated .bid.BidAgentResponse.Creative.Macro dynamic_macros = 4;

Specified by:

getDynamicMacros in interface Request.BidAgentResponse.CreativeOrBuilder

getDynamicMacrosOrBuilder

public Request.BidAgentResponse.Creative.MacroOrBuilder getDynamicMacrosOrBuilder(int index)

repeated .bid.BidAgentResponse.Creative.Macro dynamic_macros = 4;

Specified by:

getDynamicMacrosOrBuilder in interface Request.BidAgentResponse.CreativeOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Request.BidAgentResponse.Creative parseFrom(com.google.protobuf.ByteString data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Request.BidAgentResponse.Creative parseFrom(com.google.protobuf.ByteString data,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Request.BidAgentResponse.Creative parseFrom(byte[] data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Request.BidAgentResponse.Creative parseFrom(byte[] data,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Request.BidAgentResponse.Creative parseFrom(InputStream input)
                                                   throws IOException

Throws:

IOException

parseFrom

public static Request.BidAgentResponse.Creative parseFrom(InputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static Request.BidAgentResponse.Creative parseDelimitedFrom(InputStream input)
                                                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static Request.BidAgentResponse.Creative parseDelimitedFrom(InputStream input,
                                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                            throws IOException

Throws:

IOException

parseFrom

public static Request.BidAgentResponse.Creative parseFrom(com.google.protobuf.CodedInputStream input)
                                                   throws IOException

Throws:

IOException

parseFrom

public static Request.BidAgentResponse.Creative parseFrom(com.google.protobuf.CodedInputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws IOException

Throws:

IOException

newBuilderForType

public Request.BidAgentResponse.Creative.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Request.BidAgentResponse.Creative.Builder newBuilder()

newBuilder

public static Request.BidAgentResponse.Creative.Builder newBuilder(Request.BidAgentResponse.Creative prototype)

toBuilder

public Request.BidAgentResponse.Creative.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Request.BidAgentResponse.Creative.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Request.BidAgentResponse.Creative getDefaultInstance()

parser

public static com.google.protobuf.Parser<Request.BidAgentResponse.Creative> parser()

getParserForType

public com.google.protobuf.Parser<Request.BidAgentResponse.Creative> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Request.BidAgentResponse.Creative getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder