Package com.google.ads.googleads.v14.resources

Class AdParameter.Builder

  • All Implemented Interfaces:
    AdParameterOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable
    Enclosing class:
    AdParameter
    public static final class AdParameter.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<AdParameter.Builder>
implements AdParameterOrBuilder
     An ad parameter that is used to update numeric values (such as prices or
 inventory levels) in any text line of an ad (including URLs). There can
 be a maximum of two AdParameters per ad group criterion. (One with
 parameter_index = 1 and one with parameter_index = 2.)
 In the ad the parameters are referenced by a placeholder of the form
 "{param#:value}". For example, "{param1:$17}"
    Protobuf type google.ads.googleads.v14.resources.AdParameter

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

      • clear

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

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

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

      • clearField

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

      • clearOneof

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

      • setRepeatedField

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

      • addRepeatedField

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

      • mergeFrom

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

      • isInitialized

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

      • mergeFrom

        public AdParameter.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<AdParameter.Builder>
        Throws:
        java.io.IOException

      • getResourceName

        public java.lang.String getResourceName()
         Immutable. The resource name of the ad parameter.
 Ad parameter resource names have the form:

 `customers/{customer_id}/adParameters/{ad_group_id}~{criterion_id}~{parameter_index}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceName in interface AdParameterOrBuilder
        Returns:
        The resourceName.

      • getResourceNameBytes

        public com.google.protobuf.ByteString getResourceNameBytes()
         Immutable. The resource name of the ad parameter.
 Ad parameter resource names have the form:

 `customers/{customer_id}/adParameters/{ad_group_id}~{criterion_id}~{parameter_index}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceNameBytes in interface AdParameterOrBuilder
        Returns:
        The bytes for resourceName.

      • setResourceName

        public AdParameter.Builder setResourceName​(java.lang.String value)
         Immutable. The resource name of the ad parameter.
 Ad parameter resource names have the form:

 `customers/{customer_id}/adParameters/{ad_group_id}~{criterion_id}~{parameter_index}`
        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 AdParameter.Builder clearResourceName()
         Immutable. The resource name of the ad parameter.
 Ad parameter resource names have the form:

 `customers/{customer_id}/adParameters/{ad_group_id}~{criterion_id}~{parameter_index}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setResourceNameBytes

        public AdParameter.Builder setResourceNameBytes​(com.google.protobuf.ByteString value)
         Immutable. The resource name of the ad parameter.
 Ad parameter resource names have the form:

 `customers/{customer_id}/adParameters/{ad_group_id}~{criterion_id}~{parameter_index}`
        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.

      • hasAdGroupCriterion

        public boolean hasAdGroupCriterion()
         Immutable. The ad group criterion that this ad parameter belongs to.
        optional string ad_group_criterion = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        hasAdGroupCriterion in interface AdParameterOrBuilder
        Returns:
        Whether the adGroupCriterion field is set.

      • getAdGroupCriterion

        public java.lang.String getAdGroupCriterion()
         Immutable. The ad group criterion that this ad parameter belongs to.
        optional string ad_group_criterion = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getAdGroupCriterion in interface AdParameterOrBuilder
        Returns:
        The adGroupCriterion.

      • getAdGroupCriterionBytes

        public com.google.protobuf.ByteString getAdGroupCriterionBytes()
         Immutable. The ad group criterion that this ad parameter belongs to.
        optional string ad_group_criterion = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getAdGroupCriterionBytes in interface AdParameterOrBuilder
        Returns:
        The bytes for adGroupCriterion.

      • setAdGroupCriterion

        public AdParameter.Builder setAdGroupCriterion​(java.lang.String value)
         Immutable. The ad group criterion that this ad parameter belongs to.
        optional string ad_group_criterion = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The adGroupCriterion to set.
        Returns:
        This builder for chaining.

      • clearAdGroupCriterion

        public AdParameter.Builder clearAdGroupCriterion()
         Immutable. The ad group criterion that this ad parameter belongs to.
        optional string ad_group_criterion = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setAdGroupCriterionBytes

        public AdParameter.Builder setAdGroupCriterionBytes​(com.google.protobuf.ByteString value)
         Immutable. The ad group criterion that this ad parameter belongs to.
        optional string ad_group_criterion = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for adGroupCriterion to set.
        Returns:
        This builder for chaining.

      • hasParameterIndex

        public boolean hasParameterIndex()
         Immutable. The unique index of this ad parameter. Must be either 1 or 2.
        optional int64 parameter_index = 6 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        hasParameterIndex in interface AdParameterOrBuilder
        Returns:
        Whether the parameterIndex field is set.

      • getParameterIndex

        public long getParameterIndex()
         Immutable. The unique index of this ad parameter. Must be either 1 or 2.
        optional int64 parameter_index = 6 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getParameterIndex in interface AdParameterOrBuilder
        Returns:
        The parameterIndex.

      • setParameterIndex

        public AdParameter.Builder setParameterIndex​(long value)
         Immutable. The unique index of this ad parameter. Must be either 1 or 2.
        optional int64 parameter_index = 6 [(.google.api.field_behavior) = IMMUTABLE];
        Parameters:
        value - The parameterIndex to set.
        Returns:
        This builder for chaining.

      • clearParameterIndex

        public AdParameter.Builder clearParameterIndex()
         Immutable. The unique index of this ad parameter. Must be either 1 or 2.
        optional int64 parameter_index = 6 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        This builder for chaining.

      • hasInsertionText

        public boolean hasInsertionText()
         Numeric value to insert into the ad text. The following restrictions
  apply:
  - Can use comma or period as a separator, with an optional period or
    comma (respectively) for fractional values. For example, 1,000,000.00
    and 2.000.000,10 are valid.
  - Can be prepended or appended with a currency symbol. For example,
    $99.99 is valid.
  - Can be prepended or appended with a currency code. For example, 99.99USD
    and EUR200 are valid.
  - Can use '%'. For example, 1.0% and 1,0% are valid.
  - Can use plus or minus. For example, -10.99 and 25+ are valid.
  - Can use '/' between two numbers. For example 4/1 and 0.95/0.45 are
    valid.
        optional string insertion_text = 7;
        Specified by:
        hasInsertionText in interface AdParameterOrBuilder
        Returns:
        Whether the insertionText field is set.

      • getInsertionText

        public java.lang.String getInsertionText()
         Numeric value to insert into the ad text. The following restrictions
  apply:
  - Can use comma or period as a separator, with an optional period or
    comma (respectively) for fractional values. For example, 1,000,000.00
    and 2.000.000,10 are valid.
  - Can be prepended or appended with a currency symbol. For example,
    $99.99 is valid.
  - Can be prepended or appended with a currency code. For example, 99.99USD
    and EUR200 are valid.
  - Can use '%'. For example, 1.0% and 1,0% are valid.
  - Can use plus or minus. For example, -10.99 and 25+ are valid.
  - Can use '/' between two numbers. For example 4/1 and 0.95/0.45 are
    valid.
        optional string insertion_text = 7;
        Specified by:
        getInsertionText in interface AdParameterOrBuilder
        Returns:
        The insertionText.

      • getInsertionTextBytes

        public com.google.protobuf.ByteString getInsertionTextBytes()
         Numeric value to insert into the ad text. The following restrictions
  apply:
  - Can use comma or period as a separator, with an optional period or
    comma (respectively) for fractional values. For example, 1,000,000.00
    and 2.000.000,10 are valid.
  - Can be prepended or appended with a currency symbol. For example,
    $99.99 is valid.
  - Can be prepended or appended with a currency code. For example, 99.99USD
    and EUR200 are valid.
  - Can use '%'. For example, 1.0% and 1,0% are valid.
  - Can use plus or minus. For example, -10.99 and 25+ are valid.
  - Can use '/' between two numbers. For example 4/1 and 0.95/0.45 are
    valid.
        optional string insertion_text = 7;
        Specified by:
        getInsertionTextBytes in interface AdParameterOrBuilder
        Returns:
        The bytes for insertionText.

      • setInsertionText

        public AdParameter.Builder setInsertionText​(java.lang.String value)
         Numeric value to insert into the ad text. The following restrictions
  apply:
  - Can use comma or period as a separator, with an optional period or
    comma (respectively) for fractional values. For example, 1,000,000.00
    and 2.000.000,10 are valid.
  - Can be prepended or appended with a currency symbol. For example,
    $99.99 is valid.
  - Can be prepended or appended with a currency code. For example, 99.99USD
    and EUR200 are valid.
  - Can use '%'. For example, 1.0% and 1,0% are valid.
  - Can use plus or minus. For example, -10.99 and 25+ are valid.
  - Can use '/' between two numbers. For example 4/1 and 0.95/0.45 are
    valid.
        optional string insertion_text = 7;
        Parameters:
        value - The insertionText to set.
        Returns:
        This builder for chaining.

      • clearInsertionText

        public AdParameter.Builder clearInsertionText()
         Numeric value to insert into the ad text. The following restrictions
  apply:
  - Can use comma or period as a separator, with an optional period or
    comma (respectively) for fractional values. For example, 1,000,000.00
    and 2.000.000,10 are valid.
  - Can be prepended or appended with a currency symbol. For example,
    $99.99 is valid.
  - Can be prepended or appended with a currency code. For example, 99.99USD
    and EUR200 are valid.
  - Can use '%'. For example, 1.0% and 1,0% are valid.
  - Can use plus or minus. For example, -10.99 and 25+ are valid.
  - Can use '/' between two numbers. For example 4/1 and 0.95/0.45 are
    valid.
        optional string insertion_text = 7;
        Returns:
        This builder for chaining.

      • setInsertionTextBytes

        public AdParameter.Builder setInsertionTextBytes​(com.google.protobuf.ByteString value)
         Numeric value to insert into the ad text. The following restrictions
  apply:
  - Can use comma or period as a separator, with an optional period or
    comma (respectively) for fractional values. For example, 1,000,000.00
    and 2.000.000,10 are valid.
  - Can be prepended or appended with a currency symbol. For example,
    $99.99 is valid.
  - Can be prepended or appended with a currency code. For example, 99.99USD
    and EUR200 are valid.
  - Can use '%'. For example, 1.0% and 1,0% are valid.
  - Can use plus or minus. For example, -10.99 and 25+ are valid.
  - Can use '/' between two numbers. For example 4/1 and 0.95/0.45 are
    valid.
        optional string insertion_text = 7;
        Parameters:
        value - The bytes for insertionText to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

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

      • mergeUnknownFields

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