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 more...

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

[View source]

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

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) 

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

def 
  @account_id
end

#ad_choices_destination_url ⇒ String

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

Returns:

  • (String) 

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

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) 

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

def advertiser_name
  @advertiser_name
end

#agency_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 

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

def agency_id
  @agency_id
end

#api_update_time ⇒ String

Corresponds to the JSON property apiUpdateTime

Returns:

  • (String) 

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

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

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

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

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

def click_through_urls
  @click_through_urls
end

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

Corresponds to the JSON property corrections

Returns:


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

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) 

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

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) 

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

def deals_status
  @deals_status
end

#detected_advertiser_ids ⇒ Array<Fixnum>

Corresponds to the JSON property detectedAdvertiserIds

Returns:

  • (Array<Fixnum>) 

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

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

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

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

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

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

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

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

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

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:


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

def filtering_stats
  @filtering_stats
end

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

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

Returns:


659
660
661
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 659

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

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

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:


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

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) 

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

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

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

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:


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

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

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

def vendor_ids
  @vendor_ids
end

#version ⇒ Fixnum

Corresponds to the JSON property version

Returns:

  • (Fixnum) 

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

def version
  @version
end

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

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

Returns:


759
760
761
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 759

def video
  @video
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 824

def update!(**args)
  @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)
  @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)
  @video = args[:video] if args.key?(:video)
  @serving_restrictions = args[:serving_restrictions] if args.key?(:serving_restrictions)
  @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)
end
x

Warning: This is not the latest release.

Privacy · Terms