Class PlannedProductForecast.Builder

  • All Implemented Interfaces:
    PlannedProductForecastOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable
    Enclosing class:
    PlannedProductForecast

    public static final class PlannedProductForecast.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<PlannedProductForecast.Builder>
    implements PlannedProductForecastOrBuilder
     Forecasted traffic metrics for a planned product.
     
    Protobuf type google.ads.googleads.v10.services.PlannedProductForecast
    • 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<PlannedProductForecast.Builder>
      • clear

        public PlannedProductForecast.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<PlannedProductForecast.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<PlannedProductForecast.Builder>
      • getDefaultInstanceForType

        public PlannedProductForecast getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

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

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

        public PlannedProductForecast.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<PlannedProductForecast.Builder>
      • setField

        public PlannedProductForecast.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<PlannedProductForecast.Builder>
      • clearField

        public PlannedProductForecast.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<PlannedProductForecast.Builder>
      • clearOneof

        public PlannedProductForecast.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<PlannedProductForecast.Builder>
      • setRepeatedField

        public PlannedProductForecast.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<PlannedProductForecast.Builder>
      • addRepeatedField

        public PlannedProductForecast.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<PlannedProductForecast.Builder>
      • isInitialized

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

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

        public long getOnTargetReach()
         Number of unique people reached that exactly matches the Targeting.
         Note that a minimum number of unique people must be reached in order for
         data to be reported. If the minimum number is not met, the on_target_reach
         value will be rounded to 0.
         
        int64 on_target_reach = 1;
        Specified by:
        getOnTargetReach in interface PlannedProductForecastOrBuilder
        Returns:
        The onTargetReach.
      • setOnTargetReach

        public PlannedProductForecast.Builder setOnTargetReach​(long value)
         Number of unique people reached that exactly matches the Targeting.
         Note that a minimum number of unique people must be reached in order for
         data to be reported. If the minimum number is not met, the on_target_reach
         value will be rounded to 0.
         
        int64 on_target_reach = 1;
        Parameters:
        value - The onTargetReach to set.
        Returns:
        This builder for chaining.
      • clearOnTargetReach

        public PlannedProductForecast.Builder clearOnTargetReach()
         Number of unique people reached that exactly matches the Targeting.
         Note that a minimum number of unique people must be reached in order for
         data to be reported. If the minimum number is not met, the on_target_reach
         value will be rounded to 0.
         
        int64 on_target_reach = 1;
        Returns:
        This builder for chaining.
      • getTotalReach

        public long getTotalReach()
         Number of unique people reached. This includes people that may fall
         outside the specified Targeting.
         Note that a minimum number of unique people must be reached in order for
         data to be reported. If the minimum number is not met, the total_reach
         value will be rounded to 0.
         
        int64 total_reach = 2;
        Specified by:
        getTotalReach in interface PlannedProductForecastOrBuilder
        Returns:
        The totalReach.
      • setTotalReach

        public PlannedProductForecast.Builder setTotalReach​(long value)
         Number of unique people reached. This includes people that may fall
         outside the specified Targeting.
         Note that a minimum number of unique people must be reached in order for
         data to be reported. If the minimum number is not met, the total_reach
         value will be rounded to 0.
         
        int64 total_reach = 2;
        Parameters:
        value - The totalReach to set.
        Returns:
        This builder for chaining.
      • clearTotalReach

        public PlannedProductForecast.Builder clearTotalReach()
         Number of unique people reached. This includes people that may fall
         outside the specified Targeting.
         Note that a minimum number of unique people must be reached in order for
         data to be reported. If the minimum number is not met, the total_reach
         value will be rounded to 0.
         
        int64 total_reach = 2;
        Returns:
        This builder for chaining.
      • getOnTargetImpressions

        public long getOnTargetImpressions()
         Number of ad impressions that exactly matches the Targeting.
         
        int64 on_target_impressions = 3;
        Specified by:
        getOnTargetImpressions in interface PlannedProductForecastOrBuilder
        Returns:
        The onTargetImpressions.
      • setOnTargetImpressions

        public PlannedProductForecast.Builder setOnTargetImpressions​(long value)
         Number of ad impressions that exactly matches the Targeting.
         
        int64 on_target_impressions = 3;
        Parameters:
        value - The onTargetImpressions to set.
        Returns:
        This builder for chaining.
      • clearOnTargetImpressions

        public PlannedProductForecast.Builder clearOnTargetImpressions()
         Number of ad impressions that exactly matches the Targeting.
         
        int64 on_target_impressions = 3;
        Returns:
        This builder for chaining.
      • getTotalImpressions

        public long getTotalImpressions()
         Total number of ad impressions. This includes impressions that may fall
         outside the specified Targeting, due to insufficient information on
         signed-in users.
         
        int64 total_impressions = 4;
        Specified by:
        getTotalImpressions in interface PlannedProductForecastOrBuilder
        Returns:
        The totalImpressions.
      • setTotalImpressions

        public PlannedProductForecast.Builder setTotalImpressions​(long value)
         Total number of ad impressions. This includes impressions that may fall
         outside the specified Targeting, due to insufficient information on
         signed-in users.
         
        int64 total_impressions = 4;
        Parameters:
        value - The totalImpressions to set.
        Returns:
        This builder for chaining.
      • clearTotalImpressions

        public PlannedProductForecast.Builder clearTotalImpressions()
         Total number of ad impressions. This includes impressions that may fall
         outside the specified Targeting, due to insufficient information on
         signed-in users.
         
        int64 total_impressions = 4;
        Returns:
        This builder for chaining.
      • hasViewableImpressions

        public boolean hasViewableImpressions()
         Number of times the ad's impressions were considered viewable.
         See https://support.google.com/google-ads/answer/7029393 for
         more information about what makes an ad viewable and how
         viewability is measured.
         
        optional int64 viewable_impressions = 5;
        Specified by:
        hasViewableImpressions in interface PlannedProductForecastOrBuilder
        Returns:
        Whether the viewableImpressions field is set.
      • getViewableImpressions

        public long getViewableImpressions()
         Number of times the ad's impressions were considered viewable.
         See https://support.google.com/google-ads/answer/7029393 for
         more information about what makes an ad viewable and how
         viewability is measured.
         
        optional int64 viewable_impressions = 5;
        Specified by:
        getViewableImpressions in interface PlannedProductForecastOrBuilder
        Returns:
        The viewableImpressions.
      • setViewableImpressions

        public PlannedProductForecast.Builder setViewableImpressions​(long value)
         Number of times the ad's impressions were considered viewable.
         See https://support.google.com/google-ads/answer/7029393 for
         more information about what makes an ad viewable and how
         viewability is measured.
         
        optional int64 viewable_impressions = 5;
        Parameters:
        value - The viewableImpressions to set.
        Returns:
        This builder for chaining.
      • clearViewableImpressions

        public PlannedProductForecast.Builder clearViewableImpressions()
         Number of times the ad's impressions were considered viewable.
         See https://support.google.com/google-ads/answer/7029393 for
         more information about what makes an ad viewable and how
         viewability is measured.
         
        optional int64 viewable_impressions = 5;
        Returns:
        This builder for chaining.
      • setUnknownFields

        public final PlannedProductForecast.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<PlannedProductForecast.Builder>
      • mergeUnknownFields

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