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.


807
808
809
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 807

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

Instance Attribute Details

#account_idString

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)

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

def 
  @account_id
end

#ad_choices_destination_urlString

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

Returns:

  • (String)

665
666
667
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 665

def ad_choices_destination_url
  @ad_choices_destination_url
end

#ad_technology_providersGoogle::Apis::Adexchangebuyer2V2beta1::AdTechnologyProviders

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


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

def ad_technology_providers
  @ad_technology_providers
end

#advertiser_nameString

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

Returns:

  • (String)

675
676
677
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 675

def advertiser_name
  @advertiser_name
end

#agency_idFixnum

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

Returns:

  • (Fixnum)

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

def agency_id
  @agency_id
end

#api_update_timeString

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

Returns:

  • (String)

685
686
687
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 685

def api_update_time
  @api_update_time
end

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

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

def attributes
  @attributes
end

#click_through_urlsArray<String>

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

Returns:

  • (Array<String>)

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

def click_through_urls
  @click_through_urls
end

#correctionsArray<Google::Apis::Adexchangebuyer2V2beta1::Correction>

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


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

def corrections
  @corrections
end

#creative_idString

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)

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

def creative_id
  @creative_id
end

#deals_statusString

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)

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

def deals_status
  @deals_status
end

#declared_click_through_urlsArray<String>

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

Returns:

  • (Array<String>)

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

def declared_click_through_urls
  @declared_click_through_urls
end

#detected_advertiser_idsArray<Fixnum>

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

Returns:

  • (Array<Fixnum>)

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

def detected_advertiser_ids
  @detected_advertiser_ids
end

#detected_domainsArray<String>

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

Returns:

  • (Array<String>)

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

def detected_domains
  @detected_domains
end

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

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

def detected_languages
  @detected_languages
end

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

744
745
746
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 744

def detected_product_categories
  @detected_product_categories
end

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

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

def detected_sensitive_categories
  @detected_sensitive_categories
end

#htmlGoogle::Apis::Adexchangebuyer2V2beta1::HtmlContent

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


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

def html
  @html
end

#impression_tracking_urlsArray<String>

The set of URLs to be called to record an impression. Corresponds to the JSON property impressionTrackingUrls

Returns:

  • (Array<String>)

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

def impression_tracking_urls
  @impression_tracking_urls
end

#nativeGoogle::Apis::Adexchangebuyer2V2beta1::NativeContent

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


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

def native
  @native
end

#open_auction_statusString

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)

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

def open_auction_status
  @open_auction_status
end

#restricted_categoriesArray<String>

All restricted categories for the ads that may be shown from this creative. Corresponds to the JSON property restrictedCategories

Returns:

  • (Array<String>)

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

def restricted_categories
  @restricted_categories
end

#serving_restrictionsArray<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


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

def serving_restrictions
  @serving_restrictions
end

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

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

def vendor_ids
  @vendor_ids
end

#versionFixnum

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

Returns:

  • (Fixnum)

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

def version
  @version
end

#videoGoogle::Apis::Adexchangebuyer2V2beta1::VideoContent

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


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

def video
  @video
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 812

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