Package com.google.ads.googleads.v18.services

Class GenerateKeywordForecastMetricsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<GenerateKeywordForecastMetricsRequest.Builder>
com.google.ads.googleads.v18.services.GenerateKeywordForecastMetricsRequest.Builder
All Implemented Interfaces:
GenerateKeywordForecastMetricsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
GenerateKeywordForecastMetricsRequest
public static final class GenerateKeywordForecastMetricsRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<GenerateKeywordForecastMetricsRequest.Builder> implements GenerateKeywordForecastMetricsRequestOrBuilder
 Request message for [KeywordPlanIdeaService.GenerateKeywordForecastMetrics].
Protobuf type google.ads.googleads.v18.services.GenerateKeywordForecastMetricsRequest

  • Method Details

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

    • clear

      public GenerateKeywordForecastMetricsRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear 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

    • clone

      public GenerateKeywordForecastMetricsRequest.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateKeywordForecastMetricsRequest.Builder>

    • setField

      public GenerateKeywordForecastMetricsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateKeywordForecastMetricsRequest.Builder>

    • clearField

      public GenerateKeywordForecastMetricsRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateKeywordForecastMetricsRequest.Builder>

    • clearOneof

      public GenerateKeywordForecastMetricsRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateKeywordForecastMetricsRequest.Builder>

    • setRepeatedField

      public GenerateKeywordForecastMetricsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateKeywordForecastMetricsRequest.Builder>

    • addRepeatedField

      public GenerateKeywordForecastMetricsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateKeywordForecastMetricsRequest.Builder>

    • mergeFrom

      public GenerateKeywordForecastMetricsRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GenerateKeywordForecastMetricsRequest.Builder>

    • mergeFrom

      public GenerateKeywordForecastMetricsRequest.Builder mergeFrom(GenerateKeywordForecastMetricsRequest other)

    • 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 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:
      IOException

    • getCustomerId

      public String getCustomerId()
       The ID of the customer.
      string customer_id = 1;
      Specified by:
      getCustomerId in interface GenerateKeywordForecastMetricsRequestOrBuilder
      Returns:
      The customerId.

    • getCustomerIdBytes

      public com.google.protobuf.ByteString getCustomerIdBytes()
       The ID of the customer.
      string customer_id = 1;
      Specified by:
      getCustomerIdBytes in interface GenerateKeywordForecastMetricsRequestOrBuilder
      Returns:
      The bytes for customerId.

    • setCustomerId

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

    • clearCustomerId

      public GenerateKeywordForecastMetricsRequest.Builder clearCustomerId()
       The ID of the customer.
      string customer_id = 1;
      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 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(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.v18.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.v18.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.v18.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.v18.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.v18.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.v18.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.v18.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.v18.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.v18.services.CampaignToForecast campaign = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasCampaign in interface GenerateKeywordForecastMetricsRequestOrBuilder
      Returns:
      Whether the campaign field is set.

    • getCampaign

      public CampaignToForecast getCampaign()
       Required. The campaign used in the forecast.
      .google.ads.googleads.v18.services.CampaignToForecast campaign = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCampaign in interface GenerateKeywordForecastMetricsRequestOrBuilder
      Returns:
      The campaign.

    • setCampaign

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

    • setCampaign

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

    • mergeCampaign

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

    • clearCampaign

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

    • getCampaignBuilder

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

    • getCampaignOrBuilder

      public CampaignToForecastOrBuilder getCampaignOrBuilder()
       Required. The campaign used in the forecast.
      .google.ads.googleads.v18.services.CampaignToForecast campaign = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCampaignOrBuilder in interface GenerateKeywordForecastMetricsRequestOrBuilder

    • setUnknownFields

      public final GenerateKeywordForecastMetricsRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateKeywordForecastMetricsRequest.Builder>

    • mergeUnknownFields

      public final GenerateKeywordForecastMetricsRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateKeywordForecastMetricsRequest.Builder>