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

Class BiddingSeasonalityAdjustment

  • All Implemented Interfaces:
    BiddingSeasonalityAdjustmentOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class BiddingSeasonalityAdjustment
extends com.google.protobuf.GeneratedMessageV3
implements BiddingSeasonalityAdjustmentOrBuilder
     Represents a bidding seasonality adjustment.
 See "About seasonality adjustments" at
 https://support.google.com/google-ads/answer/10369906.
    Protobuf type google.ads.googleads.v10.resources.BiddingSeasonalityAdjustment
    See Also:
    Serialized Form

    • Field Detail

      • RESOURCE_NAME_FIELD_NUMBER

        public static final int RESOURCE_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SEASONALITY_ADJUSTMENT_ID_FIELD_NUMBER

        public static final int SEASONALITY_ADJUSTMENT_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • START_DATE_TIME_FIELD_NUMBER

        public static final int START_DATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • END_DATE_TIME_FIELD_NUMBER

        public static final int END_DATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DESCRIPTION_FIELD_NUMBER

        public static final int DESCRIPTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CONVERSION_RATE_MODIFIER_FIELD_NUMBER

        public static final int CONVERSION_RATE_MODIFIER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ADVERTISING_CHANNEL_TYPES_FIELD_NUMBER

        public static final int ADVERTISING_CHANNEL_TYPES_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 seasonality adjustment.
 Seasonality adjustment resource names have the form:
 `customers/{customer_id}/biddingSeasonalityAdjustments/{seasonality_adjustment_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceName in interface BiddingSeasonalityAdjustmentOrBuilder
        Returns:
        The resourceName.

      • getResourceNameBytes

        public com.google.protobuf.ByteString getResourceNameBytes()
         Immutable. The resource name of the seasonality adjustment.
 Seasonality adjustment resource names have the form:
 `customers/{customer_id}/biddingSeasonalityAdjustments/{seasonality_adjustment_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceNameBytes in interface BiddingSeasonalityAdjustmentOrBuilder
        Returns:
        The bytes for resourceName.

      • getSeasonalityAdjustmentId

        public long getSeasonalityAdjustmentId()
         Output only. The ID of the seasonality adjustment.
        int64 seasonality_adjustment_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSeasonalityAdjustmentId in interface BiddingSeasonalityAdjustmentOrBuilder
        Returns:
        The seasonalityAdjustmentId.

      • getScopeValue

        public int getScopeValue()
         The scope of the seasonality adjustment.
        .google.ads.googleads.v10.enums.SeasonalityEventScopeEnum.SeasonalityEventScope scope = 3;
        Specified by:
        getScopeValue in interface BiddingSeasonalityAdjustmentOrBuilder
        Returns:
        The enum numeric value on the wire for scope.

      • getStatusValue

        public int getStatusValue()
         Output only. The status of the seasonality adjustment.
        .google.ads.googleads.v10.enums.SeasonalityEventStatusEnum.SeasonalityEventStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStatusValue in interface BiddingSeasonalityAdjustmentOrBuilder
        Returns:
        The enum numeric value on the wire for status.

      • getStartDateTime

        public java.lang.String getStartDateTime()
         Required. The inclusive start time of the seasonality adjustment in yyyy-MM-dd
 HH:mm:ss format.
 A seasonality adjustment is forward looking and should be used for events
 that start and end in the future.
        string start_date_time = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getStartDateTime in interface BiddingSeasonalityAdjustmentOrBuilder
        Returns:
        The startDateTime.

      • getStartDateTimeBytes

        public com.google.protobuf.ByteString getStartDateTimeBytes()
         Required. The inclusive start time of the seasonality adjustment in yyyy-MM-dd
 HH:mm:ss format.
 A seasonality adjustment is forward looking and should be used for events
 that start and end in the future.
        string start_date_time = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getStartDateTimeBytes in interface BiddingSeasonalityAdjustmentOrBuilder
        Returns:
        The bytes for startDateTime.

      • getEndDateTime

        public java.lang.String getEndDateTime()
         Required. The exclusive end time of the seasonality adjustment in yyyy-MM-dd HH:mm:ss
 format.
 The length of [start_date_time, end_date_time) interval must be
 within (0, 14 days].
        string end_date_time = 6 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getEndDateTime in interface BiddingSeasonalityAdjustmentOrBuilder
        Returns:
        The endDateTime.

      • getEndDateTimeBytes

        public com.google.protobuf.ByteString getEndDateTimeBytes()
         Required. The exclusive end time of the seasonality adjustment in yyyy-MM-dd HH:mm:ss
 format.
 The length of [start_date_time, end_date_time) interval must be
 within (0, 14 days].
        string end_date_time = 6 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getEndDateTimeBytes in interface BiddingSeasonalityAdjustmentOrBuilder
        Returns:
        The bytes for endDateTime.

      • getName

        public java.lang.String getName()
         The name of the seasonality adjustment. The name can be at most 255
 characters.
        string name = 7;
        Specified by:
        getName in interface BiddingSeasonalityAdjustmentOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The name of the seasonality adjustment. The name can be at most 255
 characters.
        string name = 7;
        Specified by:
        getNameBytes in interface BiddingSeasonalityAdjustmentOrBuilder
        Returns:
        The bytes for name.

      • getDescription

        public java.lang.String getDescription()
         The description of the seasonality adjustment. The description can be at
 most 2048 characters.
        string description = 8;
        Specified by:
        getDescription in interface BiddingSeasonalityAdjustmentOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         The description of the seasonality adjustment. The description can be at
 most 2048 characters.
        string description = 8;
        Specified by:
        getDescriptionBytes in interface BiddingSeasonalityAdjustmentOrBuilder
        Returns:
        The bytes for description.

      • getDevicesList

        public java.util.List<DeviceEnum.Device> getDevicesList()
         If not specified, all devices will be included in this adjustment.
 Otherwise, only the specified targeted devices will be included in this
 adjustment.
        repeated .google.ads.googleads.v10.enums.DeviceEnum.Device devices = 9;
        Specified by:
        getDevicesList in interface BiddingSeasonalityAdjustmentOrBuilder
        Returns:
        A list containing the devices.

      • getDevicesCount

        public int getDevicesCount()
         If not specified, all devices will be included in this adjustment.
 Otherwise, only the specified targeted devices will be included in this
 adjustment.
        repeated .google.ads.googleads.v10.enums.DeviceEnum.Device devices = 9;
        Specified by:
        getDevicesCount in interface BiddingSeasonalityAdjustmentOrBuilder
        Returns:
        The count of devices.

      • getDevices

        public DeviceEnum.Device getDevices​(int index)
         If not specified, all devices will be included in this adjustment.
 Otherwise, only the specified targeted devices will be included in this
 adjustment.
        repeated .google.ads.googleads.v10.enums.DeviceEnum.Device devices = 9;
        Specified by:
        getDevices in interface BiddingSeasonalityAdjustmentOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The devices at the given index.

      • getDevicesValueList

        public java.util.List<java.lang.Integer> getDevicesValueList()
         If not specified, all devices will be included in this adjustment.
 Otherwise, only the specified targeted devices will be included in this
 adjustment.
        repeated .google.ads.googleads.v10.enums.DeviceEnum.Device devices = 9;
        Specified by:
        getDevicesValueList in interface BiddingSeasonalityAdjustmentOrBuilder
        Returns:
        A list containing the enum numeric values on the wire for devices.

      • getDevicesValue

        public int getDevicesValue​(int index)
         If not specified, all devices will be included in this adjustment.
 Otherwise, only the specified targeted devices will be included in this
 adjustment.
        repeated .google.ads.googleads.v10.enums.DeviceEnum.Device devices = 9;
        Specified by:
        getDevicesValue in interface BiddingSeasonalityAdjustmentOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of devices at the given index.

      • getConversionRateModifier

        public double getConversionRateModifier()
         Conversion rate modifier estimated based on expected conversion rate
 changes. When this field is unset or set to 1.0 no adjustment will be
 applied to traffic. The allowed range is 0.1 to 10.0.
        double conversion_rate_modifier = 10;
        Specified by:
        getConversionRateModifier in interface BiddingSeasonalityAdjustmentOrBuilder
        Returns:
        The conversionRateModifier.

      • getCampaignsList

        public com.google.protobuf.ProtocolStringList getCampaignsList()
         The seasonality adjustment will apply to the campaigns listed when the
 scope of this adjustment is CAMPAIGN. The maximum number of campaigns per
 event is 2000.
 Note: a seasonality adjustment with both advertising_channel_types and
 campaign_ids is not supported.
        repeated string campaigns = 11 [(.google.api.resource_reference) = { ... }
        Specified by:
        getCampaignsList in interface BiddingSeasonalityAdjustmentOrBuilder
        Returns:
        A list containing the campaigns.

      • getCampaignsCount

        public int getCampaignsCount()
         The seasonality adjustment will apply to the campaigns listed when the
 scope of this adjustment is CAMPAIGN. The maximum number of campaigns per
 event is 2000.
 Note: a seasonality adjustment with both advertising_channel_types and
 campaign_ids is not supported.
        repeated string campaigns = 11 [(.google.api.resource_reference) = { ... }
        Specified by:
        getCampaignsCount in interface BiddingSeasonalityAdjustmentOrBuilder
        Returns:
        The count of campaigns.

      • getCampaigns

        public java.lang.String getCampaigns​(int index)
         The seasonality adjustment will apply to the campaigns listed when the
 scope of this adjustment is CAMPAIGN. The maximum number of campaigns per
 event is 2000.
 Note: a seasonality adjustment with both advertising_channel_types and
 campaign_ids is not supported.
        repeated string campaigns = 11 [(.google.api.resource_reference) = { ... }
        Specified by:
        getCampaigns in interface BiddingSeasonalityAdjustmentOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The campaigns at the given index.

      • getCampaignsBytes

        public com.google.protobuf.ByteString getCampaignsBytes​(int index)
         The seasonality adjustment will apply to the campaigns listed when the
 scope of this adjustment is CAMPAIGN. The maximum number of campaigns per
 event is 2000.
 Note: a seasonality adjustment with both advertising_channel_types and
 campaign_ids is not supported.
        repeated string campaigns = 11 [(.google.api.resource_reference) = { ... }
        Specified by:
        getCampaignsBytes in interface BiddingSeasonalityAdjustmentOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the campaigns at the given index.

      • getAdvertisingChannelTypesList

        public java.util.List<AdvertisingChannelTypeEnum.AdvertisingChannelType> getAdvertisingChannelTypesList()
         The seasonality adjustment will apply to all the campaigns under the listed
 channels retroactively as well as going forward when the scope of this
 adjustment is CHANNEL.
 The supported advertising channel types are DISPLAY, SEARCH and SHOPPING.
 Note: a seasonality adjustment with both advertising_channel_types and
 campaign_ids is not supported.
        repeated .google.ads.googleads.v10.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_types = 12;
        Specified by:
        getAdvertisingChannelTypesList in interface BiddingSeasonalityAdjustmentOrBuilder
        Returns:
        A list containing the advertisingChannelTypes.

      • getAdvertisingChannelTypesCount

        public int getAdvertisingChannelTypesCount()
         The seasonality adjustment will apply to all the campaigns under the listed
 channels retroactively as well as going forward when the scope of this
 adjustment is CHANNEL.
 The supported advertising channel types are DISPLAY, SEARCH and SHOPPING.
 Note: a seasonality adjustment with both advertising_channel_types and
 campaign_ids is not supported.
        repeated .google.ads.googleads.v10.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_types = 12;
        Specified by:
        getAdvertisingChannelTypesCount in interface BiddingSeasonalityAdjustmentOrBuilder
        Returns:
        The count of advertisingChannelTypes.

      • getAdvertisingChannelTypes

        public AdvertisingChannelTypeEnum.AdvertisingChannelType getAdvertisingChannelTypes​(int index)
         The seasonality adjustment will apply to all the campaigns under the listed
 channels retroactively as well as going forward when the scope of this
 adjustment is CHANNEL.
 The supported advertising channel types are DISPLAY, SEARCH and SHOPPING.
 Note: a seasonality adjustment with both advertising_channel_types and
 campaign_ids is not supported.
        repeated .google.ads.googleads.v10.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_types = 12;
        Specified by:
        getAdvertisingChannelTypes in interface BiddingSeasonalityAdjustmentOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The advertisingChannelTypes at the given index.

      • getAdvertisingChannelTypesValueList

        public java.util.List<java.lang.Integer> getAdvertisingChannelTypesValueList()
         The seasonality adjustment will apply to all the campaigns under the listed
 channels retroactively as well as going forward when the scope of this
 adjustment is CHANNEL.
 The supported advertising channel types are DISPLAY, SEARCH and SHOPPING.
 Note: a seasonality adjustment with both advertising_channel_types and
 campaign_ids is not supported.
        repeated .google.ads.googleads.v10.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_types = 12;
        Specified by:
        getAdvertisingChannelTypesValueList in interface BiddingSeasonalityAdjustmentOrBuilder
        Returns:
        A list containing the enum numeric values on the wire for advertisingChannelTypes.

      • getAdvertisingChannelTypesValue

        public int getAdvertisingChannelTypesValue​(int index)
         The seasonality adjustment will apply to all the campaigns under the listed
 channels retroactively as well as going forward when the scope of this
 adjustment is CHANNEL.
 The supported advertising channel types are DISPLAY, SEARCH and SHOPPING.
 Note: a seasonality adjustment with both advertising_channel_types and
 campaign_ids is not supported.
        repeated .google.ads.googleads.v10.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_types = 12;
        Specified by:
        getAdvertisingChannelTypesValue in interface BiddingSeasonalityAdjustmentOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of advertisingChannelTypes at the given index.

      • 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 BiddingSeasonalityAdjustment parseFrom​(java.nio.ByteBuffer data)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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