com.google.ads.googleads.v17.resources.BiddingStrategyOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-ads-stubs-v17 Show documentation
Stubs for GAAPI version google-ads-stubs-v17
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/ads/googleads/v17/resources/bidding_strategy.proto

// Protobuf Java Version: 3.25.3
package com.google.ads.googleads.v17.resources;

public interface BiddingStrategyOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.resources.BiddingStrategy)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * 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) = { ... }
   * @return The resourceName.
   */
  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) = { ... }
   * @return The bytes for resourceName.
   */
  com.google.protobuf.ByteString
      getResourceNameBytes();

  /**
   *    * Output only. The ID of the bidding strategy.
   * 
   *
   * optional int64 id = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the id field is set.
   */
  boolean hasId();
  /**
   *    * Output only. The ID of the bidding strategy.
   * 
   *
   * optional int64 id = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The id.
   */
  long getId();

  /**
   *    * 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;
   * @return Whether the name field is set.
   */
  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;
   * @return The name.
   */
  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;
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * Output only. The status of the bidding strategy.
   *
   * This field is read-only.
   * 
   *
   * .google.ads.googleads.v17.enums.BiddingStrategyStatusEnum.BiddingStrategyStatus status = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for status.
   */
  int getStatusValue();
  /**
   *    * Output only. The status of the bidding strategy.
   *
   * This field is read-only.
   * 
   *
   * .google.ads.googleads.v17.enums.BiddingStrategyStatusEnum.BiddingStrategyStatus status = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The status.
   */
  com.google.ads.googleads.v17.enums.BiddingStrategyStatusEnum.BiddingStrategyStatus getStatus();

  /**
   *    * 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.v17.enums.BiddingStrategyTypeEnum.BiddingStrategyType type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for type.
   */
  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.v17.enums.BiddingStrategyTypeEnum.BiddingStrategyType type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The type.
   */
  com.google.ads.googleads.v17.enums.BiddingStrategyTypeEnum.BiddingStrategyType getType();

  /**
   *    * 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];
   * @return The currencyCode.
   */
  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];
   * @return The bytes for currencyCode.
   */
  com.google.protobuf.ByteString
      getCurrencyCodeBytes();

  /**
   *    * 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];
   * @return Whether the effectiveCurrencyCode field is set.
   */
  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];
   * @return The effectiveCurrencyCode.
   */
  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];
   * @return The bytes for effectiveCurrencyCode.
   */
  com.google.protobuf.ByteString
      getEffectiveCurrencyCodeBytes();

  /**
   *    * ID of the campaign budget that this portfolio bidding strategy
   * is aligned with. When a portfolio and a campaign budget are aligned, that
   * means that they are attached to the same set of campaigns. After a bidding
   * strategy is aligned with a campaign budget, campaigns that are added to the
   * bidding strategy must also use the aligned campaign budget.
   * 
   *
   * int64 aligned_campaign_budget_id = 25;
   * @return The alignedCampaignBudgetId.
   */
  long getAlignedCampaignBudgetId();

  /**
   *    * 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];
   * @return Whether the campaignCount field is set.
   */
  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];
   * @return The campaignCount.
   */
  long getCampaignCount();

  /**
   *    * 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];
   * @return Whether the nonRemovedCampaignCount field is set.
   */
  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];
   * @return The nonRemovedCampaignCount.
   */
  long getNonRemovedCampaignCount();

  /**
   *    * 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.v17.common.EnhancedCpc enhanced_cpc = 7;
   * @return Whether the enhancedCpc field is set.
   */
  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.v17.common.EnhancedCpc enhanced_cpc = 7;
   * @return The enhancedCpc.
   */
  com.google.ads.googleads.v17.common.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.v17.common.EnhancedCpc enhanced_cpc = 7;
   */
  com.google.ads.googleads.v17.common.EnhancedCpcOrBuilder getEnhancedCpcOrBuilder();

  /**
   *    * An automated bidding strategy to help get the most conversion value for
   * your campaigns while spending your budget.
   * 
   *
   * .google.ads.googleads.v17.common.MaximizeConversionValue maximize_conversion_value = 21;
   * @return Whether the maximizeConversionValue field is set.
   */
  boolean hasMaximizeConversionValue();
  /**
   *    * An automated bidding strategy to help get the most conversion value for
   * your campaigns while spending your budget.
   * 
   *
   * .google.ads.googleads.v17.common.MaximizeConversionValue maximize_conversion_value = 21;
   * @return The maximizeConversionValue.
   */
  com.google.ads.googleads.v17.common.MaximizeConversionValue getMaximizeConversionValue();
  /**
   *    * An automated bidding strategy to help get the most conversion value for
   * your campaigns while spending your budget.
   * 
   *
   * .google.ads.googleads.v17.common.MaximizeConversionValue maximize_conversion_value = 21;
   */
  com.google.ads.googleads.v17.common.MaximizeConversionValueOrBuilder getMaximizeConversionValueOrBuilder();

  /**
   *    * An automated bidding strategy to help get the most conversions for your
   * campaigns while spending your budget.
   * 
   *
   * .google.ads.googleads.v17.common.MaximizeConversions maximize_conversions = 22;
   * @return Whether the maximizeConversions field is set.
   */
  boolean hasMaximizeConversions();
  /**
   *    * An automated bidding strategy to help get the most conversions for your
   * campaigns while spending your budget.
   * 
   *
   * .google.ads.googleads.v17.common.MaximizeConversions maximize_conversions = 22;
   * @return The maximizeConversions.
   */
  com.google.ads.googleads.v17.common.MaximizeConversions getMaximizeConversions();
  /**
   *    * An automated bidding strategy to help get the most conversions for your
   * campaigns while spending your budget.
   * 
   *
   * .google.ads.googleads.v17.common.MaximizeConversions maximize_conversions = 22;
   */
  com.google.ads.googleads.v17.common.MaximizeConversionsOrBuilder getMaximizeConversionsOrBuilder();

  /**
   *    * 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.v17.common.TargetCpa target_cpa = 9;
   * @return Whether the targetCpa field is set.
   */
  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.v17.common.TargetCpa target_cpa = 9;
   * @return The targetCpa.
   */
  com.google.ads.googleads.v17.common.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.v17.common.TargetCpa target_cpa = 9;
   */
  com.google.ads.googleads.v17.common.TargetCpaOrBuilder getTargetCpaOrBuilder();

  /**
   *    * A bidding strategy that automatically optimizes towards a chosen
   * percentage of impressions.
   * 
   *
   * .google.ads.googleads.v17.common.TargetImpressionShare target_impression_share = 48;
   * @return Whether the targetImpressionShare field is set.
   */
  boolean hasTargetImpressionShare();
  /**
   *    * A bidding strategy that automatically optimizes towards a chosen
   * percentage of impressions.
   * 
   *
   * .google.ads.googleads.v17.common.TargetImpressionShare target_impression_share = 48;
   * @return The targetImpressionShare.
   */
  com.google.ads.googleads.v17.common.TargetImpressionShare getTargetImpressionShare();
  /**
   *    * A bidding strategy that automatically optimizes towards a chosen
   * percentage of impressions.
   * 
   *
   * .google.ads.googleads.v17.common.TargetImpressionShare target_impression_share = 48;
   */
  com.google.ads.googleads.v17.common.TargetImpressionShareOrBuilder getTargetImpressionShareOrBuilder();

  /**
   *    * A bidding strategy that helps you maximize revenue while averaging a
   * specific target Return On Ad Spend (ROAS).
   * 
   *
   * .google.ads.googleads.v17.common.TargetRoas target_roas = 11;
   * @return Whether the targetRoas field is set.
   */
  boolean hasTargetRoas();
  /**
   *    * A bidding strategy that helps you maximize revenue while averaging a
   * specific target Return On Ad Spend (ROAS).
   * 
   *
   * .google.ads.googleads.v17.common.TargetRoas target_roas = 11;
   * @return The targetRoas.
   */
  com.google.ads.googleads.v17.common.TargetRoas getTargetRoas();
  /**
   *    * A bidding strategy that helps you maximize revenue while averaging a
   * specific target Return On Ad Spend (ROAS).
   * 
   *
   * .google.ads.googleads.v17.common.TargetRoas target_roas = 11;
   */
  com.google.ads.googleads.v17.common.TargetRoasOrBuilder getTargetRoasOrBuilder();

  /**
   *    * A bid strategy that sets your bids to help get as many clicks as
   * possible within your budget.
   * 
   *
   * .google.ads.googleads.v17.common.TargetSpend target_spend = 12;
   * @return Whether the targetSpend field is set.
   */
  boolean hasTargetSpend();
  /**
   *    * A bid strategy that sets your bids to help get as many clicks as
   * possible within your budget.
   * 
   *
   * .google.ads.googleads.v17.common.TargetSpend target_spend = 12;
   * @return The targetSpend.
   */
  com.google.ads.googleads.v17.common.TargetSpend getTargetSpend();
  /**
   *    * A bid strategy that sets your bids to help get as many clicks as
   * possible within your budget.
   * 
   *
   * .google.ads.googleads.v17.common.TargetSpend target_spend = 12;
   */
  com.google.ads.googleads.v17.common.TargetSpendOrBuilder getTargetSpendOrBuilder();

  com.google.ads.googleads.v17.resources.BiddingStrategy.SchemeCase getSchemeCase();
}