Package com.google.ads.googleads.v13.resources

Interface ExperimentArmOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getCampaigns​(int index)
      List of campaigns in the trial arm.
      com.google.protobuf.ByteString getCampaignsBytes​(int index)
      List of campaigns in the trial arm.
      int getCampaignsCount()
      List of campaigns in the trial arm.
      java.util.List<java.lang.String> getCampaignsList()
      List of campaigns in the trial arm.
      boolean getControl()
      Whether this arm is a control arm.
      java.lang.String getExperiment()
      Immutable.
      com.google.protobuf.ByteString getExperimentBytes()
      Immutable.
      java.lang.String getInDesignCampaigns​(int index)
      Output only.
      com.google.protobuf.ByteString getInDesignCampaignsBytes​(int index)
      Output only.
      int getInDesignCampaignsCount()
      Output only.
      java.util.List<java.lang.String> getInDesignCampaignsList()
      Output only.
      java.lang.String getName()
      Required.
      com.google.protobuf.ByteString getNameBytes()
      Required.
      java.lang.String getResourceName()
      Immutable.
      com.google.protobuf.ByteString getResourceNameBytes()
      Immutable.
      long getTrafficSplit()
      Traffic split of the trial arm.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getResourceName

        java.lang.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

        java.lang.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

        java.lang.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

        java.util.List<java.lang.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

        java.lang.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

        java.util.List<java.lang.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

        java.lang.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.