Class: Google::Apis::Adexchangebuyer2V2beta1::Creative

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

Overview

A creative and its classification data. Next ID: 39

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



796
797
798
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 796

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

Instance Attribute Details

#account_id ⇒ String

The account that this creative belongs to. Can be used to filter the response of the creatives.list method. Corresponds to the JSON property accountId

Returns:

  • (String) 


634
635
636
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 634

def 
  @account_id
end

#ad_choices_destination_url ⇒ String

The link to AdChoices destination page. Corresponds to the JSON property adChoicesDestinationUrl

Returns:

  • (String) 


639
640
641
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 639

def ad_choices_destination_url
  @ad_choices_destination_url
end

#advertiser_name ⇒ String

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

Returns:

  • (String) 


644
645
646
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 644

def advertiser_name
  @advertiser_name
end

#agency_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


649
650
651
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 649

def agency_id
  @agency_id
end

#api_update_time ⇒ String

Corresponds to the JSON property apiUpdateTime

Returns:

  • (String) 


654
655
656
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 654

def api_update_time
  @api_update_time
end

#attributes ⇒ Array<String>

All attributes 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 attributes

Returns:

  • (Array<String>) 


662
663
664
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 662

def attributes
  @attributes
end

#click_through_urls ⇒ Array<String>

The set of destination URLs for the creative. Corresponds to the JSON property clickThroughUrls

Returns:

  • (Array<String>) 


667
668
669
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 667

def click_through_urls
  @click_through_urls
end

#corrections ⇒ Array<Google::Apis::Adexchangebuyer2V2beta1::Correction>

Corresponds to the JSON property corrections

Returns:



672
673
674
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 672

def corrections
  @corrections
end

#creative_id ⇒ String

The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method. Corresponds to the JSON property creativeId

Returns:

  • (String) 


680
681
682
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 680

def creative_id
  @creative_id
end

#deals_status ⇒ String

If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method. Corresponds to the JSON property dealsStatus

Returns:

  • (String) 


692
693
694
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 692

def deals_status
  @deals_status
end

#declared_click_through_urls ⇒ Array<String>

The set of declared destination URLs for the creative. Corresponds to the JSON property declaredClickThroughUrls

Returns:

  • (Array<String>) 


697
698
699
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 697

def declared_click_through_urls
  @declared_click_through_urls
end

#detected_advertiser_ids ⇒ Array<Fixnum>

Corresponds to the JSON property detectedAdvertiserIds

Returns:

  • (Array<Fixnum>) 


702
703
704
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 702

def detected_advertiser_ids
  @detected_advertiser_ids
end

#detected_domains ⇒ Array<String>

The detected domains for this creative. Corresponds to the JSON property detectedDomains

Returns:

  • (Array<String>) 


708
709
710
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 708

def detected_domains
  @detected_domains
end

#detected_languages ⇒ Array<String>

The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes. Corresponds to the JSON property detectedLanguages

Returns:

  • (Array<String>) 


716
717
718
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 716

def detected_languages
  @detected_languages
end

#detected_product_categories ⇒ Array<Fixnum>

See the ad-product-categories.txt file in the technical documentation for a list of IDs. Corresponds to the JSON property detectedProductCategories

Returns:

  • (Array<Fixnum>) 


723
724
725
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 723

def detected_product_categories
  @detected_product_categories
end

#detected_sensitive_categories ⇒ Array<Fixnum>

See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids. Corresponds to the JSON property detectedSensitiveCategories

Returns:

  • (Array<Fixnum>) 


731
732
733
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 731

def detected_sensitive_categories
  @detected_sensitive_categories
end

#filtering_stats ⇒ Google::Apis::Adexchangebuyer2V2beta1::FilteringStats

day (from midnight to midnight Pacific). Corresponds to the JSON property filteringStats

Returns:



737
738
739
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 737

def filtering_stats
  @filtering_stats
end

#html ⇒ Google::Apis::Adexchangebuyer2V2beta1::HtmlContent

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

Returns:



742
743
744
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 742

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


747
748
749
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 747

def impression_tracking_urls
  @impression_tracking_urls
end

#native ⇒ Google::Apis::Adexchangebuyer2V2beta1::NativeContent

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

Returns:



752
753
754
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 752

def native
  @native
end

#open_auction_status ⇒ String

If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method. Corresponds to the JSON property openAuctionStatus

Returns:

  • (String) 


764
765
766
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 764

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


769
770
771
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 769

def restricted_categories
  @restricted_categories
end

#serving_restrictions ⇒ Array<Google::Apis::Adexchangebuyer2V2beta1::ServingRestriction>

A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). Corresponds to the JSON property servingRestrictions

Returns:



777
778
779
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 777

def serving_restrictions
  @serving_restrictions
end

#vendor_ids ⇒ Array<Fixnum>

All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. Corresponds to the JSON property vendorIds

Returns:

  • (Array<Fixnum>) 


784
785
786
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 784

def vendor_ids
  @vendor_ids
end

#version ⇒ Fixnum

Corresponds to the JSON property version

Returns:

  • (Fixnum) 


789
790
791
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 789

def version
  @version
end

#video ⇒ Google::Apis::Adexchangebuyer2V2beta1::VideoContent

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

Returns:



794
795
796
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 794

def video
  @video
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 801

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)
  @attributes = args[:attributes] if args.key?(:attributes)
  @click_through_urls = args[:click_through_urls] if args.key?(:click_through_urls)
  @corrections = args[:corrections] if args.key?(:corrections)
  @creative_id = args[:creative_id] if args.key?(:creative_id)
  @deals_status = args[:deals_status] if args.key?(:deals_status)
  @declared_click_through_urls = args[:declared_click_through_urls] if args.key?(:declared_click_through_urls)
  @detected_advertiser_ids = args[:detected_advertiser_ids] if args.key?(:detected_advertiser_ids)
  @detected_domains = args[:detected_domains] if args.key?(:detected_domains)
  @detected_languages = args[:detected_languages] if args.key?(:detected_languages)
  @detected_product_categories = args[:detected_product_categories] if args.key?(:detected_product_categories)
  @detected_sensitive_categories = args[:detected_sensitive_categories] if args.key?(:detected_sensitive_categories)
  @filtering_stats = args[:filtering_stats] if args.key?(:filtering_stats)
  @html = args[:html] if args.key?(:html)
  @impression_tracking_urls = args[:impression_tracking_urls] if args.key?(:impression_tracking_urls)
  @native = args[:native] if args.key?(:native)
  @open_auction_status = args[:open_auction_status] if args.key?(:open_auction_status)
  @restricted_categories = args[:restricted_categories] if args.key?(:restricted_categories)
  @serving_restrictions = args[:serving_restrictions] if args.key?(:serving_restrictions)
  @vendor_ids = args[:vendor_ids] if args.key?(:vendor_ids)
  @version = args[:version] if args.key?(:version)
  @video = args[:video] if args.key?(:video)
end