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

Class Experiment.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<Experiment.Builder>
com.google.ads.googleads.v18.resources.Experiment.Builder
All Implemented Interfaces:
ExperimentOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Experiment
public static final class Experiment.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Experiment.Builder> implements ExperimentOrBuilder
 A Google ads experiment for users to experiment changes on multiple
 campaigns, compare the performance, and apply the effective changes.
Protobuf type google.ads.googleads.v18.resources.Experiment

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

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

    • clearField

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

    • clearOneof

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

    • setRepeatedField

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

    • addRepeatedField

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

    • mergeFrom

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

    • mergeFrom

      public Experiment.Builder mergeFrom(Experiment other)

    • isInitialized

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

    • mergeFrom

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

    • getResourceName

      public String getResourceName()
       Immutable. The resource name of the experiment.
 Experiment resource names have the form:

 `customers/{customer_id}/experiments/{experiment_id}`
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getResourceName in interface ExperimentOrBuilder
      Returns:
      The resourceName.

    • getResourceNameBytes

      public com.google.protobuf.ByteString getResourceNameBytes()
       Immutable. The resource name of the experiment.
 Experiment resource names have the form:

 `customers/{customer_id}/experiments/{experiment_id}`
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getResourceNameBytes in interface ExperimentOrBuilder
      Returns:
      The bytes for resourceName.

    • setResourceName

      public Experiment.Builder setResourceName(String value)
       Immutable. The resource name of the experiment.
 Experiment resource names have the form:

 `customers/{customer_id}/experiments/{experiment_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 Experiment.Builder clearResourceName()
       Immutable. The resource name of the experiment.
 Experiment resource names have the form:

 `customers/{customer_id}/experiments/{experiment_id}`
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setResourceNameBytes

      public Experiment.Builder setResourceNameBytes(com.google.protobuf.ByteString value)
       Immutable. The resource name of the experiment.
 Experiment resource names have the form:

 `customers/{customer_id}/experiments/{experiment_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.

    • hasExperimentId

      public boolean hasExperimentId()
       Output only. The ID of the experiment. Read only.
      optional int64 experiment_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasExperimentId in interface ExperimentOrBuilder
      Returns:
      Whether the experimentId field is set.

    • getExperimentId

      public long getExperimentId()
       Output only. The ID of the experiment. Read only.
      optional int64 experiment_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getExperimentId in interface ExperimentOrBuilder
      Returns:
      The experimentId.

    • setExperimentId

      public Experiment.Builder setExperimentId(long value)
       Output only. The ID of the experiment. Read only.
      optional int64 experiment_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The experimentId to set.
      Returns:
      This builder for chaining.

    • clearExperimentId

      public Experiment.Builder clearExperimentId()
       Output only. The ID of the experiment. Read only.
      optional int64 experiment_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • getName

      public String getName()
       Required. The name of the experiment. It must have a minimum length of 1
 and maximum length of 1024. It must be unique under a customer.
      string name = 10 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getName in interface ExperimentOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Required. The name of the experiment. It must have a minimum length of 1
 and maximum length of 1024. It must be unique under a customer.
      string name = 10 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getNameBytes in interface ExperimentOrBuilder
      Returns:
      The bytes for name.

    • setName

      public Experiment.Builder setName(String value)
       Required. The name of the experiment. It must have a minimum length of 1
 and maximum length of 1024. It must be unique under a customer.
      string name = 10 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public Experiment.Builder clearName()
       Required. The name of the experiment. It must have a minimum length of 1
 and maximum length of 1024. It must be unique under a customer.
      string name = 10 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setNameBytes

      public Experiment.Builder setNameBytes(com.google.protobuf.ByteString value)
       Required. The name of the experiment. It must have a minimum length of 1
 and maximum length of 1024. It must be unique under a customer.
      string name = 10 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • getDescription

      public String getDescription()
       The description of the experiment. It must have a minimum length of 1 and
 maximum length of 2048.
      string description = 11;
      Specified by:
      getDescription in interface ExperimentOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       The description of the experiment. It must have a minimum length of 1 and
 maximum length of 2048.
      string description = 11;
      Specified by:
      getDescriptionBytes in interface ExperimentOrBuilder
      Returns:
      The bytes for description.

    • setDescription

      public Experiment.Builder setDescription(String value)
       The description of the experiment. It must have a minimum length of 1 and
 maximum length of 2048.
      string description = 11;
      Parameters:
      value - The description to set.
      Returns:
      This builder for chaining.

    • clearDescription

      public Experiment.Builder clearDescription()
       The description of the experiment. It must have a minimum length of 1 and
 maximum length of 2048.
      string description = 11;
      Returns:
      This builder for chaining.

    • setDescriptionBytes

      public Experiment.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
       The description of the experiment. It must have a minimum length of 1 and
 maximum length of 2048.
      string description = 11;
      Parameters:
      value - The bytes for description to set.
      Returns:
      This builder for chaining.

    • getSuffix

      public String getSuffix()
       For system managed experiments, the advertiser must provide a suffix during
 construction, in the setup stage before moving to initiated. The suffix
 will be appended to the in-design and experiment campaign names so that the
 name is base campaign name + suffix.
      string suffix = 12;
      Specified by:
      getSuffix in interface ExperimentOrBuilder
      Returns:
      The suffix.

    • getSuffixBytes

      public com.google.protobuf.ByteString getSuffixBytes()
       For system managed experiments, the advertiser must provide a suffix during
 construction, in the setup stage before moving to initiated. The suffix
 will be appended to the in-design and experiment campaign names so that the
 name is base campaign name + suffix.
      string suffix = 12;
      Specified by:
      getSuffixBytes in interface ExperimentOrBuilder
      Returns:
      The bytes for suffix.

    • setSuffix

      public Experiment.Builder setSuffix(String value)
       For system managed experiments, the advertiser must provide a suffix during
 construction, in the setup stage before moving to initiated. The suffix
 will be appended to the in-design and experiment campaign names so that the
 name is base campaign name + suffix.
      string suffix = 12;
      Parameters:
      value - The suffix to set.
      Returns:
      This builder for chaining.

    • clearSuffix

      public Experiment.Builder clearSuffix()
       For system managed experiments, the advertiser must provide a suffix during
 construction, in the setup stage before moving to initiated. The suffix
 will be appended to the in-design and experiment campaign names so that the
 name is base campaign name + suffix.
      string suffix = 12;
      Returns:
      This builder for chaining.

    • setSuffixBytes

      public Experiment.Builder setSuffixBytes(com.google.protobuf.ByteString value)
       For system managed experiments, the advertiser must provide a suffix during
 construction, in the setup stage before moving to initiated. The suffix
 will be appended to the in-design and experiment campaign names so that the
 name is base campaign name + suffix.
      string suffix = 12;
      Parameters:
      value - The bytes for suffix to set.
      Returns:
      This builder for chaining.

    • getTypeValue

      public int getTypeValue()
       Required. The product/feature that uses this experiment.
      .google.ads.googleads.v18.enums.ExperimentTypeEnum.ExperimentType type = 13 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getTypeValue in interface ExperimentOrBuilder
      Returns:
      The enum numeric value on the wire for type.

    • setTypeValue

      public Experiment.Builder setTypeValue(int value)
       Required. The product/feature that uses this experiment.
      .google.ads.googleads.v18.enums.ExperimentTypeEnum.ExperimentType type = 13 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The enum numeric value on the wire for type to set.
      Returns:
      This builder for chaining.

    • getType

      public ExperimentTypeEnum.ExperimentType getType()
       Required. The product/feature that uses this experiment.
      .google.ads.googleads.v18.enums.ExperimentTypeEnum.ExperimentType type = 13 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getType in interface ExperimentOrBuilder
      Returns:
      The type.

    • setType

      public Experiment.Builder setType(ExperimentTypeEnum.ExperimentType value)
       Required. The product/feature that uses this experiment.
      .google.ads.googleads.v18.enums.ExperimentTypeEnum.ExperimentType type = 13 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The type to set.
      Returns:
      This builder for chaining.

    • clearType

      public Experiment.Builder clearType()
       Required. The product/feature that uses this experiment.
      .google.ads.googleads.v18.enums.ExperimentTypeEnum.ExperimentType type = 13 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • getStatusValue

      public int getStatusValue()
       The Advertiser-chosen status of this experiment.
      .google.ads.googleads.v18.enums.ExperimentStatusEnum.ExperimentStatus status = 14;
      Specified by:
      getStatusValue in interface ExperimentOrBuilder
      Returns:
      The enum numeric value on the wire for status.

    • setStatusValue

      public Experiment.Builder setStatusValue(int value)
       The Advertiser-chosen status of this experiment.
      .google.ads.googleads.v18.enums.ExperimentStatusEnum.ExperimentStatus status = 14;
      Parameters:
      value - The enum numeric value on the wire for status to set.
      Returns:
      This builder for chaining.

    • getStatus

      public ExperimentStatusEnum.ExperimentStatus getStatus()
       The Advertiser-chosen status of this experiment.
      .google.ads.googleads.v18.enums.ExperimentStatusEnum.ExperimentStatus status = 14;
      Specified by:
      getStatus in interface ExperimentOrBuilder
      Returns:
      The status.

    • setStatus

      public Experiment.Builder setStatus(ExperimentStatusEnum.ExperimentStatus value)
       The Advertiser-chosen status of this experiment.
      .google.ads.googleads.v18.enums.ExperimentStatusEnum.ExperimentStatus status = 14;
      Parameters:
      value - The status to set.
      Returns:
      This builder for chaining.

    • clearStatus

      public Experiment.Builder clearStatus()
       The Advertiser-chosen status of this experiment.
      .google.ads.googleads.v18.enums.ExperimentStatusEnum.ExperimentStatus status = 14;
      Returns:
      This builder for chaining.

    • hasStartDate

      public boolean hasStartDate()
       Date when the experiment starts. By default, the experiment starts
 now or on the campaign's start date, whichever is later. If this field is
 set, then the experiment starts at the beginning of the specified date in
 the customer's time zone.

 Format: YYYY-MM-DD
 Example: 2019-03-14
      optional string start_date = 15;
      Specified by:
      hasStartDate in interface ExperimentOrBuilder
      Returns:
      Whether the startDate field is set.

    • getStartDate

      public String getStartDate()
       Date when the experiment starts. By default, the experiment starts
 now or on the campaign's start date, whichever is later. If this field is
 set, then the experiment starts at the beginning of the specified date in
 the customer's time zone.

 Format: YYYY-MM-DD
 Example: 2019-03-14
      optional string start_date = 15;
      Specified by:
      getStartDate in interface ExperimentOrBuilder
      Returns:
      The startDate.

    • getStartDateBytes

      public com.google.protobuf.ByteString getStartDateBytes()
       Date when the experiment starts. By default, the experiment starts
 now or on the campaign's start date, whichever is later. If this field is
 set, then the experiment starts at the beginning of the specified date in
 the customer's time zone.

 Format: YYYY-MM-DD
 Example: 2019-03-14
      optional string start_date = 15;
      Specified by:
      getStartDateBytes in interface ExperimentOrBuilder
      Returns:
      The bytes for startDate.

    • setStartDate

      public Experiment.Builder setStartDate(String value)
       Date when the experiment starts. By default, the experiment starts
 now or on the campaign's start date, whichever is later. If this field is
 set, then the experiment starts at the beginning of the specified date in
 the customer's time zone.

 Format: YYYY-MM-DD
 Example: 2019-03-14
      optional string start_date = 15;
      Parameters:
      value - The startDate to set.
      Returns:
      This builder for chaining.

    • clearStartDate

      public Experiment.Builder clearStartDate()
       Date when the experiment starts. By default, the experiment starts
 now or on the campaign's start date, whichever is later. If this field is
 set, then the experiment starts at the beginning of the specified date in
 the customer's time zone.

 Format: YYYY-MM-DD
 Example: 2019-03-14
      optional string start_date = 15;
      Returns:
      This builder for chaining.

    • setStartDateBytes

      public Experiment.Builder setStartDateBytes(com.google.protobuf.ByteString value)
       Date when the experiment starts. By default, the experiment starts
 now or on the campaign's start date, whichever is later. If this field is
 set, then the experiment starts at the beginning of the specified date in
 the customer's time zone.

 Format: YYYY-MM-DD
 Example: 2019-03-14
      optional string start_date = 15;
      Parameters:
      value - The bytes for startDate to set.
      Returns:
      This builder for chaining.

    • hasEndDate

      public boolean hasEndDate()
       Date when the experiment ends. By default, the experiment ends on
 the campaign's end date. If this field is set, then the experiment ends at
 the end of the specified date in the customer's time zone.

 Format: YYYY-MM-DD
 Example: 2019-04-18
      optional string end_date = 16;
      Specified by:
      hasEndDate in interface ExperimentOrBuilder
      Returns:
      Whether the endDate field is set.

    • getEndDate

      public String getEndDate()
       Date when the experiment ends. By default, the experiment ends on
 the campaign's end date. If this field is set, then the experiment ends at
 the end of the specified date in the customer's time zone.

 Format: YYYY-MM-DD
 Example: 2019-04-18
      optional string end_date = 16;
      Specified by:
      getEndDate in interface ExperimentOrBuilder
      Returns:
      The endDate.

    • getEndDateBytes

      public com.google.protobuf.ByteString getEndDateBytes()
       Date when the experiment ends. By default, the experiment ends on
 the campaign's end date. If this field is set, then the experiment ends at
 the end of the specified date in the customer's time zone.

 Format: YYYY-MM-DD
 Example: 2019-04-18
      optional string end_date = 16;
      Specified by:
      getEndDateBytes in interface ExperimentOrBuilder
      Returns:
      The bytes for endDate.

    • setEndDate

      public Experiment.Builder setEndDate(String value)
       Date when the experiment ends. By default, the experiment ends on
 the campaign's end date. If this field is set, then the experiment ends at
 the end of the specified date in the customer's time zone.

 Format: YYYY-MM-DD
 Example: 2019-04-18
      optional string end_date = 16;
      Parameters:
      value - The endDate to set.
      Returns:
      This builder for chaining.

    • clearEndDate

      public Experiment.Builder clearEndDate()
       Date when the experiment ends. By default, the experiment ends on
 the campaign's end date. If this field is set, then the experiment ends at
 the end of the specified date in the customer's time zone.

 Format: YYYY-MM-DD
 Example: 2019-04-18
      optional string end_date = 16;
      Returns:
      This builder for chaining.

    • setEndDateBytes

      public Experiment.Builder setEndDateBytes(com.google.protobuf.ByteString value)
       Date when the experiment ends. By default, the experiment ends on
 the campaign's end date. If this field is set, then the experiment ends at
 the end of the specified date in the customer's time zone.

 Format: YYYY-MM-DD
 Example: 2019-04-18
      optional string end_date = 16;
      Parameters:
      value - The bytes for endDate to set.
      Returns:
      This builder for chaining.

    • getGoalsList

      public List<MetricGoal> getGoalsList()
       The goals of this experiment.
      repeated .google.ads.googleads.v18.common.MetricGoal goals = 17;
      Specified by:
      getGoalsList in interface ExperimentOrBuilder

    • getGoalsCount

      public int getGoalsCount()
       The goals of this experiment.
      repeated .google.ads.googleads.v18.common.MetricGoal goals = 17;
      Specified by:
      getGoalsCount in interface ExperimentOrBuilder

    • getGoals

      public MetricGoal getGoals(int index)
       The goals of this experiment.
      repeated .google.ads.googleads.v18.common.MetricGoal goals = 17;
      Specified by:
      getGoals in interface ExperimentOrBuilder

    • setGoals

      public Experiment.Builder setGoals(int index, MetricGoal value)
       The goals of this experiment.
      repeated .google.ads.googleads.v18.common.MetricGoal goals = 17;

    • setGoals

      public Experiment.Builder setGoals(int index, MetricGoal.Builder builderForValue)
       The goals of this experiment.
      repeated .google.ads.googleads.v18.common.MetricGoal goals = 17;

    • addGoals

      public Experiment.Builder addGoals(MetricGoal value)
       The goals of this experiment.
      repeated .google.ads.googleads.v18.common.MetricGoal goals = 17;

    • addGoals

      public Experiment.Builder addGoals(int index, MetricGoal value)
       The goals of this experiment.
      repeated .google.ads.googleads.v18.common.MetricGoal goals = 17;

    • addGoals

      public Experiment.Builder addGoals(MetricGoal.Builder builderForValue)
       The goals of this experiment.
      repeated .google.ads.googleads.v18.common.MetricGoal goals = 17;

    • addGoals

      public Experiment.Builder addGoals(int index, MetricGoal.Builder builderForValue)
       The goals of this experiment.
      repeated .google.ads.googleads.v18.common.MetricGoal goals = 17;

    • addAllGoals

      public Experiment.Builder addAllGoals(Iterable<? extends MetricGoal> values)
       The goals of this experiment.
      repeated .google.ads.googleads.v18.common.MetricGoal goals = 17;

    • clearGoals

      public Experiment.Builder clearGoals()
       The goals of this experiment.
      repeated .google.ads.googleads.v18.common.MetricGoal goals = 17;

    • removeGoals

      public Experiment.Builder removeGoals(int index)
       The goals of this experiment.
      repeated .google.ads.googleads.v18.common.MetricGoal goals = 17;

    • getGoalsBuilder

      public MetricGoal.Builder getGoalsBuilder(int index)
       The goals of this experiment.
      repeated .google.ads.googleads.v18.common.MetricGoal goals = 17;

    • getGoalsOrBuilder

      public MetricGoalOrBuilder getGoalsOrBuilder(int index)
       The goals of this experiment.
      repeated .google.ads.googleads.v18.common.MetricGoal goals = 17;
      Specified by:
      getGoalsOrBuilder in interface ExperimentOrBuilder

    • getGoalsOrBuilderList

      public List<? extends MetricGoalOrBuilder> getGoalsOrBuilderList()
       The goals of this experiment.
      repeated .google.ads.googleads.v18.common.MetricGoal goals = 17;
      Specified by:
      getGoalsOrBuilderList in interface ExperimentOrBuilder

    • addGoalsBuilder

      public MetricGoal.Builder addGoalsBuilder()
       The goals of this experiment.
      repeated .google.ads.googleads.v18.common.MetricGoal goals = 17;

    • addGoalsBuilder

      public MetricGoal.Builder addGoalsBuilder(int index)
       The goals of this experiment.
      repeated .google.ads.googleads.v18.common.MetricGoal goals = 17;

    • getGoalsBuilderList

      public List<MetricGoal.Builder> getGoalsBuilderList()
       The goals of this experiment.
      repeated .google.ads.googleads.v18.common.MetricGoal goals = 17;

    • hasLongRunningOperation

      public boolean hasLongRunningOperation()
       Output only. The resource name of the long-running operation that can be
 used to poll for completion of experiment schedule or promote. The most
 recent long running operation is returned.
      optional string long_running_operation = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasLongRunningOperation in interface ExperimentOrBuilder
      Returns:
      Whether the longRunningOperation field is set.

    • getLongRunningOperation

      public String getLongRunningOperation()
       Output only. The resource name of the long-running operation that can be
 used to poll for completion of experiment schedule or promote. The most
 recent long running operation is returned.
      optional string long_running_operation = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getLongRunningOperation in interface ExperimentOrBuilder
      Returns:
      The longRunningOperation.

    • getLongRunningOperationBytes

      public com.google.protobuf.ByteString getLongRunningOperationBytes()
       Output only. The resource name of the long-running operation that can be
 used to poll for completion of experiment schedule or promote. The most
 recent long running operation is returned.
      optional string long_running_operation = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getLongRunningOperationBytes in interface ExperimentOrBuilder
      Returns:
      The bytes for longRunningOperation.

    • setLongRunningOperation

      public Experiment.Builder setLongRunningOperation(String value)
       Output only. The resource name of the long-running operation that can be
 used to poll for completion of experiment schedule or promote. The most
 recent long running operation is returned.
      optional string long_running_operation = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The longRunningOperation to set.
      Returns:
      This builder for chaining.

    • clearLongRunningOperation

      public Experiment.Builder clearLongRunningOperation()
       Output only. The resource name of the long-running operation that can be
 used to poll for completion of experiment schedule or promote. The most
 recent long running operation is returned.
      optional string long_running_operation = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • setLongRunningOperationBytes

      public Experiment.Builder setLongRunningOperationBytes(com.google.protobuf.ByteString value)
       Output only. The resource name of the long-running operation that can be
 used to poll for completion of experiment schedule or promote. The most
 recent long running operation is returned.
      optional string long_running_operation = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The bytes for longRunningOperation to set.
      Returns:
      This builder for chaining.

    • getPromoteStatusValue

      public int getPromoteStatusValue()
       Output only. The status of the experiment promotion process.
      .google.ads.googleads.v18.enums.AsyncActionStatusEnum.AsyncActionStatus promote_status = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPromoteStatusValue in interface ExperimentOrBuilder
      Returns:
      The enum numeric value on the wire for promoteStatus.

    • setPromoteStatusValue

      public Experiment.Builder setPromoteStatusValue(int value)
       Output only. The status of the experiment promotion process.
      .google.ads.googleads.v18.enums.AsyncActionStatusEnum.AsyncActionStatus promote_status = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The enum numeric value on the wire for promoteStatus to set.
      Returns:
      This builder for chaining.

    • getPromoteStatus

      public AsyncActionStatusEnum.AsyncActionStatus getPromoteStatus()
       Output only. The status of the experiment promotion process.
      .google.ads.googleads.v18.enums.AsyncActionStatusEnum.AsyncActionStatus promote_status = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPromoteStatus in interface ExperimentOrBuilder
      Returns:
      The promoteStatus.

    • setPromoteStatus

      public Experiment.Builder setPromoteStatus(AsyncActionStatusEnum.AsyncActionStatus value)
       Output only. The status of the experiment promotion process.
      .google.ads.googleads.v18.enums.AsyncActionStatusEnum.AsyncActionStatus promote_status = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The promoteStatus to set.
      Returns:
      This builder for chaining.

    • clearPromoteStatus

      public Experiment.Builder clearPromoteStatus()
       Output only. The status of the experiment promotion process.
      .google.ads.googleads.v18.enums.AsyncActionStatusEnum.AsyncActionStatus promote_status = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • hasSyncEnabled

      public boolean hasSyncEnabled()
       Immutable. Set to true if changes to base campaigns should be synced to the
 trial campaigns. Any changes made directly to trial campaigns will be
 preserved. This field can only be set when the experiment is being created.
      optional bool sync_enabled = 20 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      hasSyncEnabled in interface ExperimentOrBuilder
      Returns:
      Whether the syncEnabled field is set.

    • getSyncEnabled

      public boolean getSyncEnabled()
       Immutable. Set to true if changes to base campaigns should be synced to the
 trial campaigns. Any changes made directly to trial campaigns will be
 preserved. This field can only be set when the experiment is being created.
      optional bool sync_enabled = 20 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getSyncEnabled in interface ExperimentOrBuilder
      Returns:
      The syncEnabled.

    • setSyncEnabled

      public Experiment.Builder setSyncEnabled(boolean value)
       Immutable. Set to true if changes to base campaigns should be synced to the
 trial campaigns. Any changes made directly to trial campaigns will be
 preserved. This field can only be set when the experiment is being created.
      optional bool sync_enabled = 20 [(.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The syncEnabled to set.
      Returns:
      This builder for chaining.

    • clearSyncEnabled

      public Experiment.Builder clearSyncEnabled()
       Immutable. Set to true if changes to base campaigns should be synced to the
 trial campaigns. Any changes made directly to trial campaigns will be
 preserved. This field can only be set when the experiment is being created.
      optional bool sync_enabled = 20 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final Experiment.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<Experiment.Builder>

    • mergeUnknownFields

      public final Experiment.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<Experiment.Builder>