Package com.google.ads.googleads.v25.resources

Class CampaignGoalConfig.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<CampaignGoalConfig.Builder>
com.google.ads.googleads.v25.resources.CampaignGoalConfig.Builder
All Implemented Interfaces:
CampaignGoalConfigOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
CampaignGoalConfig
public static final class CampaignGoalConfig.Builder extends com.google.protobuf.GeneratedMessage.Builder<CampaignGoalConfig.Builder> implements CampaignGoalConfigOrBuilder
 A link between a campaign and a goal enabling campaign-specific optimization.
Protobuf type google.ads.googleads.v25.resources.CampaignGoalConfig

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<CampaignGoalConfig.Builder>

    • clear

      public CampaignGoalConfig.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.GeneratedMessage.Builder<CampaignGoalConfig.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.GeneratedMessage.Builder<CampaignGoalConfig.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public CampaignGoalConfig.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<CampaignGoalConfig.Builder>

    • mergeFrom

      public CampaignGoalConfig.Builder mergeFrom(CampaignGoalConfig other)

    • isInitialized

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

    • mergeFrom

      public CampaignGoalConfig.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<CampaignGoalConfig.Builder>
      Throws:
      IOException

    • getCampaignGoalConfigSettingsCase

      public CampaignGoalConfig.CampaignGoalConfigSettingsCase getCampaignGoalConfigSettingsCase()
      Specified by:
      getCampaignGoalConfigSettingsCase in interface CampaignGoalConfigOrBuilder

    • clearCampaignGoalConfigSettings

      public CampaignGoalConfig.Builder clearCampaignGoalConfigSettings()

    • getResourceName

      public String getResourceName()
       Immutable. The resource name of the campaign goal config.
 campaign goal config resource names have the form:
 `customers/{customer_id}/campaignGoalConfigs/{campaign_id}~{goal_id}`
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getResourceName in interface CampaignGoalConfigOrBuilder
      Returns:
      The resourceName.

    • getResourceNameBytes

      public com.google.protobuf.ByteString getResourceNameBytes()
       Immutable. The resource name of the campaign goal config.
 campaign goal config resource names have the form:
 `customers/{customer_id}/campaignGoalConfigs/{campaign_id}~{goal_id}`
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getResourceNameBytes in interface CampaignGoalConfigOrBuilder
      Returns:
      The bytes for resourceName.

    • setResourceName

      public CampaignGoalConfig.Builder setResourceName(String value)
       Immutable. The resource name of the campaign goal config.
 campaign goal config resource names have the form:
 `customers/{customer_id}/campaignGoalConfigs/{campaign_id}~{goal_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 CampaignGoalConfig.Builder clearResourceName()
       Immutable. The resource name of the campaign goal config.
 campaign goal config resource names have the form:
 `customers/{customer_id}/campaignGoalConfigs/{campaign_id}~{goal_id}`
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setResourceNameBytes

      public CampaignGoalConfig.Builder setResourceNameBytes(com.google.protobuf.ByteString value)
       Immutable. The resource name of the campaign goal config.
 campaign goal config resource names have the form:
 `customers/{customer_id}/campaignGoalConfigs/{campaign_id}~{goal_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.

    • getCampaign

      public String getCampaign()
       Immutable. The resource name of the campaign for this link.
      string campaign = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getCampaign in interface CampaignGoalConfigOrBuilder
      Returns:
      The campaign.

    • getCampaignBytes

      public com.google.protobuf.ByteString getCampaignBytes()
       Immutable. The resource name of the campaign for this link.
      string campaign = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getCampaignBytes in interface CampaignGoalConfigOrBuilder
      Returns:
      The bytes for campaign.

    • setCampaign

      public CampaignGoalConfig.Builder setCampaign(String value)
       Immutable. The resource name of the campaign for this link.
      string campaign = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The campaign to set.
      Returns:
      This builder for chaining.

    • clearCampaign

      public CampaignGoalConfig.Builder clearCampaign()
       Immutable. The resource name of the campaign for this link.
      string campaign = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setCampaignBytes

      public CampaignGoalConfig.Builder setCampaignBytes(com.google.protobuf.ByteString value)
       Immutable. The resource name of the campaign for this link.
      string campaign = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for campaign to set.
      Returns:
      This builder for chaining.

    • getGoal

      public String getGoal()
       Immutable. The resource name of the goal this link is attached to.
      string goal = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getGoal in interface CampaignGoalConfigOrBuilder
      Returns:
      The goal.

    • getGoalBytes

      public com.google.protobuf.ByteString getGoalBytes()
       Immutable. The resource name of the goal this link is attached to.
      string goal = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getGoalBytes in interface CampaignGoalConfigOrBuilder
      Returns:
      The bytes for goal.

    • setGoal

      public CampaignGoalConfig.Builder setGoal(String value)
       Immutable. The resource name of the goal this link is attached to.
      string goal = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The goal to set.
      Returns:
      This builder for chaining.

    • clearGoal

      public CampaignGoalConfig.Builder clearGoal()
       Immutable. The resource name of the goal this link is attached to.
      string goal = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setGoalBytes

      public CampaignGoalConfig.Builder setGoalBytes(com.google.protobuf.ByteString value)
       Immutable. The resource name of the goal this link is attached to.
      string goal = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for goal to set.
      Returns:
      This builder for chaining.

    • getGoalTypeValue

      public int getGoalTypeValue()
       Output only. The goal type this link is attached to.
      .google.ads.googleads.v25.enums.GoalTypeEnum.GoalType goal_type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getGoalTypeValue in interface CampaignGoalConfigOrBuilder
      Returns:
      The enum numeric value on the wire for goalType.

    • setGoalTypeValue

      public CampaignGoalConfig.Builder setGoalTypeValue(int value)
       Output only. The goal type this link is attached to.
      .google.ads.googleads.v25.enums.GoalTypeEnum.GoalType goal_type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The enum numeric value on the wire for goalType to set.
      Returns:
      This builder for chaining.

    • getGoalType

      public GoalTypeEnum.GoalType getGoalType()
       Output only. The goal type this link is attached to.
      .google.ads.googleads.v25.enums.GoalTypeEnum.GoalType goal_type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getGoalType in interface CampaignGoalConfigOrBuilder
      Returns:
      The goalType.

    • setGoalType

      public CampaignGoalConfig.Builder setGoalType(GoalTypeEnum.GoalType value)
       Output only. The goal type this link is attached to.
      .google.ads.googleads.v25.enums.GoalTypeEnum.GoalType goal_type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The goalType to set.
      Returns:
      This builder for chaining.

    • clearGoalType

      public CampaignGoalConfig.Builder clearGoalType()
       Output only. The goal type this link is attached to.
      .google.ads.googleads.v25.enums.GoalTypeEnum.GoalType goal_type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • hasCampaignRetentionSettings

      public boolean hasCampaignRetentionSettings()
       Retention goal campaign settings.
      .google.ads.googleads.v25.common.CampaignGoalSettings.CampaignRetentionGoalSettings campaign_retention_settings = 5;
      Specified by:
      hasCampaignRetentionSettings in interface CampaignGoalConfigOrBuilder
      Returns:
      Whether the campaignRetentionSettings field is set.

    • getCampaignRetentionSettings

      public CampaignGoalSettings.CampaignRetentionGoalSettings getCampaignRetentionSettings()
       Retention goal campaign settings.
      .google.ads.googleads.v25.common.CampaignGoalSettings.CampaignRetentionGoalSettings campaign_retention_settings = 5;
      Specified by:
      getCampaignRetentionSettings in interface CampaignGoalConfigOrBuilder
      Returns:
      The campaignRetentionSettings.

    • setCampaignRetentionSettings

      public CampaignGoalConfig.Builder setCampaignRetentionSettings(CampaignGoalSettings.CampaignRetentionGoalSettings value)
       Retention goal campaign settings.
      .google.ads.googleads.v25.common.CampaignGoalSettings.CampaignRetentionGoalSettings campaign_retention_settings = 5;

    • setCampaignRetentionSettings

      public CampaignGoalConfig.Builder setCampaignRetentionSettings(CampaignGoalSettings.CampaignRetentionGoalSettings.Builder builderForValue)
       Retention goal campaign settings.
      .google.ads.googleads.v25.common.CampaignGoalSettings.CampaignRetentionGoalSettings campaign_retention_settings = 5;

    • mergeCampaignRetentionSettings

      public CampaignGoalConfig.Builder mergeCampaignRetentionSettings(CampaignGoalSettings.CampaignRetentionGoalSettings value)
       Retention goal campaign settings.
      .google.ads.googleads.v25.common.CampaignGoalSettings.CampaignRetentionGoalSettings campaign_retention_settings = 5;

    • clearCampaignRetentionSettings

      public CampaignGoalConfig.Builder clearCampaignRetentionSettings()
       Retention goal campaign settings.
      .google.ads.googleads.v25.common.CampaignGoalSettings.CampaignRetentionGoalSettings campaign_retention_settings = 5;

    • getCampaignRetentionSettingsBuilder

      public CampaignGoalSettings.CampaignRetentionGoalSettings.Builder getCampaignRetentionSettingsBuilder()
       Retention goal campaign settings.
      .google.ads.googleads.v25.common.CampaignGoalSettings.CampaignRetentionGoalSettings campaign_retention_settings = 5;

    • getCampaignRetentionSettingsOrBuilder

      public CampaignGoalSettings.CampaignRetentionGoalSettingsOrBuilder getCampaignRetentionSettingsOrBuilder()
       Retention goal campaign settings.
      .google.ads.googleads.v25.common.CampaignGoalSettings.CampaignRetentionGoalSettings campaign_retention_settings = 5;
      Specified by:
      getCampaignRetentionSettingsOrBuilder in interface CampaignGoalConfigOrBuilder

    • hasCampaignNewCustomerAcquisitionSettings

      public boolean hasCampaignNewCustomerAcquisitionSettings()
       New customer acquisition goal campaign settings.
      .google.ads.googleads.v25.common.CampaignGoalSettings.CampaignNewCustomerAcquisitionGoalSettings campaign_new_customer_acquisition_settings = 6;
      Specified by:
      hasCampaignNewCustomerAcquisitionSettings in interface CampaignGoalConfigOrBuilder
      Returns:
      Whether the campaignNewCustomerAcquisitionSettings field is set.

    • getCampaignNewCustomerAcquisitionSettings

      public CampaignGoalSettings.CampaignNewCustomerAcquisitionGoalSettings getCampaignNewCustomerAcquisitionSettings()
       New customer acquisition goal campaign settings.
      .google.ads.googleads.v25.common.CampaignGoalSettings.CampaignNewCustomerAcquisitionGoalSettings campaign_new_customer_acquisition_settings = 6;
      Specified by:
      getCampaignNewCustomerAcquisitionSettings in interface CampaignGoalConfigOrBuilder
      Returns:
      The campaignNewCustomerAcquisitionSettings.

    • setCampaignNewCustomerAcquisitionSettings

      public CampaignGoalConfig.Builder setCampaignNewCustomerAcquisitionSettings(CampaignGoalSettings.CampaignNewCustomerAcquisitionGoalSettings value)
       New customer acquisition goal campaign settings.
      .google.ads.googleads.v25.common.CampaignGoalSettings.CampaignNewCustomerAcquisitionGoalSettings campaign_new_customer_acquisition_settings = 6;

    • setCampaignNewCustomerAcquisitionSettings

      public CampaignGoalConfig.Builder setCampaignNewCustomerAcquisitionSettings(CampaignGoalSettings.CampaignNewCustomerAcquisitionGoalSettings.Builder builderForValue)
       New customer acquisition goal campaign settings.
      .google.ads.googleads.v25.common.CampaignGoalSettings.CampaignNewCustomerAcquisitionGoalSettings campaign_new_customer_acquisition_settings = 6;

    • mergeCampaignNewCustomerAcquisitionSettings

      public CampaignGoalConfig.Builder mergeCampaignNewCustomerAcquisitionSettings(CampaignGoalSettings.CampaignNewCustomerAcquisitionGoalSettings value)
       New customer acquisition goal campaign settings.
      .google.ads.googleads.v25.common.CampaignGoalSettings.CampaignNewCustomerAcquisitionGoalSettings campaign_new_customer_acquisition_settings = 6;

    • clearCampaignNewCustomerAcquisitionSettings

      public CampaignGoalConfig.Builder clearCampaignNewCustomerAcquisitionSettings()
       New customer acquisition goal campaign settings.
      .google.ads.googleads.v25.common.CampaignGoalSettings.CampaignNewCustomerAcquisitionGoalSettings campaign_new_customer_acquisition_settings = 6;

    • getCampaignNewCustomerAcquisitionSettingsBuilder

      public CampaignGoalSettings.CampaignNewCustomerAcquisitionGoalSettings.Builder getCampaignNewCustomerAcquisitionSettingsBuilder()
       New customer acquisition goal campaign settings.
      .google.ads.googleads.v25.common.CampaignGoalSettings.CampaignNewCustomerAcquisitionGoalSettings campaign_new_customer_acquisition_settings = 6;

    • getCampaignNewCustomerAcquisitionSettingsOrBuilder

      public CampaignGoalSettings.CampaignNewCustomerAcquisitionGoalSettingsOrBuilder getCampaignNewCustomerAcquisitionSettingsOrBuilder()
       New customer acquisition goal campaign settings.
      .google.ads.googleads.v25.common.CampaignGoalSettings.CampaignNewCustomerAcquisitionGoalSettings campaign_new_customer_acquisition_settings = 6;
      Specified by:
      getCampaignNewCustomerAcquisitionSettingsOrBuilder in interface CampaignGoalConfigOrBuilder

    • hasCampaignLoyaltyRetentionSettings

      public boolean hasCampaignLoyaltyRetentionSettings()
       Loyalty retention goal campaign settings.
      .google.ads.googleads.v25.common.CampaignGoalSettings.CampaignLoyaltyRetentionGoalSettings campaign_loyalty_retention_settings = 7;
      Specified by:
      hasCampaignLoyaltyRetentionSettings in interface CampaignGoalConfigOrBuilder
      Returns:
      Whether the campaignLoyaltyRetentionSettings field is set.

    • getCampaignLoyaltyRetentionSettings

      public CampaignGoalSettings.CampaignLoyaltyRetentionGoalSettings getCampaignLoyaltyRetentionSettings()
       Loyalty retention goal campaign settings.
      .google.ads.googleads.v25.common.CampaignGoalSettings.CampaignLoyaltyRetentionGoalSettings campaign_loyalty_retention_settings = 7;
      Specified by:
      getCampaignLoyaltyRetentionSettings in interface CampaignGoalConfigOrBuilder
      Returns:
      The campaignLoyaltyRetentionSettings.

    • setCampaignLoyaltyRetentionSettings

      public CampaignGoalConfig.Builder setCampaignLoyaltyRetentionSettings(CampaignGoalSettings.CampaignLoyaltyRetentionGoalSettings value)
       Loyalty retention goal campaign settings.
      .google.ads.googleads.v25.common.CampaignGoalSettings.CampaignLoyaltyRetentionGoalSettings campaign_loyalty_retention_settings = 7;

    • setCampaignLoyaltyRetentionSettings

      public CampaignGoalConfig.Builder setCampaignLoyaltyRetentionSettings(CampaignGoalSettings.CampaignLoyaltyRetentionGoalSettings.Builder builderForValue)
       Loyalty retention goal campaign settings.
      .google.ads.googleads.v25.common.CampaignGoalSettings.CampaignLoyaltyRetentionGoalSettings campaign_loyalty_retention_settings = 7;

    • mergeCampaignLoyaltyRetentionSettings

      public CampaignGoalConfig.Builder mergeCampaignLoyaltyRetentionSettings(CampaignGoalSettings.CampaignLoyaltyRetentionGoalSettings value)
       Loyalty retention goal campaign settings.
      .google.ads.googleads.v25.common.CampaignGoalSettings.CampaignLoyaltyRetentionGoalSettings campaign_loyalty_retention_settings = 7;

    • clearCampaignLoyaltyRetentionSettings

      public CampaignGoalConfig.Builder clearCampaignLoyaltyRetentionSettings()
       Loyalty retention goal campaign settings.
      .google.ads.googleads.v25.common.CampaignGoalSettings.CampaignLoyaltyRetentionGoalSettings campaign_loyalty_retention_settings = 7;

    • getCampaignLoyaltyRetentionSettingsBuilder

      public CampaignGoalSettings.CampaignLoyaltyRetentionGoalSettings.Builder getCampaignLoyaltyRetentionSettingsBuilder()
       Loyalty retention goal campaign settings.
      .google.ads.googleads.v25.common.CampaignGoalSettings.CampaignLoyaltyRetentionGoalSettings campaign_loyalty_retention_settings = 7;

    • getCampaignLoyaltyRetentionSettingsOrBuilder

      public CampaignGoalSettings.CampaignLoyaltyRetentionGoalSettingsOrBuilder getCampaignLoyaltyRetentionSettingsOrBuilder()
       Loyalty retention goal campaign settings.
      .google.ads.googleads.v25.common.CampaignGoalSettings.CampaignLoyaltyRetentionGoalSettings campaign_loyalty_retention_settings = 7;
      Specified by:
      getCampaignLoyaltyRetentionSettingsOrBuilder in interface CampaignGoalConfigOrBuilder