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

Class CampaignBudget.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<CampaignBudget.Builder>
com.google.ads.googleads.v18.resources.CampaignBudget.Builder
All Implemented Interfaces:
CampaignBudgetOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
CampaignBudget
public static final class CampaignBudget.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<CampaignBudget.Builder> implements CampaignBudgetOrBuilder
 A campaign budget.
Protobuf type google.ads.googleads.v18.resources.CampaignBudget

  • Method Details

    • 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.Builder<CampaignBudget.Builder>

    • clear

      public CampaignBudget.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<CampaignBudget.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<CampaignBudget.Builder>

    • getDefaultInstanceForType

      public CampaignBudget getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public CampaignBudget build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public CampaignBudget buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public CampaignBudget.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<CampaignBudget.Builder>

    • setField

      public CampaignBudget.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<CampaignBudget.Builder>

    • clearField

      public CampaignBudget.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<CampaignBudget.Builder>

    • clearOneof

      public CampaignBudget.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<CampaignBudget.Builder>

    • setRepeatedField

      public CampaignBudget.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CampaignBudget.Builder>

    • addRepeatedField

      public CampaignBudget.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CampaignBudget.Builder>

    • mergeFrom

      public CampaignBudget.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CampaignBudget.Builder>

    • mergeFrom

      public CampaignBudget.Builder mergeFrom(CampaignBudget other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<CampaignBudget.Builder>

    • mergeFrom

      public CampaignBudget.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CampaignBudget.Builder>
      Throws:
      IOException

    • getResourceName

      public 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) = { ... }
      Specified by:
      getResourceName in interface CampaignBudgetOrBuilder
      Returns:
      The resourceName.

    • getResourceNameBytes

      public 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) = { ... }
      Specified by:
      getResourceNameBytes in interface CampaignBudgetOrBuilder
      Returns:
      The bytes for resourceName.

    • setResourceName

      public CampaignBudget.Builder setResourceName(String value)
       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) = { ... }
      Parameters:
      value - The resourceName to set.
      Returns:
      This builder for chaining.

    • clearResourceName

      public CampaignBudget.Builder clearResourceName()
       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:
      This builder for chaining.

    • setResourceNameBytes

      public CampaignBudget.Builder setResourceNameBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for resourceName to set.
      Returns:
      This builder for chaining.

    • hasId

      public 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];
      Specified by:
      hasId in interface CampaignBudgetOrBuilder
      Returns:
      Whether the id field is set.

    • getId

      public 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];
      Specified by:
      getId in interface CampaignBudgetOrBuilder
      Returns:
      The id.

    • setId

      public CampaignBudget.Builder setId(long value)
       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];
      Parameters:
      value - The id to set.
      Returns:
      This builder for chaining.

    • clearId

      public CampaignBudget.Builder clearId()
       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:
      This builder for chaining.

    • hasName

      public 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;
      Specified by:
      hasName in interface CampaignBudgetOrBuilder
      Returns:
      Whether the name field is set.

    • getName

      public 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;
      Specified by:
      getName in interface CampaignBudgetOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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;
      Specified by:
      getNameBytes in interface CampaignBudgetOrBuilder
      Returns:
      The bytes for name.

    • setName

      public CampaignBudget.Builder setName(String value)
       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;
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public CampaignBudget.Builder clearName()
       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:
      This builder for chaining.

    • setNameBytes

      public CampaignBudget.Builder setNameBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • hasAmountMicros

      public 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;
      Specified by:
      hasAmountMicros in interface CampaignBudgetOrBuilder
      Returns:
      Whether the amountMicros field is set.

    • getAmountMicros

      public 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;
      Specified by:
      getAmountMicros in interface CampaignBudgetOrBuilder
      Returns:
      The amountMicros.

    • setAmountMicros

      public CampaignBudget.Builder setAmountMicros(long value)
       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;
      Parameters:
      value - The amountMicros to set.
      Returns:
      This builder for chaining.

    • clearAmountMicros

      public CampaignBudget.Builder clearAmountMicros()
       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:
      This builder for chaining.

    • hasTotalAmountMicros

      public 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;
      Specified by:
      hasTotalAmountMicros in interface CampaignBudgetOrBuilder
      Returns:
      Whether the totalAmountMicros field is set.

    • getTotalAmountMicros

      public 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;
      Specified by:
      getTotalAmountMicros in interface CampaignBudgetOrBuilder
      Returns:
      The totalAmountMicros.

    • setTotalAmountMicros

      public CampaignBudget.Builder setTotalAmountMicros(long value)
       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;
      Parameters:
      value - The totalAmountMicros to set.
      Returns:
      This builder for chaining.

    • clearTotalAmountMicros

      public CampaignBudget.Builder clearTotalAmountMicros()
       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:
      This builder for chaining.

    • getStatusValue

      public 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];
      Specified by:
      getStatusValue in interface CampaignBudgetOrBuilder
      Returns:
      The enum numeric value on the wire for status.

    • setStatusValue

      public CampaignBudget.Builder setStatusValue(int value)
       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];
      Parameters:
      value - The enum numeric value on the wire for status to set.
      Returns:
      This builder for chaining.

    • getStatus

      public 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];
      Specified by:
      getStatus in interface CampaignBudgetOrBuilder
      Returns:
      The status.

    • setStatus

      public CampaignBudget.Builder setStatus(BudgetStatusEnum.BudgetStatus value)
       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];
      Parameters:
      value - The status to set.
      Returns:
      This builder for chaining.

    • clearStatus

      public CampaignBudget.Builder clearStatus()
       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:
      This builder for chaining.

    • getDeliveryMethodValue

      public 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;
      Specified by:
      getDeliveryMethodValue in interface CampaignBudgetOrBuilder
      Returns:
      The enum numeric value on the wire for deliveryMethod.

    • setDeliveryMethodValue

      public CampaignBudget.Builder setDeliveryMethodValue(int value)
       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;
      Parameters:
      value - The enum numeric value on the wire for deliveryMethod to set.
      Returns:
      This builder for chaining.

    • getDeliveryMethod

      public 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;
      Specified by:
      getDeliveryMethod in interface CampaignBudgetOrBuilder
      Returns:
      The deliveryMethod.

    • setDeliveryMethod

      public CampaignBudget.Builder setDeliveryMethod(BudgetDeliveryMethodEnum.BudgetDeliveryMethod value)
       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;
      Parameters:
      value - The deliveryMethod to set.
      Returns:
      This builder for chaining.

    • clearDeliveryMethod

      public CampaignBudget.Builder clearDeliveryMethod()
       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:
      This builder for chaining.

    • hasExplicitlyShared

      public 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;
      Specified by:
      hasExplicitlyShared in interface CampaignBudgetOrBuilder
      Returns:
      Whether the explicitlyShared field is set.

    • getExplicitlyShared

      public 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;
      Specified by:
      getExplicitlyShared in interface CampaignBudgetOrBuilder
      Returns:
      The explicitlyShared.

    • setExplicitlyShared

      public CampaignBudget.Builder setExplicitlyShared(boolean value)
       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;
      Parameters:
      value - The explicitlyShared to set.
      Returns:
      This builder for chaining.

    • clearExplicitlyShared

      public CampaignBudget.Builder clearExplicitlyShared()
       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:
      This builder for chaining.

    • hasReferenceCount

      public 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];
      Specified by:
      hasReferenceCount in interface CampaignBudgetOrBuilder
      Returns:
      Whether the referenceCount field is set.

    • getReferenceCount

      public 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];
      Specified by:
      getReferenceCount in interface CampaignBudgetOrBuilder
      Returns:
      The referenceCount.

    • setReferenceCount

      public CampaignBudget.Builder setReferenceCount(long value)
       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];
      Parameters:
      value - The referenceCount to set.
      Returns:
      This builder for chaining.

    • clearReferenceCount

      public CampaignBudget.Builder clearReferenceCount()
       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:
      This builder for chaining.

    • hasHasRecommendedBudget

      public 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];
      Specified by:
      hasHasRecommendedBudget in interface CampaignBudgetOrBuilder
      Returns:
      Whether the hasRecommendedBudget field is set.

    • getHasRecommendedBudget

      public 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];
      Specified by:
      getHasRecommendedBudget in interface CampaignBudgetOrBuilder
      Returns:
      The hasRecommendedBudget.

    • setHasRecommendedBudget

      public CampaignBudget.Builder setHasRecommendedBudget(boolean value)
       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];
      Parameters:
      value - The hasRecommendedBudget to set.
      Returns:
      This builder for chaining.

    • clearHasRecommendedBudget

      public CampaignBudget.Builder clearHasRecommendedBudget()
       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:
      This builder for chaining.

    • hasRecommendedBudgetAmountMicros

      public 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];
      Specified by:
      hasRecommendedBudgetAmountMicros in interface CampaignBudgetOrBuilder
      Returns:
      Whether the recommendedBudgetAmountMicros field is set.

    • getRecommendedBudgetAmountMicros

      public 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];
      Specified by:
      getRecommendedBudgetAmountMicros in interface CampaignBudgetOrBuilder
      Returns:
      The recommendedBudgetAmountMicros.

    • setRecommendedBudgetAmountMicros

      public CampaignBudget.Builder setRecommendedBudgetAmountMicros(long value)
       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];
      Parameters:
      value - The recommendedBudgetAmountMicros to set.
      Returns:
      This builder for chaining.

    • clearRecommendedBudgetAmountMicros

      public CampaignBudget.Builder clearRecommendedBudgetAmountMicros()
       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:
      This builder for chaining.

    • getPeriodValue

      public 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];
      Specified by:
      getPeriodValue in interface CampaignBudgetOrBuilder
      Returns:
      The enum numeric value on the wire for period.

    • setPeriodValue

      public CampaignBudget.Builder setPeriodValue(int value)
       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];
      Parameters:
      value - The enum numeric value on the wire for period to set.
      Returns:
      This builder for chaining.

    • getPeriod

      public 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];
      Specified by:
      getPeriod in interface CampaignBudgetOrBuilder
      Returns:
      The period.

    • setPeriod

      public CampaignBudget.Builder setPeriod(BudgetPeriodEnum.BudgetPeriod value)
       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];
      Parameters:
      value - The period to set.
      Returns:
      This builder for chaining.

    • clearPeriod

      public CampaignBudget.Builder clearPeriod()
       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:
      This builder for chaining.

    • hasRecommendedBudgetEstimatedChangeWeeklyClicks

      public 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];
      Specified by:
      hasRecommendedBudgetEstimatedChangeWeeklyClicks in interface CampaignBudgetOrBuilder
      Returns:
      Whether the recommendedBudgetEstimatedChangeWeeklyClicks field is set.

    • getRecommendedBudgetEstimatedChangeWeeklyClicks

      public 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];
      Specified by:
      getRecommendedBudgetEstimatedChangeWeeklyClicks in interface CampaignBudgetOrBuilder
      Returns:
      The recommendedBudgetEstimatedChangeWeeklyClicks.

    • setRecommendedBudgetEstimatedChangeWeeklyClicks

      public CampaignBudget.Builder setRecommendedBudgetEstimatedChangeWeeklyClicks(long value)
       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];
      Parameters:
      value - The recommendedBudgetEstimatedChangeWeeklyClicks to set.
      Returns:
      This builder for chaining.

    • clearRecommendedBudgetEstimatedChangeWeeklyClicks

      public CampaignBudget.Builder clearRecommendedBudgetEstimatedChangeWeeklyClicks()
       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:
      This builder for chaining.

    • hasRecommendedBudgetEstimatedChangeWeeklyCostMicros

      public 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];
      Specified by:
      hasRecommendedBudgetEstimatedChangeWeeklyCostMicros in interface CampaignBudgetOrBuilder
      Returns:
      Whether the recommendedBudgetEstimatedChangeWeeklyCostMicros field is set.

    • getRecommendedBudgetEstimatedChangeWeeklyCostMicros

      public 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];
      Specified by:
      getRecommendedBudgetEstimatedChangeWeeklyCostMicros in interface CampaignBudgetOrBuilder
      Returns:
      The recommendedBudgetEstimatedChangeWeeklyCostMicros.

    • setRecommendedBudgetEstimatedChangeWeeklyCostMicros

      public CampaignBudget.Builder setRecommendedBudgetEstimatedChangeWeeklyCostMicros(long value)
       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];
      Parameters:
      value - The recommendedBudgetEstimatedChangeWeeklyCostMicros to set.
      Returns:
      This builder for chaining.

    • clearRecommendedBudgetEstimatedChangeWeeklyCostMicros

      public CampaignBudget.Builder clearRecommendedBudgetEstimatedChangeWeeklyCostMicros()
       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:
      This builder for chaining.

    • hasRecommendedBudgetEstimatedChangeWeeklyInteractions

      public 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];
      Specified by:
      hasRecommendedBudgetEstimatedChangeWeeklyInteractions in interface CampaignBudgetOrBuilder
      Returns:
      Whether the recommendedBudgetEstimatedChangeWeeklyInteractions field is set.

    • getRecommendedBudgetEstimatedChangeWeeklyInteractions

      public 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];
      Specified by:
      getRecommendedBudgetEstimatedChangeWeeklyInteractions in interface CampaignBudgetOrBuilder
      Returns:
      The recommendedBudgetEstimatedChangeWeeklyInteractions.

    • setRecommendedBudgetEstimatedChangeWeeklyInteractions

      public CampaignBudget.Builder setRecommendedBudgetEstimatedChangeWeeklyInteractions(long value)
       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];
      Parameters:
      value - The recommendedBudgetEstimatedChangeWeeklyInteractions to set.
      Returns:
      This builder for chaining.

    • clearRecommendedBudgetEstimatedChangeWeeklyInteractions

      public CampaignBudget.Builder clearRecommendedBudgetEstimatedChangeWeeklyInteractions()
       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:
      This builder for chaining.

    • hasRecommendedBudgetEstimatedChangeWeeklyViews

      public 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];
      Specified by:
      hasRecommendedBudgetEstimatedChangeWeeklyViews in interface CampaignBudgetOrBuilder
      Returns:
      Whether the recommendedBudgetEstimatedChangeWeeklyViews field is set.

    • getRecommendedBudgetEstimatedChangeWeeklyViews

      public 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];
      Specified by:
      getRecommendedBudgetEstimatedChangeWeeklyViews in interface CampaignBudgetOrBuilder
      Returns:
      The recommendedBudgetEstimatedChangeWeeklyViews.

    • setRecommendedBudgetEstimatedChangeWeeklyViews

      public CampaignBudget.Builder setRecommendedBudgetEstimatedChangeWeeklyViews(long value)
       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];
      Parameters:
      value - The recommendedBudgetEstimatedChangeWeeklyViews to set.
      Returns:
      This builder for chaining.

    • clearRecommendedBudgetEstimatedChangeWeeklyViews

      public CampaignBudget.Builder clearRecommendedBudgetEstimatedChangeWeeklyViews()
       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:
      This builder for chaining.

    • getTypeValue

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

    • setTypeValue

      public CampaignBudget.Builder setTypeValue(int value)
       Immutable. The type of the campaign budget.
      .google.ads.googleads.v18.enums.BudgetTypeEnum.BudgetType type = 18 [(.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The enum numeric value on the wire for type to set.
      Returns:
      This builder for chaining.

    • getType

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

    • setType

      public CampaignBudget.Builder setType(BudgetTypeEnum.BudgetType value)
       Immutable. The type of the campaign budget.
      .google.ads.googleads.v18.enums.BudgetTypeEnum.BudgetType type = 18 [(.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The type to set.
      Returns:
      This builder for chaining.

    • clearType

      public CampaignBudget.Builder clearType()
       Immutable. The type of the campaign budget.
      .google.ads.googleads.v18.enums.BudgetTypeEnum.BudgetType type = 18 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      This builder for chaining.

    • getAlignedBiddingStrategyId

      public 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;
      Specified by:
      getAlignedBiddingStrategyId in interface CampaignBudgetOrBuilder
      Returns:
      The alignedBiddingStrategyId.

    • setAlignedBiddingStrategyId

      public CampaignBudget.Builder setAlignedBiddingStrategyId(long value)
       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;
      Parameters:
      value - The alignedBiddingStrategyId to set.
      Returns:
      This builder for chaining.

    • clearAlignedBiddingStrategyId

      public CampaignBudget.Builder clearAlignedBiddingStrategyId()
       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:
      This builder for chaining.

    • setUnknownFields

      public final CampaignBudget.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CampaignBudget.Builder>

    • mergeUnknownFields

      public final CampaignBudget.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CampaignBudget.Builder>