Package com.google.ads.googleads.v9.resources

Class BiddingStrategy

  • All Implemented Interfaces:
    BiddingStrategyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class BiddingStrategy
extends com.google.protobuf.GeneratedMessageV3
implements BiddingStrategyOrBuilder
     A bidding strategy.
    Protobuf type google.ads.googleads.v9.resources.BiddingStrategy
    See Also:
    Serialized Form

    • Field Detail

      • RESOURCE_NAME_FIELD_NUMBER

        public static final int RESOURCE_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CURRENCY_CODE_FIELD_NUMBER

        public static final int CURRENCY_CODE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EFFECTIVE_CURRENCY_CODE_FIELD_NUMBER

        public static final int EFFECTIVE_CURRENCY_CODE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CAMPAIGN_COUNT_FIELD_NUMBER

        public static final int CAMPAIGN_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NON_REMOVED_CAMPAIGN_COUNT_FIELD_NUMBER

        public static final int NON_REMOVED_CAMPAIGN_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENHANCED_CPC_FIELD_NUMBER

        public static final int ENHANCED_CPC_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MAXIMIZE_CONVERSION_VALUE_FIELD_NUMBER

        public static final int MAXIMIZE_CONVERSION_VALUE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MAXIMIZE_CONVERSIONS_FIELD_NUMBER

        public static final int MAXIMIZE_CONVERSIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TARGET_CPA_FIELD_NUMBER

        public static final int TARGET_CPA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TARGET_IMPRESSION_SHARE_FIELD_NUMBER

        public static final int TARGET_IMPRESSION_SHARE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TARGET_ROAS_FIELD_NUMBER

        public static final int TARGET_ROAS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TARGET_SPEND_FIELD_NUMBER

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

      • getResourceName

        public java.lang.String getResourceName()
         Immutable. The resource name of the bidding strategy.
 Bidding strategy resource names have the form:
 `customers/{customer_id}/biddingStrategies/{bidding_strategy_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceName in interface BiddingStrategyOrBuilder
        Returns:
        The resourceName.

      • getResourceNameBytes

        public com.google.protobuf.ByteString getResourceNameBytes()
         Immutable. The resource name of the bidding strategy.
 Bidding strategy resource names have the form:
 `customers/{customer_id}/biddingStrategies/{bidding_strategy_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceNameBytes in interface BiddingStrategyOrBuilder
        Returns:
        The bytes for resourceName.

      • hasId

        public boolean hasId()
         Output only. The ID of the bidding strategy.
        optional int64 id = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasId in interface BiddingStrategyOrBuilder
        Returns:
        Whether the id field is set.

      • getId

        public long getId()
         Output only. The ID of the bidding strategy.
        optional int64 id = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getId in interface BiddingStrategyOrBuilder
        Returns:
        The id.

      • hasName

        public boolean hasName()
         The name of the bidding strategy.
 All bidding strategies within an account must be named distinctly.
 The length of this string should be between 1 and 255, inclusive,
 in UTF-8 bytes, (trimmed).
        optional string name = 17;
        Specified by:
        hasName in interface BiddingStrategyOrBuilder
        Returns:
        Whether the name field is set.

      • getName

        public java.lang.String getName()
         The name of the bidding strategy.
 All bidding strategies within an account must be named distinctly.
 The length of this string should be between 1 and 255, inclusive,
 in UTF-8 bytes, (trimmed).
        optional string name = 17;
        Specified by:
        getName in interface BiddingStrategyOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The name of the bidding strategy.
 All bidding strategies within an account must be named distinctly.
 The length of this string should be between 1 and 255, inclusive,
 in UTF-8 bytes, (trimmed).
        optional string name = 17;
        Specified by:
        getNameBytes in interface BiddingStrategyOrBuilder
        Returns:
        The bytes for name.

      • getStatusValue

        public int getStatusValue()
         Output only. The status of the bidding strategy.
 This field is read-only.
        .google.ads.googleads.v9.enums.BiddingStrategyStatusEnum.BiddingStrategyStatus status = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStatusValue in interface BiddingStrategyOrBuilder
        Returns:
        The enum numeric value on the wire for status.

      • getTypeValue

        public int getTypeValue()
         Output only. The type of the bidding strategy.
 Create a bidding strategy by setting the bidding scheme.
 This field is read-only.
        .google.ads.googleads.v9.enums.BiddingStrategyTypeEnum.BiddingStrategyType type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getTypeValue in interface BiddingStrategyOrBuilder
        Returns:
        The enum numeric value on the wire for type.

      • getType

        public BiddingStrategyTypeEnum.BiddingStrategyType getType()
         Output only. The type of the bidding strategy.
 Create a bidding strategy by setting the bidding scheme.
 This field is read-only.
        .google.ads.googleads.v9.enums.BiddingStrategyTypeEnum.BiddingStrategyType type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getType in interface BiddingStrategyOrBuilder
        Returns:
        The type.

      • getCurrencyCode

        public java.lang.String getCurrencyCode()
         Immutable. The currency used by the bidding strategy (ISO 4217 three-letter code).
 For bidding strategies in manager customers, this currency can be set on
 creation and defaults to the manager customer's currency. For serving
 customers, this field cannot be set; all strategies in a serving customer
 implicitly use the serving customer's currency. In all cases the
 effective_currency_code field returns the currency used by the strategy.
        string currency_code = 23 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getCurrencyCode in interface BiddingStrategyOrBuilder
        Returns:
        The currencyCode.

      • getCurrencyCodeBytes

        public com.google.protobuf.ByteString getCurrencyCodeBytes()
         Immutable. The currency used by the bidding strategy (ISO 4217 three-letter code).
 For bidding strategies in manager customers, this currency can be set on
 creation and defaults to the manager customer's currency. For serving
 customers, this field cannot be set; all strategies in a serving customer
 implicitly use the serving customer's currency. In all cases the
 effective_currency_code field returns the currency used by the strategy.
        string currency_code = 23 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getCurrencyCodeBytes in interface BiddingStrategyOrBuilder
        Returns:
        The bytes for currencyCode.

      • hasEffectiveCurrencyCode

        public boolean hasEffectiveCurrencyCode()
         Output only. The currency used by the bidding strategy (ISO 4217 three-letter code).
 For bidding strategies in manager customers, this is the currency set by
 the advertiser when creating the strategy. For serving customers, this is
 the customer's currency_code.
 Bidding strategy metrics are reported in this currency.
 This field is read-only.
        optional string effective_currency_code = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasEffectiveCurrencyCode in interface BiddingStrategyOrBuilder
        Returns:
        Whether the effectiveCurrencyCode field is set.

      • getEffectiveCurrencyCode

        public java.lang.String getEffectiveCurrencyCode()
         Output only. The currency used by the bidding strategy (ISO 4217 three-letter code).
 For bidding strategies in manager customers, this is the currency set by
 the advertiser when creating the strategy. For serving customers, this is
 the customer's currency_code.
 Bidding strategy metrics are reported in this currency.
 This field is read-only.
        optional string effective_currency_code = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEffectiveCurrencyCode in interface BiddingStrategyOrBuilder
        Returns:
        The effectiveCurrencyCode.

      • getEffectiveCurrencyCodeBytes

        public com.google.protobuf.ByteString getEffectiveCurrencyCodeBytes()
         Output only. The currency used by the bidding strategy (ISO 4217 three-letter code).
 For bidding strategies in manager customers, this is the currency set by
 the advertiser when creating the strategy. For serving customers, this is
 the customer's currency_code.
 Bidding strategy metrics are reported in this currency.
 This field is read-only.
        optional string effective_currency_code = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEffectiveCurrencyCodeBytes in interface BiddingStrategyOrBuilder
        Returns:
        The bytes for effectiveCurrencyCode.

      • hasCampaignCount

        public boolean hasCampaignCount()
         Output only. The number of campaigns attached to this bidding strategy.
 This field is read-only.
        optional int64 campaign_count = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCampaignCount in interface BiddingStrategyOrBuilder
        Returns:
        Whether the campaignCount field is set.

      • getCampaignCount

        public long getCampaignCount()
         Output only. The number of campaigns attached to this bidding strategy.
 This field is read-only.
        optional int64 campaign_count = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCampaignCount in interface BiddingStrategyOrBuilder
        Returns:
        The campaignCount.

      • hasNonRemovedCampaignCount

        public boolean hasNonRemovedCampaignCount()
         Output only. The number of non-removed campaigns attached to this bidding strategy.
 This field is read-only.
        optional int64 non_removed_campaign_count = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasNonRemovedCampaignCount in interface BiddingStrategyOrBuilder
        Returns:
        Whether the nonRemovedCampaignCount field is set.

      • getNonRemovedCampaignCount

        public long getNonRemovedCampaignCount()
         Output only. The number of non-removed campaigns attached to this bidding strategy.
 This field is read-only.
        optional int64 non_removed_campaign_count = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNonRemovedCampaignCount in interface BiddingStrategyOrBuilder
        Returns:
        The nonRemovedCampaignCount.

      • hasEnhancedCpc

        public boolean hasEnhancedCpc()
         A bidding strategy that raises bids for clicks that seem more likely to
 lead to a conversion and lowers them for clicks where they seem less
 likely.
        .google.ads.googleads.v9.common.EnhancedCpc enhanced_cpc = 7;
        Specified by:
        hasEnhancedCpc in interface BiddingStrategyOrBuilder
        Returns:
        Whether the enhancedCpc field is set.

      • getEnhancedCpc

        public EnhancedCpc getEnhancedCpc()
         A bidding strategy that raises bids for clicks that seem more likely to
 lead to a conversion and lowers them for clicks where they seem less
 likely.
        .google.ads.googleads.v9.common.EnhancedCpc enhanced_cpc = 7;
        Specified by:
        getEnhancedCpc in interface BiddingStrategyOrBuilder
        Returns:
        The enhancedCpc.

      • getEnhancedCpcOrBuilder

        public EnhancedCpcOrBuilder getEnhancedCpcOrBuilder()
         A bidding strategy that raises bids for clicks that seem more likely to
 lead to a conversion and lowers them for clicks where they seem less
 likely.
        .google.ads.googleads.v9.common.EnhancedCpc enhanced_cpc = 7;
        Specified by:
        getEnhancedCpcOrBuilder in interface BiddingStrategyOrBuilder

      • hasMaximizeConversionValue

        public boolean hasMaximizeConversionValue()
         An automated bidding strategy to help get the most conversion value for
 your campaigns while spending your budget.
        .google.ads.googleads.v9.common.MaximizeConversionValue maximize_conversion_value = 21;
        Specified by:
        hasMaximizeConversionValue in interface BiddingStrategyOrBuilder
        Returns:
        Whether the maximizeConversionValue field is set.

      • getMaximizeConversionValue

        public MaximizeConversionValue getMaximizeConversionValue()
         An automated bidding strategy to help get the most conversion value for
 your campaigns while spending your budget.
        .google.ads.googleads.v9.common.MaximizeConversionValue maximize_conversion_value = 21;
        Specified by:
        getMaximizeConversionValue in interface BiddingStrategyOrBuilder
        Returns:
        The maximizeConversionValue.

      • hasMaximizeConversions

        public boolean hasMaximizeConversions()
         An automated bidding strategy to help get the most conversions for your
 campaigns while spending your budget.
        .google.ads.googleads.v9.common.MaximizeConversions maximize_conversions = 22;
        Specified by:
        hasMaximizeConversions in interface BiddingStrategyOrBuilder
        Returns:
        Whether the maximizeConversions field is set.

      • getMaximizeConversions

        public MaximizeConversions getMaximizeConversions()
         An automated bidding strategy to help get the most conversions for your
 campaigns while spending your budget.
        .google.ads.googleads.v9.common.MaximizeConversions maximize_conversions = 22;
        Specified by:
        getMaximizeConversions in interface BiddingStrategyOrBuilder
        Returns:
        The maximizeConversions.

      • hasTargetCpa

        public boolean hasTargetCpa()
         A bidding strategy that sets bids to help get as many conversions as
 possible at the target cost-per-acquisition (CPA) you set.
        .google.ads.googleads.v9.common.TargetCpa target_cpa = 9;
        Specified by:
        hasTargetCpa in interface BiddingStrategyOrBuilder
        Returns:
        Whether the targetCpa field is set.

      • getTargetCpa

        public TargetCpa getTargetCpa()
         A bidding strategy that sets bids to help get as many conversions as
 possible at the target cost-per-acquisition (CPA) you set.
        .google.ads.googleads.v9.common.TargetCpa target_cpa = 9;
        Specified by:
        getTargetCpa in interface BiddingStrategyOrBuilder
        Returns:
        The targetCpa.

      • getTargetCpaOrBuilder

        public TargetCpaOrBuilder getTargetCpaOrBuilder()
         A bidding strategy that sets bids to help get as many conversions as
 possible at the target cost-per-acquisition (CPA) you set.
        .google.ads.googleads.v9.common.TargetCpa target_cpa = 9;
        Specified by:
        getTargetCpaOrBuilder in interface BiddingStrategyOrBuilder

      • hasTargetImpressionShare

        public boolean hasTargetImpressionShare()
         A bidding strategy that automatically optimizes towards a desired
 percentage of impressions.
        .google.ads.googleads.v9.common.TargetImpressionShare target_impression_share = 48;
        Specified by:
        hasTargetImpressionShare in interface BiddingStrategyOrBuilder
        Returns:
        Whether the targetImpressionShare field is set.

      • getTargetImpressionShare

        public TargetImpressionShare getTargetImpressionShare()
         A bidding strategy that automatically optimizes towards a desired
 percentage of impressions.
        .google.ads.googleads.v9.common.TargetImpressionShare target_impression_share = 48;
        Specified by:
        getTargetImpressionShare in interface BiddingStrategyOrBuilder
        Returns:
        The targetImpressionShare.

      • hasTargetRoas

        public boolean hasTargetRoas()
         A bidding strategy that helps you maximize revenue while averaging a
 specific target Return On Ad Spend (ROAS).
        .google.ads.googleads.v9.common.TargetRoas target_roas = 11;
        Specified by:
        hasTargetRoas in interface BiddingStrategyOrBuilder
        Returns:
        Whether the targetRoas field is set.

      • getTargetRoas

        public TargetRoas getTargetRoas()
         A bidding strategy that helps you maximize revenue while averaging a
 specific target Return On Ad Spend (ROAS).
        .google.ads.googleads.v9.common.TargetRoas target_roas = 11;
        Specified by:
        getTargetRoas in interface BiddingStrategyOrBuilder
        Returns:
        The targetRoas.

      • getTargetRoasOrBuilder

        public TargetRoasOrBuilder getTargetRoasOrBuilder()
         A bidding strategy that helps you maximize revenue while averaging a
 specific target Return On Ad Spend (ROAS).
        .google.ads.googleads.v9.common.TargetRoas target_roas = 11;
        Specified by:
        getTargetRoasOrBuilder in interface BiddingStrategyOrBuilder

      • hasTargetSpend

        public boolean hasTargetSpend()
         A bid strategy that sets your bids to help get as many clicks as
 possible within your budget.
        .google.ads.googleads.v9.common.TargetSpend target_spend = 12;
        Specified by:
        hasTargetSpend in interface BiddingStrategyOrBuilder
        Returns:
        Whether the targetSpend field is set.

      • getTargetSpend

        public TargetSpend getTargetSpend()
         A bid strategy that sets your bids to help get as many clicks as
 possible within your budget.
        .google.ads.googleads.v9.common.TargetSpend target_spend = 12;
        Specified by:
        getTargetSpend in interface BiddingStrategyOrBuilder
        Returns:
        The targetSpend.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • parser

        public static com.google.protobuf.Parser<BiddingStrategy> parser()

      • getParserForType

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