com.google.ads.googleads.v10.resources.CampaignExperimentOrBuilder Maven / Gradle / Ivy

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

package com.google.ads.googleads.v10.resources;

public interface CampaignExperimentOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v10.resources.CampaignExperiment)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Immutable. The resource name of the campaign experiment.
   * Campaign experiment resource names have the form:
   * `customers/{customer_id}/campaignExperiments/{campaign_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 campaign experiment.
   * Campaign experiment resource names have the form:
   * `customers/{customer_id}/campaignExperiments/{campaign_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 campaign experiment.
   * This field is read-only.
   * 
   *
   * optional int64 id = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the id field is set.
   */
  boolean hasId();
  /**
   *    * Output only. The ID of the campaign experiment.
   * This field is read-only.
   * 
   *
   * optional int64 id = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The id.
   */
  long getId();

  /**
   *    * Immutable. The campaign draft with staged changes to the base campaign.
   * 
   *
   * optional string campaign_draft = 14 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return Whether the campaignDraft field is set.
   */
  boolean hasCampaignDraft();
  /**
   *    * Immutable. The campaign draft with staged changes to the base campaign.
   * 
   *
   * optional string campaign_draft = 14 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The campaignDraft.
   */
  java.lang.String getCampaignDraft();
  /**
   *    * Immutable. The campaign draft with staged changes to the base campaign.
   * 
   *
   * optional string campaign_draft = 14 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The bytes for campaignDraft.
   */
  com.google.protobuf.ByteString
      getCampaignDraftBytes();

  /**
   *    * The name of the campaign experiment.
   * This field is required when creating new campaign experiments
   * and must not conflict with the name of another non-removed
   * campaign experiment or campaign.
   * It must not contain any null (code point 0x0), NL line feed
   * (code point 0xA) or carriage return (code point 0xD) characters.
   * 
   *
   * optional string name = 15;
   * @return Whether the name field is set.
   */
  boolean hasName();
  /**
   *    * The name of the campaign experiment.
   * This field is required when creating new campaign experiments
   * and must not conflict with the name of another non-removed
   * campaign experiment or campaign.
   * It must not contain any null (code point 0x0), NL line feed
   * (code point 0xA) or carriage return (code point 0xD) characters.
   * 
   *
   * optional string name = 15;
   * @return The name.
   */
  java.lang.String getName();
  /**
   *    * The name of the campaign experiment.
   * This field is required when creating new campaign experiments
   * and must not conflict with the name of another non-removed
   * campaign experiment or campaign.
   * It must not contain any null (code point 0x0), NL line feed
   * (code point 0xA) or carriage return (code point 0xD) characters.
   * 
   *
   * optional string name = 15;
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * The description of the experiment.
   * 
   *
   * optional string description = 16;
   * @return Whether the description field is set.
   */
  boolean hasDescription();
  /**
   *    * The description of the experiment.
   * 
   *
   * optional string description = 16;
   * @return The description.
   */
  java.lang.String getDescription();
  /**
   *    * The description of the experiment.
   * 
   *
   * optional string description = 16;
   * @return The bytes for description.
   */
  com.google.protobuf.ByteString
      getDescriptionBytes();

  /**
   *    * Immutable. Share of traffic directed to experiment as a percent (must be between 1 and
   * 99 inclusive. Base campaign receives the remainder of the traffic
   * (100 - traffic_split_percent). Required for create.
   * 
   *
   * optional int64 traffic_split_percent = 17 [(.google.api.field_behavior) = IMMUTABLE];
   * @return Whether the trafficSplitPercent field is set.
   */
  boolean hasTrafficSplitPercent();
  /**
   *    * Immutable. Share of traffic directed to experiment as a percent (must be between 1 and
   * 99 inclusive. Base campaign receives the remainder of the traffic
   * (100 - traffic_split_percent). Required for create.
   * 
   *
   * optional int64 traffic_split_percent = 17 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The trafficSplitPercent.
   */
  long getTrafficSplitPercent();

  /**
   *    * Immutable. Determines the behavior of the traffic split.
   * 
   *
   * .google.ads.googleads.v10.enums.CampaignExperimentTrafficSplitTypeEnum.CampaignExperimentTrafficSplitType traffic_split_type = 7 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The enum numeric value on the wire for trafficSplitType.
   */
  int getTrafficSplitTypeValue();
  /**
   *    * Immutable. Determines the behavior of the traffic split.
   * 
   *
   * .google.ads.googleads.v10.enums.CampaignExperimentTrafficSplitTypeEnum.CampaignExperimentTrafficSplitType traffic_split_type = 7 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The trafficSplitType.
   */
  com.google.ads.googleads.v10.enums.CampaignExperimentTrafficSplitTypeEnum.CampaignExperimentTrafficSplitType getTrafficSplitType();

  /**
   *    * Output only. The experiment campaign, as opposed to the base campaign.
   * 
   *
   * optional string experiment_campaign = 18 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @return Whether the experimentCampaign field is set.
   */
  boolean hasExperimentCampaign();
  /**
   *    * Output only. The experiment campaign, as opposed to the base campaign.
   * 
   *
   * optional string experiment_campaign = 18 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @return The experimentCampaign.
   */
  java.lang.String getExperimentCampaign();
  /**
   *    * Output only. The experiment campaign, as opposed to the base campaign.
   * 
   *
   * optional string experiment_campaign = 18 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @return The bytes for experimentCampaign.
   */
  com.google.protobuf.ByteString
      getExperimentCampaignBytes();

  /**
   *    * Output only. The status of the campaign experiment. This field is read-only.
   * 
   *
   * .google.ads.googleads.v10.enums.CampaignExperimentStatusEnum.CampaignExperimentStatus status = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for status.
   */
  int getStatusValue();
  /**
   *    * Output only. The status of the campaign experiment. This field is read-only.
   * 
   *
   * .google.ads.googleads.v10.enums.CampaignExperimentStatusEnum.CampaignExperimentStatus status = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The status.
   */
  com.google.ads.googleads.v10.enums.CampaignExperimentStatusEnum.CampaignExperimentStatus getStatus();

  /**
   *    * Output only. The resource name of the long-running operation that can be used to poll
   * for completion of experiment create or promote. The most recent long
   * running operation is returned.
   * 
   *
   * optional string long_running_operation = 19 [(.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 create or promote. The most recent long
   * running operation is returned.
   * 
   *
   * optional string long_running_operation = 19 [(.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 create or promote. The most recent long
   * running operation is returned.
   * 
   *
   * optional string long_running_operation = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The bytes for longRunningOperation.
   */
  com.google.protobuf.ByteString
      getLongRunningOperationBytes();

  /**
   *    * Date when the campaign 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. Cannot be changed once the experiment starts.
   * Format: YYYY-MM-DD
   * Example: 2019-03-14
   * 
   *
   * optional string start_date = 20;
   * @return Whether the startDate field is set.
   */
  boolean hasStartDate();
  /**
   *    * Date when the campaign 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. Cannot be changed once the experiment starts.
   * Format: YYYY-MM-DD
   * Example: 2019-03-14
   * 
   *
   * optional string start_date = 20;
   * @return The startDate.
   */
  java.lang.String getStartDate();
  /**
   *    * Date when the campaign 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. Cannot be changed once the experiment starts.
   * Format: YYYY-MM-DD
   * Example: 2019-03-14
   * 
   *
   * optional string start_date = 20;
   * @return The bytes for startDate.
   */
  com.google.protobuf.ByteString
      getStartDateBytes();

  /**
   *    * The last day of the campaign experiment. 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 = 21;
   * @return Whether the endDate field is set.
   */
  boolean hasEndDate();
  /**
   *    * The last day of the campaign experiment. 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 = 21;
   * @return The endDate.
   */
  java.lang.String getEndDate();
  /**
   *    * The last day of the campaign experiment. 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 = 21;
   * @return The bytes for endDate.
   */
  com.google.protobuf.ByteString
      getEndDateBytes();
}