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

Class GenerateKeywordForecastMetricsRequest.Builder

    • Method Detail

      • 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.Builder<GenerateKeywordForecastMetricsRequest.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateKeywordForecastMetricsRequest.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • isInitialized

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

      • mergeFrom

        public GenerateKeywordForecastMetricsRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GenerateKeywordForecastMetricsRequest.Builder>
        Throws:
        java.io.IOException

      • setCustomerId

        public GenerateKeywordForecastMetricsRequest.Builder setCustomerId​(java.lang.String value)
         The ID of the customer.
        string customer_id = 1;
        Parameters:
        value - The customerId to set.
        Returns:
        This builder for chaining.

      • setCustomerIdBytes

        public GenerateKeywordForecastMetricsRequest.Builder setCustomerIdBytes​(com.google.protobuf.ByteString value)
         The ID of the customer.
        string customer_id = 1;
        Parameters:
        value - The bytes for customerId to set.
        Returns:
        This builder for chaining.

      • 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.

      • setCurrencyCode

        public GenerateKeywordForecastMetricsRequest.Builder setCurrencyCode​(java.lang.String value)
         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;
        Parameters:
        value - The currencyCode to set.
        Returns:
        This builder for chaining.

      • clearCurrencyCode

        public GenerateKeywordForecastMetricsRequest.Builder clearCurrencyCode()
         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;
        Returns:
        This builder for chaining.

      • setCurrencyCodeBytes

        public GenerateKeywordForecastMetricsRequest.Builder setCurrencyCodeBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for currencyCode to set.
        Returns:
        This builder for chaining.

      • 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.

      • setForecastPeriod

        public GenerateKeywordForecastMetricsRequest.Builder setForecastPeriod​(DateRange value)
         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;

      • setForecastPeriod

        public GenerateKeywordForecastMetricsRequest.Builder setForecastPeriod​(DateRange.Builder builderForValue)
         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;

      • mergeForecastPeriod

        public GenerateKeywordForecastMetricsRequest.Builder mergeForecastPeriod​(DateRange value)
         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;

      • clearForecastPeriod

        public GenerateKeywordForecastMetricsRequest.Builder clearForecastPeriod()
         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;

      • getForecastPeriodBuilder

        public DateRange.Builder getForecastPeriodBuilder()
         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;

      • 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.

      • clearCampaign

        public GenerateKeywordForecastMetricsRequest.Builder clearCampaign()
         Required. The campaign used in the forecast.
        .google.ads.googleads.v15.services.CampaignToForecast campaign = 4 [(.google.api.field_behavior) = REQUIRED];

      • getCampaignBuilder

        public CampaignToForecast.Builder getCampaignBuilder()
         Required. The campaign used in the forecast.
        .google.ads.googleads.v15.services.CampaignToForecast campaign = 4 [(.google.api.field_behavior) = REQUIRED];