Package com.google.ads.googleads.v21.common

Class TargetRoas.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.ExtendableBuilder<com.google.protobuf.GeneratedMessageV3,BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<TargetRoas.Builder>
com.google.ads.googleads.v21.common.TargetRoas.Builder
All Implemented Interfaces:
TargetRoasOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
TargetRoas
public static final class TargetRoas.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<TargetRoas.Builder> implements TargetRoasOrBuilder
 An automated bidding strategy that helps you maximize revenue while
 averaging a specific target return on ad spend (ROAS).
Protobuf type google.ads.googleads.v21.common.TargetRoas

  • Method Summary

    Modifier and Type
    Method
    Description
    TargetRoas.Builder
    addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
     
    TargetRoas
    build()
     
    TargetRoas
    buildPartial()
     
    TargetRoas.Builder
    clear()
     
    TargetRoas.Builder
    clearCpcBidCeilingMicros()
    Maximum bid limit that can be set by the bid strategy.
    TargetRoas.Builder
    clearCpcBidFloorMicros()
    Minimum bid limit that can be set by the bid strategy.
    TargetRoas.Builder
    clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
     
    TargetRoas.Builder
    clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
     
    TargetRoas.Builder
    clearTargetRoas()
    Required.
    TargetRoas.Builder
    clearTargetRoasTolerancePercentMillis()
    The percent of ROAS(return on advertising spend) degradation tolerance allowed to increase traffic diversity and conversion volume, specified in millis (for example, 10,000 = 10%).
    TargetRoas.Builder
    clone()
     
    long
    getCpcBidCeilingMicros()
    Maximum bid limit that can be set by the bid strategy.
    long
    getCpcBidFloorMicros()
    Minimum bid limit that can be set by the bid strategy.
    TargetRoas
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    double
    getTargetRoas()
    Required.
    long
    getTargetRoasTolerancePercentMillis()
    The percent of ROAS(return on advertising spend) degradation tolerance allowed to increase traffic diversity and conversion volume, specified in millis (for example, 10,000 = 10%).
    boolean
    hasCpcBidCeilingMicros()
    Maximum bid limit that can be set by the bid strategy.
    boolean
    hasCpcBidFloorMicros()
    Minimum bid limit that can be set by the bid strategy.
    boolean
    hasTargetRoas()
    Required.
    boolean
    hasTargetRoasTolerancePercentMillis()
    The percent of ROAS(return on advertising spend) degradation tolerance allowed to increase traffic diversity and conversion volume, specified in millis (for example, 10,000 = 10%).
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    TargetRoas.Builder
    mergeFrom(TargetRoas other)
     
    TargetRoas.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    TargetRoas.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    final TargetRoas.Builder
    mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
     
    TargetRoas.Builder
    setCpcBidCeilingMicros(long value)
    Maximum bid limit that can be set by the bid strategy.
    TargetRoas.Builder
    setCpcBidFloorMicros(long value)
    Minimum bid limit that can be set by the bid strategy.
    TargetRoas.Builder
    setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
     
    TargetRoas.Builder
    setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
     
    TargetRoas.Builder
    setTargetRoas(double value)
    Required.
    TargetRoas.Builder
    setTargetRoasTolerancePercentMillis(long value)
    The percent of ROAS(return on advertising spend) degradation tolerance allowed to increase traffic diversity and conversion volume, specified in millis (for example, 10,000 = 10%).
    final TargetRoas.Builder
    setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
     

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

    getParentForChildren

    Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableBuilder

    addExtension, addExtension, clearExtension, clearExtension, extensionsAreInitialized, getAllFields, getExtension, getExtension, getExtensionCount, getField, getFieldBuilder, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, hasExtension, hasField, mergeExtensionFields, newBuilderForField, parseUnknownField, setExtension, setExtension, setExtension, setExtension

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    getOneofFieldDescriptor, getUnknownFields, getUnknownFieldSetBuilder, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, onBuilt, onChanged, setUnknownFieldSetBuilder, setUnknownFieldsProto3

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

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

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

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder

    getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, hasExtension, hasExtension

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

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

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Overrides:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<TargetRoas.Builder>

    • clear

      public TargetRoas.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<TargetRoas.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.GeneratedMessage.Builder<TargetRoas.Builder>

    • getDefaultInstanceForType

      public TargetRoas getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

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

    • buildPartial

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

    • clone

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

    • setField

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

    • clearField

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

    • clearOneof

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

    • setRepeatedField

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

    • addRepeatedField

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

    • mergeFrom

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

    • mergeFrom

      public TargetRoas.Builder mergeFrom(TargetRoas other)

    • isInitialized

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

    • mergeFrom

      public TargetRoas.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws 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<TargetRoas.Builder>
      Throws:
      IOException

    • hasTargetRoas

      public boolean hasTargetRoas()
       Required. The chosen revenue (based on conversion data) per unit of spend.
 Value must be between 0.01 and 1000.0, inclusive.
      optional double target_roas = 4;
      Specified by:
      hasTargetRoas in interface TargetRoasOrBuilder
      Returns:
      Whether the targetRoas field is set.

    • getTargetRoas

      public double getTargetRoas()
       Required. The chosen revenue (based on conversion data) per unit of spend.
 Value must be between 0.01 and 1000.0, inclusive.
      optional double target_roas = 4;
      Specified by:
      getTargetRoas in interface TargetRoasOrBuilder
      Returns:
      The targetRoas.

    • setTargetRoas

      public TargetRoas.Builder setTargetRoas(double value)
       Required. The chosen revenue (based on conversion data) per unit of spend.
 Value must be between 0.01 and 1000.0, inclusive.
      optional double target_roas = 4;
      Parameters:
      value - The targetRoas to set.
      Returns:
      This builder for chaining.

    • clearTargetRoas

      public TargetRoas.Builder clearTargetRoas()
       Required. The chosen revenue (based on conversion data) per unit of spend.
 Value must be between 0.01 and 1000.0, inclusive.
      optional double target_roas = 4;
      Returns:
      This builder for chaining.

    • hasCpcBidCeilingMicros

      public boolean hasCpcBidCeilingMicros()
       Maximum bid limit that can be set by the bid strategy.
 The limit applies to all keywords managed by the strategy.
 This should only be set for portfolio bid strategies.
      optional int64 cpc_bid_ceiling_micros = 5;
      Specified by:
      hasCpcBidCeilingMicros in interface TargetRoasOrBuilder
      Returns:
      Whether the cpcBidCeilingMicros field is set.

    • getCpcBidCeilingMicros

      public long getCpcBidCeilingMicros()
       Maximum bid limit that can be set by the bid strategy.
 The limit applies to all keywords managed by the strategy.
 This should only be set for portfolio bid strategies.
      optional int64 cpc_bid_ceiling_micros = 5;
      Specified by:
      getCpcBidCeilingMicros in interface TargetRoasOrBuilder
      Returns:
      The cpcBidCeilingMicros.

    • setCpcBidCeilingMicros

      public TargetRoas.Builder setCpcBidCeilingMicros(long value)
       Maximum bid limit that can be set by the bid strategy.
 The limit applies to all keywords managed by the strategy.
 This should only be set for portfolio bid strategies.
      optional int64 cpc_bid_ceiling_micros = 5;
      Parameters:
      value - The cpcBidCeilingMicros to set.
      Returns:
      This builder for chaining.

    • clearCpcBidCeilingMicros

      public TargetRoas.Builder clearCpcBidCeilingMicros()
       Maximum bid limit that can be set by the bid strategy.
 The limit applies to all keywords managed by the strategy.
 This should only be set for portfolio bid strategies.
      optional int64 cpc_bid_ceiling_micros = 5;
      Returns:
      This builder for chaining.

    • hasCpcBidFloorMicros

      public boolean hasCpcBidFloorMicros()
       Minimum bid limit that can be set by the bid strategy.
 The limit applies to all keywords managed by the strategy.
 This should only be set for portfolio bid strategies.
      optional int64 cpc_bid_floor_micros = 6;
      Specified by:
      hasCpcBidFloorMicros in interface TargetRoasOrBuilder
      Returns:
      Whether the cpcBidFloorMicros field is set.

    • getCpcBidFloorMicros

      public long getCpcBidFloorMicros()
       Minimum bid limit that can be set by the bid strategy.
 The limit applies to all keywords managed by the strategy.
 This should only be set for portfolio bid strategies.
      optional int64 cpc_bid_floor_micros = 6;
      Specified by:
      getCpcBidFloorMicros in interface TargetRoasOrBuilder
      Returns:
      The cpcBidFloorMicros.

    • setCpcBidFloorMicros

      public TargetRoas.Builder setCpcBidFloorMicros(long value)
       Minimum bid limit that can be set by the bid strategy.
 The limit applies to all keywords managed by the strategy.
 This should only be set for portfolio bid strategies.
      optional int64 cpc_bid_floor_micros = 6;
      Parameters:
      value - The cpcBidFloorMicros to set.
      Returns:
      This builder for chaining.

    • clearCpcBidFloorMicros

      public TargetRoas.Builder clearCpcBidFloorMicros()
       Minimum bid limit that can be set by the bid strategy.
 The limit applies to all keywords managed by the strategy.
 This should only be set for portfolio bid strategies.
      optional int64 cpc_bid_floor_micros = 6;
      Returns:
      This builder for chaining.

    • hasTargetRoasTolerancePercentMillis

      public boolean hasTargetRoasTolerancePercentMillis()
       The percent of ROAS(return on advertising spend) degradation tolerance
 allowed to increase traffic diversity and conversion volume, specified in
 millis (for example, 10,000 = 10%). A value of 10,000 means that the
 advertiser can expect ROAS degradation of up to 10% of the specified target
 ROAS. This field is only mutable for portfolio bidding strategies.
      optional int64 target_roas_tolerance_percent_millis = 7;
      Specified by:
      hasTargetRoasTolerancePercentMillis in interface TargetRoasOrBuilder
      Returns:
      Whether the targetRoasTolerancePercentMillis field is set.

    • getTargetRoasTolerancePercentMillis

      public long getTargetRoasTolerancePercentMillis()
       The percent of ROAS(return on advertising spend) degradation tolerance
 allowed to increase traffic diversity and conversion volume, specified in
 millis (for example, 10,000 = 10%). A value of 10,000 means that the
 advertiser can expect ROAS degradation of up to 10% of the specified target
 ROAS. This field is only mutable for portfolio bidding strategies.
      optional int64 target_roas_tolerance_percent_millis = 7;
      Specified by:
      getTargetRoasTolerancePercentMillis in interface TargetRoasOrBuilder
      Returns:
      The targetRoasTolerancePercentMillis.

    • setTargetRoasTolerancePercentMillis

      public TargetRoas.Builder setTargetRoasTolerancePercentMillis(long value)
       The percent of ROAS(return on advertising spend) degradation tolerance
 allowed to increase traffic diversity and conversion volume, specified in
 millis (for example, 10,000 = 10%). A value of 10,000 means that the
 advertiser can expect ROAS degradation of up to 10% of the specified target
 ROAS. This field is only mutable for portfolio bidding strategies.
      optional int64 target_roas_tolerance_percent_millis = 7;
      Parameters:
      value - The targetRoasTolerancePercentMillis to set.
      Returns:
      This builder for chaining.

    • clearTargetRoasTolerancePercentMillis

      public TargetRoas.Builder clearTargetRoasTolerancePercentMillis()
       The percent of ROAS(return on advertising spend) degradation tolerance
 allowed to increase traffic diversity and conversion volume, specified in
 millis (for example, 10,000 = 10%). A value of 10,000 means that the
 advertiser can expect ROAS degradation of up to 10% of the specified target
 ROAS. This field is only mutable for portfolio bidding strategies.
      optional int64 target_roas_tolerance_percent_millis = 7;
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final TargetRoas.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<TargetRoas.Builder>

    • mergeUnknownFields

      public final TargetRoas.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<TargetRoas.Builder>