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

Class PlannedProductForecast.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<PlannedProductForecast.Builder>
com.google.ads.googleads.v18.services.PlannedProductForecast.Builder
All Implemented Interfaces:
PlannedProductForecastOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, 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.v18.services.PlannedProductForecast

  • 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<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, 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, 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, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PlannedProductForecast.Builder>

    • mergeFrom

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

    • mergeFrom

      public PlannedProductForecast.Builder mergeFrom(PlannedProductForecast other)

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

    • hasOnTargetCoviewReach

      public boolean hasOnTargetCoviewReach()
       Number of unique people reached that exactly matches the Targeting
 including co-viewers.
      optional int64 on_target_coview_reach = 6;
      Specified by:
      hasOnTargetCoviewReach in interface PlannedProductForecastOrBuilder
      Returns:
      Whether the onTargetCoviewReach field is set.

    • getOnTargetCoviewReach

      public long getOnTargetCoviewReach()
       Number of unique people reached that exactly matches the Targeting
 including co-viewers.
      optional int64 on_target_coview_reach = 6;
      Specified by:
      getOnTargetCoviewReach in interface PlannedProductForecastOrBuilder
      Returns:
      The onTargetCoviewReach.

    • setOnTargetCoviewReach

      public PlannedProductForecast.Builder setOnTargetCoviewReach(long value)
       Number of unique people reached that exactly matches the Targeting
 including co-viewers.
      optional int64 on_target_coview_reach = 6;
      Parameters:
      value - The onTargetCoviewReach to set.
      Returns:
      This builder for chaining.

    • clearOnTargetCoviewReach

      public PlannedProductForecast.Builder clearOnTargetCoviewReach()
       Number of unique people reached that exactly matches the Targeting
 including co-viewers.
      optional int64 on_target_coview_reach = 6;
      Returns:
      This builder for chaining.

    • hasTotalCoviewReach

      public boolean hasTotalCoviewReach()
       Number of unique people reached including co-viewers. This includes
 people that may fall outside the specified Targeting.
      optional int64 total_coview_reach = 7;
      Specified by:
      hasTotalCoviewReach in interface PlannedProductForecastOrBuilder
      Returns:
      Whether the totalCoviewReach field is set.

    • getTotalCoviewReach

      public long getTotalCoviewReach()
       Number of unique people reached including co-viewers. This includes
 people that may fall outside the specified Targeting.
      optional int64 total_coview_reach = 7;
      Specified by:
      getTotalCoviewReach in interface PlannedProductForecastOrBuilder
      Returns:
      The totalCoviewReach.

    • setTotalCoviewReach

      public PlannedProductForecast.Builder setTotalCoviewReach(long value)
       Number of unique people reached including co-viewers. This includes
 people that may fall outside the specified Targeting.
      optional int64 total_coview_reach = 7;
      Parameters:
      value - The totalCoviewReach to set.
      Returns:
      This builder for chaining.

    • clearTotalCoviewReach

      public PlannedProductForecast.Builder clearTotalCoviewReach()
       Number of unique people reached including co-viewers. This includes
 people that may fall outside the specified Targeting.
      optional int64 total_coview_reach = 7;
      Returns:
      This builder for chaining.

    • hasOnTargetCoviewImpressions

      public boolean hasOnTargetCoviewImpressions()
       Number of ad impressions that exactly matches the Targeting including
 co-viewers.
      optional int64 on_target_coview_impressions = 8;
      Specified by:
      hasOnTargetCoviewImpressions in interface PlannedProductForecastOrBuilder
      Returns:
      Whether the onTargetCoviewImpressions field is set.

    • getOnTargetCoviewImpressions

      public long getOnTargetCoviewImpressions()
       Number of ad impressions that exactly matches the Targeting including
 co-viewers.
      optional int64 on_target_coview_impressions = 8;
      Specified by:
      getOnTargetCoviewImpressions in interface PlannedProductForecastOrBuilder
      Returns:
      The onTargetCoviewImpressions.

    • setOnTargetCoviewImpressions

      public PlannedProductForecast.Builder setOnTargetCoviewImpressions(long value)
       Number of ad impressions that exactly matches the Targeting including
 co-viewers.
      optional int64 on_target_coview_impressions = 8;
      Parameters:
      value - The onTargetCoviewImpressions to set.
      Returns:
      This builder for chaining.

    • clearOnTargetCoviewImpressions

      public PlannedProductForecast.Builder clearOnTargetCoviewImpressions()
       Number of ad impressions that exactly matches the Targeting including
 co-viewers.
      optional int64 on_target_coview_impressions = 8;
      Returns:
      This builder for chaining.

    • hasTotalCoviewImpressions

      public boolean hasTotalCoviewImpressions()
       Total number of ad impressions including co-viewers. This includes
 impressions that may fall outside the specified Targeting, due to
 insufficient information on signed-in users.
      optional int64 total_coview_impressions = 9;
      Specified by:
      hasTotalCoviewImpressions in interface PlannedProductForecastOrBuilder
      Returns:
      Whether the totalCoviewImpressions field is set.

    • getTotalCoviewImpressions

      public long getTotalCoviewImpressions()
       Total number of ad impressions including co-viewers. This includes
 impressions that may fall outside the specified Targeting, due to
 insufficient information on signed-in users.
      optional int64 total_coview_impressions = 9;
      Specified by:
      getTotalCoviewImpressions in interface PlannedProductForecastOrBuilder
      Returns:
      The totalCoviewImpressions.

    • setTotalCoviewImpressions

      public PlannedProductForecast.Builder setTotalCoviewImpressions(long value)
       Total number of ad impressions including co-viewers. This includes
 impressions that may fall outside the specified Targeting, due to
 insufficient information on signed-in users.
      optional int64 total_coview_impressions = 9;
      Parameters:
      value - The totalCoviewImpressions to set.
      Returns:
      This builder for chaining.

    • clearTotalCoviewImpressions

      public PlannedProductForecast.Builder clearTotalCoviewImpressions()
       Total number of ad impressions including co-viewers. This includes
 impressions that may fall outside the specified Targeting, due to
 insufficient information on signed-in users.
      optional int64 total_coview_impressions = 9;
      Returns:
      This builder for chaining.

    • hasAverageFrequency

      public boolean hasAverageFrequency()
       The number of times per selected time unit a user will see an ad, averaged
 over the number of time units in the forecast length. This field will only
 be populated for a Target Frequency campaign.

 See https://support.google.com/google-ads/answer/12400225 for more
 information about Target Frequency campaigns.
      optional double average_frequency = 10;
      Specified by:
      hasAverageFrequency in interface PlannedProductForecastOrBuilder
      Returns:
      Whether the averageFrequency field is set.

    • getAverageFrequency

      public double getAverageFrequency()
       The number of times per selected time unit a user will see an ad, averaged
 over the number of time units in the forecast length. This field will only
 be populated for a Target Frequency campaign.

 See https://support.google.com/google-ads/answer/12400225 for more
 information about Target Frequency campaigns.
      optional double average_frequency = 10;
      Specified by:
      getAverageFrequency in interface PlannedProductForecastOrBuilder
      Returns:
      The averageFrequency.

    • setAverageFrequency

      public PlannedProductForecast.Builder setAverageFrequency(double value)
       The number of times per selected time unit a user will see an ad, averaged
 over the number of time units in the forecast length. This field will only
 be populated for a Target Frequency campaign.

 See https://support.google.com/google-ads/answer/12400225 for more
 information about Target Frequency campaigns.
      optional double average_frequency = 10;
      Parameters:
      value - The averageFrequency to set.
      Returns:
      This builder for chaining.

    • clearAverageFrequency

      public PlannedProductForecast.Builder clearAverageFrequency()
       The number of times per selected time unit a user will see an ad, averaged
 over the number of time units in the forecast length. This field will only
 be populated for a Target Frequency campaign.

 See https://support.google.com/google-ads/answer/12400225 for more
 information about Target Frequency campaigns.
      optional double average_frequency = 10;
      Returns:
      This builder for chaining.

    • hasViews

      public boolean hasViews()
       Number of ad views forecasted for the specified product and targeting.
 A view is counted when a viewer views a larger portion or the entirety of
 an ad beyond an impression.

 See https://support.google.com/google-ads/answer/2375431 for
 more information on views.
      optional int64 views = 11;
      Specified by:
      hasViews in interface PlannedProductForecastOrBuilder
      Returns:
      Whether the views field is set.

    • getViews

      public long getViews()
       Number of ad views forecasted for the specified product and targeting.
 A view is counted when a viewer views a larger portion or the entirety of
 an ad beyond an impression.

 See https://support.google.com/google-ads/answer/2375431 for
 more information on views.
      optional int64 views = 11;
      Specified by:
      getViews in interface PlannedProductForecastOrBuilder
      Returns:
      The views.

    • setViews

      public PlannedProductForecast.Builder setViews(long value)
       Number of ad views forecasted for the specified product and targeting.
 A view is counted when a viewer views a larger portion or the entirety of
 an ad beyond an impression.

 See https://support.google.com/google-ads/answer/2375431 for
 more information on views.
      optional int64 views = 11;
      Parameters:
      value - The views to set.
      Returns:
      This builder for chaining.

    • clearViews

      public PlannedProductForecast.Builder clearViews()
       Number of ad views forecasted for the specified product and targeting.
 A view is counted when a viewer views a larger portion or the entirety of
 an ad beyond an impression.

 See https://support.google.com/google-ads/answer/2375431 for
 more information on views.
      optional int64 views = 11;
      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>