Package com.google.ads.googleads.v10.services

Class GenerateReachForecastRequest

  • All Implemented Interfaces:
    GenerateReachForecastRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class GenerateReachForecastRequest
extends com.google.protobuf.GeneratedMessageV3
implements GenerateReachForecastRequestOrBuilder
     Request message for [ReachPlanService.GenerateReachForecast][google.ads.googleads.v10.services.ReachPlanService.GenerateReachForecast].
    Protobuf type google.ads.googleads.v10.services.GenerateReachForecastRequest
    See Also:
    Serialized Form

    • Field Detail

      • CUSTOMER_ID_FIELD_NUMBER

        public static final int CUSTOMER_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CURRENCY_CODE_FIELD_NUMBER

        public static final int CURRENCY_CODE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CAMPAIGN_DURATION_FIELD_NUMBER

        public static final int CAMPAIGN_DURATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • COOKIE_FREQUENCY_CAP_FIELD_NUMBER

        public static final int COOKIE_FREQUENCY_CAP_FIELD_NUMBER
        See Also:
        Constant Field Values

      • COOKIE_FREQUENCY_CAP_SETTING_FIELD_NUMBER

        public static final int COOKIE_FREQUENCY_CAP_SETTING_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MIN_EFFECTIVE_FREQUENCY_FIELD_NUMBER

        public static final int MIN_EFFECTIVE_FREQUENCY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EFFECTIVE_FREQUENCY_LIMIT_FIELD_NUMBER

        public static final int EFFECTIVE_FREQUENCY_LIMIT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PLANNED_PRODUCTS_FIELD_NUMBER

        public static final int PLANNED_PRODUCTS_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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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

      • getCustomerId

        public java.lang.String getCustomerId()
         Required. The ID of the customer.
        string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getCustomerId in interface GenerateReachForecastRequestOrBuilder
        Returns:
        The customerId.

      • getCustomerIdBytes

        public com.google.protobuf.ByteString getCustomerIdBytes()
         Required. The ID of the customer.
        string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getCustomerIdBytes in interface GenerateReachForecastRequestOrBuilder
        Returns:
        The bytes for customerId.

      • hasCurrencyCode

        public boolean hasCurrencyCode()
         The currency code.
 Three-character ISO 4217 currency code.
        optional string currency_code = 9;
        Specified by:
        hasCurrencyCode in interface GenerateReachForecastRequestOrBuilder
        Returns:
        Whether the currencyCode field is set.

      • getCurrencyCode

        public java.lang.String getCurrencyCode()
         The currency code.
 Three-character ISO 4217 currency code.
        optional string currency_code = 9;
        Specified by:
        getCurrencyCode in interface GenerateReachForecastRequestOrBuilder
        Returns:
        The currencyCode.

      • getCurrencyCodeBytes

        public com.google.protobuf.ByteString getCurrencyCodeBytes()
         The currency code.
 Three-character ISO 4217 currency code.
        optional string currency_code = 9;
        Specified by:
        getCurrencyCodeBytes in interface GenerateReachForecastRequestOrBuilder
        Returns:
        The bytes for currencyCode.

      • hasCampaignDuration

        public boolean hasCampaignDuration()
         Required. Campaign duration.
        .google.ads.googleads.v10.services.CampaignDuration campaign_duration = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasCampaignDuration in interface GenerateReachForecastRequestOrBuilder
        Returns:
        Whether the campaignDuration field is set.

      • hasCookieFrequencyCap

        public boolean hasCookieFrequencyCap()
         Desired cookie frequency cap that will be applied to each planned product.
 This is equivalent to the frequency cap exposed in Google Ads when creating
 a campaign, it represents the maximum number of times an ad can be shown to
 the same user.
 If not specified no cap is applied.
 This field is deprecated in v4 and will eventually be removed.
 Please use cookie_frequency_cap_setting instead.
        optional int32 cookie_frequency_cap = 10;
        Specified by:
        hasCookieFrequencyCap in interface GenerateReachForecastRequestOrBuilder
        Returns:
        Whether the cookieFrequencyCap field is set.

      • getCookieFrequencyCap

        public int getCookieFrequencyCap()
         Desired cookie frequency cap that will be applied to each planned product.
 This is equivalent to the frequency cap exposed in Google Ads when creating
 a campaign, it represents the maximum number of times an ad can be shown to
 the same user.
 If not specified no cap is applied.
 This field is deprecated in v4 and will eventually be removed.
 Please use cookie_frequency_cap_setting instead.
        optional int32 cookie_frequency_cap = 10;
        Specified by:
        getCookieFrequencyCap in interface GenerateReachForecastRequestOrBuilder
        Returns:
        The cookieFrequencyCap.

      • hasCookieFrequencyCapSetting

        public boolean hasCookieFrequencyCapSetting()
         Desired cookie frequency cap that will be applied to each planned product.
 This is equivalent to the frequency cap exposed in Google Ads when creating
 a campaign, it represents the maximum number of times an ad can be shown to
 the same user during a specified time interval.
 If not specified, a default of 0 (no cap) is applied.
 This field replaces the deprecated cookie_frequency_cap field.
        .google.ads.googleads.v10.services.FrequencyCap cookie_frequency_cap_setting = 8;
        Specified by:
        hasCookieFrequencyCapSetting in interface GenerateReachForecastRequestOrBuilder
        Returns:
        Whether the cookieFrequencyCapSetting field is set.

      • getCookieFrequencyCapSetting

        public FrequencyCap getCookieFrequencyCapSetting()
         Desired cookie frequency cap that will be applied to each planned product.
 This is equivalent to the frequency cap exposed in Google Ads when creating
 a campaign, it represents the maximum number of times an ad can be shown to
 the same user during a specified time interval.
 If not specified, a default of 0 (no cap) is applied.
 This field replaces the deprecated cookie_frequency_cap field.
        .google.ads.googleads.v10.services.FrequencyCap cookie_frequency_cap_setting = 8;
        Specified by:
        getCookieFrequencyCapSetting in interface GenerateReachForecastRequestOrBuilder
        Returns:
        The cookieFrequencyCapSetting.

      • getCookieFrequencyCapSettingOrBuilder

        public FrequencyCapOrBuilder getCookieFrequencyCapSettingOrBuilder()
         Desired cookie frequency cap that will be applied to each planned product.
 This is equivalent to the frequency cap exposed in Google Ads when creating
 a campaign, it represents the maximum number of times an ad can be shown to
 the same user during a specified time interval.
 If not specified, a default of 0 (no cap) is applied.
 This field replaces the deprecated cookie_frequency_cap field.
        .google.ads.googleads.v10.services.FrequencyCap cookie_frequency_cap_setting = 8;
        Specified by:
        getCookieFrequencyCapSettingOrBuilder in interface GenerateReachForecastRequestOrBuilder

      • hasMinEffectiveFrequency

        public boolean hasMinEffectiveFrequency()
         Desired minimum effective frequency (the number of times a person was
 exposed to the ad) for the reported reach metrics [1-10].
 This won't affect the targeting, but just the reporting.
 If not specified, a default of 1 is applied.
 This field cannot be combined with the effective_frequency_limit field.
        optional int32 min_effective_frequency = 11;
        Specified by:
        hasMinEffectiveFrequency in interface GenerateReachForecastRequestOrBuilder
        Returns:
        Whether the minEffectiveFrequency field is set.

      • getMinEffectiveFrequency

        public int getMinEffectiveFrequency()
         Desired minimum effective frequency (the number of times a person was
 exposed to the ad) for the reported reach metrics [1-10].
 This won't affect the targeting, but just the reporting.
 If not specified, a default of 1 is applied.
 This field cannot be combined with the effective_frequency_limit field.
        optional int32 min_effective_frequency = 11;
        Specified by:
        getMinEffectiveFrequency in interface GenerateReachForecastRequestOrBuilder
        Returns:
        The minEffectiveFrequency.

      • hasEffectiveFrequencyLimit

        public boolean hasEffectiveFrequencyLimit()
         The highest minimum effective frequency (the number of times a person was
 exposed to the ad) value [1-10] to include in
 Forecast.effective_frequency_breakdowns.
 If not specified, Forecast.effective_frequency_breakdowns will not be
 provided.
 The effective frequency value provided here will also be used as the
 minimum effective frequency for the reported reach metrics.
 This field cannot be combined with the min_effective_frequency field.
        optional .google.ads.googleads.v10.services.EffectiveFrequencyLimit effective_frequency_limit = 12;
        Specified by:
        hasEffectiveFrequencyLimit in interface GenerateReachForecastRequestOrBuilder
        Returns:
        Whether the effectiveFrequencyLimit field is set.

      • getEffectiveFrequencyLimit

        public EffectiveFrequencyLimit getEffectiveFrequencyLimit()
         The highest minimum effective frequency (the number of times a person was
 exposed to the ad) value [1-10] to include in
 Forecast.effective_frequency_breakdowns.
 If not specified, Forecast.effective_frequency_breakdowns will not be
 provided.
 The effective frequency value provided here will also be used as the
 minimum effective frequency for the reported reach metrics.
 This field cannot be combined with the min_effective_frequency field.
        optional .google.ads.googleads.v10.services.EffectiveFrequencyLimit effective_frequency_limit = 12;
        Specified by:
        getEffectiveFrequencyLimit in interface GenerateReachForecastRequestOrBuilder
        Returns:
        The effectiveFrequencyLimit.

      • getEffectiveFrequencyLimitOrBuilder

        public EffectiveFrequencyLimitOrBuilder getEffectiveFrequencyLimitOrBuilder()
         The highest minimum effective frequency (the number of times a person was
 exposed to the ad) value [1-10] to include in
 Forecast.effective_frequency_breakdowns.
 If not specified, Forecast.effective_frequency_breakdowns will not be
 provided.
 The effective frequency value provided here will also be used as the
 minimum effective frequency for the reported reach metrics.
 This field cannot be combined with the min_effective_frequency field.
        optional .google.ads.googleads.v10.services.EffectiveFrequencyLimit effective_frequency_limit = 12;
        Specified by:
        getEffectiveFrequencyLimitOrBuilder in interface GenerateReachForecastRequestOrBuilder

      • hasTargeting

        public boolean hasTargeting()
         The targeting to be applied to all products selected in the product mix.
 This is planned targeting: execution details might vary based on the
 advertising product, please consult an implementation specialist.
 See specific metrics for details on how targeting affects them.
        .google.ads.googleads.v10.services.Targeting targeting = 6;
        Specified by:
        hasTargeting in interface GenerateReachForecastRequestOrBuilder
        Returns:
        Whether the targeting field is set.

      • getTargeting

        public Targeting getTargeting()
         The targeting to be applied to all products selected in the product mix.
 This is planned targeting: execution details might vary based on the
 advertising product, please consult an implementation specialist.
 See specific metrics for details on how targeting affects them.
        .google.ads.googleads.v10.services.Targeting targeting = 6;
        Specified by:
        getTargeting in interface GenerateReachForecastRequestOrBuilder
        Returns:
        The targeting.

      • getTargetingOrBuilder

        public TargetingOrBuilder getTargetingOrBuilder()
         The targeting to be applied to all products selected in the product mix.
 This is planned targeting: execution details might vary based on the
 advertising product, please consult an implementation specialist.
 See specific metrics for details on how targeting affects them.
        .google.ads.googleads.v10.services.Targeting targeting = 6;
        Specified by:
        getTargetingOrBuilder in interface GenerateReachForecastRequestOrBuilder

      • getPlannedProductsList

        public java.util.List<PlannedProduct> getPlannedProductsList()
         Required. The products to be forecast.
 The max number of allowed planned products is 15.
        repeated .google.ads.googleads.v10.services.PlannedProduct planned_products = 7 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getPlannedProductsList in interface GenerateReachForecastRequestOrBuilder

      • getPlannedProductsCount

        public int getPlannedProductsCount()
         Required. The products to be forecast.
 The max number of allowed planned products is 15.
        repeated .google.ads.googleads.v10.services.PlannedProduct planned_products = 7 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getPlannedProductsCount in interface GenerateReachForecastRequestOrBuilder

      • getPlannedProducts

        public PlannedProduct getPlannedProducts​(int index)
         Required. The products to be forecast.
 The max number of allowed planned products is 15.
        repeated .google.ads.googleads.v10.services.PlannedProduct planned_products = 7 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getPlannedProducts in interface GenerateReachForecastRequestOrBuilder

      • 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 GenerateReachForecastRequest parseFrom​(java.nio.ByteBuffer data)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<GenerateReachForecastRequest> 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 GenerateReachForecastRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder