com.google.ads.googleads.v10.resources.CampaignBudgetOrBuilder Maven / Gradle / Ivy

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

package com.google.ads.googleads.v10.resources;

public interface CampaignBudgetOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v10.resources.CampaignBudget)
    com.google.protobuf.MessageOrBuilder {

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

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

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

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

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

  /**
   *    * Output only. The status of this campaign budget. This field is read-only.
   * 
   *
   * .google.ads.googleads.v10.enums.BudgetStatusEnum.BudgetStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for status.
   */
  int getStatusValue();
  /**
   *    * Output only. The status of this campaign budget. This field is read-only.
   * 
   *
   * .google.ads.googleads.v10.enums.BudgetStatusEnum.BudgetStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The status.
   */
  com.google.ads.googleads.v10.enums.BudgetStatusEnum.BudgetStatus getStatus();

  /**
   *    * 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.v10.enums.BudgetDeliveryMethodEnum.BudgetDeliveryMethod delivery_method = 7;
   * @return The enum numeric value on the wire for deliveryMethod.
   */
  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.v10.enums.BudgetDeliveryMethodEnum.BudgetDeliveryMethod delivery_method = 7;
   * @return The deliveryMethod.
   */
  com.google.ads.googleads.v10.enums.BudgetDeliveryMethodEnum.BudgetDeliveryMethod getDeliveryMethod();

  /**
   *    * 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;
   * @return Whether the explicitlyShared field is set.
   */
  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;
   * @return The explicitlyShared.
   */
  boolean getExplicitlyShared();

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

  /**
   *    * 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];
   * @return Whether the hasRecommendedBudget field is set.
   */
  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];
   * @return The hasRecommendedBudget.
   */
  boolean getHasRecommendedBudget();

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

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

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

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

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

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

  /**
   *    * Immutable. The type of the campaign budget.
   * 
   *
   * .google.ads.googleads.v10.enums.BudgetTypeEnum.BudgetType type = 18 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The enum numeric value on the wire for type.
   */
  int getTypeValue();
  /**
   *    * Immutable. The type of the campaign budget.
   * 
   *
   * .google.ads.googleads.v10.enums.BudgetTypeEnum.BudgetType type = 18 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The type.
   */
  com.google.ads.googleads.v10.enums.BudgetTypeEnum.BudgetType getType();
}