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 Detail

      • getImpressionTrackingUrlList

        List<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

        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

        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.

      • getClickTrackingUrlsList

        List<String> getClickTrackingUrlsList()
         The URLs to call when the user clicks on the ad. Currently supported only
 for native ads and Programmatic Guaranteed deals with publisher-
 managed creatives. In the publisher managed case, these click trackers
 will be sent to the bidder server to server. In all other cases, these
 will be sent from the user's device. For more information on
 publisher-managed creatives, see
 https://support.google.com/admanager/answer/9243220.
 [AdX: BidResponse.Ad.click_tracking_urls]
        repeated string click_tracking_urls = 22;
        Returns:
        A list containing the clickTrackingUrls.

      • getClickTrackingUrlsCount

        int getClickTrackingUrlsCount()
         The URLs to call when the user clicks on the ad. Currently supported only
 for native ads and Programmatic Guaranteed deals with publisher-
 managed creatives. In the publisher managed case, these click trackers
 will be sent to the bidder server to server. In all other cases, these
 will be sent from the user's device. For more information on
 publisher-managed creatives, see
 https://support.google.com/admanager/answer/9243220.
 [AdX: BidResponse.Ad.click_tracking_urls]
        repeated string click_tracking_urls = 22;
        Returns:
        The count of clickTrackingUrls.

      • getClickTrackingUrls

        String getClickTrackingUrls​(int index)
         The URLs to call when the user clicks on the ad. Currently supported only
 for native ads and Programmatic Guaranteed deals with publisher-
 managed creatives. In the publisher managed case, these click trackers
 will be sent to the bidder server to server. In all other cases, these
 will be sent from the user's device. For more information on
 publisher-managed creatives, see
 https://support.google.com/admanager/answer/9243220.
 [AdX: BidResponse.Ad.click_tracking_urls]
        repeated string click_tracking_urls = 22;
        Parameters:
        index - The index of the element to return.
        Returns:
        The clickTrackingUrls at the given index.

      • getClickTrackingUrlsBytes

        com.google.protobuf.ByteString getClickTrackingUrlsBytes​(int index)
         The URLs to call when the user clicks on the ad. Currently supported only
 for native ads and Programmatic Guaranteed deals with publisher-
 managed creatives. In the publisher managed case, these click trackers
 will be sent to the bidder server to server. In all other cases, these
 will be sent from the user's device. For more information on
 publisher-managed creatives, see
 https://support.google.com/admanager/answer/9243220.
 [AdX: BidResponse.Ad.click_tracking_urls]
        repeated string click_tracking_urls = 22;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the clickTrackingUrls at the given index.

      • hasDEPRECATEDBidderName

        @Deprecated
boolean hasDEPRECATEDBidderName()
        Deprecated.
        com.google.doubleclick.BidExt.DEPRECATED_bidder_name is deprecated. See openrtb-adx.proto;l=318
         This field is deprecated due to being unused.
 [AdX: BidResponse.Ad.bidder_name]
        optional string DEPRECATED_bidder_name = 3 [deprecated = true];
        Returns:
        Whether the dEPRECATEDBidderName field is set.

      • getDEPRECATEDBidderName

        @Deprecated
String getDEPRECATEDBidderName()
        Deprecated.
        com.google.doubleclick.BidExt.DEPRECATED_bidder_name is deprecated. See openrtb-adx.proto;l=318
         This field is deprecated due to being unused.
 [AdX: BidResponse.Ad.bidder_name]
        optional string DEPRECATED_bidder_name = 3 [deprecated = true];
        Returns:
        The dEPRECATEDBidderName.

      • getDEPRECATEDBidderNameBytes

        @Deprecated
com.google.protobuf.ByteString getDEPRECATEDBidderNameBytes()
        Deprecated.
        com.google.doubleclick.BidExt.DEPRECATED_bidder_name is deprecated. See openrtb-adx.proto;l=318
         This field is deprecated due to being unused.
 [AdX: BidResponse.Ad.bidder_name]
        optional string DEPRECATED_bidder_name = 3 [deprecated = true];
        Returns:
        The bytes for dEPRECATEDBidderName.

      • 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

        List<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

        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.

      • 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

        List<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
 and the bidder does not have any active child seats, 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
 and the bidder does not have any active child seats, this field
 is not required and its contents will be ignored.
        optional int64 billing_id = 10;
        Returns:
        The billingId.

      • 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

        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.

      • hasBuyerReportingId

        boolean hasBuyerReportingId()
         Buyer declared ID which will be used to break down spend and invalid
 traffic metrics in IVT transparency reporting in Query Tool. Note that IDs
 with fewer than 1000 impressions will not be used to break down metrics.
 IDs longer than 64 bytes will be ignored.
        optional string buyer_reporting_id = 17;
        Returns:
        Whether the buyerReportingId field is set.

      • getBuyerReportingId

        String getBuyerReportingId()
         Buyer declared ID which will be used to break down spend and invalid
 traffic metrics in IVT transparency reporting in Query Tool. Note that IDs
 with fewer than 1000 impressions will not be used to break down metrics.
 IDs longer than 64 bytes will be ignored.
        optional string buyer_reporting_id = 17;
        Returns:
        The buyerReportingId.

      • getBuyerReportingIdBytes

        com.google.protobuf.ByteString getBuyerReportingIdBytes()
         Buyer declared ID which will be used to break down spend and invalid
 traffic metrics in IVT transparency reporting in Query Tool. Note that IDs
 with fewer than 1000 impressions will not be used to break down metrics.
 IDs longer than 64 bytes will be ignored.
        optional string buyer_reporting_id = 17;
        Returns:
        The bytes for buyerReportingId.

      • getFcapCount

        int getFcapCount()
        repeated .com.google.doubleclick.BidExt.FrequencyCap fcap = 18;

      • hasSkadn

        boolean hasSkadn()
         [AdX: BidResponse.Ad.skadn]
        optional .com.google.doubleclick.BidExt.SKAdNetworkResponse skadn = 19;
        Returns:
        Whether the skadn field is set.

      • getSkadn

        AdxExt.BidExt.SKAdNetworkResponse getSkadn()
         [AdX: BidResponse.Ad.skadn]
        optional .com.google.doubleclick.BidExt.SKAdNetworkResponse skadn = 19;
        Returns:
        The skadn.