Package com.google.doubleclick

Class AdxExt.ImpExt

  • All Implemented Interfaces:
    AdxExt.ImpExtOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    AdxExt
    public static final class AdxExt.ImpExt
extends com.google.protobuf.GeneratedMessageV3
implements AdxExt.ImpExtOrBuilder
     Ad Exchange extensions for the Imp object.
    Protobuf type com.google.doubleclick.ImpExt
    See Also:
    Serialized Form

    • Field Detail

      • BILLING_ID_FIELD_NUMBER

        public static final int BILLING_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PUBLISHER_SETTINGS_LIST_ID_FIELD_NUMBER

        public static final int PUBLISHER_SETTINGS_LIST_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ALLOWED_VENDOR_TYPE_FIELD_NUMBER

        public static final int ALLOWED_VENDOR_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXCLUDED_CREATIVES_FIELD_NUMBER

        public static final int EXCLUDED_CREATIVES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DFP_AD_UNIT_CODE_FIELD_NUMBER

        public static final int DFP_AD_UNIT_CODE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • IS_REWARDED_INVENTORY_FIELD_NUMBER

        public static final int IS_REWARDED_INVENTORY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BUYER_GENERATED_REQUEST_DATA_FIELD_NUMBER

        public static final int BUYER_GENERATED_REQUEST_DATA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BILLABLE_EVENT_RATE_ADJUSTMENT_FIELD_NUMBER

        public static final int BILLABLE_EVENT_RATE_ADJUSTMENT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OPEN_BIDDING_FIELD_NUMBER

        public static final int OPEN_BIDDING_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ALLOWED_RESTRICTED_CATEGORY_FIELD_NUMBER

        public static final int ALLOWED_RESTRICTED_CATEGORY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CREATIVE_ENFORCEMENT_SETTINGS_FIELD_NUMBER

        public static final int CREATIVE_ENFORCEMENT_SETTINGS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AUCTION_ENVIRONMENT_FIELD_NUMBER

        public static final int AUCTION_ENVIRONMENT_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getBillingIdList

        public List<Long> getBillingIdList()
         [AdX: BidRequest.AdSlot.MatchingAdData.billing_id]
        repeated int64 billing_id = 1;
        Specified by:
        getBillingIdList in interface AdxExt.ImpExtOrBuilder
        Returns:
        A list containing the billingId.

      • getBillingIdCount

        public int getBillingIdCount()
         [AdX: BidRequest.AdSlot.MatchingAdData.billing_id]
        repeated int64 billing_id = 1;
        Specified by:
        getBillingIdCount in interface AdxExt.ImpExtOrBuilder
        Returns:
        The count of billingId.

      • getBillingId

        public long getBillingId​(int index)
         [AdX: BidRequest.AdSlot.MatchingAdData.billing_id]
        repeated int64 billing_id = 1;
        Specified by:
        getBillingId in interface AdxExt.ImpExtOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The billingId at the given index.

      • getPublisherSettingsListIdList

        public List<Long> getPublisherSettingsListIdList()
         [AdX: BidRequest.publisher_settings_list_id]
 [AdX: BidRequest.AdSlot.publisher_settings_list_id]
        repeated fixed64 publisher_settings_list_id = 2;
        Specified by:
        getPublisherSettingsListIdList in interface AdxExt.ImpExtOrBuilder
        Returns:
        A list containing the publisherSettingsListId.

      • getPublisherSettingsListIdCount

        public int getPublisherSettingsListIdCount()
         [AdX: BidRequest.publisher_settings_list_id]
 [AdX: BidRequest.AdSlot.publisher_settings_list_id]
        repeated fixed64 publisher_settings_list_id = 2;
        Specified by:
        getPublisherSettingsListIdCount in interface AdxExt.ImpExtOrBuilder
        Returns:
        The count of publisherSettingsListId.

      • getPublisherSettingsListId

        public long getPublisherSettingsListId​(int index)
         [AdX: BidRequest.publisher_settings_list_id]
 [AdX: BidRequest.AdSlot.publisher_settings_list_id]
        repeated fixed64 publisher_settings_list_id = 2;
        Specified by:
        getPublisherSettingsListId in interface AdxExt.ImpExtOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The publisherSettingsListId at the given index.

      • getAllowedVendorTypeList

        public List<Integer> getAllowedVendorTypeList()
         [AdX: BidRequest.AdSlot.allowed_vendor_type]
        repeated int32 allowed_vendor_type = 3 [packed = true];
        Specified by:
        getAllowedVendorTypeList in interface AdxExt.ImpExtOrBuilder
        Returns:
        A list containing the allowedVendorType.

      • getAllowedVendorTypeCount

        public int getAllowedVendorTypeCount()
         [AdX: BidRequest.AdSlot.allowed_vendor_type]
        repeated int32 allowed_vendor_type = 3 [packed = true];
        Specified by:
        getAllowedVendorTypeCount in interface AdxExt.ImpExtOrBuilder
        Returns:
        The count of allowedVendorType.

      • getAllowedVendorType

        public int getAllowedVendorType​(int index)
         [AdX: BidRequest.AdSlot.allowed_vendor_type]
        repeated int32 allowed_vendor_type = 3 [packed = true];
        Specified by:
        getAllowedVendorType in interface AdxExt.ImpExtOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The allowedVendorType at the given index.

      • getExcludedCreativesList

        public 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;
        Specified by:
        getExcludedCreativesList in interface AdxExt.ImpExtOrBuilder

      • getExcludedCreativesOrBuilderList

        public 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;
        Specified by:
        getExcludedCreativesOrBuilderList in interface AdxExt.ImpExtOrBuilder

      • getExcludedCreativesCount

        public 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;
        Specified by:
        getExcludedCreativesCount in interface AdxExt.ImpExtOrBuilder

      • getExcludedCreatives

        public 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;
        Specified by:
        getExcludedCreatives in interface AdxExt.ImpExtOrBuilder

      • getExcludedCreativesOrBuilder

        public 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;
        Specified by:
        getExcludedCreativesOrBuilder in interface AdxExt.ImpExtOrBuilder

      • hasDfpAdUnitCode

        public boolean hasDfpAdUnitCode()
         [AdX: BidRequest.AdSlot.dfp_ad_unit_code]
        optional string dfp_ad_unit_code = 6;
        Specified by:
        hasDfpAdUnitCode in interface AdxExt.ImpExtOrBuilder
        Returns:
        Whether the dfpAdUnitCode field is set.

      • getDfpAdUnitCode

        public String getDfpAdUnitCode()
         [AdX: BidRequest.AdSlot.dfp_ad_unit_code]
        optional string dfp_ad_unit_code = 6;
        Specified by:
        getDfpAdUnitCode in interface AdxExt.ImpExtOrBuilder
        Returns:
        The dfpAdUnitCode.

      • getDfpAdUnitCodeBytes

        public com.google.protobuf.ByteString getDfpAdUnitCodeBytes()
         [AdX: BidRequest.AdSlot.dfp_ad_unit_code]
        optional string dfp_ad_unit_code = 6;
        Specified by:
        getDfpAdUnitCodeBytes in interface AdxExt.ImpExtOrBuilder
        Returns:
        The bytes for dfpAdUnitCode.

      • hasIsRewardedInventory

        public boolean hasIsRewardedInventory()
         [AdX: BidRequest.AdSlot.is_rewarded]
        optional bool is_rewarded_inventory = 7;
        Specified by:
        hasIsRewardedInventory in interface AdxExt.ImpExtOrBuilder
        Returns:
        Whether the isRewardedInventory field is set.

      • getIsRewardedInventory

        public boolean getIsRewardedInventory()
         [AdX: BidRequest.AdSlot.is_rewarded]
        optional bool is_rewarded_inventory = 7;
        Specified by:
        getIsRewardedInventory in interface AdxExt.ImpExtOrBuilder
        Returns:
        The isRewardedInventory.

      • hasAmpad

        public boolean hasAmpad()
        optional .com.google.doubleclick.ImpExt.AmpAdRequirementType ampad = 8 [default = UNKNOWN_AMP_AD_REQUIREMENT_TYPE];
        Specified by:
        hasAmpad in interface AdxExt.ImpExtOrBuilder
        Returns:
        Whether the ampad field is set.

      • hasBillableEventRateAdjustment

        public 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];
        Specified by:
        hasBillableEventRateAdjustment in interface AdxExt.ImpExtOrBuilder
        Returns:
        Whether the billableEventRateAdjustment field is set.

      • getBillableEventRateAdjustment

        public 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];
        Specified by:
        getBillableEventRateAdjustment in interface AdxExt.ImpExtOrBuilder
        Returns:
        The billableEventRateAdjustment.

      • hasOpenBidding

        public boolean hasOpenBidding()
        optional .com.google.doubleclick.ImpExt.OpenBidding open_bidding = 12;
        Specified by:
        hasOpenBidding in interface AdxExt.ImpExtOrBuilder
        Returns:
        Whether the openBidding field is set.

      • getAllowedRestrictedCategoryList

        public 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;
        Specified by:
        getAllowedRestrictedCategoryList in interface AdxExt.ImpExtOrBuilder
        Returns:
        A list containing the allowedRestrictedCategory.

      • getAllowedRestrictedCategoryCount

        public 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;
        Specified by:
        getAllowedRestrictedCategoryCount in interface AdxExt.ImpExtOrBuilder
        Returns:
        The count of allowedRestrictedCategory.

      • getAllowedRestrictedCategory

        public 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;
        Specified by:
        getAllowedRestrictedCategory in interface AdxExt.ImpExtOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The allowedRestrictedCategory at the given index.

      • hasSkadn

        public boolean hasSkadn()
         [AdX: BidRequest.Mobile.skadn]
        optional .com.google.doubleclick.ImpExt.SKAdNetworkRequest skadn = 14;
        Specified by:
        hasSkadn in interface AdxExt.ImpExtOrBuilder
        Returns:
        Whether the skadn field is set.

      • hasCreativeEnforcementSettings

        public boolean hasCreativeEnforcementSettings()
        optional .com.google.doubleclick.ImpExt.CreativeEnforcementSettings creative_enforcement_settings = 15;
        Specified by:
        hasCreativeEnforcementSettings in interface AdxExt.ImpExtOrBuilder
        Returns:
        Whether the creativeEnforcementSettings field is set.

      • hasAuctionEnvironment

        public boolean hasAuctionEnvironment()
         Specifies where the ad auction runs.
        optional .com.google.doubleclick.ImpExt.AuctionEnvironment auction_environment = 18 [default = SERVER_SIDE_AUCTION];
        Specified by:
        hasAuctionEnvironment in interface AdxExt.ImpExtOrBuilder
        Returns:
        Whether the auctionEnvironment field is set.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static AdxExt.ImpExt parseFrom​(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AdxExt.ImpExt parseFrom​(ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AdxExt.ImpExt parseFrom​(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AdxExt.ImpExt parseFrom​(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AdxExt.ImpExt parseFrom​(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AdxExt.ImpExt parseFrom​(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AdxExt.ImpExt parseFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
        Throws:
        IOException

      • newBuilderForType

        public AdxExt.ImpExt.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public AdxExt.ImpExt.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected AdxExt.ImpExt.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static AdxExt.ImpExt getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<AdxExt.ImpExt> parser()

      • getParserForType

        public com.google.protobuf.Parser<AdxExt.ImpExt> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public AdxExt.ImpExt getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder