Interface AdxExt.ImpExtOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    AdxExt.ImpExt, AdxExt.ImpExt.Builder
    Enclosing class:
    AdxExt

    public static interface AdxExt.ImpExtOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Detail

      • getBillingIdList

        List<Long> getBillingIdList()
         [AdX: BidRequest.AdSlot.MatchingAdData.billing_id]
         
        repeated int64 billing_id = 1;
        Returns:
        A list containing the billingId.
      • getBillingIdCount

        int getBillingIdCount()
         [AdX: BidRequest.AdSlot.MatchingAdData.billing_id]
         
        repeated int64 billing_id = 1;
        Returns:
        The count of billingId.
      • getBillingId

        long getBillingId​(int index)
         [AdX: BidRequest.AdSlot.MatchingAdData.billing_id]
         
        repeated int64 billing_id = 1;
        Parameters:
        index - The index of the element to return.
        Returns:
        The billingId at the given index.
      • getPublisherSettingsListIdList

        List<Long> getPublisherSettingsListIdList()
         [AdX: BidRequest.publisher_settings_list_id]
         [AdX: BidRequest.AdSlot.publisher_settings_list_id]
         
        repeated fixed64 publisher_settings_list_id = 2;
        Returns:
        A list containing the publisherSettingsListId.
      • getPublisherSettingsListIdCount

        int getPublisherSettingsListIdCount()
         [AdX: BidRequest.publisher_settings_list_id]
         [AdX: BidRequest.AdSlot.publisher_settings_list_id]
         
        repeated fixed64 publisher_settings_list_id = 2;
        Returns:
        The count of publisherSettingsListId.
      • getPublisherSettingsListId

        long getPublisherSettingsListId​(int index)
         [AdX: BidRequest.publisher_settings_list_id]
         [AdX: BidRequest.AdSlot.publisher_settings_list_id]
         
        repeated fixed64 publisher_settings_list_id = 2;
        Parameters:
        index - The index of the element to return.
        Returns:
        The publisherSettingsListId at the given index.
      • getAllowedVendorTypeList

        List<Integer> getAllowedVendorTypeList()
         [AdX: BidRequest.AdSlot.allowed_vendor_type]
         
        repeated int32 allowed_vendor_type = 3 [packed = true];
        Returns:
        A list containing the allowedVendorType.
      • getAllowedVendorTypeCount

        int getAllowedVendorTypeCount()
         [AdX: BidRequest.AdSlot.allowed_vendor_type]
         
        repeated int32 allowed_vendor_type = 3 [packed = true];
        Returns:
        The count of allowedVendorType.
      • getAllowedVendorType

        int getAllowedVendorType​(int index)
         [AdX: BidRequest.AdSlot.allowed_vendor_type]
         
        repeated int32 allowed_vendor_type = 3 [packed = true];
        Parameters:
        index - The index of the element to return.
        Returns:
        The allowedVendorType at the given index.
      • getExcludedCreativesList

        List<AdxExt.ImpExt.ExcludedCreative> getExcludedCreativesList()
         Creatives that are disallowed for the impression. Submitting a bid with
         one of the creatives in this list will result in such bid being filtered
         before the auction. Please contact your account manager if you would like
         to enable this feature.
         
        repeated .com.google.doubleclick.ImpExt.ExcludedCreative excluded_creatives = 10;
      • getExcludedCreatives

        AdxExt.ImpExt.ExcludedCreative getExcludedCreatives​(int index)
         Creatives that are disallowed for the impression. Submitting a bid with
         one of the creatives in this list will result in such bid being filtered
         before the auction. Please contact your account manager if you would like
         to enable this feature.
         
        repeated .com.google.doubleclick.ImpExt.ExcludedCreative excluded_creatives = 10;
      • getExcludedCreativesCount

        int getExcludedCreativesCount()
         Creatives that are disallowed for the impression. Submitting a bid with
         one of the creatives in this list will result in such bid being filtered
         before the auction. Please contact your account manager if you would like
         to enable this feature.
         
        repeated .com.google.doubleclick.ImpExt.ExcludedCreative excluded_creatives = 10;
      • getExcludedCreativesOrBuilderList

        List<? extends AdxExt.ImpExt.ExcludedCreativeOrBuilder> getExcludedCreativesOrBuilderList()
         Creatives that are disallowed for the impression. Submitting a bid with
         one of the creatives in this list will result in such bid being filtered
         before the auction. Please contact your account manager if you would like
         to enable this feature.
         
        repeated .com.google.doubleclick.ImpExt.ExcludedCreative excluded_creatives = 10;
      • getExcludedCreativesOrBuilder

        AdxExt.ImpExt.ExcludedCreativeOrBuilder getExcludedCreativesOrBuilder​(int index)
         Creatives that are disallowed for the impression. Submitting a bid with
         one of the creatives in this list will result in such bid being filtered
         before the auction. Please contact your account manager if you would like
         to enable this feature.
         
        repeated .com.google.doubleclick.ImpExt.ExcludedCreative excluded_creatives = 10;
      • hasDfpAdUnitCode

        boolean hasDfpAdUnitCode()
         [AdX: BidRequest.AdSlot.dfp_ad_unit_code]
         
        optional string dfp_ad_unit_code = 6;
        Returns:
        Whether the dfpAdUnitCode field is set.
      • getDfpAdUnitCode

        String getDfpAdUnitCode()
         [AdX: BidRequest.AdSlot.dfp_ad_unit_code]
         
        optional string dfp_ad_unit_code = 6;
        Returns:
        The dfpAdUnitCode.
      • getDfpAdUnitCodeBytes

        com.google.protobuf.ByteString getDfpAdUnitCodeBytes()
         [AdX: BidRequest.AdSlot.dfp_ad_unit_code]
         
        optional string dfp_ad_unit_code = 6;
        Returns:
        The bytes for dfpAdUnitCode.
      • hasIsRewardedInventory

        boolean hasIsRewardedInventory()
         [AdX: BidRequest.AdSlot.is_rewarded]
         
        optional bool is_rewarded_inventory = 7;
        Returns:
        Whether the isRewardedInventory field is set.
      • getIsRewardedInventory

        boolean getIsRewardedInventory()
         [AdX: BidRequest.AdSlot.is_rewarded]
         
        optional bool is_rewarded_inventory = 7;
        Returns:
        The isRewardedInventory.
      • hasAmpad

        boolean hasAmpad()
        optional .com.google.doubleclick.ImpExt.AmpAdRequirementType ampad = 8 [default = UNKNOWN_AMP_AD_REQUIREMENT_TYPE];
        Returns:
        Whether the ampad field is set.
      • getAmpad

        AdxExt.ImpExt.AmpAdRequirementType getAmpad()
        optional .com.google.doubleclick.ImpExt.AmpAdRequirementType ampad = 8 [default = UNKNOWN_AMP_AD_REQUIREMENT_TYPE];
        Returns:
        The ampad.
      • getBuyerGeneratedRequestDataList

        List<AdxExt.ImpExt.BuyerGeneratedRequestData> getBuyerGeneratedRequestDataList()
        repeated .com.google.doubleclick.ImpExt.BuyerGeneratedRequestData buyer_generated_request_data = 9;
      • getBuyerGeneratedRequestData

        AdxExt.ImpExt.BuyerGeneratedRequestData getBuyerGeneratedRequestData​(int index)
        repeated .com.google.doubleclick.ImpExt.BuyerGeneratedRequestData buyer_generated_request_data = 9;
      • getBuyerGeneratedRequestDataCount

        int getBuyerGeneratedRequestDataCount()
        repeated .com.google.doubleclick.ImpExt.BuyerGeneratedRequestData buyer_generated_request_data = 9;
      • getBuyerGeneratedRequestDataOrBuilder

        AdxExt.ImpExt.BuyerGeneratedRequestDataOrBuilder getBuyerGeneratedRequestDataOrBuilder​(int index)
        repeated .com.google.doubleclick.ImpExt.BuyerGeneratedRequestData buyer_generated_request_data = 9;
      • hasBillableEventRateAdjustment

        boolean hasBillableEventRateAdjustment()
         For ads rendered using a custom SDK only: multiplier applied to bid in
         the auction. The adjustment reflects the likelihood that your bid would
         generate a billable event (i.e. the ad renders successfully) if it won
         the auction, relative to the probability that other bids generate a
         billable event if they won the auction. This adjustment can be larger or
         smaller than 1. This affects the final ranking in the auction only; in
         particular, this multiplier does not affect the payment.
         
        optional double billable_event_rate_adjustment = 16 [default = 1];
        Returns:
        Whether the billableEventRateAdjustment field is set.
      • getBillableEventRateAdjustment

        double getBillableEventRateAdjustment()
         For ads rendered using a custom SDK only: multiplier applied to bid in
         the auction. The adjustment reflects the likelihood that your bid would
         generate a billable event (i.e. the ad renders successfully) if it won
         the auction, relative to the probability that other bids generate a
         billable event if they won the auction. This adjustment can be larger or
         smaller than 1. This affects the final ranking in the auction only; in
         particular, this multiplier does not affect the payment.
         
        optional double billable_event_rate_adjustment = 16 [default = 1];
        Returns:
        The billableEventRateAdjustment.
      • hasOpenBidding

        boolean hasOpenBidding()
        optional .com.google.doubleclick.ImpExt.OpenBidding open_bidding = 12;
        Returns:
        Whether the openBidding field is set.
      • getOpenBidding

        AdxExt.ImpExt.OpenBidding getOpenBidding()
        optional .com.google.doubleclick.ImpExt.OpenBidding open_bidding = 12;
        Returns:
        The openBidding.
      • getAllowedRestrictedCategoryList

        List<Integer> getAllowedRestrictedCategoryList()
         The allowed restricted ad categories. See
         https://storage.googleapis.com/adx-rtb-dictionaries/ad-restricted-categories.txt
         for a list of ids. If you bid with an ad in a restricted category, you MUST
         ALWAYS declare the category in the bid response regardless of the values in
         this field.
         
        repeated int32 allowed_restricted_category = 13;
        Returns:
        A list containing the allowedRestrictedCategory.
      • getAllowedRestrictedCategoryCount

        int getAllowedRestrictedCategoryCount()
         The allowed restricted ad categories. See
         https://storage.googleapis.com/adx-rtb-dictionaries/ad-restricted-categories.txt
         for a list of ids. If you bid with an ad in a restricted category, you MUST
         ALWAYS declare the category in the bid response regardless of the values in
         this field.
         
        repeated int32 allowed_restricted_category = 13;
        Returns:
        The count of allowedRestrictedCategory.
      • getAllowedRestrictedCategory

        int getAllowedRestrictedCategory​(int index)
         The allowed restricted ad categories. See
         https://storage.googleapis.com/adx-rtb-dictionaries/ad-restricted-categories.txt
         for a list of ids. If you bid with an ad in a restricted category, you MUST
         ALWAYS declare the category in the bid response regardless of the values in
         this field.
         
        repeated int32 allowed_restricted_category = 13;
        Parameters:
        index - The index of the element to return.
        Returns:
        The allowedRestrictedCategory at the given index.
      • hasSkadn

        boolean hasSkadn()
         [AdX: BidRequest.Mobile.skadn]
         
        optional .com.google.doubleclick.ImpExt.SKAdNetworkRequest skadn = 14;
        Returns:
        Whether the skadn field is set.
      • getSkadn

        AdxExt.ImpExt.SKAdNetworkRequest getSkadn()
         [AdX: BidRequest.Mobile.skadn]
         
        optional .com.google.doubleclick.ImpExt.SKAdNetworkRequest skadn = 14;
        Returns:
        The skadn.
      • hasCreativeEnforcementSettings

        boolean hasCreativeEnforcementSettings()
        optional .com.google.doubleclick.ImpExt.CreativeEnforcementSettings creative_enforcement_settings = 15;
        Returns:
        Whether the creativeEnforcementSettings field is set.
      • getCreativeEnforcementSettings

        AdxExt.ImpExt.CreativeEnforcementSettings getCreativeEnforcementSettings()
        optional .com.google.doubleclick.ImpExt.CreativeEnforcementSettings creative_enforcement_settings = 15;
        Returns:
        The creativeEnforcementSettings.
      • hasAuctionEnvironment

        boolean hasAuctionEnvironment()
         Specifies where the ad auction runs.
         
        optional .com.google.doubleclick.ImpExt.AuctionEnvironment auction_environment = 18 [default = SERVER_SIDE_AUCTION];
        Returns:
        Whether the auctionEnvironment field is set.
      • getAuctionEnvironment

        AdxExt.ImpExt.AuctionEnvironment getAuctionEnvironment()
         Specifies where the ad auction runs.
         
        optional .com.google.doubleclick.ImpExt.AuctionEnvironment auction_environment = 18 [default = SERVER_SIDE_AUCTION];
        Returns:
        The auctionEnvironment.