Class: Google::Apis::AdexchangebuyerV1_3::Creative

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

Overview

A creative and its classification data.

Defined Under Namespace

Classes: Correction, DisapprovalReason, FilteringReasons, NativeAd

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Creative

Returns a new instance of Creative



408
409
410
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 408

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

Instance Attribute Details

#account_id ⇒ Fixnum

Account id. Corresponds to the JSON property accountId

Returns:

  • (Fixnum) 


283
284
285
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 283

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>) 


289
290
291
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 289

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) 


294
295
296
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 294

def advertiser_name
  @advertiser_name
end

#agency_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


299
300
301
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 299

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) 


306
307
308
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 306

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>) 


311
312
313
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 311

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) 


316
317
318
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 316

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>) 


321
322
323
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 321

def click_through_url
  @click_through_url
end

#corrections ⇒ Array<Google::Apis::AdexchangebuyerV1_3::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:



327
328
329
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 327

def corrections
  @corrections
end

#disapproval_reasons ⇒ Array<Google::Apis::AdexchangebuyerV1_3::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:



336
337
338
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 336

def disapproval_reasons
  @disapproval_reasons
end

#filtering_reasons ⇒ Google::Apis::AdexchangebuyerV1_3::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:



342
343
344
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 342

def filtering_reasons
  @filtering_reasons
end

#height ⇒ Fixnum

Ad height. Corresponds to the JSON property height

Returns:

  • (Fixnum) 


347
348
349
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 347

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) 


278
279
280
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 278

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>) 


352
353
354
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 352

def impression_tracking_url
  @impression_tracking_url
end

#kind ⇒ String

Resource type. Corresponds to the JSON property kind

Returns:

  • (String) 


357
358
359
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 357

def kind
  @kind
end

#native_ad ⇒ Google::Apis::AdexchangebuyerV1_3::Creative::NativeAd

If nativeAd is set, HTMLSnippet and videoURL should not be set. Corresponds to the JSON property nativeAd

Returns:



362
363
364
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 362

def native_ad
  @native_ad
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>) 


368
369
370
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 368

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>) 


373
374
375
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 373

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>) 


379
380
381
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 379

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) 


384
385
386
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 384

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>) 


389
390
391
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 389

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) 


395
396
397
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 395

def version
  @version
end

#video_url ⇒ String

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

Returns:

  • (String) 


401
402
403
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 401

def video_url
  @video_url
end

#width ⇒ Fixnum

Ad width. Corresponds to the JSON property width

Returns:

  • (Fixnum) 


406
407
408
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 406

def width
  @width
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 413

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)
  @native_ad = args[:native_ad] if args.key?(:native_ad)
  @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