Package com.google.ads.googleads.v10.resources

Class AdGroupBidModifier

  • All Implemented Interfaces:
    AdGroupBidModifierOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class AdGroupBidModifier
extends com.google.protobuf.GeneratedMessageV3
implements AdGroupBidModifierOrBuilder
     Represents an ad group bid modifier.
    Protobuf type google.ads.googleads.v10.resources.AdGroupBidModifier
    See Also:
    Serialized Form

    • Field Detail

      • RESOURCE_NAME_FIELD_NUMBER

        public static final int RESOURCE_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CRITERION_ID_FIELD_NUMBER

        public static final int CRITERION_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BID_MODIFIER_FIELD_NUMBER

        public static final int BID_MODIFIER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BASE_AD_GROUP_FIELD_NUMBER

        public static final int BASE_AD_GROUP_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BID_MODIFIER_SOURCE_FIELD_NUMBER

        public static final int BID_MODIFIER_SOURCE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HOTEL_DATE_SELECTION_TYPE_FIELD_NUMBER

        public static final int HOTEL_DATE_SELECTION_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HOTEL_ADVANCE_BOOKING_WINDOW_FIELD_NUMBER

        public static final int HOTEL_ADVANCE_BOOKING_WINDOW_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HOTEL_LENGTH_OF_STAY_FIELD_NUMBER

        public static final int HOTEL_LENGTH_OF_STAY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HOTEL_CHECK_IN_DAY_FIELD_NUMBER

        public static final int HOTEL_CHECK_IN_DAY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PREFERRED_CONTENT_FIELD_NUMBER

        public static final int PREFERRED_CONTENT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HOTEL_CHECK_IN_DATE_RANGE_FIELD_NUMBER

        public static final int HOTEL_CHECK_IN_DATE_RANGE_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.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

      • getResourceName

        public java.lang.String getResourceName()
         Immutable. The resource name of the ad group bid modifier.
 Ad group bid modifier resource names have the form:
 `customers/{customer_id}/adGroupBidModifiers/{ad_group_id}~{criterion_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceName in interface AdGroupBidModifierOrBuilder
        Returns:
        The resourceName.

      • getResourceNameBytes

        public com.google.protobuf.ByteString getResourceNameBytes()
         Immutable. The resource name of the ad group bid modifier.
 Ad group bid modifier resource names have the form:
 `customers/{customer_id}/adGroupBidModifiers/{ad_group_id}~{criterion_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceNameBytes in interface AdGroupBidModifierOrBuilder
        Returns:
        The bytes for resourceName.

      • hasAdGroup

        public boolean hasAdGroup()
         Immutable. The ad group to which this criterion belongs.
        optional string ad_group = 13 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        hasAdGroup in interface AdGroupBidModifierOrBuilder
        Returns:
        Whether the adGroup field is set.

      • getAdGroup

        public java.lang.String getAdGroup()
         Immutable. The ad group to which this criterion belongs.
        optional string ad_group = 13 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getAdGroup in interface AdGroupBidModifierOrBuilder
        Returns:
        The adGroup.

      • getAdGroupBytes

        public com.google.protobuf.ByteString getAdGroupBytes()
         Immutable. The ad group to which this criterion belongs.
        optional string ad_group = 13 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getAdGroupBytes in interface AdGroupBidModifierOrBuilder
        Returns:
        The bytes for adGroup.

      • hasCriterionId

        public boolean hasCriterionId()
         Output only. The ID of the criterion to bid modify.
 This field is ignored for mutates.
        optional int64 criterion_id = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCriterionId in interface AdGroupBidModifierOrBuilder
        Returns:
        Whether the criterionId field is set.

      • getCriterionId

        public long getCriterionId()
         Output only. The ID of the criterion to bid modify.
 This field is ignored for mutates.
        optional int64 criterion_id = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCriterionId in interface AdGroupBidModifierOrBuilder
        Returns:
        The criterionId.

      • hasBidModifier

        public boolean hasBidModifier()
         The modifier for the bid when the criterion matches. The modifier must be
 in the range: 0.1 - 10.0. The range is 1.0 - 6.0 for PreferredContent.
 Use 0 to opt out of a Device type.
        optional double bid_modifier = 15;
        Specified by:
        hasBidModifier in interface AdGroupBidModifierOrBuilder
        Returns:
        Whether the bidModifier field is set.

      • getBidModifier

        public double getBidModifier()
         The modifier for the bid when the criterion matches. The modifier must be
 in the range: 0.1 - 10.0. The range is 1.0 - 6.0 for PreferredContent.
 Use 0 to opt out of a Device type.
        optional double bid_modifier = 15;
        Specified by:
        getBidModifier in interface AdGroupBidModifierOrBuilder
        Returns:
        The bidModifier.

      • hasBaseAdGroup

        public boolean hasBaseAdGroup()
         Output only. The base ad group from which this draft/trial adgroup bid modifier was
 created. If ad_group is a base ad group then this field will be equal to
 ad_group. If the ad group was created in the draft or trial and has no
 corresponding base ad group, then this field will be null.
 This field is readonly.
        optional string base_ad_group = 16 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        hasBaseAdGroup in interface AdGroupBidModifierOrBuilder
        Returns:
        Whether the baseAdGroup field is set.

      • getBaseAdGroup

        public java.lang.String getBaseAdGroup()
         Output only. The base ad group from which this draft/trial adgroup bid modifier was
 created. If ad_group is a base ad group then this field will be equal to
 ad_group. If the ad group was created in the draft or trial and has no
 corresponding base ad group, then this field will be null.
 This field is readonly.
        optional string base_ad_group = 16 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getBaseAdGroup in interface AdGroupBidModifierOrBuilder
        Returns:
        The baseAdGroup.

      • getBaseAdGroupBytes

        public com.google.protobuf.ByteString getBaseAdGroupBytes()
         Output only. The base ad group from which this draft/trial adgroup bid modifier was
 created. If ad_group is a base ad group then this field will be equal to
 ad_group. If the ad group was created in the draft or trial and has no
 corresponding base ad group, then this field will be null.
 This field is readonly.
        optional string base_ad_group = 16 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getBaseAdGroupBytes in interface AdGroupBidModifierOrBuilder
        Returns:
        The bytes for baseAdGroup.

      • getBidModifierSourceValue

        public int getBidModifierSourceValue()
         Output only. Bid modifier source.
        .google.ads.googleads.v10.enums.BidModifierSourceEnum.BidModifierSource bid_modifier_source = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getBidModifierSourceValue in interface AdGroupBidModifierOrBuilder
        Returns:
        The enum numeric value on the wire for bidModifierSource.

      • hasHotelDateSelectionType

        public boolean hasHotelDateSelectionType()
         Immutable. Criterion for hotel date selection (default dates vs. user selected).
        .google.ads.googleads.v10.common.HotelDateSelectionTypeInfo hotel_date_selection_type = 5 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        hasHotelDateSelectionType in interface AdGroupBidModifierOrBuilder
        Returns:
        Whether the hotelDateSelectionType field is set.

      • getHotelDateSelectionType

        public HotelDateSelectionTypeInfo getHotelDateSelectionType()
         Immutable. Criterion for hotel date selection (default dates vs. user selected).
        .google.ads.googleads.v10.common.HotelDateSelectionTypeInfo hotel_date_selection_type = 5 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getHotelDateSelectionType in interface AdGroupBidModifierOrBuilder
        Returns:
        The hotelDateSelectionType.

      • hasHotelAdvanceBookingWindow

        public boolean hasHotelAdvanceBookingWindow()
         Immutable. Criterion for number of days prior to the stay the booking is being made.
        .google.ads.googleads.v10.common.HotelAdvanceBookingWindowInfo hotel_advance_booking_window = 6 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        hasHotelAdvanceBookingWindow in interface AdGroupBidModifierOrBuilder
        Returns:
        Whether the hotelAdvanceBookingWindow field is set.

      • getHotelAdvanceBookingWindow

        public HotelAdvanceBookingWindowInfo getHotelAdvanceBookingWindow()
         Immutable. Criterion for number of days prior to the stay the booking is being made.
        .google.ads.googleads.v10.common.HotelAdvanceBookingWindowInfo hotel_advance_booking_window = 6 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getHotelAdvanceBookingWindow in interface AdGroupBidModifierOrBuilder
        Returns:
        The hotelAdvanceBookingWindow.

      • hasHotelLengthOfStay

        public boolean hasHotelLengthOfStay()
         Immutable. Criterion for length of hotel stay in nights.
        .google.ads.googleads.v10.common.HotelLengthOfStayInfo hotel_length_of_stay = 7 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        hasHotelLengthOfStay in interface AdGroupBidModifierOrBuilder
        Returns:
        Whether the hotelLengthOfStay field is set.

      • getHotelLengthOfStay

        public HotelLengthOfStayInfo getHotelLengthOfStay()
         Immutable. Criterion for length of hotel stay in nights.
        .google.ads.googleads.v10.common.HotelLengthOfStayInfo hotel_length_of_stay = 7 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getHotelLengthOfStay in interface AdGroupBidModifierOrBuilder
        Returns:
        The hotelLengthOfStay.

      • hasHotelCheckInDay

        public boolean hasHotelCheckInDay()
         Immutable. Criterion for day of the week the booking is for.
        .google.ads.googleads.v10.common.HotelCheckInDayInfo hotel_check_in_day = 8 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        hasHotelCheckInDay in interface AdGroupBidModifierOrBuilder
        Returns:
        Whether the hotelCheckInDay field is set.

      • getHotelCheckInDay

        public HotelCheckInDayInfo getHotelCheckInDay()
         Immutable. Criterion for day of the week the booking is for.
        .google.ads.googleads.v10.common.HotelCheckInDayInfo hotel_check_in_day = 8 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getHotelCheckInDay in interface AdGroupBidModifierOrBuilder
        Returns:
        The hotelCheckInDay.

      • hasDevice

        public boolean hasDevice()
         Immutable. A device criterion.
        .google.ads.googleads.v10.common.DeviceInfo device = 11 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        hasDevice in interface AdGroupBidModifierOrBuilder
        Returns:
        Whether the device field is set.

      • getDevice

        public DeviceInfo getDevice()
         Immutable. A device criterion.
        .google.ads.googleads.v10.common.DeviceInfo device = 11 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getDevice in interface AdGroupBidModifierOrBuilder
        Returns:
        The device.

      • hasPreferredContent

        public boolean hasPreferredContent()
         Immutable. A preferred content criterion.
        .google.ads.googleads.v10.common.PreferredContentInfo preferred_content = 12 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        hasPreferredContent in interface AdGroupBidModifierOrBuilder
        Returns:
        Whether the preferredContent field is set.

      • getPreferredContent

        public PreferredContentInfo getPreferredContent()
         Immutable. A preferred content criterion.
        .google.ads.googleads.v10.common.PreferredContentInfo preferred_content = 12 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getPreferredContent in interface AdGroupBidModifierOrBuilder
        Returns:
        The preferredContent.

      • hasHotelCheckInDateRange

        public boolean hasHotelCheckInDateRange()
         Immutable. Criterion for a hotel check-in date range.
        .google.ads.googleads.v10.common.HotelCheckInDateRangeInfo hotel_check_in_date_range = 17 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        hasHotelCheckInDateRange in interface AdGroupBidModifierOrBuilder
        Returns:
        Whether the hotelCheckInDateRange field is set.

      • getHotelCheckInDateRange

        public HotelCheckInDateRangeInfo getHotelCheckInDateRange()
         Immutable. Criterion for a hotel check-in date range.
        .google.ads.googleads.v10.common.HotelCheckInDateRangeInfo hotel_check_in_date_range = 17 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getHotelCheckInDateRange in interface AdGroupBidModifierOrBuilder
        Returns:
        The hotelCheckInDateRange.

      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(java.lang.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 AdGroupBidModifier parseFrom​(java.nio.ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AdGroupBidModifier parseFrom​(java.nio.ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static AdGroupBidModifier parseFrom​(java.io.InputStream input)
                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static AdGroupBidModifier parseFrom​(java.io.InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static AdGroupBidModifier parseDelimitedFrom​(java.io.InputStream input)
                                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static AdGroupBidModifier parseDelimitedFrom​(java.io.InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static AdGroupBidModifier parseFrom​(com.google.protobuf.CodedInputStream input)
                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static AdGroupBidModifier parseFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<AdGroupBidModifier> 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 AdGroupBidModifier getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder