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



1240
1241
1242
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1240

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) 


1118
1119
1120
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1118

def 
  @account_id
end

#ad_choices_destination_url ⇒ String

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

Returns:

  • (String) 


1151
1152
1153
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1151

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) 


1227
1228
1229
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1227

def advertiser_name
  @advertiser_name
end

#agency_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1141
1142
1143
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1141

def agency_id
  @agency_id
end

#api_update_time ⇒ String

Corresponds to the JSON property apiUpdateTime

Returns:

  • (String) 


1094
1095
1096
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1094

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


1089
1090
1091
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1089

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


1146
1147
1148
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1146

def click_through_urls
  @click_through_urls
end

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

Corresponds to the JSON property corrections

Returns:



1169
1170
1171
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1169

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) 


1110
1111
1112
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1110

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) 


1203
1204
1205
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1203

def deals_status
  @deals_status
end

#detected_advertiser_ids ⇒ Array<Fixnum>

Corresponds to the JSON property detectedAdvertiserIds

Returns:

  • (Array<Fixnum>) 


1232
1233
1234
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1232

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


1238
1239
1240
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1238

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


1102
1103
1104
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1102

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


1210
1211
1212
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1210

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


1159
1160
1161
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1159

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:



1081
1082
1083
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1081

def filtering_stats
  @filtering_stats
end

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

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

Returns:



1191
1192
1193
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1191

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


1186
1187
1188
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1186

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:



1123
1124
1125
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1123

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) 


1222
1223
1224
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1222

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


1164
1165
1166
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1164

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:



1136
1137
1138
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1136

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


1181
1182
1183
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1181

def vendor_ids
  @vendor_ids
end

#version ⇒ Fixnum

Corresponds to the JSON property version

Returns:

  • (Fixnum) 


1174
1175
1176
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1174

def version
  @version
end

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

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

Returns:



1128
1129
1130
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1128

def video
  @video
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1245

def update!(**args)
  @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)
  @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)
end