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

Interface ExperimentOrBuilder

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

  • Method Details

    • getResourceName

      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) = { ... }
      Returns:
      The resourceName.

    • getResourceNameBytes

      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) = { ... }
      Returns:
      The bytes for resourceName.

    • hasExperimentId

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

    • getExperimentId

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

    • getName

      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];
      Returns:
      The name.

    • getNameBytes

      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];
      Returns:
      The bytes for name.

    • getDescription

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

    • getDescriptionBytes

      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;
      Returns:
      The bytes for description.

    • getSuffix

      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;
      Returns:
      The suffix.

    • getSuffixBytes

      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;
      Returns:
      The bytes for suffix.

    • getTypeValue

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

    • getType

      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];
      Returns:
      The type.

    • getStatusValue

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

    • getStatus

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

    • hasStartDate

      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;
      Returns:
      Whether the startDate field is set.

    • getStartDate

      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;
      Returns:
      The startDate.

    • getStartDateBytes

      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;
      Returns:
      The bytes for startDate.

    • hasEndDate

      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;
      Returns:
      Whether the endDate field is set.

    • getEndDate

      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;
      Returns:
      The endDate.

    • getEndDateBytes

      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;
      Returns:
      The bytes for endDate.

    • getGoalsList

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

    • getGoals

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

    • getGoalsCount

      int getGoalsCount()
       The goals of this experiment.
      repeated .google.ads.googleads.v18.common.MetricGoal goals = 17;

    • getGoalsOrBuilderList

      List<? extends MetricGoalOrBuilder> getGoalsOrBuilderList()
       The goals of this experiment.
      repeated .google.ads.googleads.v18.common.MetricGoal goals = 17;

    • getGoalsOrBuilder

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

    • hasLongRunningOperation

      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];
      Returns:
      Whether the longRunningOperation field is set.

    • getLongRunningOperation

      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];
      Returns:
      The longRunningOperation.

    • getLongRunningOperationBytes

      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];
      Returns:
      The bytes for longRunningOperation.

    • getPromoteStatusValue

      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];
      Returns:
      The enum numeric value on the wire for promoteStatus.

    • getPromoteStatus

      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];
      Returns:
      The promoteStatus.

    • hasSyncEnabled

      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];
      Returns:
      Whether the syncEnabled field is set.

    • getSyncEnabled

      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];
      Returns:
      The syncEnabled.