Package com.google.ads.googleads.v10.resources

Class ExperimentArm

  • All Implemented Interfaces:
    ExperimentArmOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class ExperimentArm
extends com.google.protobuf.GeneratedMessageV3
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.v10.resources.ExperimentArm
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ExperimentArm.Builder
      A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      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.
      com.google.protobuf.ProtocolStringList getCampaignsList()
      List of campaigns in the trial arm.
      boolean getControl()
      Whether this arm is a control arm.
      static ExperimentArm getDefaultInstance()  
      ExperimentArm getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.lang.String getInDesignCampaigns​(int index)
      Output only.
      com.google.protobuf.ByteString getInDesignCampaignsBytes​(int index)
      Output only.
      int getInDesignCampaignsCount()
      Output only.
      com.google.protobuf.ProtocolStringList getInDesignCampaignsList()
      Output only.
      java.lang.String getName()
      Required.
      com.google.protobuf.ByteString getNameBytes()
      Required.
      com.google.protobuf.Parser<ExperimentArm> getParserForType()  
      java.lang.String getResourceName()
      Immutable.
      com.google.protobuf.ByteString getResourceNameBytes()
      Immutable.
      int getSerializedSize()  
      long getTrafficSplit()
      Traffic split of the trial arm.
      java.lang.String getTrial()
      Immutable.
      com.google.protobuf.ByteString getTrialBytes()
      Immutable.
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static ExperimentArm.Builder newBuilder()  
      static ExperimentArm.Builder newBuilder​(ExperimentArm prototype)  
      ExperimentArm.Builder newBuilderForType()  
      protected ExperimentArm.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static ExperimentArm parseDelimitedFrom​(java.io.InputStream input)  
      static ExperimentArm parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ExperimentArm parseFrom​(byte[] data)  
      static ExperimentArm parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ExperimentArm parseFrom​(com.google.protobuf.ByteString data)  
      static ExperimentArm parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ExperimentArm parseFrom​(com.google.protobuf.CodedInputStream input)  
      static ExperimentArm parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ExperimentArm parseFrom​(java.io.InputStream input)  
      static ExperimentArm parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ExperimentArm parseFrom​(java.nio.ByteBuffer data)  
      static ExperimentArm parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<ExperimentArm> parser()  
      ExperimentArm.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

        toByteArray, toByteString, writeDelimitedTo, writeTo

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

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

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • 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

      • 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.

      • getTrial

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

      • getTrialBytes

        public com.google.protobuf.ByteString getTrialBytes()
         Immutable. The experiment to which the ExperimentArm belongs.
        string trial = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getTrialBytes in interface ExperimentArmOrBuilder
        Returns:
        The bytes for trial.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • isInitialized

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

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ExperimentArm parseFrom​(java.nio.ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExperimentArm parseFrom​(java.nio.ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExperimentArm parseFrom​(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExperimentArm parseFrom​(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExperimentArm parseFrom​(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExperimentArm parseFrom​(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExperimentArm parseFrom​(java.io.InputStream input)
                               throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ExperimentArm parseFrom​(java.io.InputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static ExperimentArm parseDelimitedFrom​(java.io.InputStream input)
                                        throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static ExperimentArm parseDelimitedFrom​(java.io.InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ExperimentArm parseFrom​(com.google.protobuf.CodedInputStream input)
                               throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ExperimentArm parseFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected ExperimentArm.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static ExperimentArm getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<ExperimentArm> parser()

      • getParserForType

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

      • getDefaultInstanceForType

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