Class: Google::Apis::AdexchangebuyerV1_2::Creative

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/adexchangebuyer_v1_2/classes.rb,
generated/google/apis/adexchangebuyer_v1_2/representations.rb,
generated/google/apis/adexchangebuyer_v1_2/representations.rb more...

Overview

A creative and its classification data.

Defined Under Namespace

Classes: Correction, DisapprovalReason, FilteringReasons

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Creative

Returns a new instance of Creative.

[View source]

286
287
288
 
# File 'generated/google/apis/adexchangebuyer_v1_2/classes.rb', line 286

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#account_id ⇒ Fixnum

Account id. Corresponds to the JSON property accountId

Returns:

  • (Fixnum) 

167
168
169
 
# File 'generated/google/apis/adexchangebuyer_v1_2/classes.rb', line 167

def 
  @account_id
end

#advertiser_id ⇒ Array<Fixnum>

Detected advertiser id, if any. Read-only. This field should not be set in requests. Corresponds to the JSON property advertiserId

Returns:

  • (Array<Fixnum>) 

173
174
175
 
# File 'generated/google/apis/adexchangebuyer_v1_2/classes.rb', line 173

def advertiser_id
  @advertiser_id
end

#advertiser_name ⇒ String

The name of the company being advertised in the creative. Corresponds to the JSON property advertiserName

Returns:

  • (String) 

178
179
180
 
# File 'generated/google/apis/adexchangebuyer_v1_2/classes.rb', line 178

def advertiser_name
  @advertiser_name
end

#agency_id ⇒ Fixnum

The agency id for this creative. Corresponds to the JSON property agencyId

Returns:

  • (Fixnum) 

183
184
185
 
# File 'generated/google/apis/adexchangebuyer_v1_2/classes.rb', line 183

def agency_id
  @agency_id
end

#api_upload_timestamp ⇒ DateTime

The last upload timestamp of this creative if it was uploaded via API. Read- only. The value of this field is generated, and will be ignored for uploads. ( formatted RFC 3339 timestamp). Corresponds to the JSON property apiUploadTimestamp

Returns:

  • (DateTime) 

190
191
192
 
# File 'generated/google/apis/adexchangebuyer_v1_2/classes.rb', line 190

def api_upload_timestamp
  @api_upload_timestamp
end

#attribute ⇒ Array<Fixnum>

All attributes for the ads that may be shown from this snippet. Corresponds to the JSON property attribute

Returns:

  • (Array<Fixnum>) 

195
196
197
 
# File 'generated/google/apis/adexchangebuyer_v1_2/classes.rb', line 195

def attribute
  @attribute
end

#buyer_creative_id ⇒ String

A buyer-specific id identifying the creative in this ad. Corresponds to the JSON property buyerCreativeId

Returns:

  • (String) 

200
201
202
 
# File 'generated/google/apis/adexchangebuyer_v1_2/classes.rb', line 200

def buyer_creative_id
  @buyer_creative_id
end

#click_through_url ⇒ Array<String>

The set of destination urls for the snippet. Corresponds to the JSON property clickThroughUrl

Returns:

  • (Array<String>) 

205
206
207
 
# File 'generated/google/apis/adexchangebuyer_v1_2/classes.rb', line 205

def click_through_url
  @click_through_url
end

#corrections ⇒ Array<Google::Apis::AdexchangebuyerV1_2::Creative::Correction>

Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests. Corresponds to the JSON property corrections

Returns:


211
212
213
 
# File 'generated/google/apis/adexchangebuyer_v1_2/classes.rb', line 211

def corrections
  @corrections
end

#disapproval_reasons ⇒ Array<Google::Apis::AdexchangebuyerV1_2::Creative::DisapprovalReason>

The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests. Corresponds to the JSON property disapprovalReasons

Returns:


220
221
222
 
# File 'generated/google/apis/adexchangebuyer_v1_2/classes.rb', line 220

def disapproval_reasons
  @disapproval_reasons
end

#filtering_reasons ⇒ Google::Apis::AdexchangebuyerV1_2::Creative::FilteringReasons

The filtering reasons for the creative. Read-only. This field should not be set in requests. Corresponds to the JSON property filteringReasons

Returns:


226
227
228
 
# File 'generated/google/apis/adexchangebuyer_v1_2/classes.rb', line 226

def filtering_reasons
  @filtering_reasons
end

#height ⇒ Fixnum

Ad height. Corresponds to the JSON property height

Returns:

  • (Fixnum) 

231
232
233
 
# File 'generated/google/apis/adexchangebuyer_v1_2/classes.rb', line 231

def height
  @height
end

#html_snippet ⇒ String

The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set. Corresponds to the JSON property HTMLSnippet

Returns:

  • (String) 

162
163
164
 
# File 'generated/google/apis/adexchangebuyer_v1_2/classes.rb', line 162

def html_snippet
  @html_snippet
end

#impression_tracking_url ⇒ Array<String>

The set of urls to be called to record an impression. Corresponds to the JSON property impressionTrackingUrl

Returns:

  • (Array<String>) 

236
237
238
 
# File 'generated/google/apis/adexchangebuyer_v1_2/classes.rb', line 236

def impression_tracking_url
  @impression_tracking_url
end

#kind ⇒ String

Resource type. Corresponds to the JSON property kind

Returns:

  • (String) 

241
242
243
 
# File 'generated/google/apis/adexchangebuyer_v1_2/classes.rb', line 241

def kind
  @kind
end

#product_categories ⇒ Array<Fixnum>

Detected product categories, if any. Read-only. This field should not be set in requests. Corresponds to the JSON property productCategories

Returns:

  • (Array<Fixnum>) 

247
248
249
 
# File 'generated/google/apis/adexchangebuyer_v1_2/classes.rb', line 247

def product_categories
  @product_categories
end

#restricted_categories ⇒ Array<Fixnum>

All restricted categories for the ads that may be shown from this snippet. Corresponds to the JSON property restrictedCategories

Returns:

  • (Array<Fixnum>) 

252
253
254
 
# File 'generated/google/apis/adexchangebuyer_v1_2/classes.rb', line 252

def restricted_categories
  @restricted_categories
end

#sensitive_categories ⇒ Array<Fixnum>

Detected sensitive categories, if any. Read-only. This field should not be set in requests. Corresponds to the JSON property sensitiveCategories

Returns:

  • (Array<Fixnum>) 

258
259
260
 
# File 'generated/google/apis/adexchangebuyer_v1_2/classes.rb', line 258

def sensitive_categories
  @sensitive_categories
end

#status ⇒ String

Creative serving status. Read-only. This field should not be set in requests. Corresponds to the JSON property status

Returns:

  • (String) 

263
264
265
 
# File 'generated/google/apis/adexchangebuyer_v1_2/classes.rb', line 263

def status
  @status
end

#vendor_type ⇒ Array<Fixnum>

All vendor types for the ads that may be shown from this snippet. Corresponds to the JSON property vendorType

Returns:

  • (Array<Fixnum>) 

268
269
270
 
# File 'generated/google/apis/adexchangebuyer_v1_2/classes.rb', line 268

def vendor_type
  @vendor_type
end

#version ⇒ Fixnum

The version for this creative. Read-only. This field should not be set in requests. Corresponds to the JSON property version

Returns:

  • (Fixnum) 

274
275
276
 
# File 'generated/google/apis/adexchangebuyer_v1_2/classes.rb', line 274

def version
  @version
end

#video_url ⇒ String

The url to fetch a video ad. If set, HTMLSnippet should not be set. Corresponds to the JSON property videoURL

Returns:

  • (String) 

279
280
281
 
# File 'generated/google/apis/adexchangebuyer_v1_2/classes.rb', line 279

def video_url
  @video_url
end

#width ⇒ Fixnum

Ad width. Corresponds to the JSON property width

Returns:

  • (Fixnum) 

284
285
286
 
# File 'generated/google/apis/adexchangebuyer_v1_2/classes.rb', line 284

def width
  @width
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'generated/google/apis/adexchangebuyer_v1_2/classes.rb', line 291

def update!(**args)
  @html_snippet = args[:html_snippet] if args.key?(:html_snippet)
  @account_id = args[:account_id] if args.key?(:account_id)
  @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id)
  @advertiser_name = args[:advertiser_name] if args.key?(:advertiser_name)
  @agency_id = args[:agency_id] if args.key?(:agency_id)
  @api_upload_timestamp = args[:api_upload_timestamp] if args.key?(:api_upload_timestamp)
  @attribute = args[:attribute] if args.key?(:attribute)
  @buyer_creative_id = args[:buyer_creative_id] if args.key?(:buyer_creative_id)
  @click_through_url = args[:click_through_url] if args.key?(:click_through_url)
  @corrections = args[:corrections] if args.key?(:corrections)
  @disapproval_reasons = args[:disapproval_reasons] if args.key?(:disapproval_reasons)
  @filtering_reasons = args[:filtering_reasons] if args.key?(:filtering_reasons)
  @height = args[:height] if args.key?(:height)
  @impression_tracking_url = args[:impression_tracking_url] if args.key?(:impression_tracking_url)
  @kind = args[:kind] if args.key?(:kind)
  @product_categories = args[:product_categories] if args.key?(:product_categories)
  @restricted_categories = args[:restricted_categories] if args.key?(:restricted_categories)
  @sensitive_categories = args[:sensitive_categories] if args.key?(:sensitive_categories)
  @status = args[:status] if args.key?(:status)
  @vendor_type = args[:vendor_type] if args.key?(:vendor_type)
  @version = args[:version] if args.key?(:version)
  @video_url = args[:video_url] if args.key?(:video_url)
  @width = args[:width] if args.key?(:width)
end
x
Privacy · Terms