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



487
488
489
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 487

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) 


462
463
464
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 462

def 
  @account_id
end

#ad_choices_destination_url ⇒ String

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

Returns:

  • (String) 


340
341
342
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 340

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) 


408
409
410
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 408

def advertiser_name
  @advertiser_name
end

#agency_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


485
486
487
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 485

def agency_id
  @agency_id
end

#api_update_time ⇒ String

Corresponds to the JSON property apiUpdateTime

Returns:

  • (String) 


438
439
440
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 438

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


433
434
435
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 433

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


327
328
329
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 327

def click_through_urls
  @click_through_urls
end

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

Corresponds to the JSON property corrections

Returns:



350
351
352
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 350

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) 


454
455
456
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 454

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) 


384
385
386
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 384

def deals_status
  @deals_status
end

#detected_advertiser_ids ⇒ Array<Fixnum>

Corresponds to the JSON property detectedAdvertiserIds

Returns:

  • (Array<Fixnum>) 


413
414
415
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 413

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


419
420
421
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 419

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


446
447
448
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 446

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


391
392
393
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 391

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


335
336
337
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 335

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:



425
426
427
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 425

def filtering_stats
  @filtering_stats
end

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

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

Returns:



372
373
374
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 372

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


367
368
369
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 367

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:



467
468
469
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 467

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) 


403
404
405
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 403

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


345
346
347
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 345

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:



475
476
477
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 475

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


362
363
364
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 362

def vendor_ids
  @vendor_ids
end

#version ⇒ Fixnum

Corresponds to the JSON property version

Returns:

  • (Fixnum) 


355
356
357
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 355

def version
  @version
end

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

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

Returns:



480
481
482
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 480

def video
  @video
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 492

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