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.



617
618
619
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 617

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) 


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

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) 


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

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) 


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

def advertiser_name
  @advertiser_name
end

#agency_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


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

def agency_id
  @agency_id
end

#api_update_time ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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) 


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

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:



529
530
531
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 529

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


535
536
537
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 535

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


545
546
547
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 545

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


551
552
553
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 551

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


557
558
559
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 557

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


565
566
567
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 565

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:



570
571
572
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 570

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


575
576
577
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 575

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) 


583
584
585
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 583

def name
  @name
end

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

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

Returns:



588
589
590
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 588

def native
  @native
end

#render_url ⇒ String

Experimental field that can be used during the FLEDGE Origin Trial. The URL to fetch an interest group ad used in TURTLEDOVE on-device auction. This should be unique among all creatives for a given accountId. This URL should be the same as the URL returned by generateBid(). Corresponds to the JSON property renderUrl

Returns:

  • (String) 


599
600
601
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 599

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


604
605
606
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 604

def restricted_categories
  @restricted_categories
end

#version ⇒ Fixnum

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

Returns:

  • (Fixnum) 


610
611
612
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 610

def version
  @version
end

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

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

Returns:



615
616
617
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 615

def video
  @video
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 622

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