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

Class PlannedProductForecast

  • All Implemented Interfaces:
    PlannedProductForecastOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class PlannedProductForecast
extends com.google.protobuf.GeneratedMessageV3
implements PlannedProductForecastOrBuilder
     Forecasted traffic metrics for a planned product.
    Protobuf type google.ads.googleads.v15.services.PlannedProductForecast
    See Also:
    Serialized Form

    • Field Detail

      • ON_TARGET_REACH_FIELD_NUMBER

        public static final int ON_TARGET_REACH_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TOTAL_REACH_FIELD_NUMBER

        public static final int TOTAL_REACH_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ON_TARGET_IMPRESSIONS_FIELD_NUMBER

        public static final int ON_TARGET_IMPRESSIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TOTAL_IMPRESSIONS_FIELD_NUMBER

        public static final int TOTAL_IMPRESSIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • VIEWABLE_IMPRESSIONS_FIELD_NUMBER

        public static final int VIEWABLE_IMPRESSIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ON_TARGET_COVIEW_REACH_FIELD_NUMBER

        public static final int ON_TARGET_COVIEW_REACH_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TOTAL_COVIEW_REACH_FIELD_NUMBER

        public static final int TOTAL_COVIEW_REACH_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ON_TARGET_COVIEW_IMPRESSIONS_FIELD_NUMBER

        public static final int ON_TARGET_COVIEW_IMPRESSIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TOTAL_COVIEW_IMPRESSIONS_FIELD_NUMBER

        public static final int TOTAL_COVIEW_IMPRESSIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AVERAGE_FREQUENCY_FIELD_NUMBER

        public static final int AVERAGE_FREQUENCY_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • 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

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

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

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

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

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

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

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

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

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

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

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

      • isInitialized

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

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static PlannedProductForecast parseFrom​(java.nio.ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PlannedProductForecast parseFrom​(java.nio.ByteBuffer data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PlannedProductForecast parseFrom​(com.google.protobuf.ByteString data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PlannedProductForecast parseFrom​(com.google.protobuf.ByteString data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PlannedProductForecast parseFrom​(byte[] data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PlannedProductForecast parseFrom​(byte[] data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PlannedProductForecast parseFrom​(java.io.InputStream input)
                                        throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static PlannedProductForecast parseFrom​(java.io.InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static PlannedProductForecast parseDelimitedFrom​(java.io.InputStream input)
                                                 throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static PlannedProductForecast parseDelimitedFrom​(java.io.InputStream input,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static PlannedProductForecast parseFrom​(com.google.protobuf.CodedInputStream input)
                                        throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static PlannedProductForecast parseFrom​(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected PlannedProductForecast.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<PlannedProductForecast> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

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