Package com.google.ads.googleads.v15.resources

Class ExperimentArm.Builder

  • All Implemented Interfaces:
    ExperimentArmOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable
    Enclosing class:
    ExperimentArm
    public static final class ExperimentArm.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ExperimentArm.Builder>
implements ExperimentArmOrBuilder
     A Google ads experiment for users to experiment changes on multiple
 campaigns, compare the performance, and apply the effective changes.
    Protobuf type google.ads.googleads.v15.resources.ExperimentArm

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ExperimentArm.Builder>

      • clear

        public ExperimentArm.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<ExperimentArm.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ExperimentArm.Builder>

      • getDefaultInstanceForType

        public ExperimentArm getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public ExperimentArm build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public ExperimentArm buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public ExperimentArm.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<ExperimentArm.Builder>

      • setField

        public ExperimentArm.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      java.lang.Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<ExperimentArm.Builder>

      • clearField

        public ExperimentArm.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ExperimentArm.Builder>

      • clearOneof

        public ExperimentArm.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ExperimentArm.Builder>

      • setRepeatedField

        public ExperimentArm.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              int index,
                                              java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExperimentArm.Builder>

      • addRepeatedField

        public ExperimentArm.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExperimentArm.Builder>

      • mergeFrom

        public ExperimentArm.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExperimentArm.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ExperimentArm.Builder>

      • mergeFrom

        public ExperimentArm.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExperimentArm.Builder>
        Throws:
        java.io.IOException

      • getResourceName

        public 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) = { ... }
        Specified by:
        getResourceName in interface ExperimentArmOrBuilder
        Returns:
        The resourceName.

      • getResourceNameBytes

        public 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) = { ... }
        Specified by:
        getResourceNameBytes in interface ExperimentArmOrBuilder
        Returns:
        The bytes for resourceName.

      • setResourceName

        public ExperimentArm.Builder setResourceName​(java.lang.String value)
         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) = { ... }
        Parameters:
        value - The resourceName to set.
        Returns:
        This builder for chaining.

      • clearResourceName

        public ExperimentArm.Builder clearResourceName()
         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:
        This builder for chaining.

      • setResourceNameBytes

        public ExperimentArm.Builder setResourceNameBytes​(com.google.protobuf.ByteString value)
         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) = { ... }
        Parameters:
        value - The bytes for resourceName to set.
        Returns:
        This builder for chaining.

      • getExperiment

        public java.lang.String getExperiment()
         Immutable. The experiment to which the ExperimentArm belongs.
        string experiment = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getExperiment in interface ExperimentArmOrBuilder
        Returns:
        The experiment.

      • getExperimentBytes

        public 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) = { ... }
        Specified by:
        getExperimentBytes in interface ExperimentArmOrBuilder
        Returns:
        The bytes for experiment.

      • setExperiment

        public ExperimentArm.Builder setExperiment​(java.lang.String value)
         Immutable. The experiment to which the ExperimentArm belongs.
        string experiment = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The experiment to set.
        Returns:
        This builder for chaining.

      • clearExperiment

        public ExperimentArm.Builder clearExperiment()
         Immutable. The experiment to which the ExperimentArm belongs.
        string experiment = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setExperimentBytes

        public ExperimentArm.Builder setExperimentBytes​(com.google.protobuf.ByteString value)
         Immutable. The experiment to which the ExperimentArm belongs.
        string experiment = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for experiment to set.
        Returns:
        This builder for chaining.

      • getName

        public 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];
        Specified by:
        getName in interface ExperimentArmOrBuilder
        Returns:
        The name.

      • getNameBytes

        public 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];
        Specified by:
        getNameBytes in interface ExperimentArmOrBuilder
        Returns:
        The bytes for name.

      • setName

        public ExperimentArm.Builder setName​(java.lang.String value)
         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];
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public ExperimentArm.Builder clearName()
         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:
        This builder for chaining.

      • setNameBytes

        public ExperimentArm.Builder setNameBytes​(com.google.protobuf.ByteString value)
         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];
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

      • getControl

        public 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;
        Specified by:
        getControl in interface ExperimentArmOrBuilder
        Returns:
        The control.

      • setControl

        public ExperimentArm.Builder setControl​(boolean value)
         Whether this arm is a control arm. A control arm is the arm against
 which the other arms are compared.
        bool control = 4;
        Parameters:
        value - The control to set.
        Returns:
        This builder for chaining.

      • clearControl

        public ExperimentArm.Builder clearControl()
         Whether this arm is a control arm. A control arm is the arm against
 which the other arms are compared.
        bool control = 4;
        Returns:
        This builder for chaining.

      • getTrafficSplit

        public 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;
        Specified by:
        getTrafficSplit in interface ExperimentArmOrBuilder
        Returns:
        The trafficSplit.

      • setTrafficSplit

        public ExperimentArm.Builder setTrafficSplit​(long value)
         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;
        Parameters:
        value - The trafficSplit to set.
        Returns:
        This builder for chaining.

      • clearTrafficSplit

        public ExperimentArm.Builder clearTrafficSplit()
         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:
        This builder for chaining.

      • getCampaignsList

        public com.google.protobuf.ProtocolStringList getCampaignsList()
         List of campaigns in the trial arm. The max length is one.
        repeated string campaigns = 6 [(.google.api.resource_reference) = { ... }
        Specified by:
        getCampaignsList in interface ExperimentArmOrBuilder
        Returns:
        A list containing the campaigns.

      • getCampaignsCount

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

      • getCampaigns

        public 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) = { ... }
        Specified by:
        getCampaigns in interface ExperimentArmOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The campaigns at the given index.

      • getCampaignsBytes

        public 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) = { ... }
        Specified by:
        getCampaignsBytes in interface ExperimentArmOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the campaigns at the given index.

      • setCampaigns

        public ExperimentArm.Builder setCampaigns​(int index,
                                          java.lang.String value)
         List of campaigns in the trial arm. The max length is one.
        repeated string campaigns = 6 [(.google.api.resource_reference) = { ... }
        Parameters:
        index - The index to set the value at.
        value - The campaigns to set.
        Returns:
        This builder for chaining.

      • addCampaigns

        public ExperimentArm.Builder addCampaigns​(java.lang.String value)
         List of campaigns in the trial arm. The max length is one.
        repeated string campaigns = 6 [(.google.api.resource_reference) = { ... }
        Parameters:
        value - The campaigns to add.
        Returns:
        This builder for chaining.

      • addAllCampaigns

        public ExperimentArm.Builder addAllCampaigns​(java.lang.Iterable<java.lang.String> values)
         List of campaigns in the trial arm. The max length is one.
        repeated string campaigns = 6 [(.google.api.resource_reference) = { ... }
        Parameters:
        values - The campaigns to add.
        Returns:
        This builder for chaining.

      • clearCampaigns

        public ExperimentArm.Builder clearCampaigns()
         List of campaigns in the trial arm. The max length is one.
        repeated string campaigns = 6 [(.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • addCampaignsBytes

        public ExperimentArm.Builder addCampaignsBytes​(com.google.protobuf.ByteString value)
         List of campaigns in the trial arm. The max length is one.
        repeated string campaigns = 6 [(.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes of the campaigns to add.
        Returns:
        This builder for chaining.

      • getInDesignCampaignsList

        public com.google.protobuf.ProtocolStringList 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) = { ... }
        Specified by:
        getInDesignCampaignsList in interface ExperimentArmOrBuilder
        Returns:
        A list containing the inDesignCampaigns.

      • getInDesignCampaignsCount

        public 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) = { ... }
        Specified by:
        getInDesignCampaignsCount in interface ExperimentArmOrBuilder
        Returns:
        The count of inDesignCampaigns.

      • getInDesignCampaigns

        public 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) = { ... }
        Specified by:
        getInDesignCampaigns in interface ExperimentArmOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The inDesignCampaigns at the given index.

      • getInDesignCampaignsBytes

        public 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) = { ... }
        Specified by:
        getInDesignCampaignsBytes in interface ExperimentArmOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the inDesignCampaigns at the given index.

      • setInDesignCampaigns

        public ExperimentArm.Builder setInDesignCampaigns​(int index,
                                                  java.lang.String value)
         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 to set the value at.
        value - The inDesignCampaigns to set.
        Returns:
        This builder for chaining.

      • addInDesignCampaigns

        public ExperimentArm.Builder addInDesignCampaigns​(java.lang.String value)
         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:
        value - The inDesignCampaigns to add.
        Returns:
        This builder for chaining.

      • addAllInDesignCampaigns

        public ExperimentArm.Builder addAllInDesignCampaigns​(java.lang.Iterable<java.lang.String> values)
         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:
        values - The inDesignCampaigns to add.
        Returns:
        This builder for chaining.

      • clearInDesignCampaigns

        public ExperimentArm.Builder clearInDesignCampaigns()
         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:
        This builder for chaining.

      • addInDesignCampaignsBytes

        public ExperimentArm.Builder addInDesignCampaignsBytes​(com.google.protobuf.ByteString value)
         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:
        value - The bytes of the inDesignCampaigns to add.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final ExperimentArm.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExperimentArm.Builder>

      • mergeUnknownFields

        public final ExperimentArm.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExperimentArm.Builder>