Package com.google.ads.googleads.v10.resources

Interface BiddingStrategyOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    BiddingStrategy, BiddingStrategy.Builder
    public interface BiddingStrategyOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getResourceName

        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) = { ... }
        Returns:
        The resourceName.

      • getResourceNameBytes

        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) = { ... }
        Returns:
        The bytes for resourceName.

      • hasId

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

      • getId

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

      • hasName

        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;
        Returns:
        Whether the name field is set.

      • getName

        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;
        Returns:
        The name.

      • getNameBytes

        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;
        Returns:
        The bytes for name.

      • getStatusValue

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

      • getStatus

        BiddingStrategyStatusEnum.BiddingStrategyStatus getStatus()
         Output only. The status of the bidding strategy.
 This field is read-only.
        .google.ads.googleads.v10.enums.BiddingStrategyStatusEnum.BiddingStrategyStatus status = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The status.

      • getTypeValue

        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.v10.enums.BiddingStrategyTypeEnum.BiddingStrategyType type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The enum numeric value on the wire for type.

      • getType

        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.v10.enums.BiddingStrategyTypeEnum.BiddingStrategyType type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The type.

      • getCurrencyCode

        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];
        Returns:
        The currencyCode.

      • getCurrencyCodeBytes

        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];
        Returns:
        The bytes for currencyCode.

      • hasEffectiveCurrencyCode

        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];
        Returns:
        Whether the effectiveCurrencyCode field is set.

      • getEffectiveCurrencyCode

        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];
        Returns:
        The effectiveCurrencyCode.

      • getEffectiveCurrencyCodeBytes

        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];
        Returns:
        The bytes for effectiveCurrencyCode.

      • hasCampaignCount

        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];
        Returns:
        Whether the campaignCount field is set.

      • getCampaignCount

        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];
        Returns:
        The campaignCount.

      • hasNonRemovedCampaignCount

        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];
        Returns:
        Whether the nonRemovedCampaignCount field is set.

      • getNonRemovedCampaignCount

        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];
        Returns:
        The nonRemovedCampaignCount.

      • hasEnhancedCpc

        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.v10.common.EnhancedCpc enhanced_cpc = 7;
        Returns:
        Whether the enhancedCpc field is set.

      • getEnhancedCpc

        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.v10.common.EnhancedCpc enhanced_cpc = 7;
        Returns:
        The enhancedCpc.

      • getEnhancedCpcOrBuilder

        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.v10.common.EnhancedCpc enhanced_cpc = 7;

      • hasMaximizeConversionValue

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

      • getMaximizeConversionValue

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

      • getMaximizeConversionValueOrBuilder

        MaximizeConversionValueOrBuilder getMaximizeConversionValueOrBuilder()
         An automated bidding strategy to help get the most conversion value for
 your campaigns while spending your budget.
        .google.ads.googleads.v10.common.MaximizeConversionValue maximize_conversion_value = 21;

      • hasMaximizeConversions

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

      • getMaximizeConversions

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

      • getMaximizeConversionsOrBuilder

        MaximizeConversionsOrBuilder getMaximizeConversionsOrBuilder()
         An automated bidding strategy to help get the most conversions for your
 campaigns while spending your budget.
        .google.ads.googleads.v10.common.MaximizeConversions maximize_conversions = 22;

      • hasTargetCpa

        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.v10.common.TargetCpa target_cpa = 9;
        Returns:
        Whether the targetCpa field is set.

      • getTargetCpa

        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.v10.common.TargetCpa target_cpa = 9;
        Returns:
        The targetCpa.

      • getTargetCpaOrBuilder

        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.v10.common.TargetCpa target_cpa = 9;

      • hasTargetImpressionShare

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

      • getTargetImpressionShare

        TargetImpressionShare getTargetImpressionShare()
         A bidding strategy that automatically optimizes towards a desired
 percentage of impressions.
        .google.ads.googleads.v10.common.TargetImpressionShare target_impression_share = 48;
        Returns:
        The targetImpressionShare.

      • getTargetImpressionShareOrBuilder

        TargetImpressionShareOrBuilder getTargetImpressionShareOrBuilder()
         A bidding strategy that automatically optimizes towards a desired
 percentage of impressions.
        .google.ads.googleads.v10.common.TargetImpressionShare target_impression_share = 48;

      • hasTargetRoas

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

      • getTargetRoas

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

      • getTargetRoasOrBuilder

        TargetRoasOrBuilder getTargetRoasOrBuilder()
         A bidding strategy that helps you maximize revenue while averaging a
 specific target Return On Ad Spend (ROAS).
        .google.ads.googleads.v10.common.TargetRoas target_roas = 11;

      • hasTargetSpend

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

      • getTargetSpend

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

      • getTargetSpendOrBuilder

        TargetSpendOrBuilder getTargetSpendOrBuilder()
         A bid strategy that sets your bids to help get as many clicks as
 possible within your budget.
        .google.ads.googleads.v10.common.TargetSpend target_spend = 12;