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

Class AdParameter

  • All Implemented Interfaces:
    AdParameterOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class AdParameter
extends com.google.protobuf.GeneratedMessageV3
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}". E.g. "{param1:$17}"
    Protobuf type google.ads.googleads.v10.resources.AdParameter
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  AdParameter.Builder
      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).

      • 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 getAdGroupCriterion()
      Immutable.
      com.google.protobuf.ByteString getAdGroupCriterionBytes()
      Immutable.
      static AdParameter getDefaultInstance()  
      AdParameter getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.lang.String getInsertionText()
      Numeric value to insert into the ad text.
      com.google.protobuf.ByteString getInsertionTextBytes()
      Numeric value to insert into the ad text.
      long getParameterIndex()
      Immutable.
      com.google.protobuf.Parser<AdParameter> getParserForType()  
      java.lang.String getResourceName()
      Immutable.
      com.google.protobuf.ByteString getResourceNameBytes()
      Immutable.
      int getSerializedSize()  
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      boolean hasAdGroupCriterion()
      Immutable.
      int hashCode()  
      boolean hasInsertionText()
      Numeric value to insert into the ad text.
      boolean hasParameterIndex()
      Immutable.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static AdParameter.Builder newBuilder()  
      static AdParameter.Builder newBuilder​(AdParameter prototype)  
      AdParameter.Builder newBuilderForType()  
      protected AdParameter.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static AdParameter parseDelimitedFrom​(java.io.InputStream input)  
      static AdParameter parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static AdParameter parseFrom​(byte[] data)  
      static AdParameter parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static AdParameter parseFrom​(com.google.protobuf.ByteString data)  
      static AdParameter parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static AdParameter parseFrom​(com.google.protobuf.CodedInputStream input)  
      static AdParameter parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static AdParameter parseFrom​(java.io.InputStream input)  
      static AdParameter parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static AdParameter parseFrom​(java.nio.ByteBuffer data)  
      static AdParameter parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<AdParameter> parser()  
      AdParameter.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

    • Field Detail

      • RESOURCE_NAME_FIELD_NUMBER

        public static final int RESOURCE_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AD_GROUP_CRITERION_FIELD_NUMBER

        public static final int AD_GROUP_CRITERION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PARAMETER_INDEX_FIELD_NUMBER

        public static final int PARAMETER_INDEX_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INSERTION_TEXT_FIELD_NUMBER

        public static final int INSERTION_TEXT_FIELD_NUMBER
        See Also:
        Constant Field Values

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

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

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

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

      • 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 AdParameter parseFrom​(java.nio.ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static AdParameter getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<AdParameter> 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 AdParameter getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder