Class: Google::Apis::RealtimebiddingV1::Creative

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

Overview

A creative and its classification data.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Creative

Returns a new instance of Creative.



524
525
526
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 524

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

Instance Attribute Details

#account_id ⇒ Fixnum

Output only. ID of the buyer account that this creative is owned by. Can be used to filter the response of the creatives.list method with equality and inequality check. Corresponds to the JSON property accountId

Returns:

  • (Fixnum) 


407
408
409
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 407

def 
  @account_id
end

#ad_choices_destination_url ⇒ String

The link to AdChoices destination page. This is only supported for native ads. Corresponds to the JSON property adChoicesDestinationUrl

Returns:

  • (String) 


412
413
414
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 412

def ad_choices_destination_url
  @ad_choices_destination_url
end

#advertiser_name ⇒ String

The name of the company being advertised in the creative. Can be used to filter the response of the creatives.list method. Corresponds to the JSON property advertiserName

Returns:

  • (String) 


418
419
420
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 418

def advertiser_name
  @advertiser_name
end

#agency_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


423
424
425
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 423

def agency_id
  @agency_id
end

#api_update_time ⇒ String

Output only. The last update timestamp of the creative via API. Corresponds to the JSON property apiUpdateTime

Returns:

  • (String) 


428
429
430
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 428

def api_update_time
  @api_update_time
end

#creative_format ⇒ String

Output only. The format of this creative. Can be used to filter the response of the creatives.list method. Corresponds to the JSON property creativeFormat

Returns:

  • (String) 


434
435
436
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 434

def creative_format
  @creative_format
end

#creative_id ⇒ String

Buyer-specific creative ID that references this creative in bid responses. This field is Ignored in update operations. Can be used to filter the response of the creatives.list method. The maximum length of the creative ID is 128 bytes. Corresponds to the JSON property creativeId

Returns:

  • (String) 


442
443
444
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 442

def creative_id
  @creative_id
end

#creative_serving_decision ⇒ Google::Apis::RealtimebiddingV1::CreativeServingDecision

Top level status and detected attributes of a creative. Corresponds to the JSON property creativeServingDecision

Returns:



447
448
449
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 447

def creative_serving_decision
  @creative_serving_decision
end

#deal_ids ⇒ Array<String>

Output only. IDs of all of the deals with which this creative has been used in bidding. Can be used to filter the response of the creatives.list method. Corresponds to the JSON property dealIds

Returns:

  • (Array<String>) 


453
454
455
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 453

def deal_ids
  @deal_ids
end

#declared_attributes ⇒ Array<String>

All declared attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. If the excluded_attribute field of a bid request contains one of the attributes that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction. Corresponds to the JSON property declaredAttributes

Returns:

  • (Array<String>) 


463
464
465
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 463

def declared_attributes
  @declared_attributes
end

#declared_click_through_urls ⇒ Array<String>

The set of declared destination URLs for the creative. Can be used to filter the response of the creatives.list method. Corresponds to the JSON property declaredClickThroughUrls

Returns:

  • (Array<String>) 


469
470
471
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 469

def declared_click_through_urls
  @declared_click_through_urls
end

#declared_restricted_categories ⇒ Array<String>

All declared restricted categories for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. Corresponds to the JSON property declaredRestrictedCategories

Returns:

  • (Array<String>) 


475
476
477
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 475

def declared_restricted_categories
  @declared_restricted_categories
end

#declared_vendor_ids ⇒ Array<Fixnum>

IDs for the declared ad technology vendors that may be used by this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. Can be used to filter the response of the creatives.list method. Corresponds to the JSON property declaredVendorIds

Returns:

  • (Array<Fixnum>) 


483
484
485
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 483

def declared_vendor_ids
  @declared_vendor_ids
end

#html ⇒ Google::Apis::RealtimebiddingV1::HtmlContent

HTML content for a creative. Corresponds to the JSON property html

Returns:



488
489
490
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 488

def html
  @html
end

#impression_tracking_urls ⇒ Array<String>

The set of URLs to be called to record an impression. Corresponds to the JSON property impressionTrackingUrls

Returns:

  • (Array<String>) 


493
494
495
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 493

def impression_tracking_urls
  @impression_tracking_urls
end

#name ⇒ String

Output only. Name of the creative. Follows the pattern buyers/buyer/ creatives/creative, wherebuyerrepresents the account ID of the buyer who owns the creative, andcreative`is the buyer-specific creative ID that references this creative in the bid response. Corresponds to the JSON propertyname`

Returns:

  • (String) 


501
502
503
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 501

def name
  @name
end

#native ⇒ Google::Apis::RealtimebiddingV1::NativeContent

Native content for a creative. Corresponds to the JSON property native

Returns:



506
507
508
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 506

def native
  @native
end

#restricted_categories ⇒ Array<String>

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

Returns:

  • (Array<String>) 


511
512
513
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 511

def restricted_categories
  @restricted_categories
end

#version ⇒ Fixnum

Output only. The version of this creative. Version for a new creative is 1 and it increments during subsequent creative updates. Corresponds to the JSON property version

Returns:

  • (Fixnum) 


517
518
519
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 517

def version
  @version
end

#video ⇒ Google::Apis::RealtimebiddingV1::VideoContent

Video content for a creative. Corresponds to the JSON property video

Returns:



522
523
524
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 522

def video
  @video
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 529

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @ad_choices_destination_url = args[:ad_choices_destination_url] if args.key?(:ad_choices_destination_url)
  @advertiser_name = args[:advertiser_name] if args.key?(:advertiser_name)
  @agency_id = args[:agency_id] if args.key?(:agency_id)
  @api_update_time = args[:api_update_time] if args.key?(:api_update_time)
  @creative_format = args[:creative_format] if args.key?(:creative_format)
  @creative_id = args[:creative_id] if args.key?(:creative_id)
  @creative_serving_decision = args[:creative_serving_decision] if args.key?(:creative_serving_decision)
  @deal_ids = args[:deal_ids] if args.key?(:deal_ids)
  @declared_attributes = args[:declared_attributes] if args.key?(:declared_attributes)
  @declared_click_through_urls = args[:declared_click_through_urls] if args.key?(:declared_click_through_urls)
  @declared_restricted_categories = args[:declared_restricted_categories] if args.key?(:declared_restricted_categories)
  @declared_vendor_ids = args[:declared_vendor_ids] if args.key?(:declared_vendor_ids)
  @html = args[:html] if args.key?(:html)
  @impression_tracking_urls = args[:impression_tracking_urls] if args.key?(:impression_tracking_urls)
  @name = args[:name] if args.key?(:name)
  @native = args[:native] if args.key?(:native)
  @restricted_categories = args[:restricted_categories] if args.key?(:restricted_categories)
  @version = args[:version] if args.key?(:version)
  @video = args[:video] if args.key?(:video)
end