Package com.google.doubleclick

Interface AdxExt.BidExtOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

AdxExt.BidExt, AdxExt.BidExt.Builder

Enclosing class:

AdxExt

public static interface AdxExt.BidExtOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAdChoicesDestinationUrl()	[AdX: BidResponse.Ad.ad_choices_destination_url]
com.google.protobuf.ByteString	getAdChoicesDestinationUrlBytes()	[AdX: BidResponse.Ad.ad_choices_destination_url]
java.lang.String	getAmpAdUrl()	The URL to fetch an AMPHTML ad.
com.google.protobuf.ByteString	getAmpAdUrlBytes()	The URL to fetch an AMPHTML ad.
int	getAttribute(int index)	[AdX: BidResponse.Ad.attribute] See buyer-declarable-creative-attributes.txt in the technical documentation for a list of ids.
int	getAttributeCount()	[AdX: BidResponse.Ad.attribute] See buyer-declarable-creative-attributes.txt in the technical documentation for a list of ids.
java.util.List<java.lang.Integer>	getAttributeList()	[AdX: BidResponse.Ad.attribute] See buyer-declarable-creative-attributes.txt in the technical documentation for a list of ids.
java.lang.String	getBidderName()	[AdX: BidResponse.Ad.bidder_name]
com.google.protobuf.ByteString	getBidderNameBytes()	[AdX: BidResponse.Ad.bidder_name]
long	getBillingId()	The billing ID to attribute this impression to.
AdxExt.BidExt.EventNotificationToken	getEventNotificationToken()	A token set by bidders for troubleshooting which will be included in the real-time feedback for the Bid it is sent in.
AdxExt.BidExt.EventNotificationTokenOrBuilder	getEventNotificationTokenOrBuilder()	A token set by bidders for troubleshooting which will be included in the real-time feedback for the Bid it is sent in.
AdxExt.BidExt.ExchangeDealType	getExchangeDealType()	optional .com.google.doubleclick.BidExt.ExchangeDealType exchange_deal_type = 4 [default = OPEN_AUCTION];
java.lang.String	getImpressionTrackingUrl(int index)	[AdX: BidResponse.Ad.impression_tracking_url]
com.google.protobuf.ByteString	getImpressionTrackingUrlBytes(int index)	[AdX: BidResponse.Ad.impression_tracking_url]
int	getImpressionTrackingUrlCount()	[AdX: BidResponse.Ad.impression_tracking_url]
java.util.List<java.lang.String>	getImpressionTrackingUrlList()	[AdX: BidResponse.Ad.impression_tracking_url]
int	getRestrictedCategory(int index)	All restricted categories for the ads that may be shown from this snippet.
int	getRestrictedCategoryCount()	All restricted categories for the ads that may be shown from this snippet.
java.util.List<java.lang.Integer>	getRestrictedCategoryList()	All restricted categories for the ads that may be shown from this snippet.
AdxExt.BidExt.SdkRenderedAd	getSdkRenderedAd()	optional .com.google.doubleclick.BidExt.SdkRenderedAd sdk_rendered_ad = 7;
AdxExt.BidExt.SdkRenderedAdOrBuilder	getSdkRenderedAdOrBuilder()	optional .com.google.doubleclick.BidExt.SdkRenderedAd sdk_rendered_ad = 7;
java.lang.String	getThirdPartyBuyerToken()	Token used to identify end third party buyer information if an exchange as an open bidder is an intermediary.
com.google.protobuf.ByteString	getThirdPartyBuyerTokenBytes()	Token used to identify end third party buyer information if an exchange as an open bidder is an intermediary.
boolean	getUseBidTranslationService()	[AdX: BidResponse.Ad.AdSlot.use_bid_translation_service] This field is applicable only for bid requests that are marked as first price, and will otherwise be ignored.
boolean	hasAdChoicesDestinationUrl()	[AdX: BidResponse.Ad.ad_choices_destination_url]
boolean	hasAmpAdUrl()	The URL to fetch an AMPHTML ad.
boolean	hasBidderName()	[AdX: BidResponse.Ad.bidder_name]
boolean	hasBillingId()	The billing ID to attribute this impression to.
boolean	hasEventNotificationToken()	A token set by bidders for troubleshooting which will be included in the real-time feedback for the Bid it is sent in.
boolean	hasExchangeDealType()	optional .com.google.doubleclick.BidExt.ExchangeDealType exchange_deal_type = 4 [default = OPEN_AUCTION];
boolean	hasSdkRenderedAd()	optional .com.google.doubleclick.BidExt.SdkRenderedAd sdk_rendered_ad = 7;
boolean	hasThirdPartyBuyerToken()	Token used to identify end third party buyer information if an exchange as an open bidder is an intermediary.
boolean	hasUseBidTranslationService()	[AdX: BidResponse.Ad.AdSlot.use_bid_translation_service] This field is applicable only for bid requests that are marked as first price, and will otherwise be ignored.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Detail

getImpressionTrackingUrlList

java.util.List<java.lang.String> getImpressionTrackingUrlList()

 [AdX: BidResponse.Ad.impression_tracking_url]
 

repeated string impression_tracking_url = 1;

Returns:

A list containing the impressionTrackingUrl.

getImpressionTrackingUrlCount

int getImpressionTrackingUrlCount()

 [AdX: BidResponse.Ad.impression_tracking_url]
 

repeated string impression_tracking_url = 1;

Returns:

The count of impressionTrackingUrl.

getImpressionTrackingUrl

java.lang.String getImpressionTrackingUrl(int index)

 [AdX: BidResponse.Ad.impression_tracking_url]
 

repeated string impression_tracking_url = 1;

Parameters:

index - The index of the element to return.

Returns:

The impressionTrackingUrl at the given index.

getImpressionTrackingUrlBytes

com.google.protobuf.ByteString getImpressionTrackingUrlBytes(int index)

 [AdX: BidResponse.Ad.impression_tracking_url]
 

repeated string impression_tracking_url = 1;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the impressionTrackingUrl at the given index.

hasAdChoicesDestinationUrl

boolean hasAdChoicesDestinationUrl()

 [AdX: BidResponse.Ad.ad_choices_destination_url]
 

optional string ad_choices_destination_url = 2;

Returns:

Whether the adChoicesDestinationUrl field is set.

getAdChoicesDestinationUrl

java.lang.String getAdChoicesDestinationUrl()

 [AdX: BidResponse.Ad.ad_choices_destination_url]
 

optional string ad_choices_destination_url = 2;

Returns:

The adChoicesDestinationUrl.

getAdChoicesDestinationUrlBytes

com.google.protobuf.ByteString getAdChoicesDestinationUrlBytes()

 [AdX: BidResponse.Ad.ad_choices_destination_url]
 

optional string ad_choices_destination_url = 2;

Returns:

The bytes for adChoicesDestinationUrl.

hasBidderName

boolean hasBidderName()

 [AdX: BidResponse.Ad.bidder_name]
 

optional string bidder_name = 3;

Returns:

Whether the bidderName field is set.

getBidderName

java.lang.String getBidderName()

 [AdX: BidResponse.Ad.bidder_name]
 

optional string bidder_name = 3;

Returns:

The bidderName.

getBidderNameBytes

com.google.protobuf.ByteString getBidderNameBytes()

 [AdX: BidResponse.Ad.bidder_name]
 

optional string bidder_name = 3;

Returns:

The bytes for bidderName.

hasExchangeDealType

boolean hasExchangeDealType()

optional .com.google.doubleclick.BidExt.ExchangeDealType exchange_deal_type = 4 [default = OPEN_AUCTION];

Returns:

Whether the exchangeDealType field is set.

getExchangeDealType

AdxExt.BidExt.ExchangeDealType getExchangeDealType()

optional .com.google.doubleclick.BidExt.ExchangeDealType exchange_deal_type = 4 [default = OPEN_AUCTION];

Returns:

The exchangeDealType.

getAttributeList

java.util.List<java.lang.Integer> getAttributeList()

 [AdX: BidResponse.Ad.attribute]
 See buyer-declarable-creative-attributes.txt in the technical documentation
 for a list of ids. Note that not all declarable attributes come through in
 the BidRequest in the various `battr` fields.
 

repeated int32 attribute = 5 [packed = true];

Returns:

A list containing the attribute.

getAttributeCount

int getAttributeCount()

 [AdX: BidResponse.Ad.attribute]
 See buyer-declarable-creative-attributes.txt in the technical documentation
 for a list of ids. Note that not all declarable attributes come through in
 the BidRequest in the various `battr` fields.
 

repeated int32 attribute = 5 [packed = true];

Returns:

The count of attribute.

getAttribute

int getAttribute(int index)

 [AdX: BidResponse.Ad.attribute]
 See buyer-declarable-creative-attributes.txt in the technical documentation
 for a list of ids. Note that not all declarable attributes come through in
 the BidRequest in the various `battr` fields.
 

repeated int32 attribute = 5 [packed = true];

Parameters:

index - The index of the element to return.

Returns:

The attribute at the given index.

hasAmpAdUrl

boolean hasAmpAdUrl()

 The URL to fetch an AMPHTML ad. Only one of the following should be set:
 html_snippet, video_url, amp_ad_url, native_ad.
 

optional string amp_ad_url = 6;

Returns:

Whether the ampAdUrl field is set.

getAmpAdUrl

java.lang.String getAmpAdUrl()

 The URL to fetch an AMPHTML ad. Only one of the following should be set:
 html_snippet, video_url, amp_ad_url, native_ad.
 

optional string amp_ad_url = 6;

Returns:

The ampAdUrl.

getAmpAdUrlBytes

com.google.protobuf.ByteString getAmpAdUrlBytes()

 The URL to fetch an AMPHTML ad. Only one of the following should be set:
 html_snippet, video_url, amp_ad_url, native_ad.
 

optional string amp_ad_url = 6;

Returns:

The bytes for ampAdUrl.

hasSdkRenderedAd

boolean hasSdkRenderedAd()

optional .com.google.doubleclick.BidExt.SdkRenderedAd sdk_rendered_ad = 7;

Returns:

Whether the sdkRenderedAd field is set.

getSdkRenderedAd

AdxExt.BidExt.SdkRenderedAd getSdkRenderedAd()

optional .com.google.doubleclick.BidExt.SdkRenderedAd sdk_rendered_ad = 7;

Returns:

The sdkRenderedAd.

getSdkRenderedAdOrBuilder

AdxExt.BidExt.SdkRenderedAdOrBuilder getSdkRenderedAdOrBuilder()

optional .com.google.doubleclick.BidExt.SdkRenderedAd sdk_rendered_ad = 7;

hasEventNotificationToken

boolean hasEventNotificationToken()

 A token set by bidders for troubleshooting which will be included in the
 real-time feedback for the Bid it is sent in. The contents of the token
 will not be logged.
 

optional .com.google.doubleclick.BidExt.EventNotificationToken event_notification_token = 8;

Returns:

Whether the eventNotificationToken field is set.

getEventNotificationToken

AdxExt.BidExt.EventNotificationToken getEventNotificationToken()

 A token set by bidders for troubleshooting which will be included in the
 real-time feedback for the Bid it is sent in. The contents of the token
 will not be logged.
 

optional .com.google.doubleclick.BidExt.EventNotificationToken event_notification_token = 8;

Returns:

The eventNotificationToken.

getEventNotificationTokenOrBuilder

AdxExt.BidExt.EventNotificationTokenOrBuilder getEventNotificationTokenOrBuilder()

 A token set by bidders for troubleshooting which will be included in the
 real-time feedback for the Bid it is sent in. The contents of the token
 will not be logged.
 

optional .com.google.doubleclick.BidExt.EventNotificationToken event_notification_token = 8;

getRestrictedCategoryList

java.util.List<java.lang.Integer> getRestrictedCategoryList()

 All restricted categories for the ads that may be shown from this snippet.
 See ad-restricted-categories.txt in the technical documentation for a list
 of ids. If you are bidding with ads in restricted categories, you must
 always declare them here.
 

repeated int32 restricted_category = 9;

Returns:

A list containing the restrictedCategory.

getRestrictedCategoryCount

int getRestrictedCategoryCount()

 All restricted categories for the ads that may be shown from this snippet.
 See ad-restricted-categories.txt in the technical documentation for a list
 of ids. If you are bidding with ads in restricted categories, you must
 always declare them here.
 

repeated int32 restricted_category = 9;

Returns:

The count of restrictedCategory.

getRestrictedCategory

int getRestrictedCategory(int index)

 All restricted categories for the ads that may be shown from this snippet.
 See ad-restricted-categories.txt in the technical documentation for a list
 of ids. If you are bidding with ads in restricted categories, you must
 always declare them here.
 

repeated int32 restricted_category = 9;

Parameters:

index - The index of the element to return.

Returns:

The restrictedCategory at the given index.

hasBillingId

boolean hasBillingId()

 The billing ID to attribute this impression to. The value must be in the
 repeated BidRequest.Imp.ImpExt.billing_id field sent for this impression.
 If the length of BidRequest.Imp.ImpExt.billing_id is exactly 1, this field
 is not required and its contents will be ignored.
 

optional int64 billing_id = 10;

Returns:

Whether the billingId field is set.

getBillingId

long getBillingId()

 The billing ID to attribute this impression to. The value must be in the
 repeated BidRequest.Imp.ImpExt.billing_id field sent for this impression.
 If the length of BidRequest.Imp.ImpExt.billing_id is exactly 1, this field
 is not required and its contents will be ignored.
 

optional int64 billing_id = 10;

Returns:

The billingId.

hasUseBidTranslationService

boolean hasUseBidTranslationService()

 [AdX: BidResponse.Ad.AdSlot.use_bid_translation_service]
 This field is applicable only for bid requests that are marked as first
 price, and will otherwise be ignored. If the field is set to true on a
 first price request, then the bid will go through a bid translation service
 that converts the second price bid into a first price bid for
 participation in the first price auction (i.e. may reduce but will
 never increase the bid). If the field is not set, then for first price
 eligible queries the bid will be treated as a first price bid. This
 field is a temporary product for bidders that require assistance
 migrating to 1st price bidding, and will eventually be deprecated.
 

optional bool use_bid_translation_service = 12;

Returns:

Whether the useBidTranslationService field is set.

getUseBidTranslationService

boolean getUseBidTranslationService()

 [AdX: BidResponse.Ad.AdSlot.use_bid_translation_service]
 This field is applicable only for bid requests that are marked as first
 price, and will otherwise be ignored. If the field is set to true on a
 first price request, then the bid will go through a bid translation service
 that converts the second price bid into a first price bid for
 participation in the first price auction (i.e. may reduce but will
 never increase the bid). If the field is not set, then for first price
 eligible queries the bid will be treated as a first price bid. This
 field is a temporary product for bidders that require assistance
 migrating to 1st price bidding, and will eventually be deprecated.
 

optional bool use_bid_translation_service = 12;

Returns:

The useBidTranslationService.

hasThirdPartyBuyerToken

boolean hasThirdPartyBuyerToken()

 Token used to identify end third party buyer information if an
 exchange as an open bidder is an intermediary. This is obtained from the
 third party buyer and must be passed to Google unaltered in the bid
 response.
 

optional string third_party_buyer_token = 14;

Returns:

Whether the thirdPartyBuyerToken field is set.

getThirdPartyBuyerToken

java.lang.String getThirdPartyBuyerToken()

 Token used to identify end third party buyer information if an
 exchange as an open bidder is an intermediary. This is obtained from the
 third party buyer and must be passed to Google unaltered in the bid
 response.
 

optional string third_party_buyer_token = 14;

Returns:

The thirdPartyBuyerToken.

getThirdPartyBuyerTokenBytes

com.google.protobuf.ByteString getThirdPartyBuyerTokenBytes()

 Token used to identify end third party buyer information if an
 exchange as an open bidder is an intermediary. This is obtained from the
 third party buyer and must be passed to Google unaltered in the bid
 response.
 

optional string third_party_buyer_token = 14;

Returns:

The bytes for thirdPartyBuyerToken.