Class AdExchangeCreativeDetails (0.62.0)

public final class AdExchangeCreativeDetails extends GeneratedMessage implements AdExchangeCreativeDetailsOrBuilder

An Ad Exchange dynamic allocation creative.

Protobuf type google.ads.admanager.v1.AdExchangeCreativeDetails

Static Fields

ALLOWS_ALL_REQUESTED_SIZES_FIELD_NUMBER

public static final int ALLOWS_ALL_REQUESTED_SIZES_FIELD_NUMBER
Field Value
Type Description
int

BACKFILL_SNIPPET_FIELD_NUMBER

public static final int BACKFILL_SNIPPET_FIELD_NUMBER
Field Value
Type Description
int

INTERSTITIAL_FIELD_NUMBER

public static final int INTERSTITIAL_FIELD_NUMBER
Field Value
Type Description
int

NATIVE_ELIGIBLE_FIELD_NUMBER

public static final int NATIVE_ELIGIBLE_FIELD_NUMBER
Field Value
Type Description
int

SLOT_ID_FIELD_NUMBER

public static final int SLOT_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AdExchangeCreativeDetails getDefaultInstance()
Returns
Type Description
AdExchangeCreativeDetails

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AdExchangeCreativeDetails.Builder newBuilder()
Returns
Type Description
AdExchangeCreativeDetails.Builder

newBuilder(AdExchangeCreativeDetails prototype)

public static AdExchangeCreativeDetails.Builder newBuilder(AdExchangeCreativeDetails prototype)
Parameter
Name Description
prototype AdExchangeCreativeDetails
Returns
Type Description
AdExchangeCreativeDetails.Builder

parseDelimitedFrom(InputStream input)

public static AdExchangeCreativeDetails parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AdExchangeCreativeDetails
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AdExchangeCreativeDetails parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AdExchangeCreativeDetails
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AdExchangeCreativeDetails parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AdExchangeCreativeDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AdExchangeCreativeDetails parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AdExchangeCreativeDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AdExchangeCreativeDetails parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AdExchangeCreativeDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AdExchangeCreativeDetails parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AdExchangeCreativeDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AdExchangeCreativeDetails parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AdExchangeCreativeDetails
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AdExchangeCreativeDetails parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AdExchangeCreativeDetails
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AdExchangeCreativeDetails parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AdExchangeCreativeDetails
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AdExchangeCreativeDetails parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AdExchangeCreativeDetails
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AdExchangeCreativeDetails parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AdExchangeCreativeDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AdExchangeCreativeDetails parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AdExchangeCreativeDetails
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AdExchangeCreativeDetails> parser()
Returns
Type Description
Parser<AdExchangeCreativeDetails>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAllowsAllRequestedSizes()

public boolean getAllowsAllRequestedSizes()

Optional. True if this creative is eligible for all requested sizes.

optional bool allows_all_requested_sizes = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The allowsAllRequestedSizes.

getBackfillSnippet()

public String getBackfillSnippet()

Optional. The code snippet (ad tag) from Ad Exchange or AdSense to traffic the dynamic allocation creative. Only valid Ad Exchange or AdSense parameters will be considered. Any extraneous HTML or JavaScript will be ignored.

optional string backfill_snippet = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The backfillSnippet.

getBackfillSnippetBytes()

public ByteString getBackfillSnippetBytes()

Optional. The code snippet (ad tag) from Ad Exchange or AdSense to traffic the dynamic allocation creative. Only valid Ad Exchange or AdSense parameters will be considered. Any extraneous HTML or JavaScript will be ignored.

optional string backfill_snippet = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for backfillSnippet.

getDefaultInstanceForType()

public AdExchangeCreativeDetails getDefaultInstanceForType()
Returns
Type Description
AdExchangeCreativeDetails

getInterstitial()

public boolean getInterstitial()

Optional. True if this creative is interstitial. An interstitial creative will not consider an impression served until it is fully rendered in the browser.

optional bool interstitial = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The interstitial.

getNativeEligible()

public boolean getNativeEligible()

Optional. Whether this creative is eligible for native ad-serving. This value is optional and defaults to false.

optional bool native_eligible = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The nativeEligible.

getParserForType()

public Parser<AdExchangeCreativeDetails> getParserForType()
Returns
Type Description
Parser<AdExchangeCreativeDetails>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSlotId()

public String getSlotId()

Output only. The ID of ad slot (inventory) that an advertiser might want to target.

optional string slot_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The slotId.

getSlotIdBytes()

public ByteString getSlotIdBytes()

Output only. The ID of ad slot (inventory) that an advertiser might want to target.

optional string slot_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for slotId.

hasAllowsAllRequestedSizes()

public boolean hasAllowsAllRequestedSizes()

Optional. True if this creative is eligible for all requested sizes.

optional bool allows_all_requested_sizes = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the allowsAllRequestedSizes field is set.

hasBackfillSnippet()

public boolean hasBackfillSnippet()

Optional. The code snippet (ad tag) from Ad Exchange or AdSense to traffic the dynamic allocation creative. Only valid Ad Exchange or AdSense parameters will be considered. Any extraneous HTML or JavaScript will be ignored.

optional string backfill_snippet = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the backfillSnippet field is set.

hasInterstitial()

public boolean hasInterstitial()

Optional. True if this creative is interstitial. An interstitial creative will not consider an impression served until it is fully rendered in the browser.

optional bool interstitial = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the interstitial field is set.

hasNativeEligible()

public boolean hasNativeEligible()

Optional. Whether this creative is eligible for native ad-serving. This value is optional and defaults to false.

optional bool native_eligible = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the nativeEligible field is set.

hasSlotId()

public boolean hasSlotId()

Output only. The ID of ad slot (inventory) that an advertiser might want to target.

optional string slot_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the slotId field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AdExchangeCreativeDetails.Builder newBuilderForType()
Returns
Type Description
AdExchangeCreativeDetails.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected AdExchangeCreativeDetails.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AdExchangeCreativeDetails.Builder
Overrides

toBuilder()

public AdExchangeCreativeDetails.Builder toBuilder()
Returns
Type Description
AdExchangeCreativeDetails.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException