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

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 variable defined in a creative template.

Defined Under Namespace

Classes: AssetCreativeTemplateVariable, ListStringCreativeTemplateVariable, LongCreativeTemplateVariable, StringCreativeTemplateVariable, UrlCreativeTemplateVariable

Instance Attribute Summary collapse

Instance Attribute Details

#asset_variable ⇒ ::Google::Ads::AdManager::V1::CreativeTemplateVariable::AssetCreativeTemplateVariable

Returns Optional. Represents a file asset variable defined in a creative template.

Note: The following fields are mutually exclusive: asset_variable, list_string_variable, long_variable, string_variable, url_variable. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'proto_docs/google/ads/admanager/v1/creative_template_messages.rb', line 116

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

  # Represents a file asset variable defined in a creative template.
  #
  # Use [AssetCreativeTemplateVariableValue][] to specify the value for this
  # variable when creating a [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] mime_types
  #   @return [::Array<::Google::Ads::AdManager::V1::CreativeTemplateVariable::AssetCreativeTemplateVariable::MimeType>]
  #     Optional. The set of allowed MIME types. If unspecified, all MIME types
  #     are allowed.
  class AssetCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Different MIME types that the asset variable supports.
    module MimeType
      # Default value. This value is unused.
      MIME_TYPE_UNSPECIFIED = 0

      # The `image/jpeg` MIME type.
      JPG = 1

      # The `image/png` MIME type.
      PNG = 2

      # The `image/gif` MIME type.
      GIF = 3
    end
  end

  # Represents a list variable defined in a creative template. This is similar
  # to
  # {::Google::Ads::AdManager::V1::CreativeTemplateVariable::StringCreativeTemplateVariable 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
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::String]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::String]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  # @!attribute [rw] choices
  #   @return [::Array<::Google::Ads::AdManager::V1::CreativeTemplateVariable::ListStringCreativeTemplateVariable::VariableChoice>]
  #     Optional. The selectable values that the user can choose from.
  # @!attribute [rw] allow_other_choice
  #   @return [::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.
  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

  # Represents a long variable defined in a creative template.
  #
  # Use [LongCreativeTemplateVariableValue][] to specify the value
  # for this variable when creating [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::Integer]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::Integer]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  class LongCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a string variable defined in a creative template.
  #
  # Use [StringCreativeTemplateVariableValue][] to specify the value
  # for this variable when creating [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::String]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::String]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  class StringCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a url variable defined in a creative template.
  #
  # Use [UrlCreativeTemplateVariableValue][] to specify the value for this
  # variable when creating a [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::String]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::String]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  # @!attribute [rw] url_type
  #   @return [::Google::Ads::AdManager::V1::CreativeTemplateVariableUrlTypeEnum::CreativeTemplateVariableUrlType]
  #     Optional. The type of URL that this variable represents. Different types
  #     of URLs may be handled differently at rendering time.
  class UrlCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#description ⇒ ::String

Returns Required. A descriptive help text that is displayed to users along with the label. This attribute has a maximum length of 255 characters.

Returns:

  • (::String) —

    Required. A descriptive help text that is displayed to users along with the label. This attribute has a maximum length of 255 characters.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'proto_docs/google/ads/admanager/v1/creative_template_messages.rb', line 116

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

  # Represents a file asset variable defined in a creative template.
  #
  # Use [AssetCreativeTemplateVariableValue][] to specify the value for this
  # variable when creating a [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] mime_types
  #   @return [::Array<::Google::Ads::AdManager::V1::CreativeTemplateVariable::AssetCreativeTemplateVariable::MimeType>]
  #     Optional. The set of allowed MIME types. If unspecified, all MIME types
  #     are allowed.
  class AssetCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Different MIME types that the asset variable supports.
    module MimeType
      # Default value. This value is unused.
      MIME_TYPE_UNSPECIFIED = 0

      # The `image/jpeg` MIME type.
      JPG = 1

      # The `image/png` MIME type.
      PNG = 2

      # The `image/gif` MIME type.
      GIF = 3
    end
  end

  # Represents a list variable defined in a creative template. This is similar
  # to
  # {::Google::Ads::AdManager::V1::CreativeTemplateVariable::StringCreativeTemplateVariable 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
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::String]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::String]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  # @!attribute [rw] choices
  #   @return [::Array<::Google::Ads::AdManager::V1::CreativeTemplateVariable::ListStringCreativeTemplateVariable::VariableChoice>]
  #     Optional. The selectable values that the user can choose from.
  # @!attribute [rw] allow_other_choice
  #   @return [::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.
  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

  # Represents a long variable defined in a creative template.
  #
  # Use [LongCreativeTemplateVariableValue][] to specify the value
  # for this variable when creating [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::Integer]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::Integer]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  class LongCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a string variable defined in a creative template.
  #
  # Use [StringCreativeTemplateVariableValue][] to specify the value
  # for this variable when creating [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::String]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::String]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  class StringCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a url variable defined in a creative template.
  #
  # Use [UrlCreativeTemplateVariableValue][] to specify the value for this
  # variable when creating a [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::String]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::String]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  # @!attribute [rw] url_type
  #   @return [::Google::Ads::AdManager::V1::CreativeTemplateVariableUrlTypeEnum::CreativeTemplateVariableUrlType]
  #     Optional. The type of URL that this variable represents. Different types
  #     of URLs may be handled differently at rendering time.
  class UrlCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#label ⇒ ::String

Returns Required. Label that is displayed to users when creating from the creative template. This has a maximum length of 127 characters.

Returns:

  • (::String) —

    Required. Label that is displayed to users when creating from the creative template. This has a maximum length of 127 characters.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'proto_docs/google/ads/admanager/v1/creative_template_messages.rb', line 116

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

  # Represents a file asset variable defined in a creative template.
  #
  # Use [AssetCreativeTemplateVariableValue][] to specify the value for this
  # variable when creating a [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] mime_types
  #   @return [::Array<::Google::Ads::AdManager::V1::CreativeTemplateVariable::AssetCreativeTemplateVariable::MimeType>]
  #     Optional. The set of allowed MIME types. If unspecified, all MIME types
  #     are allowed.
  class AssetCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Different MIME types that the asset variable supports.
    module MimeType
      # Default value. This value is unused.
      MIME_TYPE_UNSPECIFIED = 0

      # The `image/jpeg` MIME type.
      JPG = 1

      # The `image/png` MIME type.
      PNG = 2

      # The `image/gif` MIME type.
      GIF = 3
    end
  end

  # Represents a list variable defined in a creative template. This is similar
  # to
  # {::Google::Ads::AdManager::V1::CreativeTemplateVariable::StringCreativeTemplateVariable 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
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::String]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::String]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  # @!attribute [rw] choices
  #   @return [::Array<::Google::Ads::AdManager::V1::CreativeTemplateVariable::ListStringCreativeTemplateVariable::VariableChoice>]
  #     Optional. The selectable values that the user can choose from.
  # @!attribute [rw] allow_other_choice
  #   @return [::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.
  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

  # Represents a long variable defined in a creative template.
  #
  # Use [LongCreativeTemplateVariableValue][] to specify the value
  # for this variable when creating [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::Integer]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::Integer]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  class LongCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a string variable defined in a creative template.
  #
  # Use [StringCreativeTemplateVariableValue][] to specify the value
  # for this variable when creating [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::String]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::String]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  class StringCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a url variable defined in a creative template.
  #
  # Use [UrlCreativeTemplateVariableValue][] to specify the value for this
  # variable when creating a [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::String]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::String]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  # @!attribute [rw] url_type
  #   @return [::Google::Ads::AdManager::V1::CreativeTemplateVariableUrlTypeEnum::CreativeTemplateVariableUrlType]
  #     Optional. The type of URL that this variable represents. Different types
  #     of URLs may be handled differently at rendering time.
  class UrlCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#list_string_variable ⇒ ::Google::Ads::AdManager::V1::CreativeTemplateVariable::ListStringCreativeTemplateVariable

Returns Optional. Represents a list variable defined in a creative template.

Note: The following fields are mutually exclusive: list_string_variable, asset_variable, long_variable, string_variable, url_variable. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'proto_docs/google/ads/admanager/v1/creative_template_messages.rb', line 116

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

  # Represents a file asset variable defined in a creative template.
  #
  # Use [AssetCreativeTemplateVariableValue][] to specify the value for this
  # variable when creating a [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] mime_types
  #   @return [::Array<::Google::Ads::AdManager::V1::CreativeTemplateVariable::AssetCreativeTemplateVariable::MimeType>]
  #     Optional. The set of allowed MIME types. If unspecified, all MIME types
  #     are allowed.
  class AssetCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Different MIME types that the asset variable supports.
    module MimeType
      # Default value. This value is unused.
      MIME_TYPE_UNSPECIFIED = 0

      # The `image/jpeg` MIME type.
      JPG = 1

      # The `image/png` MIME type.
      PNG = 2

      # The `image/gif` MIME type.
      GIF = 3
    end
  end

  # Represents a list variable defined in a creative template. This is similar
  # to
  # {::Google::Ads::AdManager::V1::CreativeTemplateVariable::StringCreativeTemplateVariable 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
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::String]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::String]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  # @!attribute [rw] choices
  #   @return [::Array<::Google::Ads::AdManager::V1::CreativeTemplateVariable::ListStringCreativeTemplateVariable::VariableChoice>]
  #     Optional. The selectable values that the user can choose from.
  # @!attribute [rw] allow_other_choice
  #   @return [::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.
  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

  # Represents a long variable defined in a creative template.
  #
  # Use [LongCreativeTemplateVariableValue][] to specify the value
  # for this variable when creating [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::Integer]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::Integer]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  class LongCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a string variable defined in a creative template.
  #
  # Use [StringCreativeTemplateVariableValue][] to specify the value
  # for this variable when creating [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::String]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::String]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  class StringCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a url variable defined in a creative template.
  #
  # Use [UrlCreativeTemplateVariableValue][] to specify the value for this
  # variable when creating a [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::String]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::String]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  # @!attribute [rw] url_type
  #   @return [::Google::Ads::AdManager::V1::CreativeTemplateVariableUrlTypeEnum::CreativeTemplateVariableUrlType]
  #     Optional. The type of URL that this variable represents. Different types
  #     of URLs may be handled differently at rendering time.
  class UrlCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#long_variable ⇒ ::Google::Ads::AdManager::V1::CreativeTemplateVariable::LongCreativeTemplateVariable

Returns Optional. Represents a long variable defined in a creative template.

Note: The following fields are mutually exclusive: long_variable, asset_variable, list_string_variable, string_variable, url_variable. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'proto_docs/google/ads/admanager/v1/creative_template_messages.rb', line 116

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

  # Represents a file asset variable defined in a creative template.
  #
  # Use [AssetCreativeTemplateVariableValue][] to specify the value for this
  # variable when creating a [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] mime_types
  #   @return [::Array<::Google::Ads::AdManager::V1::CreativeTemplateVariable::AssetCreativeTemplateVariable::MimeType>]
  #     Optional. The set of allowed MIME types. If unspecified, all MIME types
  #     are allowed.
  class AssetCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Different MIME types that the asset variable supports.
    module MimeType
      # Default value. This value is unused.
      MIME_TYPE_UNSPECIFIED = 0

      # The `image/jpeg` MIME type.
      JPG = 1

      # The `image/png` MIME type.
      PNG = 2

      # The `image/gif` MIME type.
      GIF = 3
    end
  end

  # Represents a list variable defined in a creative template. This is similar
  # to
  # {::Google::Ads::AdManager::V1::CreativeTemplateVariable::StringCreativeTemplateVariable 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
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::String]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::String]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  # @!attribute [rw] choices
  #   @return [::Array<::Google::Ads::AdManager::V1::CreativeTemplateVariable::ListStringCreativeTemplateVariable::VariableChoice>]
  #     Optional. The selectable values that the user can choose from.
  # @!attribute [rw] allow_other_choice
  #   @return [::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.
  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

  # Represents a long variable defined in a creative template.
  #
  # Use [LongCreativeTemplateVariableValue][] to specify the value
  # for this variable when creating [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::Integer]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::Integer]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  class LongCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a string variable defined in a creative template.
  #
  # Use [StringCreativeTemplateVariableValue][] to specify the value
  # for this variable when creating [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::String]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::String]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  class StringCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a url variable defined in a creative template.
  #
  # Use [UrlCreativeTemplateVariableValue][] to specify the value for this
  # variable when creating a [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::String]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::String]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  # @!attribute [rw] url_type
  #   @return [::Google::Ads::AdManager::V1::CreativeTemplateVariableUrlTypeEnum::CreativeTemplateVariableUrlType]
  #     Optional. The type of URL that this variable represents. Different types
  #     of URLs may be handled differently at rendering time.
  class UrlCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#required ⇒ ::Boolean

Returns Optional. True if this variable is required to be filled in by users when creating a creative from the creative template.

Returns:

  • (::Boolean) —

    Optional. True if this variable is required to be filled in by users when creating a creative from the creative template.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'proto_docs/google/ads/admanager/v1/creative_template_messages.rb', line 116

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

  # Represents a file asset variable defined in a creative template.
  #
  # Use [AssetCreativeTemplateVariableValue][] to specify the value for this
  # variable when creating a [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] mime_types
  #   @return [::Array<::Google::Ads::AdManager::V1::CreativeTemplateVariable::AssetCreativeTemplateVariable::MimeType>]
  #     Optional. The set of allowed MIME types. If unspecified, all MIME types
  #     are allowed.
  class AssetCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Different MIME types that the asset variable supports.
    module MimeType
      # Default value. This value is unused.
      MIME_TYPE_UNSPECIFIED = 0

      # The `image/jpeg` MIME type.
      JPG = 1

      # The `image/png` MIME type.
      PNG = 2

      # The `image/gif` MIME type.
      GIF = 3
    end
  end

  # Represents a list variable defined in a creative template. This is similar
  # to
  # {::Google::Ads::AdManager::V1::CreativeTemplateVariable::StringCreativeTemplateVariable 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
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::String]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::String]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  # @!attribute [rw] choices
  #   @return [::Array<::Google::Ads::AdManager::V1::CreativeTemplateVariable::ListStringCreativeTemplateVariable::VariableChoice>]
  #     Optional. The selectable values that the user can choose from.
  # @!attribute [rw] allow_other_choice
  #   @return [::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.
  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

  # Represents a long variable defined in a creative template.
  #
  # Use [LongCreativeTemplateVariableValue][] to specify the value
  # for this variable when creating [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::Integer]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::Integer]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  class LongCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a string variable defined in a creative template.
  #
  # Use [StringCreativeTemplateVariableValue][] to specify the value
  # for this variable when creating [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::String]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::String]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  class StringCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a url variable defined in a creative template.
  #
  # Use [UrlCreativeTemplateVariableValue][] to specify the value for this
  # variable when creating a [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::String]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::String]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  # @!attribute [rw] url_type
  #   @return [::Google::Ads::AdManager::V1::CreativeTemplateVariableUrlTypeEnum::CreativeTemplateVariableUrlType]
  #     Optional. The type of URL that this variable represents. Different types
  #     of URLs may be handled differently at rendering time.
  class UrlCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#string_variable ⇒ ::Google::Ads::AdManager::V1::CreativeTemplateVariable::StringCreativeTemplateVariable

Returns Optional. Represents a string variable defined in a creative template.

Note: The following fields are mutually exclusive: string_variable, asset_variable, list_string_variable, long_variable, url_variable. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'proto_docs/google/ads/admanager/v1/creative_template_messages.rb', line 116

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

  # Represents a file asset variable defined in a creative template.
  #
  # Use [AssetCreativeTemplateVariableValue][] to specify the value for this
  # variable when creating a [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] mime_types
  #   @return [::Array<::Google::Ads::AdManager::V1::CreativeTemplateVariable::AssetCreativeTemplateVariable::MimeType>]
  #     Optional. The set of allowed MIME types. If unspecified, all MIME types
  #     are allowed.
  class AssetCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Different MIME types that the asset variable supports.
    module MimeType
      # Default value. This value is unused.
      MIME_TYPE_UNSPECIFIED = 0

      # The `image/jpeg` MIME type.
      JPG = 1

      # The `image/png` MIME type.
      PNG = 2

      # The `image/gif` MIME type.
      GIF = 3
    end
  end

  # Represents a list variable defined in a creative template. This is similar
  # to
  # {::Google::Ads::AdManager::V1::CreativeTemplateVariable::StringCreativeTemplateVariable 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
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::String]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::String]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  # @!attribute [rw] choices
  #   @return [::Array<::Google::Ads::AdManager::V1::CreativeTemplateVariable::ListStringCreativeTemplateVariable::VariableChoice>]
  #     Optional. The selectable values that the user can choose from.
  # @!attribute [rw] allow_other_choice
  #   @return [::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.
  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

  # Represents a long variable defined in a creative template.
  #
  # Use [LongCreativeTemplateVariableValue][] to specify the value
  # for this variable when creating [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::Integer]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::Integer]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  class LongCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a string variable defined in a creative template.
  #
  # Use [StringCreativeTemplateVariableValue][] to specify the value
  # for this variable when creating [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::String]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::String]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  class StringCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a url variable defined in a creative template.
  #
  # Use [UrlCreativeTemplateVariableValue][] to specify the value for this
  # variable when creating a [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::String]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::String]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  # @!attribute [rw] url_type
  #   @return [::Google::Ads::AdManager::V1::CreativeTemplateVariableUrlTypeEnum::CreativeTemplateVariableUrlType]
  #     Optional. The type of URL that this variable represents. Different types
  #     of URLs may be handled differently at rendering time.
  class UrlCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#unique_display_name ⇒ ::String (readonly)

Returns Output only. Unique name used to identify the variable. This attribute is assigned by Google when a creative template variable is created.

Returns:

  • (::String) —

    Output only. Unique name used to identify the variable. This attribute is assigned by Google when a creative template variable is created.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'proto_docs/google/ads/admanager/v1/creative_template_messages.rb', line 116

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

  # Represents a file asset variable defined in a creative template.
  #
  # Use [AssetCreativeTemplateVariableValue][] to specify the value for this
  # variable when creating a [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] mime_types
  #   @return [::Array<::Google::Ads::AdManager::V1::CreativeTemplateVariable::AssetCreativeTemplateVariable::MimeType>]
  #     Optional. The set of allowed MIME types. If unspecified, all MIME types
  #     are allowed.
  class AssetCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Different MIME types that the asset variable supports.
    module MimeType
      # Default value. This value is unused.
      MIME_TYPE_UNSPECIFIED = 0

      # The `image/jpeg` MIME type.
      JPG = 1

      # The `image/png` MIME type.
      PNG = 2

      # The `image/gif` MIME type.
      GIF = 3
    end
  end

  # Represents a list variable defined in a creative template. This is similar
  # to
  # {::Google::Ads::AdManager::V1::CreativeTemplateVariable::StringCreativeTemplateVariable 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
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::String]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::String]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  # @!attribute [rw] choices
  #   @return [::Array<::Google::Ads::AdManager::V1::CreativeTemplateVariable::ListStringCreativeTemplateVariable::VariableChoice>]
  #     Optional. The selectable values that the user can choose from.
  # @!attribute [rw] allow_other_choice
  #   @return [::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.
  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

  # Represents a long variable defined in a creative template.
  #
  # Use [LongCreativeTemplateVariableValue][] to specify the value
  # for this variable when creating [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::Integer]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::Integer]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  class LongCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a string variable defined in a creative template.
  #
  # Use [StringCreativeTemplateVariableValue][] to specify the value
  # for this variable when creating [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::String]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::String]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  class StringCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a url variable defined in a creative template.
  #
  # Use [UrlCreativeTemplateVariableValue][] to specify the value for this
  # variable when creating a [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::String]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::String]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  # @!attribute [rw] url_type
  #   @return [::Google::Ads::AdManager::V1::CreativeTemplateVariableUrlTypeEnum::CreativeTemplateVariableUrlType]
  #     Optional. The type of URL that this variable represents. Different types
  #     of URLs may be handled differently at rendering time.
  class UrlCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#url_variable ⇒ ::Google::Ads::AdManager::V1::CreativeTemplateVariable::UrlCreativeTemplateVariable

Returns Optional. Represents a url variable defined in a creative template.

Note: The following fields are mutually exclusive: url_variable, asset_variable, list_string_variable, long_variable, string_variable. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'proto_docs/google/ads/admanager/v1/creative_template_messages.rb', line 116

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

  # Represents a file asset variable defined in a creative template.
  #
  # Use [AssetCreativeTemplateVariableValue][] to specify the value for this
  # variable when creating a [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] mime_types
  #   @return [::Array<::Google::Ads::AdManager::V1::CreativeTemplateVariable::AssetCreativeTemplateVariable::MimeType>]
  #     Optional. The set of allowed MIME types. If unspecified, all MIME types
  #     are allowed.
  class AssetCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Different MIME types that the asset variable supports.
    module MimeType
      # Default value. This value is unused.
      MIME_TYPE_UNSPECIFIED = 0

      # The `image/jpeg` MIME type.
      JPG = 1

      # The `image/png` MIME type.
      PNG = 2

      # The `image/gif` MIME type.
      GIF = 3
    end
  end

  # Represents a list variable defined in a creative template. This is similar
  # to
  # {::Google::Ads::AdManager::V1::CreativeTemplateVariable::StringCreativeTemplateVariable 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
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::String]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::String]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  # @!attribute [rw] choices
  #   @return [::Array<::Google::Ads::AdManager::V1::CreativeTemplateVariable::ListStringCreativeTemplateVariable::VariableChoice>]
  #     Optional. The selectable values that the user can choose from.
  # @!attribute [rw] allow_other_choice
  #   @return [::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.
  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

  # Represents a long variable defined in a creative template.
  #
  # Use [LongCreativeTemplateVariableValue][] to specify the value
  # for this variable when creating [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::Integer]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::Integer]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  class LongCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a string variable defined in a creative template.
  #
  # Use [StringCreativeTemplateVariableValue][] to specify the value
  # for this variable when creating [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::String]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::String]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  class StringCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents a url variable defined in a creative template.
  #
  # Use [UrlCreativeTemplateVariableValue][] to specify the value for this
  # variable when creating a [TemplateCreative][] from a
  # {::Google::Ads::AdManager::V1::CreativeTemplate CreativeTemplate}.
  # @!attribute [rw] default_value
  #   @return [::String]
  #     Optional. Default value to be filled in when creating creatives from the
  #     creative template.
  # @!attribute [rw] sample_value
  #   @return [::String]
  #     Optional. Sample value that is used when previewing the template in the
  #     UI.
  # @!attribute [rw] url_type
  #   @return [::Google::Ads::AdManager::V1::CreativeTemplateVariableUrlTypeEnum::CreativeTemplateVariableUrlType]
  #     Optional. The type of URL that this variable represents. Different types
  #     of URLs may be handled differently at rendering time.
  class UrlCreativeTemplateVariable
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end