com.google.ads.googleads.v17.resources.ExperimentOrBuilder Maven / Gradle / Ivy

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

// Protobuf Java Version: 3.25.3
package com.google.ads.googleads.v17.resources;

public interface ExperimentOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.resources.Experiment)
    com.google.protobuf.MessageOrBuilder {

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

  /**
   *    * Output only. The ID of the experiment. Read only.
   * 
   *
   * optional int64 experiment_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the experimentId field is set.
   */
  boolean hasExperimentId();
  /**
   *    * Output only. The ID of the experiment. Read only.
   * 
   *
   * optional int64 experiment_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The experimentId.
   */
  long getExperimentId();

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

  /**
   *    * The description of the experiment. It must have a minimum length of 1 and
   * maximum length of 2048.
   * 
   *
   * string description = 11;
   * @return The description.
   */
  java.lang.String getDescription();
  /**
   *    * The description of the experiment. It must have a minimum length of 1 and
   * maximum length of 2048.
   * 
   *
   * string description = 11;
   * @return The bytes for description.
   */
  com.google.protobuf.ByteString
      getDescriptionBytes();

  /**
   *    * 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;
   * @return The suffix.
   */
  java.lang.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;
   * @return The bytes for suffix.
   */
  com.google.protobuf.ByteString
      getSuffixBytes();

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

  /**
   *    * The Advertiser-chosen status of this experiment.
   * 
   *
   * .google.ads.googleads.v17.enums.ExperimentStatusEnum.ExperimentStatus status = 14;
   * @return The enum numeric value on the wire for status.
   */
  int getStatusValue();
  /**
   *    * The Advertiser-chosen status of this experiment.
   * 
   *
   * .google.ads.googleads.v17.enums.ExperimentStatusEnum.ExperimentStatus status = 14;
   * @return The status.
   */
  com.google.ads.googleads.v17.enums.ExperimentStatusEnum.ExperimentStatus getStatus();

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

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

  /**
   *    * The goals of this experiment.
   * 
   *
   * repeated .google.ads.googleads.v17.common.MetricGoal goals = 17;
   */
  java.util.List 
      getGoalsList();
  /**
   *    * The goals of this experiment.
   * 
   *
   * repeated .google.ads.googleads.v17.common.MetricGoal goals = 17;
   */
  com.google.ads.googleads.v17.common.MetricGoal getGoals(int index);
  /**
   *    * The goals of this experiment.
   * 
   *
   * repeated .google.ads.googleads.v17.common.MetricGoal goals = 17;
   */
  int getGoalsCount();
  /**
   *    * The goals of this experiment.
   * 
   *
   * repeated .google.ads.googleads.v17.common.MetricGoal goals = 17;
   */
  java.util.List 
      getGoalsOrBuilderList();
  /**
   *    * The goals of this experiment.
   * 
   *
   * repeated .google.ads.googleads.v17.common.MetricGoal goals = 17;
   */
  com.google.ads.googleads.v17.common.MetricGoalOrBuilder getGoalsOrBuilder(
      int index);

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

  /**
   *    * Output only. The status of the experiment promotion process.
   * 
   *
   * .google.ads.googleads.v17.enums.AsyncActionStatusEnum.AsyncActionStatus promote_status = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for promoteStatus.
   */
  int getPromoteStatusValue();
  /**
   *    * Output only. The status of the experiment promotion process.
   * 
   *
   * .google.ads.googleads.v17.enums.AsyncActionStatusEnum.AsyncActionStatus promote_status = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The promoteStatus.
   */
  com.google.ads.googleads.v17.enums.AsyncActionStatusEnum.AsyncActionStatus getPromoteStatus();

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