com.beeswax.openrtb

Class Openrtb.BidRequest.Impression.Native.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessage.Builder<Openrtb.BidRequest.Impression.Native.Builder>

com.beeswax.openrtb.Openrtb.BidRequest.Impression.Native.Builder

All Implemented Interfaces:

Openrtb.BidRequest.Impression.NativeOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

Openrtb.BidRequest.Impression.Native

public static final class Openrtb.BidRequest.Impression.Native.Builder
extends com.google.protobuf.GeneratedMessage.Builder<Openrtb.BidRequest.Impression.Native.Builder>
implements Openrtb.BidRequest.Impression.NativeOrBuilder

Protobuf type openrtb.BidRequest.Impression.Native

 OpenRTB 3.2.5: This object represents a native type impression.
 Native ad units are intended to blend seamlessly into the surrounding content
 (e.g., a sponsored Twitter or Facebook post). As such, the response must be
 well-structured to afford the publisher fine-grained control over rendering.
 The Native Subcommittee has developed a companion specification to OpenRTB
 called the Native Ad Specification. It defines the request parameters and response markup
 structure of native ad units. This object provides the means of transporting request
 parameters as an opaque string so that the specific parameters can evolve separately
 under the auspices of the Native Ad Specification. Similarly, the ad markup served
 will be structured according to that specification.
 The presence of a Native as a subordinate of the Imp object indicates that this
 impression is offered as a native type impression. At the publisher's discretion,
 that same impression may also be offered as banner and/or video by also including as
 Imp subordinates the Banner and/or Video objects, respectively.
 However, any given bid for the impression must conform to one of the offered types.
 

Method Summary

Modifier and Type	Method and Description
Openrtb.BidRequest.Impression.Native.Builder	addAllApi(Iterable<? extends OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework> values) repeated .openrtb.Enums.BidRequest.Impression.ApiFramework api = 3 [packed = true];
Openrtb.BidRequest.Impression.Native.Builder	addAllBattr(Iterable<? extends OpenrtbCommon.CreativeAttribute> values) repeated .openrtb.CreativeAttribute battr = 4 [packed = true];
Openrtb.BidRequest.Impression.Native.Builder	addApi(OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework value) repeated .openrtb.Enums.BidRequest.Impression.ApiFramework api = 3 [packed = true];
Openrtb.BidRequest.Impression.Native.Builder	addBattr(OpenrtbCommon.CreativeAttribute value) repeated .openrtb.CreativeAttribute battr = 4 [packed = true];
Openrtb.BidRequest.Impression.Native	build()
Openrtb.BidRequest.Impression.Native	buildPartial()
Openrtb.BidRequest.Impression.Native.Builder	clear()
Openrtb.BidRequest.Impression.Native.Builder	clearApi() repeated .openrtb.Enums.BidRequest.Impression.ApiFramework api = 3 [packed = true];
Openrtb.BidRequest.Impression.Native.Builder	clearBattr() repeated .openrtb.CreativeAttribute battr = 4 [packed = true];
Openrtb.BidRequest.Impression.Native.Builder	clearExt() optional .openrtb.NativeExtensions ext = 1000;
Openrtb.BidRequest.Impression.Native.Builder	clearRequest() required .openrtb.NativeRequest request = 1;
Openrtb.BidRequest.Impression.Native.Builder	clearVer() optional string ver = 2;
OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework	getApi(int index) repeated .openrtb.Enums.BidRequest.Impression.ApiFramework api = 3 [packed = true];
int	getApiCount() repeated .openrtb.Enums.BidRequest.Impression.ApiFramework api = 3 [packed = true];
List<OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework>	getApiList() repeated .openrtb.Enums.BidRequest.Impression.ApiFramework api = 3 [packed = true];
OpenrtbCommon.CreativeAttribute	getBattr(int index) repeated .openrtb.CreativeAttribute battr = 4 [packed = true];
int	getBattrCount() repeated .openrtb.CreativeAttribute battr = 4 [packed = true];
List<OpenrtbCommon.CreativeAttribute>	getBattrList() repeated .openrtb.CreativeAttribute battr = 4 [packed = true];
Openrtb.BidRequest.Impression.Native	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
Extension.NativeExtensions	getExt() optional .openrtb.NativeExtensions ext = 1000;
Extension.NativeExtensions.Builder	getExtBuilder() optional .openrtb.NativeExtensions ext = 1000;
Extension.NativeExtensionsOrBuilder	getExtOrBuilder() optional .openrtb.NativeExtensions ext = 1000;
Openrtb.NativeRequest	getRequest() required .openrtb.NativeRequest request = 1;
Openrtb.NativeRequest.Builder	getRequestBuilder() required .openrtb.NativeRequest request = 1;
Openrtb.NativeRequestOrBuilder	getRequestOrBuilder() required .openrtb.NativeRequest request = 1;
String	getVer() optional string ver = 2;
com.google.protobuf.ByteString	getVerBytes() optional string ver = 2;
boolean	hasExt() optional .openrtb.NativeExtensions ext = 1000;
boolean	hasRequest() required .openrtb.NativeRequest request = 1;
boolean	hasVer() optional string ver = 2;
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Openrtb.BidRequest.Impression.Native.Builder	mergeExt(Extension.NativeExtensions value) optional .openrtb.NativeExtensions ext = 1000;
Openrtb.BidRequest.Impression.Native.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Openrtb.BidRequest.Impression.Native.Builder	mergeFrom(com.google.protobuf.Message other)
Openrtb.BidRequest.Impression.Native.Builder	mergeFrom(Openrtb.BidRequest.Impression.Native other)
Openrtb.BidRequest.Impression.Native.Builder	mergeRequest(Openrtb.NativeRequest value) required .openrtb.NativeRequest request = 1;
Openrtb.BidRequest.Impression.Native.Builder	setApi(int index, OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework value) repeated .openrtb.Enums.BidRequest.Impression.ApiFramework api = 3 [packed = true];
Openrtb.BidRequest.Impression.Native.Builder	setBattr(int index, OpenrtbCommon.CreativeAttribute value) repeated .openrtb.CreativeAttribute battr = 4 [packed = true];
Openrtb.BidRequest.Impression.Native.Builder	setExt(Extension.NativeExtensions.Builder builderForValue) optional .openrtb.NativeExtensions ext = 1000;
Openrtb.BidRequest.Impression.Native.Builder	setExt(Extension.NativeExtensions value) optional .openrtb.NativeExtensions ext = 1000;
Openrtb.BidRequest.Impression.Native.Builder	setRequest(Openrtb.NativeRequest.Builder builderForValue) required .openrtb.NativeRequest request = 1;
Openrtb.BidRequest.Impression.Native.Builder	setRequest(Openrtb.NativeRequest value) required .openrtb.NativeRequest request = 1;
Openrtb.BidRequest.Impression.Native.Builder	setVer(String value) optional string ver = 2;
Openrtb.BidRequest.Impression.Native.Builder	setVerBytes(com.google.protobuf.ByteString value) optional string ver = 2;

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownFields, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Openrtb.BidRequest.Impression.Native.Builder>

clear

public Openrtb.BidRequest.Impression.Native.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<Openrtb.BidRequest.Impression.Native.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Openrtb.BidRequest.Impression.Native.Builder>

getDefaultInstanceForType

public Openrtb.BidRequest.Impression.Native getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Openrtb.BidRequest.Impression.Native build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Openrtb.BidRequest.Impression.Native buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public Openrtb.BidRequest.Impression.Native.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Openrtb.BidRequest.Impression.Native.Builder>

mergeFrom

public Openrtb.BidRequest.Impression.Native.Builder mergeFrom(Openrtb.BidRequest.Impression.Native other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Openrtb.BidRequest.Impression.Native.Builder>

mergeFrom

public Openrtb.BidRequest.Impression.Native.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                       throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Openrtb.BidRequest.Impression.Native.Builder>

Throws:

IOException

hasRequest

public boolean hasRequest()

required .openrtb.NativeRequest request = 1;

 Request payload complying with the Native Ad Specification.
 

Specified by:

hasRequest in interface Openrtb.BidRequest.Impression.NativeOrBuilder

getRequest

public Openrtb.NativeRequest getRequest()

required .openrtb.NativeRequest request = 1;

 Request payload complying with the Native Ad Specification.
 

Specified by:

getRequest in interface Openrtb.BidRequest.Impression.NativeOrBuilder

setRequest

public Openrtb.BidRequest.Impression.Native.Builder setRequest(Openrtb.NativeRequest value)

required .openrtb.NativeRequest request = 1;

 Request payload complying with the Native Ad Specification.
 

setRequest

public Openrtb.BidRequest.Impression.Native.Builder setRequest(Openrtb.NativeRequest.Builder builderForValue)

required .openrtb.NativeRequest request = 1;

 Request payload complying with the Native Ad Specification.
 

mergeRequest

public Openrtb.BidRequest.Impression.Native.Builder mergeRequest(Openrtb.NativeRequest value)

required .openrtb.NativeRequest request = 1;

 Request payload complying with the Native Ad Specification.
 

clearRequest

public Openrtb.BidRequest.Impression.Native.Builder clearRequest()

required .openrtb.NativeRequest request = 1;

 Request payload complying with the Native Ad Specification.
 

getRequestBuilder

public Openrtb.NativeRequest.Builder getRequestBuilder()

required .openrtb.NativeRequest request = 1;

 Request payload complying with the Native Ad Specification.
 

getRequestOrBuilder

public Openrtb.NativeRequestOrBuilder getRequestOrBuilder()

required .openrtb.NativeRequest request = 1;

 Request payload complying with the Native Ad Specification.
 

Specified by:

getRequestOrBuilder in interface Openrtb.BidRequest.Impression.NativeOrBuilder

hasVer

public boolean hasVer()

optional string ver = 2;

 Version of the Native Ad Specification to which request complies;
 highly recommended for efficient parsing.
 

Specified by:

hasVer in interface Openrtb.BidRequest.Impression.NativeOrBuilder

getVer

public String getVer()

optional string ver = 2;

 Version of the Native Ad Specification to which request complies;
 highly recommended for efficient parsing.
 

Specified by:

getVer in interface Openrtb.BidRequest.Impression.NativeOrBuilder

getVerBytes

public com.google.protobuf.ByteString getVerBytes()

optional string ver = 2;

 Version of the Native Ad Specification to which request complies;
 highly recommended for efficient parsing.
 

Specified by:

getVerBytes in interface Openrtb.BidRequest.Impression.NativeOrBuilder

setVer

public Openrtb.BidRequest.Impression.Native.Builder setVer(String value)

optional string ver = 2;

 Version of the Native Ad Specification to which request complies;
 highly recommended for efficient parsing.
 

clearVer

public Openrtb.BidRequest.Impression.Native.Builder clearVer()

optional string ver = 2;

 Version of the Native Ad Specification to which request complies;
 highly recommended for efficient parsing.
 

setVerBytes

public Openrtb.BidRequest.Impression.Native.Builder setVerBytes(com.google.protobuf.ByteString value)

optional string ver = 2;

 Version of the Native Ad Specification to which request complies;
 highly recommended for efficient parsing.
 

getApiList

public List<OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework> getApiList()

repeated .openrtb.Enums.BidRequest.Impression.ApiFramework api = 3 [packed = true];

 List of supported API frameworks for this impression.  Refer to List 5.6.
 If an API is not explicitly listed, it is assumed not to be supported.
 

Specified by:

getApiList in interface Openrtb.BidRequest.Impression.NativeOrBuilder

getApiCount

public int getApiCount()

repeated .openrtb.Enums.BidRequest.Impression.ApiFramework api = 3 [packed = true];

 List of supported API frameworks for this impression.  Refer to List 5.6.
 If an API is not explicitly listed, it is assumed not to be supported.
 

Specified by:

getApiCount in interface Openrtb.BidRequest.Impression.NativeOrBuilder

getApi

public OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework getApi(int index)

repeated .openrtb.Enums.BidRequest.Impression.ApiFramework api = 3 [packed = true];

 List of supported API frameworks for this impression.  Refer to List 5.6.
 If an API is not explicitly listed, it is assumed not to be supported.
 

Specified by:

getApi in interface Openrtb.BidRequest.Impression.NativeOrBuilder

setApi

public Openrtb.BidRequest.Impression.Native.Builder setApi(int index,
                                                           OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework value)

repeated .openrtb.Enums.BidRequest.Impression.ApiFramework api = 3 [packed = true];

 List of supported API frameworks for this impression.  Refer to List 5.6.
 If an API is not explicitly listed, it is assumed not to be supported.
 

addApi

public Openrtb.BidRequest.Impression.Native.Builder addApi(OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework value)

repeated .openrtb.Enums.BidRequest.Impression.ApiFramework api = 3 [packed = true];

 List of supported API frameworks for this impression.  Refer to List 5.6.
 If an API is not explicitly listed, it is assumed not to be supported.
 

addAllApi

public Openrtb.BidRequest.Impression.Native.Builder addAllApi(Iterable<? extends OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework> values)

repeated .openrtb.Enums.BidRequest.Impression.ApiFramework api = 3 [packed = true];

 List of supported API frameworks for this impression.  Refer to List 5.6.
 If an API is not explicitly listed, it is assumed not to be supported.
 

clearApi

public Openrtb.BidRequest.Impression.Native.Builder clearApi()

repeated .openrtb.Enums.BidRequest.Impression.ApiFramework api = 3 [packed = true];

 List of supported API frameworks for this impression.  Refer to List 5.6.
 If an API is not explicitly listed, it is assumed not to be supported.
 

getBattrList

public List<OpenrtbCommon.CreativeAttribute> getBattrList()

repeated .openrtb.CreativeAttribute battr = 4 [packed = true];

 Blocked creative attributes. Refer to List 5.3.
 

Specified by:

getBattrList in interface Openrtb.BidRequest.Impression.NativeOrBuilder

getBattrCount

public int getBattrCount()

repeated .openrtb.CreativeAttribute battr = 4 [packed = true];

 Blocked creative attributes. Refer to List 5.3.
 

Specified by:

getBattrCount in interface Openrtb.BidRequest.Impression.NativeOrBuilder

getBattr

public OpenrtbCommon.CreativeAttribute getBattr(int index)

repeated .openrtb.CreativeAttribute battr = 4 [packed = true];

 Blocked creative attributes. Refer to List 5.3.
 

Specified by:

getBattr in interface Openrtb.BidRequest.Impression.NativeOrBuilder

setBattr

public Openrtb.BidRequest.Impression.Native.Builder setBattr(int index,
                                                             OpenrtbCommon.CreativeAttribute value)

repeated .openrtb.CreativeAttribute battr = 4 [packed = true];

 Blocked creative attributes. Refer to List 5.3.
 

addBattr

public Openrtb.BidRequest.Impression.Native.Builder addBattr(OpenrtbCommon.CreativeAttribute value)

repeated .openrtb.CreativeAttribute battr = 4 [packed = true];

 Blocked creative attributes. Refer to List 5.3.
 

addAllBattr

public Openrtb.BidRequest.Impression.Native.Builder addAllBattr(Iterable<? extends OpenrtbCommon.CreativeAttribute> values)

repeated .openrtb.CreativeAttribute battr = 4 [packed = true];

 Blocked creative attributes. Refer to List 5.3.
 

clearBattr

public Openrtb.BidRequest.Impression.Native.Builder clearBattr()

repeated .openrtb.CreativeAttribute battr = 4 [packed = true];

 Blocked creative attributes. Refer to List 5.3.
 

hasExt

public boolean hasExt()

optional .openrtb.NativeExtensions ext = 1000;

Specified by:

hasExt in interface Openrtb.BidRequest.Impression.NativeOrBuilder

getExt

public Extension.NativeExtensions getExt()

optional .openrtb.NativeExtensions ext = 1000;

Specified by:

getExt in interface Openrtb.BidRequest.Impression.NativeOrBuilder

setExt

public Openrtb.BidRequest.Impression.Native.Builder setExt(Extension.NativeExtensions value)

optional .openrtb.NativeExtensions ext = 1000;

setExt

public Openrtb.BidRequest.Impression.Native.Builder setExt(Extension.NativeExtensions.Builder builderForValue)

optional .openrtb.NativeExtensions ext = 1000;

mergeExt

public Openrtb.BidRequest.Impression.Native.Builder mergeExt(Extension.NativeExtensions value)

optional .openrtb.NativeExtensions ext = 1000;

clearExt

public Openrtb.BidRequest.Impression.Native.Builder clearExt()

optional .openrtb.NativeExtensions ext = 1000;

getExtBuilder

public Extension.NativeExtensions.Builder getExtBuilder()

optional .openrtb.NativeExtensions ext = 1000;

getExtOrBuilder

public Extension.NativeExtensionsOrBuilder getExtOrBuilder()

optional .openrtb.NativeExtensions ext = 1000;

Specified by:

getExtOrBuilder in interface Openrtb.BidRequest.Impression.NativeOrBuilder