Package com.google.ads.googleads.v24.services

Class KeywordForecastMetrics.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<KeywordForecastMetrics.Builder>
com.google.ads.googleads.v24.services.KeywordForecastMetrics.Builder
All Implemented Interfaces:
KeywordForecastMetricsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
KeywordForecastMetrics
public static final class KeywordForecastMetrics.Builder extends com.google.protobuf.GeneratedMessage.Builder<KeywordForecastMetrics.Builder> implements KeywordForecastMetricsOrBuilder
 The forecast metrics for the planless keyword campaign.
Protobuf type google.ads.googleads.v24.services.KeywordForecastMetrics

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<KeywordForecastMetrics.Builder>

    • clear

      public KeywordForecastMetrics.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.GeneratedMessage.Builder<KeywordForecastMetrics.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.GeneratedMessage.Builder<KeywordForecastMetrics.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public KeywordForecastMetrics.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<KeywordForecastMetrics.Builder>

    • mergeFrom

      public KeywordForecastMetrics.Builder mergeFrom(KeywordForecastMetrics other)

    • isInitialized

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

    • mergeFrom

      public KeywordForecastMetrics.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<KeywordForecastMetrics.Builder>
      Throws:
      IOException

    • hasAverageCpcMicros

      public boolean hasAverageCpcMicros()
       The average cpc. Available only if clicks > 0.
      optional int64 average_cpc_micros = 3;
      Specified by:
      hasAverageCpcMicros in interface KeywordForecastMetricsOrBuilder
      Returns:
      Whether the averageCpcMicros field is set.

    • getAverageCpcMicros

      public long getAverageCpcMicros()
       The average cpc. Available only if clicks > 0.
      optional int64 average_cpc_micros = 3;
      Specified by:
      getAverageCpcMicros in interface KeywordForecastMetricsOrBuilder
      Returns:
      The averageCpcMicros.

    • setAverageCpcMicros

      public KeywordForecastMetrics.Builder setAverageCpcMicros(long value)
       The average cpc. Available only if clicks > 0.
      optional int64 average_cpc_micros = 3;
      Parameters:
      value - The averageCpcMicros to set.
      Returns:
      This builder for chaining.

    • clearAverageCpcMicros

      public KeywordForecastMetrics.Builder clearAverageCpcMicros()
       The average cpc. Available only if clicks > 0.
      optional int64 average_cpc_micros = 3;
      Returns:
      This builder for chaining.

    • hasClicks

      public boolean hasClicks()
       The total number of clicks.
 This field is only available if the bidding strategy is
 [MaximizeClicksBiddingStrategy][google.ads.googleads.v24.services.MaximizeClicksBiddingStrategy]
 or
 [ManualCpcBiddingStrategy][google.ads.googleads.v24.services.ManualCpcBiddingStrategy].
      optional double clicks = 4;
      Specified by:
      hasClicks in interface KeywordForecastMetricsOrBuilder
      Returns:
      Whether the clicks field is set.

    • getClicks

      public double getClicks()
       The total number of clicks.
 This field is only available if the bidding strategy is
 [MaximizeClicksBiddingStrategy][google.ads.googleads.v24.services.MaximizeClicksBiddingStrategy]
 or
 [ManualCpcBiddingStrategy][google.ads.googleads.v24.services.ManualCpcBiddingStrategy].
      optional double clicks = 4;
      Specified by:
      getClicks in interface KeywordForecastMetricsOrBuilder
      Returns:
      The clicks.

    • setClicks

      public KeywordForecastMetrics.Builder setClicks(double value)
       The total number of clicks.
 This field is only available if the bidding strategy is
 [MaximizeClicksBiddingStrategy][google.ads.googleads.v24.services.MaximizeClicksBiddingStrategy]
 or
 [ManualCpcBiddingStrategy][google.ads.googleads.v24.services.ManualCpcBiddingStrategy].
      optional double clicks = 4;
      Parameters:
      value - The clicks to set.
      Returns:
      This builder for chaining.

    • clearClicks

      public KeywordForecastMetrics.Builder clearClicks()
       The total number of clicks.
 This field is only available if the bidding strategy is
 [MaximizeClicksBiddingStrategy][google.ads.googleads.v24.services.MaximizeClicksBiddingStrategy]
 or
 [ManualCpcBiddingStrategy][google.ads.googleads.v24.services.ManualCpcBiddingStrategy].
      optional double clicks = 4;
      Returns:
      This builder for chaining.

    • hasCostMicros

      public boolean hasCostMicros()
       The total cost.
      optional int64 cost_micros = 5;
      Specified by:
      hasCostMicros in interface KeywordForecastMetricsOrBuilder
      Returns:
      Whether the costMicros field is set.

    • getCostMicros

      public long getCostMicros()
       The total cost.
      optional int64 cost_micros = 5;
      Specified by:
      getCostMicros in interface KeywordForecastMetricsOrBuilder
      Returns:
      The costMicros.

    • setCostMicros

      public KeywordForecastMetrics.Builder setCostMicros(long value)
       The total cost.
      optional int64 cost_micros = 5;
      Parameters:
      value - The costMicros to set.
      Returns:
      This builder for chaining.

    • clearCostMicros

      public KeywordForecastMetrics.Builder clearCostMicros()
       The total cost.
      optional int64 cost_micros = 5;
      Returns:
      This builder for chaining.

    • hasConversions

      public boolean hasConversions()
       Forecasted number of conversions. This field is only available if
 the bidding strategy is
 [MaximizeConversionsBiddingStrategy][google.ads.googleads.v24.services.MaximizeConversionsBiddingStrategy].
      optional double conversions = 6;
      Specified by:
      hasConversions in interface KeywordForecastMetricsOrBuilder
      Returns:
      Whether the conversions field is set.

    • getConversions

      public double getConversions()
       Forecasted number of conversions. This field is only available if
 the bidding strategy is
 [MaximizeConversionsBiddingStrategy][google.ads.googleads.v24.services.MaximizeConversionsBiddingStrategy].
      optional double conversions = 6;
      Specified by:
      getConversions in interface KeywordForecastMetricsOrBuilder
      Returns:
      The conversions.

    • setConversions

      public KeywordForecastMetrics.Builder setConversions(double value)
       Forecasted number of conversions. This field is only available if
 the bidding strategy is
 [MaximizeConversionsBiddingStrategy][google.ads.googleads.v24.services.MaximizeConversionsBiddingStrategy].
      optional double conversions = 6;
      Parameters:
      value - The conversions to set.
      Returns:
      This builder for chaining.

    • clearConversions

      public KeywordForecastMetrics.Builder clearConversions()
       Forecasted number of conversions. This field is only available if
 the bidding strategy is
 [MaximizeConversionsBiddingStrategy][google.ads.googleads.v24.services.MaximizeConversionsBiddingStrategy].
      optional double conversions = 6;
      Returns:
      This builder for chaining.

    • hasAverageCpaMicros

      public boolean hasAverageCpaMicros()
       Average cost per acquisition calculated as cost_micros / conversions.
      optional int64 average_cpa_micros = 8;
      Specified by:
      hasAverageCpaMicros in interface KeywordForecastMetricsOrBuilder
      Returns:
      Whether the averageCpaMicros field is set.

    • getAverageCpaMicros

      public long getAverageCpaMicros()
       Average cost per acquisition calculated as cost_micros / conversions.
      optional int64 average_cpa_micros = 8;
      Specified by:
      getAverageCpaMicros in interface KeywordForecastMetricsOrBuilder
      Returns:
      The averageCpaMicros.

    • setAverageCpaMicros

      public KeywordForecastMetrics.Builder setAverageCpaMicros(long value)
       Average cost per acquisition calculated as cost_micros / conversions.
      optional int64 average_cpa_micros = 8;
      Parameters:
      value - The averageCpaMicros to set.
      Returns:
      This builder for chaining.

    • clearAverageCpaMicros

      public KeywordForecastMetrics.Builder clearAverageCpaMicros()
       Average cost per acquisition calculated as cost_micros / conversions.
      optional int64 average_cpa_micros = 8;
      Returns:
      This builder for chaining.