Package com.google.ads.googleads.v18.resources

Class ExperimentArm

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v18.resources.ExperimentArm
All Implemented Interfaces:
ExperimentArmOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, 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.v18.resources.ExperimentArm
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final 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<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, 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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CAMPAIGNS_FIELD_NUMBER
     
    static final int
    CONTROL_FIELD_NUMBER
     
    static final int
    EXPERIMENT_FIELD_NUMBER
     
    static final int
    IN_DESIGN_CAMPAIGNS_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    RESOURCE_NAME_FIELD_NUMBER
     
    static final int
    TRAFFIC_SPLIT_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    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 final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getExperiment()
    Immutable.
    com.google.protobuf.ByteString
    getExperimentBytes()
    Immutable.
    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.
    String
    getName()
    Required.
    com.google.protobuf.ByteString
    getNameBytes()
    Required.
    com.google.protobuf.Parser<ExperimentArm>
    getParserForType()
     
    String
    getResourceName()
    Immutable.
    com.google.protobuf.ByteString
    getResourceNameBytes()
    Immutable.
    int
    getSerializedSize()
     
    long
    getTrafficSplit()
    Traffic split of the trial arm.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final 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 Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static ExperimentArm
    parseDelimitedFrom(InputStream input)
     
    static ExperimentArm
    parseDelimitedFrom(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(InputStream input)
     
    static ExperimentArm
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ExperimentArm
    parseFrom(ByteBuffer data)
     
    static ExperimentArm
    parseFrom(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, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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, getUnknownFields, hasField, hasOneof

  • Field Details

    • RESOURCE_NAME_FIELD_NUMBER

      public static final int RESOURCE_NAME_FIELD_NUMBER
      See Also:

    • EXPERIMENT_FIELD_NUMBER

      public static final int EXPERIMENT_FIELD_NUMBER
      See Also:

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • CONTROL_FIELD_NUMBER

      public static final int CONTROL_FIELD_NUMBER
      See Also:

    • TRAFFIC_SPLIT_FIELD_NUMBER

      public static final int TRAFFIC_SPLIT_FIELD_NUMBER
      See Also:

    • CAMPAIGNS_FIELD_NUMBER

      public static final int CAMPAIGNS_FIELD_NUMBER
      See Also:

    • IN_DESIGN_CAMPAIGNS_FIELD_NUMBER

      public static final int IN_DESIGN_CAMPAIGNS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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 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.

    • getExperiment

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

    • getName

      public 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 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 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExperimentArm parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static ExperimentArm parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ExperimentArm.Builder newBuilder()

    • newBuilder

      public static ExperimentArm.Builder newBuilder(ExperimentArm prototype)

    • 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