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.

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



842
843
844
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 842

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) 


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

def 
  @account_id
end

#ad_choices_destination_url ⇒ String

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

Returns:

  • (String) 


781
782
783
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 781

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) 


694
695
696
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 694

def advertiser_name
  @advertiser_name
end

#agency_id ⇒ String

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

Returns:

  • (String) 


771
772
773
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 771

def agency_id
  @agency_id
end

#api_update_time ⇒ String

Corresponds to the JSON property apiUpdateTime

Returns:

  • (String) 


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

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


719
720
721
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 719

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


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

def click_through_urls
  @click_through_urls
end

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

Corresponds to the JSON property corrections

Returns:



799
800
801
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 799

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) 


740
741
742
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 740

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) 


833
834
835
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 833

def deals_status
  @deals_status
end

#detected_advertiser_ids ⇒ Array<String>

Corresponds to the JSON property detectedAdvertiserIds

Returns:

  • (Array<String>) 


699
700
701
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 699

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


705
706
707
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 705

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


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

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


840
841
842
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 840

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


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

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:



711
712
713
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 711

def filtering_stats
  @filtering_stats
end

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

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

Returns:



821
822
823
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 821

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


816
817
818
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 816

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:



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

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) 


689
690
691
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 689

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


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

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:



761
762
763
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 761

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


811
812
813
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 811

def vendor_ids
  @vendor_ids
end

#version ⇒ Fixnum

Corresponds to the JSON property version

Returns:

  • (Fixnum) 


804
805
806
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 804

def version
  @version
end

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

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

Returns:



766
767
768
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 766

def video
  @video
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 847

def update!(**args)
  @open_auction_status = args[:open_auction_status] if args.key?(:open_auction_status)
  @advertiser_name = args[:advertiser_name] if args.key?(:advertiser_name)
  @detected_advertiser_ids = args[:detected_advertiser_ids] if args.key?(:detected_advertiser_ids)
  @detected_domains = args[:detected_domains] if args.key?(:detected_domains)
  @filtering_stats = args[:filtering_stats] if args.key?(:filtering_stats)
  @attributes = args[:attributes] if args.key?(:attributes)
  @api_update_time = args[:api_update_time] if args.key?(:api_update_time)
  @detected_languages = args[:detected_languages] if args.key?(:detected_languages)
  @creative_id = args[:creative_id] if args.key?(:creative_id)
  @account_id = args[:account_id] if args.key?(:account_id)
  @native = args[:native] if args.key?(:native)
  @serving_restrictions = args[:serving_restrictions] if args.key?(:serving_restrictions)
  @video = args[:video] if args.key?(:video)
  @agency_id = args[:agency_id] if args.key?(:agency_id)
  @click_through_urls = args[:click_through_urls] if args.key?(:click_through_urls)
  @ad_choices_destination_url = args[:ad_choices_destination_url] if args.key?(:ad_choices_destination_url)
  @detected_sensitive_categories = args[:detected_sensitive_categories] if args.key?(:detected_sensitive_categories)
  @restricted_categories = args[:restricted_categories] if args.key?(:restricted_categories)
  @corrections = args[:corrections] if args.key?(:corrections)
  @version = args[:version] if args.key?(:version)
  @vendor_ids = args[:vendor_ids] if args.key?(:vendor_ids)
  @impression_tracking_urls = args[:impression_tracking_urls] if args.key?(:impression_tracking_urls)
  @html = args[:html] if args.key?(:html)
  @deals_status = args[:deals_status] if args.key?(:deals_status)
  @detected_product_categories = args[:detected_product_categories] if args.key?(:detected_product_categories)
end