Class AdExchangeCreativeDetails.Builder (0.62.0)

public static final class AdExchangeCreativeDetails.Builder extends GeneratedMessage.Builder<AdExchangeCreativeDetails.Builder> implements AdExchangeCreativeDetailsOrBuilder

An Ad Exchange dynamic allocation creative.

Protobuf type google.ads.admanager.v1.AdExchangeCreativeDetails

Static Methods

getDescriptor()

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

Methods

build()

public AdExchangeCreativeDetails build()
Returns
Type Description
AdExchangeCreativeDetails

buildPartial()

public AdExchangeCreativeDetails buildPartial()
Returns
Type Description
AdExchangeCreativeDetails

clear()

public AdExchangeCreativeDetails.Builder clear()
Returns
Type Description
AdExchangeCreativeDetails.Builder
Overrides

clearAllowsAllRequestedSizes()

public AdExchangeCreativeDetails.Builder clearAllowsAllRequestedSizes()

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
AdExchangeCreativeDetails.Builder

This builder for chaining.

clearBackfillSnippet()

public AdExchangeCreativeDetails.Builder clearBackfillSnippet()

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
AdExchangeCreativeDetails.Builder

This builder for chaining.

clearInterstitial()

public AdExchangeCreativeDetails.Builder clearInterstitial()

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
AdExchangeCreativeDetails.Builder

This builder for chaining.

clearNativeEligible()

public AdExchangeCreativeDetails.Builder clearNativeEligible()

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
AdExchangeCreativeDetails.Builder

This builder for chaining.

clearSlotId()

public AdExchangeCreativeDetails.Builder clearSlotId()

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
AdExchangeCreativeDetails.Builder

This builder for chaining.

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AdExchangeCreativeDetails other)

public AdExchangeCreativeDetails.Builder mergeFrom(AdExchangeCreativeDetails other)
Parameter
Name Description
other AdExchangeCreativeDetails
Returns
Type Description
AdExchangeCreativeDetails.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AdExchangeCreativeDetails.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AdExchangeCreativeDetails.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AdExchangeCreativeDetails.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AdExchangeCreativeDetails.Builder
Overrides

setAllowsAllRequestedSizes(boolean value)

public AdExchangeCreativeDetails.Builder setAllowsAllRequestedSizes(boolean value)

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

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

Parameter
Name Description
value boolean

The allowsAllRequestedSizes to set.

Returns
Type Description
AdExchangeCreativeDetails.Builder

This builder for chaining.

setBackfillSnippet(String value)

public AdExchangeCreativeDetails.Builder setBackfillSnippet(String value)

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];

Parameter
Name Description
value String

The backfillSnippet to set.

Returns
Type Description
AdExchangeCreativeDetails.Builder

This builder for chaining.

setBackfillSnippetBytes(ByteString value)

public AdExchangeCreativeDetails.Builder setBackfillSnippetBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for backfillSnippet to set.

Returns
Type Description
AdExchangeCreativeDetails.Builder

This builder for chaining.

setInterstitial(boolean value)

public AdExchangeCreativeDetails.Builder setInterstitial(boolean value)

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];

Parameter
Name Description
value boolean

The interstitial to set.

Returns
Type Description
AdExchangeCreativeDetails.Builder

This builder for chaining.

setNativeEligible(boolean value)

public AdExchangeCreativeDetails.Builder setNativeEligible(boolean value)

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];

Parameter
Name Description
value boolean

The nativeEligible to set.

Returns
Type Description
AdExchangeCreativeDetails.Builder

This builder for chaining.

setSlotId(String value)

public AdExchangeCreativeDetails.Builder setSlotId(String value)

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];

Parameter
Name Description
value String

The slotId to set.

Returns
Type Description
AdExchangeCreativeDetails.Builder

This builder for chaining.

setSlotIdBytes(ByteString value)

public AdExchangeCreativeDetails.Builder setSlotIdBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for slotId to set.

Returns
Type Description
AdExchangeCreativeDetails.Builder

This builder for chaining.