Package com.google.ads.googleads.v18.resources

Interface CampaignBudgetOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CampaignBudget, CampaignBudget.Builder
public interface CampaignBudgetOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getResourceName

      String getResourceName()
       Immutable. The resource name of the campaign budget.
 Campaign budget resource names have the form:

 `customers/{customer_id}/campaignBudgets/{campaign_budget_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 campaign budget.
 Campaign budget resource names have the form:

 `customers/{customer_id}/campaignBudgets/{campaign_budget_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 campaign budget.

 A campaign budget is created using the CampaignBudgetService create
 operation and is assigned a budget ID. A budget ID can be shared across
 different campaigns; the system will then allocate the campaign budget
 among different campaigns to get optimum results.
      optional int64 id = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the id field is set.

    • getId

      long getId()
       Output only. The ID of the campaign budget.

 A campaign budget is created using the CampaignBudgetService create
 operation and is assigned a budget ID. A budget ID can be shared across
 different campaigns; the system will then allocate the campaign budget
 among different campaigns to get optimum results.
      optional int64 id = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The id.

    • hasName

      boolean hasName()
       The name of the campaign budget.

 When creating a campaign budget through CampaignBudgetService, every
 explicitly shared campaign budget must have a non-null, non-empty name.
 Campaign budgets that are not explicitly shared derive their name from the
 attached campaign's name.

 The length of this string must be between 1 and 255, inclusive,
 in UTF-8 bytes, (trimmed).
      optional string name = 20;
      Returns:
      Whether the name field is set.

    • getName

      String getName()
       The name of the campaign budget.

 When creating a campaign budget through CampaignBudgetService, every
 explicitly shared campaign budget must have a non-null, non-empty name.
 Campaign budgets that are not explicitly shared derive their name from the
 attached campaign's name.

 The length of this string must be between 1 and 255, inclusive,
 in UTF-8 bytes, (trimmed).
      optional string name = 20;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The name of the campaign budget.

 When creating a campaign budget through CampaignBudgetService, every
 explicitly shared campaign budget must have a non-null, non-empty name.
 Campaign budgets that are not explicitly shared derive their name from the
 attached campaign's name.

 The length of this string must be between 1 and 255, inclusive,
 in UTF-8 bytes, (trimmed).
      optional string name = 20;
      Returns:
      The bytes for name.

    • hasAmountMicros

      boolean hasAmountMicros()
       The amount of the budget, in the local currency for the account.
 Amount is specified in micros, where one million is equivalent to one
 currency unit. Monthly spend is capped at 30.4 times this amount.
      optional int64 amount_micros = 21;
      Returns:
      Whether the amountMicros field is set.

    • getAmountMicros

      long getAmountMicros()
       The amount of the budget, in the local currency for the account.
 Amount is specified in micros, where one million is equivalent to one
 currency unit. Monthly spend is capped at 30.4 times this amount.
      optional int64 amount_micros = 21;
      Returns:
      The amountMicros.

    • hasTotalAmountMicros

      boolean hasTotalAmountMicros()
       The lifetime amount of the budget, in the local currency for the account.
 Amount is specified in micros, where one million is equivalent to one
 currency unit.
      optional int64 total_amount_micros = 22;
      Returns:
      Whether the totalAmountMicros field is set.

    • getTotalAmountMicros

      long getTotalAmountMicros()
       The lifetime amount of the budget, in the local currency for the account.
 Amount is specified in micros, where one million is equivalent to one
 currency unit.
      optional int64 total_amount_micros = 22;
      Returns:
      The totalAmountMicros.

    • getStatusValue

      int getStatusValue()
       Output only. The status of this campaign budget. This field is read-only.
      .google.ads.googleads.v18.enums.BudgetStatusEnum.BudgetStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for status.

    • getStatus

      BudgetStatusEnum.BudgetStatus getStatus()
       Output only. The status of this campaign budget. This field is read-only.
      .google.ads.googleads.v18.enums.BudgetStatusEnum.BudgetStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The status.

    • getDeliveryMethodValue

      int getDeliveryMethodValue()
       The delivery method that determines the rate at which the campaign budget
 is spent.

 Defaults to STANDARD if unspecified in a create operation.
      .google.ads.googleads.v18.enums.BudgetDeliveryMethodEnum.BudgetDeliveryMethod delivery_method = 7;
      Returns:
      The enum numeric value on the wire for deliveryMethod.

    • getDeliveryMethod

      BudgetDeliveryMethodEnum.BudgetDeliveryMethod getDeliveryMethod()
       The delivery method that determines the rate at which the campaign budget
 is spent.

 Defaults to STANDARD if unspecified in a create operation.
      .google.ads.googleads.v18.enums.BudgetDeliveryMethodEnum.BudgetDeliveryMethod delivery_method = 7;
      Returns:
      The deliveryMethod.

    • hasExplicitlyShared

      boolean hasExplicitlyShared()
       Specifies whether the budget is explicitly shared. Defaults to true if
 unspecified in a create operation.

 If true, the budget was created with the purpose of sharing
 across one or more campaigns.

 If false, the budget was created with the intention of only being used
 with a single campaign. The budget's name and status will stay in sync
 with the campaign's name and status. Attempting to share the budget with a
 second campaign will result in an error.

 A non-shared budget can become an explicitly shared. The same operation
 must also assign the budget a name.

 A shared campaign budget can never become non-shared.
      optional bool explicitly_shared = 23;
      Returns:
      Whether the explicitlyShared field is set.

    • getExplicitlyShared

      boolean getExplicitlyShared()
       Specifies whether the budget is explicitly shared. Defaults to true if
 unspecified in a create operation.

 If true, the budget was created with the purpose of sharing
 across one or more campaigns.

 If false, the budget was created with the intention of only being used
 with a single campaign. The budget's name and status will stay in sync
 with the campaign's name and status. Attempting to share the budget with a
 second campaign will result in an error.

 A non-shared budget can become an explicitly shared. The same operation
 must also assign the budget a name.

 A shared campaign budget can never become non-shared.
      optional bool explicitly_shared = 23;
      Returns:
      The explicitlyShared.

    • hasReferenceCount

      boolean hasReferenceCount()
       Output only. The number of campaigns actively using the budget.

 This field is read-only.
      optional int64 reference_count = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the referenceCount field is set.

    • getReferenceCount

      long getReferenceCount()
       Output only. The number of campaigns actively using the budget.

 This field is read-only.
      optional int64 reference_count = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The referenceCount.

    • hasHasRecommendedBudget

      boolean hasHasRecommendedBudget()
       Output only. Indicates whether there is a recommended budget for this
 campaign budget.

 This field is read-only.
      optional bool has_recommended_budget = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the hasRecommendedBudget field is set.

    • getHasRecommendedBudget

      boolean getHasRecommendedBudget()
       Output only. Indicates whether there is a recommended budget for this
 campaign budget.

 This field is read-only.
      optional bool has_recommended_budget = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The hasRecommendedBudget.

    • hasRecommendedBudgetAmountMicros

      boolean hasRecommendedBudgetAmountMicros()
       Output only. The recommended budget amount. If no recommendation is
 available, this will be set to the budget amount. Amount is specified in
 micros, where one million is equivalent to one currency unit.

 This field is read-only.
      optional int64 recommended_budget_amount_micros = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the recommendedBudgetAmountMicros field is set.

    • getRecommendedBudgetAmountMicros

      long getRecommendedBudgetAmountMicros()
       Output only. The recommended budget amount. If no recommendation is
 available, this will be set to the budget amount. Amount is specified in
 micros, where one million is equivalent to one currency unit.

 This field is read-only.
      optional int64 recommended_budget_amount_micros = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The recommendedBudgetAmountMicros.

    • getPeriodValue

      int getPeriodValue()
       Immutable. Period over which to spend the budget. Defaults to DAILY if not
 specified.
      .google.ads.googleads.v18.enums.BudgetPeriodEnum.BudgetPeriod period = 13 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The enum numeric value on the wire for period.

    • getPeriod

      BudgetPeriodEnum.BudgetPeriod getPeriod()
       Immutable. Period over which to spend the budget. Defaults to DAILY if not
 specified.
      .google.ads.googleads.v18.enums.BudgetPeriodEnum.BudgetPeriod period = 13 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The period.

    • hasRecommendedBudgetEstimatedChangeWeeklyClicks

      boolean hasRecommendedBudgetEstimatedChangeWeeklyClicks()
       Output only. The estimated change in weekly clicks if the recommended
 budget is applied.

 This field is read-only.
      optional int64 recommended_budget_estimated_change_weekly_clicks = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the recommendedBudgetEstimatedChangeWeeklyClicks field is set.

    • getRecommendedBudgetEstimatedChangeWeeklyClicks

      long getRecommendedBudgetEstimatedChangeWeeklyClicks()
       Output only. The estimated change in weekly clicks if the recommended
 budget is applied.

 This field is read-only.
      optional int64 recommended_budget_estimated_change_weekly_clicks = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The recommendedBudgetEstimatedChangeWeeklyClicks.

    • hasRecommendedBudgetEstimatedChangeWeeklyCostMicros

      boolean hasRecommendedBudgetEstimatedChangeWeeklyCostMicros()
       Output only. The estimated change in weekly cost in micros if the
 recommended budget is applied. One million is equivalent to one currency
 unit.

 This field is read-only.
      optional int64 recommended_budget_estimated_change_weekly_cost_micros = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the recommendedBudgetEstimatedChangeWeeklyCostMicros field is set.

    • getRecommendedBudgetEstimatedChangeWeeklyCostMicros

      long getRecommendedBudgetEstimatedChangeWeeklyCostMicros()
       Output only. The estimated change in weekly cost in micros if the
 recommended budget is applied. One million is equivalent to one currency
 unit.

 This field is read-only.
      optional int64 recommended_budget_estimated_change_weekly_cost_micros = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The recommendedBudgetEstimatedChangeWeeklyCostMicros.

    • hasRecommendedBudgetEstimatedChangeWeeklyInteractions

      boolean hasRecommendedBudgetEstimatedChangeWeeklyInteractions()
       Output only. The estimated change in weekly interactions if the recommended
 budget is applied.

 This field is read-only.
      optional int64 recommended_budget_estimated_change_weekly_interactions = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the recommendedBudgetEstimatedChangeWeeklyInteractions field is set.

    • getRecommendedBudgetEstimatedChangeWeeklyInteractions

      long getRecommendedBudgetEstimatedChangeWeeklyInteractions()
       Output only. The estimated change in weekly interactions if the recommended
 budget is applied.

 This field is read-only.
      optional int64 recommended_budget_estimated_change_weekly_interactions = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The recommendedBudgetEstimatedChangeWeeklyInteractions.

    • hasRecommendedBudgetEstimatedChangeWeeklyViews

      boolean hasRecommendedBudgetEstimatedChangeWeeklyViews()
       Output only. The estimated change in weekly views if the recommended budget
 is applied.

 This field is read-only.
      optional int64 recommended_budget_estimated_change_weekly_views = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the recommendedBudgetEstimatedChangeWeeklyViews field is set.

    • getRecommendedBudgetEstimatedChangeWeeklyViews

      long getRecommendedBudgetEstimatedChangeWeeklyViews()
       Output only. The estimated change in weekly views if the recommended budget
 is applied.

 This field is read-only.
      optional int64 recommended_budget_estimated_change_weekly_views = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The recommendedBudgetEstimatedChangeWeeklyViews.

    • getTypeValue

      int getTypeValue()
       Immutable. The type of the campaign budget.
      .google.ads.googleads.v18.enums.BudgetTypeEnum.BudgetType type = 18 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The enum numeric value on the wire for type.

    • getType

      BudgetTypeEnum.BudgetType getType()
       Immutable. The type of the campaign budget.
      .google.ads.googleads.v18.enums.BudgetTypeEnum.BudgetType type = 18 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The type.

    • getAlignedBiddingStrategyId

      long getAlignedBiddingStrategyId()
       ID of the portfolio bidding strategy that this shared campaign budget
 is aligned with. When a bidding strategy and a campaign budget are aligned,
 they are attached to the same set of campaigns. After a campaign budget is
 aligned with a bidding strategy, campaigns that are added to the campaign
 budget must also use the aligned bidding strategy.
      int64 aligned_bidding_strategy_id = 31;
      Returns:
      The alignedBiddingStrategyId.