Package com.google.ads.googleads.v14.services

Class CampaignToForecast

  • All Implemented Interfaces:
    CampaignToForecastOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class CampaignToForecast
extends com.google.protobuf.GeneratedMessageV3
implements CampaignToForecastOrBuilder
     A campaign to do a keyword campaign forecast.
    Protobuf type google.ads.googleads.v14.services.CampaignToForecast
    See Also:
    Serialized Form

    • Field Detail

      • LANGUAGE_CONSTANTS_FIELD_NUMBER

        public static final int LANGUAGE_CONSTANTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • GEO_MODIFIERS_FIELD_NUMBER

        public static final int GEO_MODIFIERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • KEYWORD_PLAN_NETWORK_FIELD_NUMBER

        public static final int KEYWORD_PLAN_NETWORK_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NEGATIVE_KEYWORDS_FIELD_NUMBER

        public static final int NEGATIVE_KEYWORDS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BIDDING_STRATEGY_FIELD_NUMBER

        public static final int BIDDING_STRATEGY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CONVERSION_RATE_FIELD_NUMBER

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

      • getLanguageConstantsList

        public com.google.protobuf.ProtocolStringList getLanguageConstantsList()
         The list of resource names of languages to be targeted. The resource name
 is of the format "languageConstants/{criterion_id}". See
 https://developers.google.com/google-ads/api/data/codes-formats#languages
 for the list of language criterion codes.
        repeated string language_constants = 1;
        Specified by:
        getLanguageConstantsList in interface CampaignToForecastOrBuilder
        Returns:
        A list containing the languageConstants.

      • getLanguageConstantsCount

        public int getLanguageConstantsCount()
         The list of resource names of languages to be targeted. The resource name
 is of the format "languageConstants/{criterion_id}". See
 https://developers.google.com/google-ads/api/data/codes-formats#languages
 for the list of language criterion codes.
        repeated string language_constants = 1;
        Specified by:
        getLanguageConstantsCount in interface CampaignToForecastOrBuilder
        Returns:
        The count of languageConstants.

      • getLanguageConstants

        public java.lang.String getLanguageConstants​(int index)
         The list of resource names of languages to be targeted. The resource name
 is of the format "languageConstants/{criterion_id}". See
 https://developers.google.com/google-ads/api/data/codes-formats#languages
 for the list of language criterion codes.
        repeated string language_constants = 1;
        Specified by:
        getLanguageConstants in interface CampaignToForecastOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The languageConstants at the given index.

      • getLanguageConstantsBytes

        public com.google.protobuf.ByteString getLanguageConstantsBytes​(int index)
         The list of resource names of languages to be targeted. The resource name
 is of the format "languageConstants/{criterion_id}". See
 https://developers.google.com/google-ads/api/data/codes-formats#languages
 for the list of language criterion codes.
        repeated string language_constants = 1;
        Specified by:
        getLanguageConstantsBytes in interface CampaignToForecastOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the languageConstants at the given index.

      • getGeoModifiersCount

        public int getGeoModifiersCount()
         Locations to be targeted. Locations must be unique.
        repeated .google.ads.googleads.v14.services.CriterionBidModifier geo_modifiers = 2;
        Specified by:
        getGeoModifiersCount in interface CampaignToForecastOrBuilder

      • getKeywordPlanNetworkValue

        public int getKeywordPlanNetworkValue()
         Required. The network used for targeting.
        .google.ads.googleads.v14.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getKeywordPlanNetworkValue in interface CampaignToForecastOrBuilder
        Returns:
        The enum numeric value on the wire for keywordPlanNetwork.

      • getNegativeKeywordsList

        public java.util.List<KeywordInfo> getNegativeKeywordsList()
         The list of negative keywords to be used in the campaign when doing the
 forecast.
        repeated .google.ads.googleads.v14.common.KeywordInfo negative_keywords = 4;
        Specified by:
        getNegativeKeywordsList in interface CampaignToForecastOrBuilder

      • getNegativeKeywordsCount

        public int getNegativeKeywordsCount()
         The list of negative keywords to be used in the campaign when doing the
 forecast.
        repeated .google.ads.googleads.v14.common.KeywordInfo negative_keywords = 4;
        Specified by:
        getNegativeKeywordsCount in interface CampaignToForecastOrBuilder

      • getNegativeKeywords

        public KeywordInfo getNegativeKeywords​(int index)
         The list of negative keywords to be used in the campaign when doing the
 forecast.
        repeated .google.ads.googleads.v14.common.KeywordInfo negative_keywords = 4;
        Specified by:
        getNegativeKeywords in interface CampaignToForecastOrBuilder

      • hasBiddingStrategy

        public boolean hasBiddingStrategy()
         Required. The bidding strategy for the campaign.
        .google.ads.googleads.v14.services.CampaignToForecast.CampaignBiddingStrategy bidding_strategy = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasBiddingStrategy in interface CampaignToForecastOrBuilder
        Returns:
        Whether the biddingStrategy field is set.

      • hasConversionRate

        public boolean hasConversionRate()
         The expected conversion rate (number of conversions divided by number of
 total clicks) as defined by the user. This value is expressed as a decimal
 value, so an expected conversion rate of 2% should be entered as 0.02. If
 left empty, an estimated conversion rate will be used.
        optional double conversion_rate = 6;
        Specified by:
        hasConversionRate in interface CampaignToForecastOrBuilder
        Returns:
        Whether the conversionRate field is set.

      • getConversionRate

        public double getConversionRate()
         The expected conversion rate (number of conversions divided by number of
 total clicks) as defined by the user. This value is expressed as a decimal
 value, so an expected conversion rate of 2% should be entered as 0.02. If
 left empty, an estimated conversion rate will be used.
        optional double conversion_rate = 6;
        Specified by:
        getConversionRate in interface CampaignToForecastOrBuilder
        Returns:
        The conversionRate.

      • getAdGroupsCount

        public int getAdGroupsCount()
         The ad groups in the new campaign to forecast.
        repeated .google.ads.googleads.v14.services.ForecastAdGroup ad_groups = 7;
        Specified by:
        getAdGroupsCount in interface CampaignToForecastOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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