Class: Google::Ads::AdManager::V1::CreativeTemplateVariable::ListStringCreativeTemplateVariable

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/ads/admanager/v1/creative_template_messages.rb

Overview

Represents a list variable defined in a creative template. This is similar to StringCreativeTemplateVariable, except that there are possible choices to choose from.

Use [StringCreativeTemplateVariableValue][] to specify the value for this variable when creating a [TemplateCreative][] from a CreativeTemplate.

Defined Under Namespace

Classes: VariableChoice

Instance Attribute Summary collapse

Instance Attribute Details

#allow_other_choice ⇒ ::Boolean

Returns Optional. True if a user can specify an 'other' value. For example, if a variable called backgroundColor is defined as a list with values: red, green, blue, this boolean can be set to allow a user to enter a value not on the list such as purple.

Returns:

  • (::Boolean) —

    Optional. True if a user can specify an 'other' value. For example, if a variable called backgroundColor is defined as a list with values: red, green, blue, this boolean can be set to allow a user to enter a value not on the list such as purple.



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'proto_docs/google/ads/admanager/v1/creative_template_messages.rb', line 174

class ListStringCreativeTemplateVariable
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Stores variable choices selectable by users.
  # @!attribute [rw] label
  #   @return [::String]
  #     Required. A label is displayed to users when creating a
  #     [TemplateCreative][]. This attribute is intended to be more descriptive
  #     than value. This attribute has a maximum length of 255 characters.
  # @!attribute [rw] value
  #   @return [::String]
  #     Required. When creating a [TemplateCreative][], the value in
  #     [StringCreativeTemplateVariableValue][] should match this value, if you
  #     intend to select this value. This attribute has a maximum length of 255
  #     characters.
  class VariableChoice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#choices ⇒ ::Array<::Google::Ads::AdManager::V1::CreativeTemplateVariable::ListStringCreativeTemplateVariable::VariableChoice>

Returns Optional. The selectable values that the user can choose from.

Returns:



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'proto_docs/google/ads/admanager/v1/creative_template_messages.rb', line 174

class ListStringCreativeTemplateVariable
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Stores variable choices selectable by users.
  # @!attribute [rw] label
  #   @return [::String]
  #     Required. A label is displayed to users when creating a
  #     [TemplateCreative][]. This attribute is intended to be more descriptive
  #     than value. This attribute has a maximum length of 255 characters.
  # @!attribute [rw] value
  #   @return [::String]
  #     Required. When creating a [TemplateCreative][], the value in
  #     [StringCreativeTemplateVariableValue][] should match this value, if you
  #     intend to select this value. This attribute has a maximum length of 255
  #     characters.
  class VariableChoice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#default_value ⇒ ::String

Returns Optional. Default value to be filled in when creating creatives from the creative template.

Returns:

  • (::String) —

    Optional. Default value to be filled in when creating creatives from the creative template.



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'proto_docs/google/ads/admanager/v1/creative_template_messages.rb', line 174

class ListStringCreativeTemplateVariable
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Stores variable choices selectable by users.
  # @!attribute [rw] label
  #   @return [::String]
  #     Required. A label is displayed to users when creating a
  #     [TemplateCreative][]. This attribute is intended to be more descriptive
  #     than value. This attribute has a maximum length of 255 characters.
  # @!attribute [rw] value
  #   @return [::String]
  #     Required. When creating a [TemplateCreative][], the value in
  #     [StringCreativeTemplateVariableValue][] should match this value, if you
  #     intend to select this value. This attribute has a maximum length of 255
  #     characters.
  class VariableChoice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#sample_value ⇒ ::String

Returns Optional. Sample value that is used when previewing the template in the UI.

Returns:

  • (::String) —

    Optional. Sample value that is used when previewing the template in the UI.



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'proto_docs/google/ads/admanager/v1/creative_template_messages.rb', line 174

class ListStringCreativeTemplateVariable
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Stores variable choices selectable by users.
  # @!attribute [rw] label
  #   @return [::String]
  #     Required. A label is displayed to users when creating a
  #     [TemplateCreative][]. This attribute is intended to be more descriptive
  #     than value. This attribute has a maximum length of 255 characters.
  # @!attribute [rw] value
  #   @return [::String]
  #     Required. When creating a [TemplateCreative][], the value in
  #     [StringCreativeTemplateVariableValue][] should match this value, if you
  #     intend to select this value. This attribute has a maximum length of 255
  #     characters.
  class VariableChoice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end