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

Class KeywordForecastMetrics.Builder

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

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

      • clone

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

      • setField

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

      • clearField

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

      • clearOneof

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

      • setRepeatedField

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

      • addRepeatedField

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

      • isInitialized

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

      • mergeFrom

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

      • hasImpressions

        public boolean hasImpressions()
         The total number of impressions.
        optional double impressions = 1;
        Specified by:
        hasImpressions in interface KeywordForecastMetricsOrBuilder
        Returns:
        Whether the impressions field is set.

      • setImpressions

        public KeywordForecastMetrics.Builder setImpressions​(double value)
         The total number of impressions.
        optional double impressions = 1;
        Parameters:
        value - The impressions to set.
        Returns:
        This builder for chaining.

      • clearImpressions

        public KeywordForecastMetrics.Builder clearImpressions()
         The total number of impressions.
        optional double impressions = 1;
        Returns:
        This builder for chaining.

      • hasClickThroughRate

        public boolean hasClickThroughRate()
         The average click through rate. Available only if impressions > 0.
        optional double click_through_rate = 2;
        Specified by:
        hasClickThroughRate in interface KeywordForecastMetricsOrBuilder
        Returns:
        Whether the clickThroughRate field is set.

      • getClickThroughRate

        public double getClickThroughRate()
         The average click through rate. Available only if impressions > 0.
        optional double click_through_rate = 2;
        Specified by:
        getClickThroughRate in interface KeywordForecastMetricsOrBuilder
        Returns:
        The clickThroughRate.

      • setClickThroughRate

        public KeywordForecastMetrics.Builder setClickThroughRate​(double value)
         The average click through rate. Available only if impressions > 0.
        optional double click_through_rate = 2;
        Parameters:
        value - The clickThroughRate to set.
        Returns:
        This builder for chaining.

      • clearClickThroughRate

        public KeywordForecastMetrics.Builder clearClickThroughRate()
         The average click through rate. Available only if impressions > 0.
        optional double click_through_rate = 2;
        Returns:
        This builder for chaining.

      • 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.
        optional double clicks = 4;
        Specified by:
        hasClicks in interface KeywordForecastMetricsOrBuilder
        Returns:
        Whether the clicks field is set.

      • setClicks

        public KeywordForecastMetrics.Builder setClicks​(double value)
         The total number of clicks.
        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.
        optional double clicks = 4;
        Returns:
        This builder for chaining.

      • 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: clicks * conversion_rate.
        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: clicks * conversion_rate.
        optional double conversions = 6;
        Specified by:
        getConversions in interface KeywordForecastMetricsOrBuilder
        Returns:
        The conversions.

      • setConversions

        public KeywordForecastMetrics.Builder setConversions​(double value)
         Forecasted number of conversions: clicks * conversion_rate.
        optional double conversions = 6;
        Parameters:
        value - The conversions to set.
        Returns:
        This builder for chaining.

      • clearConversions

        public KeywordForecastMetrics.Builder clearConversions()
         Forecasted number of conversions: clicks * conversion_rate.
        optional double conversions = 6;
        Returns:
        This builder for chaining.

      • hasConversionRate

        public boolean hasConversionRate()
         Forecasted conversion rate.
        optional double conversion_rate = 7;
        Specified by:
        hasConversionRate in interface KeywordForecastMetricsOrBuilder
        Returns:
        Whether the conversionRate field is set.

      • setConversionRate

        public KeywordForecastMetrics.Builder setConversionRate​(double value)
         Forecasted conversion rate.
        optional double conversion_rate = 7;
        Parameters:
        value - The conversionRate to set.
        Returns:
        This builder for chaining.

      • clearConversionRate

        public KeywordForecastMetrics.Builder clearConversionRate()
         Forecasted conversion rate.
        optional double conversion_rate = 7;
        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.

      • setUnknownFields

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

      • mergeUnknownFields

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