public static final class Openrtb.BidRequest.Impression.Native.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Openrtb.BidRequest.Impression.Native.Builder> implements Openrtb.BidRequest.Impression.NativeOrBuilder
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.Protobuf type
openrtb.BidRequest.Impression.Native| Modifier and Type | Method and Description |
|---|---|
Openrtb.BidRequest.Impression.Native.Builder |
addAllApi(Iterable<? extends OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework> values)
List of supported API frameworks for this impression.
|
Openrtb.BidRequest.Impression.Native.Builder |
addAllBattr(Iterable<? extends OpenrtbCommon.CreativeAttribute> values)
Blocked creative attributes.
|
Openrtb.BidRequest.Impression.Native.Builder |
addApi(OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework value)
List of supported API frameworks for this impression.
|
Openrtb.BidRequest.Impression.Native.Builder |
addBattr(OpenrtbCommon.CreativeAttribute value)
Blocked creative attributes.
|
Openrtb.BidRequest.Impression.Native.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Openrtb.BidRequest.Impression.Native |
build() |
Openrtb.BidRequest.Impression.Native |
buildPartial() |
Openrtb.BidRequest.Impression.Native.Builder |
clear() |
Openrtb.BidRequest.Impression.Native.Builder |
clearApi()
List of supported API frameworks for this impression.
|
Openrtb.BidRequest.Impression.Native.Builder |
clearBattr()
Blocked creative attributes.
|
Openrtb.BidRequest.Impression.Native.Builder |
clearExt()
optional .openrtb.NativeExtensions ext = 1000; |
Openrtb.BidRequest.Impression.Native.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
Openrtb.BidRequest.Impression.Native.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
Openrtb.BidRequest.Impression.Native.Builder |
clearRequest()
Request payload complying with the Native Ad Specification.
|
Openrtb.BidRequest.Impression.Native.Builder |
clearVer()
Version of the Native Ad Specification to which request complies;
highly recommended for efficient parsing.
|
Openrtb.BidRequest.Impression.Native.Builder |
clone() |
OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework |
getApi(int index)
List of supported API frameworks for this impression.
|
int |
getApiCount()
List of supported API frameworks for this impression.
|
List<OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework> |
getApiList()
List of supported API frameworks for this impression.
|
OpenrtbCommon.CreativeAttribute |
getBattr(int index)
Blocked creative attributes.
|
int |
getBattrCount()
Blocked creative attributes.
|
List<OpenrtbCommon.CreativeAttribute> |
getBattrList()
Blocked creative attributes.
|
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()
Request payload complying with the Native Ad Specification.
|
Openrtb.NativeRequest.Builder |
getRequestBuilder()
Request payload complying with the Native Ad Specification.
|
Openrtb.NativeRequestOrBuilder |
getRequestOrBuilder()
Request payload complying with the Native Ad Specification.
|
String |
getVer()
Version of the Native Ad Specification to which request complies;
highly recommended for efficient parsing.
|
com.google.protobuf.ByteString |
getVerBytes()
Version of the Native Ad Specification to which request complies;
highly recommended for efficient parsing.
|
boolean |
hasExt()
optional .openrtb.NativeExtensions ext = 1000; |
boolean |
hasRequest()
Request payload complying with the Native Ad Specification.
|
boolean |
hasVer()
Version of the Native Ad Specification to which request complies;
highly recommended for efficient parsing.
|
protected com.google.protobuf.GeneratedMessageV3.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)
Request payload complying with the Native Ad Specification.
|
Openrtb.BidRequest.Impression.Native.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Openrtb.BidRequest.Impression.Native.Builder |
setApi(int index,
OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework value)
List of supported API frameworks for this impression.
|
Openrtb.BidRequest.Impression.Native.Builder |
setBattr(int index,
OpenrtbCommon.CreativeAttribute value)
Blocked creative attributes.
|
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 |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Openrtb.BidRequest.Impression.Native.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
Openrtb.BidRequest.Impression.Native.Builder |
setRequest(Openrtb.NativeRequest.Builder builderForValue)
Request payload complying with the Native Ad Specification.
|
Openrtb.BidRequest.Impression.Native.Builder |
setRequest(Openrtb.NativeRequest value)
Request payload complying with the Native Ad Specification.
|
Openrtb.BidRequest.Impression.Native.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Openrtb.BidRequest.Impression.Native.Builder |
setVer(String value)
Version of the Native Ad Specification to which request complies;
highly recommended for efficient parsing.
|
Openrtb.BidRequest.Impression.Native.Builder |
setVerBytes(com.google.protobuf.ByteString value)
Version of the Native Ad Specification to which request complies;
highly recommended for efficient parsing.
|
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, parseUnknownFieldfindInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Openrtb.BidRequest.Impression.Native.Builder>public Openrtb.BidRequest.Impression.Native.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Openrtb.BidRequest.Impression.Native.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Openrtb.BidRequest.Impression.Native.Builder>public Openrtb.BidRequest.Impression.Native getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Openrtb.BidRequest.Impression.Native build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Openrtb.BidRequest.Impression.Native buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Openrtb.BidRequest.Impression.Native.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Openrtb.BidRequest.Impression.Native.Builder>public Openrtb.BidRequest.Impression.Native.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Openrtb.BidRequest.Impression.Native.Builder>public Openrtb.BidRequest.Impression.Native.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Openrtb.BidRequest.Impression.Native.Builder>public Openrtb.BidRequest.Impression.Native.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Openrtb.BidRequest.Impression.Native.Builder>public Openrtb.BidRequest.Impression.Native.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Openrtb.BidRequest.Impression.Native.Builder>public Openrtb.BidRequest.Impression.Native.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Openrtb.BidRequest.Impression.Native.Builder>public Openrtb.BidRequest.Impression.Native.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Openrtb.BidRequest.Impression.Native.Builder>public Openrtb.BidRequest.Impression.Native.Builder mergeFrom(Openrtb.BidRequest.Impression.Native other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Openrtb.BidRequest.Impression.Native.Builder>public Openrtb.BidRequest.Impression.Native.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Openrtb.BidRequest.Impression.Native.Builder>IOExceptionpublic boolean hasRequest()
Request payload complying with the Native Ad Specification.
required .openrtb.NativeRequest request = 1;hasRequest in interface Openrtb.BidRequest.Impression.NativeOrBuilderpublic Openrtb.NativeRequest getRequest()
Request payload complying with the Native Ad Specification.
required .openrtb.NativeRequest request = 1;getRequest in interface Openrtb.BidRequest.Impression.NativeOrBuilderpublic Openrtb.BidRequest.Impression.Native.Builder setRequest(Openrtb.NativeRequest value)
Request payload complying with the Native Ad Specification.
required .openrtb.NativeRequest request = 1;public Openrtb.BidRequest.Impression.Native.Builder setRequest(Openrtb.NativeRequest.Builder builderForValue)
Request payload complying with the Native Ad Specification.
required .openrtb.NativeRequest request = 1;public Openrtb.BidRequest.Impression.Native.Builder mergeRequest(Openrtb.NativeRequest value)
Request payload complying with the Native Ad Specification.
required .openrtb.NativeRequest request = 1;public Openrtb.BidRequest.Impression.Native.Builder clearRequest()
Request payload complying with the Native Ad Specification.
required .openrtb.NativeRequest request = 1;public Openrtb.NativeRequest.Builder getRequestBuilder()
Request payload complying with the Native Ad Specification.
required .openrtb.NativeRequest request = 1;public Openrtb.NativeRequestOrBuilder getRequestOrBuilder()
Request payload complying with the Native Ad Specification.
required .openrtb.NativeRequest request = 1;getRequestOrBuilder in interface Openrtb.BidRequest.Impression.NativeOrBuilderpublic boolean hasVer()
Version of the Native Ad Specification to which request complies; highly recommended for efficient parsing.
optional string ver = 2;hasVer in interface Openrtb.BidRequest.Impression.NativeOrBuilderpublic String getVer()
Version of the Native Ad Specification to which request complies; highly recommended for efficient parsing.
optional string ver = 2;getVer in interface Openrtb.BidRequest.Impression.NativeOrBuilderpublic com.google.protobuf.ByteString getVerBytes()
Version of the Native Ad Specification to which request complies; highly recommended for efficient parsing.
optional string ver = 2;getVerBytes in interface Openrtb.BidRequest.Impression.NativeOrBuilderpublic Openrtb.BidRequest.Impression.Native.Builder setVer(String value)
Version of the Native Ad Specification to which request complies; highly recommended for efficient parsing.
optional string ver = 2;public Openrtb.BidRequest.Impression.Native.Builder clearVer()
Version of the Native Ad Specification to which request complies; highly recommended for efficient parsing.
optional string ver = 2;public Openrtb.BidRequest.Impression.Native.Builder setVerBytes(com.google.protobuf.ByteString value)
Version of the Native Ad Specification to which request complies; highly recommended for efficient parsing.
optional string ver = 2;public List<OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework> getApiList()
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.
repeated .openrtb.Enums.BidRequest.Impression.ApiFramework api = 3 [packed = true];getApiList in interface Openrtb.BidRequest.Impression.NativeOrBuilderpublic int getApiCount()
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.
repeated .openrtb.Enums.BidRequest.Impression.ApiFramework api = 3 [packed = true];getApiCount in interface Openrtb.BidRequest.Impression.NativeOrBuilderpublic OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework getApi(int index)
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.
repeated .openrtb.Enums.BidRequest.Impression.ApiFramework api = 3 [packed = true];getApi in interface Openrtb.BidRequest.Impression.NativeOrBuilderpublic Openrtb.BidRequest.Impression.Native.Builder setApi(int index, OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework value)
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.
repeated .openrtb.Enums.BidRequest.Impression.ApiFramework api = 3 [packed = true];public Openrtb.BidRequest.Impression.Native.Builder addApi(OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework value)
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.
repeated .openrtb.Enums.BidRequest.Impression.ApiFramework api = 3 [packed = true];public Openrtb.BidRequest.Impression.Native.Builder addAllApi(Iterable<? extends OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework> values)
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.
repeated .openrtb.Enums.BidRequest.Impression.ApiFramework api = 3 [packed = true];public Openrtb.BidRequest.Impression.Native.Builder clearApi()
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.
repeated .openrtb.Enums.BidRequest.Impression.ApiFramework api = 3 [packed = true];public List<OpenrtbCommon.CreativeAttribute> getBattrList()
Blocked creative attributes. Refer to List 5.3.
repeated .openrtb.CreativeAttribute battr = 4 [packed = true];getBattrList in interface Openrtb.BidRequest.Impression.NativeOrBuilderpublic int getBattrCount()
Blocked creative attributes. Refer to List 5.3.
repeated .openrtb.CreativeAttribute battr = 4 [packed = true];getBattrCount in interface Openrtb.BidRequest.Impression.NativeOrBuilderpublic OpenrtbCommon.CreativeAttribute getBattr(int index)
Blocked creative attributes. Refer to List 5.3.
repeated .openrtb.CreativeAttribute battr = 4 [packed = true];getBattr in interface Openrtb.BidRequest.Impression.NativeOrBuilderpublic Openrtb.BidRequest.Impression.Native.Builder setBattr(int index, OpenrtbCommon.CreativeAttribute value)
Blocked creative attributes. Refer to List 5.3.
repeated .openrtb.CreativeAttribute battr = 4 [packed = true];public Openrtb.BidRequest.Impression.Native.Builder addBattr(OpenrtbCommon.CreativeAttribute value)
Blocked creative attributes. Refer to List 5.3.
repeated .openrtb.CreativeAttribute battr = 4 [packed = true];public Openrtb.BidRequest.Impression.Native.Builder addAllBattr(Iterable<? extends OpenrtbCommon.CreativeAttribute> values)
Blocked creative attributes. Refer to List 5.3.
repeated .openrtb.CreativeAttribute battr = 4 [packed = true];public Openrtb.BidRequest.Impression.Native.Builder clearBattr()
Blocked creative attributes. Refer to List 5.3.
repeated .openrtb.CreativeAttribute battr = 4 [packed = true];public boolean hasExt()
optional .openrtb.NativeExtensions ext = 1000;hasExt in interface Openrtb.BidRequest.Impression.NativeOrBuilderpublic Extension.NativeExtensions getExt()
optional .openrtb.NativeExtensions ext = 1000;getExt in interface Openrtb.BidRequest.Impression.NativeOrBuilderpublic Openrtb.BidRequest.Impression.Native.Builder setExt(Extension.NativeExtensions value)
optional .openrtb.NativeExtensions ext = 1000;public Openrtb.BidRequest.Impression.Native.Builder setExt(Extension.NativeExtensions.Builder builderForValue)
optional .openrtb.NativeExtensions ext = 1000;public Openrtb.BidRequest.Impression.Native.Builder mergeExt(Extension.NativeExtensions value)
optional .openrtb.NativeExtensions ext = 1000;public Openrtb.BidRequest.Impression.Native.Builder clearExt()
optional .openrtb.NativeExtensions ext = 1000;public Extension.NativeExtensions.Builder getExtBuilder()
optional .openrtb.NativeExtensions ext = 1000;public Extension.NativeExtensionsOrBuilder getExtOrBuilder()
optional .openrtb.NativeExtensions ext = 1000;getExtOrBuilder in interface Openrtb.BidRequest.Impression.NativeOrBuilderpublic final Openrtb.BidRequest.Impression.Native.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Openrtb.BidRequest.Impression.Native.Builder>public final Openrtb.BidRequest.Impression.Native.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Openrtb.BidRequest.Impression.Native.Builder>Copyright © 2017. All rights reserved.