Package com.google.ads.googleads.v15.services

Class GenerateKeywordForecastMetricsRequest

  • All Implemented Interfaces:
    GenerateKeywordForecastMetricsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class GenerateKeywordForecastMetricsRequest
extends com.google.protobuf.GeneratedMessageV3
implements GenerateKeywordForecastMetricsRequestOrBuilder
     Request message for [KeywordPlanIdeaService.GenerateKeywordForecastMetrics].
    Protobuf type google.ads.googleads.v15.services.GenerateKeywordForecastMetricsRequest
    See Also:
    Serialized Form

    • Field Detail

      • CUSTOMER_ID_FIELD_NUMBER

        public static final int CUSTOMER_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CURRENCY_CODE_FIELD_NUMBER

        public static final int CURRENCY_CODE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FORECAST_PERIOD_FIELD_NUMBER

        public static final int FORECAST_PERIOD_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

      • 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

      • hasCurrencyCode

        public boolean hasCurrencyCode()
         The currency used for exchange rate conversion.
 By default, the account currency of the customer is used.
 Set this field only if the currency is different from the account currency.
 The list of valid currency codes can be found at
 https://developers.google.com/google-ads/api/data/codes-formats#currency-codes.
        optional string currency_code = 2;
        Specified by:
        hasCurrencyCode in interface GenerateKeywordForecastMetricsRequestOrBuilder
        Returns:
        Whether the currencyCode field is set.

      • getCurrencyCode

        public java.lang.String getCurrencyCode()
         The currency used for exchange rate conversion.
 By default, the account currency of the customer is used.
 Set this field only if the currency is different from the account currency.
 The list of valid currency codes can be found at
 https://developers.google.com/google-ads/api/data/codes-formats#currency-codes.
        optional string currency_code = 2;
        Specified by:
        getCurrencyCode in interface GenerateKeywordForecastMetricsRequestOrBuilder
        Returns:
        The currencyCode.

      • getCurrencyCodeBytes

        public com.google.protobuf.ByteString getCurrencyCodeBytes()
         The currency used for exchange rate conversion.
 By default, the account currency of the customer is used.
 Set this field only if the currency is different from the account currency.
 The list of valid currency codes can be found at
 https://developers.google.com/google-ads/api/data/codes-formats#currency-codes.
        optional string currency_code = 2;
        Specified by:
        getCurrencyCodeBytes in interface GenerateKeywordForecastMetricsRequestOrBuilder
        Returns:
        The bytes for currencyCode.

      • hasForecastPeriod

        public boolean hasForecastPeriod()
         The date range for the forecast. The start date must be in the future and
 end date must be within 1 year from today. The reference timezone used is
 the one of the Google Ads account belonging to the customer. If not set, a
 default date range from next Sunday to the following Saturday will be used.
        .google.ads.googleads.v15.common.DateRange forecast_period = 3;
        Specified by:
        hasForecastPeriod in interface GenerateKeywordForecastMetricsRequestOrBuilder
        Returns:
        Whether the forecastPeriod field is set.

      • getForecastPeriod

        public DateRange getForecastPeriod()
         The date range for the forecast. The start date must be in the future and
 end date must be within 1 year from today. The reference timezone used is
 the one of the Google Ads account belonging to the customer. If not set, a
 default date range from next Sunday to the following Saturday will be used.
        .google.ads.googleads.v15.common.DateRange forecast_period = 3;
        Specified by:
        getForecastPeriod in interface GenerateKeywordForecastMetricsRequestOrBuilder
        Returns:
        The forecastPeriod.

      • getForecastPeriodOrBuilder

        public DateRangeOrBuilder getForecastPeriodOrBuilder()
         The date range for the forecast. The start date must be in the future and
 end date must be within 1 year from today. The reference timezone used is
 the one of the Google Ads account belonging to the customer. If not set, a
 default date range from next Sunday to the following Saturday will be used.
        .google.ads.googleads.v15.common.DateRange forecast_period = 3;
        Specified by:
        getForecastPeriodOrBuilder in interface GenerateKeywordForecastMetricsRequestOrBuilder

      • hasCampaign

        public boolean hasCampaign()
         Required. The campaign used in the forecast.
        .google.ads.googleads.v15.services.CampaignToForecast campaign = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasCampaign in interface GenerateKeywordForecastMetricsRequestOrBuilder
        Returns:
        Whether the campaign 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 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 GenerateKeywordForecastMetricsRequest parseFrom​(java.nio.ByteBuffer data)
                                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • newBuilderForType

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

      • getParserForType

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