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: AdTechnologyProviders, 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.


413
414
415
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 413

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

Instance Attribute Details

#account_idFixnum

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

#ad_technology_providersGoogle::Apis::AdexchangebuyerV1_3::Creative::AdTechnologyProviders

Corresponds to the JSON property adTechnologyProviders


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

def ad_technology_providers
  @ad_technology_providers
end

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

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

def advertiser_id
  @advertiser_id
end

#advertiser_nameString

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

Returns:

  • (String)

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

def advertiser_name
  @advertiser_name
end

#agency_idFixnum

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

Returns:

  • (Fixnum)

304
305
306
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 304

def agency_id
  @agency_id
end

#api_upload_timestampDateTime

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)

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

def api_upload_timestamp
  @api_upload_timestamp
end

#attributeArray<Fixnum>

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

Returns:

  • (Array<Fixnum>)

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

def attribute
  @attribute
end

#buyer_creative_idString

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

Returns:

  • (String)

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

def buyer_creative_id
  @buyer_creative_id
end

#click_through_urlArray<String>

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

Returns:

  • (Array<String>)

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

def click_through_url
  @click_through_url
end

#correctionsArray<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


332
333
334
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 332

def corrections
  @corrections
end

#disapproval_reasonsArray<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


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

def disapproval_reasons
  @disapproval_reasons
end

#filtering_reasonsGoogle::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


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

def filtering_reasons
  @filtering_reasons
end

#heightFixnum

Ad height. Corresponds to the JSON property height

Returns:

  • (Fixnum)

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

def height
  @height
end

#html_snippetString

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_urlArray<String>

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

Returns:

  • (Array<String>)

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

def impression_tracking_url
  @impression_tracking_url
end

#kindString

Resource type. Corresponds to the JSON property kind

Returns:

  • (String)

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

def kind
  @kind
end

#native_adGoogle::Apis::AdexchangebuyerV1_3::Creative::NativeAd

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


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

def native_ad
  @native_ad
end

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

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

def product_categories
  @product_categories
end

#restricted_categoriesArray<Fixnum>

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

Returns:

  • (Array<Fixnum>)

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

def restricted_categories
  @restricted_categories
end

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

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

def sensitive_categories
  @sensitive_categories
end

#statusString

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

Returns:

  • (String)

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

def status
  @status
end

#vendor_typeArray<Fixnum>

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

Returns:

  • (Array<Fixnum>)

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

def vendor_type
  @vendor_type
end

#versionFixnum

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

Returns:

  • (Fixnum)

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

def version
  @version
end

#video_urlString

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)

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

def video_url
  @video_url
end

#widthFixnum

Ad width. Corresponds to the JSON property width

Returns:

  • (Fixnum)

411
412
413
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 411

def width
  @width
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 418

def update!(**args)
  @html_snippet = args[:html_snippet] if args.key?(:html_snippet)
  @account_id = args[:account_id] if args.key?(:account_id)
  @ad_technology_providers = args[:ad_technology_providers] if args.key?(:ad_technology_providers)
  @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