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.



837
838
839
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 837

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) 


678
679
680
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 678

def 
  @account_id
end

#ad_choices_destination_url ⇒ String

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

Returns:

  • (String) 


683
684
685
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 683

def ad_choices_destination_url
  @ad_choices_destination_url
end

#ad_technology_providers ⇒ Google::Apis::Adexchangebuyer2V2beta1::AdTechnologyProviders

Detected ad technology provider information. Corresponds to the JSON property adTechnologyProviders

Returns:



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

def ad_technology_providers
  @ad_technology_providers
end

#advertiser_name ⇒ String

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

Returns:

  • (String) 


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

def advertiser_name
  @advertiser_name
end

#agency_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


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

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) 


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

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


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

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


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

def click_through_urls
  @click_through_urls
end

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

Output only. Shows any corrections that were applied to this creative. Corresponds to the JSON property corrections

Returns:



721
722
723
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 721

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) 


729
730
731
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 729

def creative_id
  @creative_id
end

#deals_status ⇒ String

Output only. The top-level deals status of this creative. 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) 


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

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


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

def declared_click_through_urls
  @declared_click_through_urls
end

#detected_advertiser_ids ⇒ Array<Fixnum>

Output only. Detected advertiser IDs, if any. Corresponds to the JSON property detectedAdvertiserIds

Returns:

  • (Array<Fixnum>) 


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

def detected_advertiser_ids
  @detected_advertiser_ids
end

#detected_domains ⇒ Array<String>

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

Returns:

  • (Array<String>) 


756
757
758
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 756

def detected_domains
  @detected_domains
end

#detected_languages ⇒ Array<String>

Output only. 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>) 


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

def detected_languages
  @detected_languages
end

#detected_product_categories ⇒ Array<Fixnum>

Output only. Detected product categories, if any. 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>) 


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

def detected_product_categories
  @detected_product_categories
end

#detected_sensitive_categories ⇒ Array<Fixnum>

Output only. Detected sensitive categories, if any. 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>) 


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

def detected_sensitive_categories
  @detected_sensitive_categories
end

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

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

Returns:



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

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


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

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:



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

def native
  @native
end

#open_auction_status ⇒ String

Output only. The top-level open auction status of this creative. 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) 


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

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


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

def restricted_categories
  @restricted_categories
end

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

Output only. The granular status of this ad in specific contexts. 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:



818
819
820
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 818

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


825
826
827
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 825

def vendor_ids
  @vendor_ids
end

#version ⇒ Fixnum

Output only. The version of this creative. Corresponds to the JSON property version

Returns:

  • (Fixnum) 


830
831
832
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 830

def version
  @version
end

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

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

Returns:



835
836
837
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 835

def video
  @video
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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

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