Package com.google.ads.googleads.v24.resources

Interface ExperimentArmOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ExperimentArm, ExperimentArm.Builder
@Generated public interface ExperimentArmOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getResourceName

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

 `customers/{customer_id}/experimentArms/{TrialArm.trial_id}~{TrialArm.trial_arm_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 arm.
 Experiment arm resource names have the form:

 `customers/{customer_id}/experimentArms/{TrialArm.trial_id}~{TrialArm.trial_arm_id}`
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for resourceName.

    • getExperiment

      String getExperiment()
       Immutable. The experiment to which the ExperimentArm belongs.
      string experiment = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      The experiment.

    • getExperimentBytes

      com.google.protobuf.ByteString getExperimentBytes()
       Immutable. The experiment to which the ExperimentArm belongs.
      string experiment = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for experiment.

    • getName

      String getName()
       Required. The name of the experiment arm. It must have a minimum length of
 1 and maximum length of 1024. It must be unique under an experiment.
      string name = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Required. The name of the experiment arm. It must have a minimum length of
 1 and maximum length of 1024. It must be unique under an experiment.
      string name = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for name.

    • getControl

      boolean getControl()
       Whether this arm is a control arm. A control arm is the arm against
 which the other arms are compared.
      bool control = 4;
      Returns:
      The control.

    • getTrafficSplit

      long getTrafficSplit()
       Traffic split of the trial arm. The value should be between 1 and 100
 and must total 100 between the two trial arms.
      int64 traffic_split = 5;
      Returns:
      The trafficSplit.

    • getCampaignsList

      List<String> getCampaignsList()
       List of campaigns in the trial arm. The max length is one.
      repeated string campaigns = 6 [(.google.api.resource_reference) = { ... }
      Returns:
      A list containing the campaigns.

    • getCampaignsCount

      int getCampaignsCount()
       List of campaigns in the trial arm. The max length is one.
      repeated string campaigns = 6 [(.google.api.resource_reference) = { ... }
      Returns:
      The count of campaigns.

    • getCampaigns

      String getCampaigns(int index)
       List of campaigns in the trial arm. The max length is one.
      repeated string campaigns = 6 [(.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the element to return.
      Returns:
      The campaigns at the given index.

    • getCampaignsBytes

      com.google.protobuf.ByteString getCampaignsBytes(int index)
       List of campaigns in the trial arm. The max length is one.
      repeated string campaigns = 6 [(.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the campaigns at the given index.

    • getInDesignCampaignsList

      List<String> getInDesignCampaignsList()
       Output only. The in design campaigns in the treatment experiment arm.
      repeated string in_design_campaigns = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      A list containing the inDesignCampaigns.

    • getInDesignCampaignsCount

      int getInDesignCampaignsCount()
       Output only. The in design campaigns in the treatment experiment arm.
      repeated string in_design_campaigns = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The count of inDesignCampaigns.

    • getInDesignCampaigns

      String getInDesignCampaigns(int index)
       Output only. The in design campaigns in the treatment experiment arm.
      repeated string in_design_campaigns = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the element to return.
      Returns:
      The inDesignCampaigns at the given index.

    • getInDesignCampaignsBytes

      com.google.protobuf.ByteString getInDesignCampaignsBytes(int index)
       Output only. The in design campaigns in the treatment experiment arm.
      repeated string in_design_campaigns = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the inDesignCampaigns at the given index.

    • hasAssetTestingInfo

      boolean hasAssetTestingInfo()
       Details of assets under experiment.
      .google.ads.googleads.v24.resources.ExperimentArm.AssetTestingInfo asset_testing_info = 9;
      Returns:
      Whether the assetTestingInfo field is set.

    • getAssetTestingInfo

      ExperimentArm.AssetTestingInfo getAssetTestingInfo()
       Details of assets under experiment.
      .google.ads.googleads.v24.resources.ExperimentArm.AssetTestingInfo asset_testing_info = 9;
      Returns:
      The assetTestingInfo.

    • getAssetTestingInfoOrBuilder

      ExperimentArm.AssetTestingInfoOrBuilder getAssetTestingInfoOrBuilder()
       Details of assets under experiment.
      .google.ads.googleads.v24.resources.ExperimentArm.AssetTestingInfo asset_testing_info = 9;

    • getAssetGroupsList

      List<ExperimentArm.AssetGroupInfo> getAssetGroupsList()
       List of asset groups in the experiment arm. The max length is one. In the
 Optimize Assets experiment construction, the control arm and treatment arm
 should both contain the same asset group ID.
      repeated .google.ads.googleads.v24.resources.ExperimentArm.AssetGroupInfo asset_groups = 10;

    • getAssetGroups

      ExperimentArm.AssetGroupInfo getAssetGroups(int index)
       List of asset groups in the experiment arm. The max length is one. In the
 Optimize Assets experiment construction, the control arm and treatment arm
 should both contain the same asset group ID.
      repeated .google.ads.googleads.v24.resources.ExperimentArm.AssetGroupInfo asset_groups = 10;

    • getAssetGroupsCount

      int getAssetGroupsCount()
       List of asset groups in the experiment arm. The max length is one. In the
 Optimize Assets experiment construction, the control arm and treatment arm
 should both contain the same asset group ID.
      repeated .google.ads.googleads.v24.resources.ExperimentArm.AssetGroupInfo asset_groups = 10;

    • getAssetGroupsOrBuilderList

      List<? extends ExperimentArm.AssetGroupInfoOrBuilder> getAssetGroupsOrBuilderList()
       List of asset groups in the experiment arm. The max length is one. In the
 Optimize Assets experiment construction, the control arm and treatment arm
 should both contain the same asset group ID.
      repeated .google.ads.googleads.v24.resources.ExperimentArm.AssetGroupInfo asset_groups = 10;

    • getAssetGroupsOrBuilder

      ExperimentArm.AssetGroupInfoOrBuilder getAssetGroupsOrBuilder(int index)
       List of asset groups in the experiment arm. The max length is one. In the
 Optimize Assets experiment construction, the control arm and treatment arm
 should both contain the same asset group ID.
      repeated .google.ads.googleads.v24.resources.ExperimentArm.AssetGroupInfo asset_groups = 10;

    • hasPerformanceMaxExperimentArmInfo

      boolean hasPerformanceMaxExperimentArmInfo()
       Immutable. Information specific to the control or treatment campaign of a
 Performance Max experiment.

 This field is specific to experiments of type PMAX_REPLACEMENT_SHOPPING.
 For example, the treatment experiment arm contains the
 information of treatment Performance Max campaign settings for
 PMAX_REPLACEMENT_SHOPPING experiments.
      .google.ads.googleads.v24.resources.ExperimentArm.PerformanceMaxExperimentArmInfo performance_max_experiment_arm_info = 11 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      Whether the performanceMaxExperimentArmInfo field is set.

    • getPerformanceMaxExperimentArmInfo

      ExperimentArm.PerformanceMaxExperimentArmInfo getPerformanceMaxExperimentArmInfo()
       Immutable. Information specific to the control or treatment campaign of a
 Performance Max experiment.

 This field is specific to experiments of type PMAX_REPLACEMENT_SHOPPING.
 For example, the treatment experiment arm contains the
 information of treatment Performance Max campaign settings for
 PMAX_REPLACEMENT_SHOPPING experiments.
      .google.ads.googleads.v24.resources.ExperimentArm.PerformanceMaxExperimentArmInfo performance_max_experiment_arm_info = 11 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The performanceMaxExperimentArmInfo.

    • getPerformanceMaxExperimentArmInfoOrBuilder

      ExperimentArm.PerformanceMaxExperimentArmInfoOrBuilder getPerformanceMaxExperimentArmInfoOrBuilder()
       Immutable. Information specific to the control or treatment campaign of a
 Performance Max experiment.

 This field is specific to experiments of type PMAX_REPLACEMENT_SHOPPING.
 For example, the treatment experiment arm contains the
 information of treatment Performance Max campaign settings for
 PMAX_REPLACEMENT_SHOPPING experiments.
      .google.ads.googleads.v24.resources.ExperimentArm.PerformanceMaxExperimentArmInfo performance_max_experiment_arm_info = 11 [(.google.api.field_behavior) = IMMUTABLE];