Class: Google::Apis::AdexchangebuyerV1_4::Creative

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/adexchangebuyer_v1_4/classes.rb,
generated/google/apis/adexchangebuyer_v1_4/representations.rb,
generated/google/apis/adexchangebuyer_v1_4/representations.rb

Overview

A creative and its classification data.

Defined Under Namespace

Classes: Correction, FilteringReasons, NativeAd, ServingRestriction

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.


633
634
635
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 633

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

Instance Attribute Details

#account_idFixnum

Account id. Corresponds to the JSON property accountId

Returns:

  • (Fixnum)

478
479
480
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 478

def 
  @account_id
end

#ad_choices_destination_urlString

The link to the Ad Preferences page. This is only supported for native ads. Corresponds to the JSON property adChoicesDestinationUrl

Returns:

  • (String)

483
484
485
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 483

def ad_choices_destination_url
  @ad_choices_destination_url
end

#advertiser_idArray<String>

Detected advertiser id, if any. Read-only. This field should not be set in requests. Corresponds to the JSON property advertiserId

Returns:

  • (Array<String>)

489
490
491
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 489

def advertiser_id
  @advertiser_id
end

#advertiser_nameString

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

Returns:

  • (String)

494
495
496
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 494

def advertiser_name
  @advertiser_name
end

#agency_idString

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

Returns:

  • (String)

499
500
501
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 499

def agency_id
  @agency_id
end

#api_upload_timestampDateTime

The last upload timestamp of this creative if it was uploaded via API. Read- only. The value of this field is generated, and will be ignored for uploads. ( formatted RFC 3339 timestamp). Corresponds to the JSON property apiUploadTimestamp

Returns:

  • (DateTime)

506
507
508
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 506

def api_upload_timestamp
  @api_upload_timestamp
end

#attributeArray<Fixnum>

All attributes for the ads that may be shown from this snippet. Corresponds to the JSON property attribute

Returns:

  • (Array<Fixnum>)

511
512
513
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 511

def attribute
  @attribute
end

#buyer_creative_idString

A buyer-specific id identifying the creative in this ad. Corresponds to the JSON property buyerCreativeId

Returns:

  • (String)

516
517
518
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 516

def buyer_creative_id
  @buyer_creative_id
end

#click_through_urlArray<String>

The set of destination urls for the snippet. Corresponds to the JSON property clickThroughUrl

Returns:

  • (Array<String>)

521
522
523
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 521

def click_through_url
  @click_through_url
end

#correctionsArray<Google::Apis::AdexchangebuyerV1_4::Creative::Correction>

Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests. Corresponds to the JSON property corrections


527
528
529
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 527

def corrections
  @corrections
end

#deals_statusString

Top-level deals status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=DIRECT_DEALS (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from servingRestrictions directly. Corresponds to the JSON property dealsStatus

Returns:

  • (String)

536
537
538
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 536

def deals_status
  @deals_status
end

#detected_domainsArray<String>

Detected domains for this creative. Read-only. This field should not be set in requests. Corresponds to the JSON property detectedDomains

Returns:

  • (Array<String>)

542
543
544
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 542

def detected_domains
  @detected_domains
end

#filtering_reasonsGoogle::Apis::AdexchangebuyerV1_4::Creative::FilteringReasons

The filtering reasons for the creative. Read-only. This field should not be set in requests. Corresponds to the JSON property filteringReasons


548
549
550
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 548

def filtering_reasons
  @filtering_reasons
end

#heightFixnum

Ad height. Corresponds to the JSON property height

Returns:

  • (Fixnum)

553
554
555
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 553

def height
  @height
end

#html_snippetString

The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set. Corresponds to the JSON property HTMLSnippet

Returns:

  • (String)

473
474
475
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 473

def html_snippet
  @html_snippet
end

#impression_tracking_urlArray<String>

The set of urls to be called to record an impression. Corresponds to the JSON property impressionTrackingUrl

Returns:

  • (Array<String>)

558
559
560
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 558

def impression_tracking_url
  @impression_tracking_url
end

#kindString

Resource type. Corresponds to the JSON property kind

Returns:

  • (String)

563
564
565
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 563

def kind
  @kind
end

#languagesArray<String>

Detected languages for this creative. Read-only. This field should not be set in requests. Corresponds to the JSON property languages

Returns:

  • (Array<String>)

569
570
571
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 569

def languages
  @languages
end

#native_adGoogle::Apis::AdexchangebuyerV1_4::Creative::NativeAd

If nativeAd is set, HTMLSnippet and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.) Corresponds to the JSON property nativeAd


575
576
577
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 575

def native_ad
  @native_ad
end

#open_auction_statusString

Top-level open auction status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=OPEN_AUCTION (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from ServingRestrictions directly. Corresponds to the JSON property openAuctionStatus

Returns:

  • (String)

584
585
586
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 584

def open_auction_status
  @open_auction_status
end

#product_categoriesArray<Fixnum>

Detected product categories, if any. Read-only. This field should not be set in requests. Corresponds to the JSON property productCategories

Returns:

  • (Array<Fixnum>)

590
591
592
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 590

def product_categories
  @product_categories
end

#restricted_categoriesArray<Fixnum>

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

Returns:

  • (Array<Fixnum>)

595
596
597
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 595

def restricted_categories
  @restricted_categories
end

#sensitive_categoriesArray<Fixnum>

Detected sensitive categories, if any. Read-only. This field should not be set in requests. Corresponds to the JSON property sensitiveCategories

Returns:

  • (Array<Fixnum>)

601
602
603
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 601

def sensitive_categories
  @sensitive_categories
end

#serving_restrictionsArray<Google::Apis::AdexchangebuyerV1_4::Creative::ServingRestriction>

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). Read-only. This field should not be set in requests. Corresponds to the JSON property servingRestrictions


609
610
611
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 609

def serving_restrictions
  @serving_restrictions
end

#vendor_typeArray<Fixnum>

All vendor types for the ads that may be shown from this snippet. Corresponds to the JSON property vendorType

Returns:

  • (Array<Fixnum>)

614
615
616
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 614

def vendor_type
  @vendor_type
end

#versionFixnum

The version for this creative. Read-only. This field should not be set in requests. Corresponds to the JSON property version

Returns:

  • (Fixnum)

620
621
622
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 620

def version
  @version
end

#video_urlString

The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should not be set. Note, this is diffrent from resource.native_ad.video_url above. Corresponds to the JSON property videoURL

Returns:

  • (String)

626
627
628
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 626

def video_url
  @video_url
end

#widthFixnum

Ad width. Corresponds to the JSON property width

Returns:

  • (Fixnum)

631
632
633
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 631

def width
  @width
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 638

def update!(**args)
  @html_snippet = args[:html_snippet] if args.key?(:html_snippet)
  @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)
  @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id)
  @advertiser_name = args[:advertiser_name] if args.key?(:advertiser_name)
  @agency_id = args[:agency_id] if args.key?(:agency_id)
  @api_upload_timestamp = args[:api_upload_timestamp] if args.key?(:api_upload_timestamp)
  @attribute = args[:attribute] if args.key?(:attribute)
  @buyer_creative_id = args[:buyer_creative_id] if args.key?(:buyer_creative_id)
  @click_through_url = args[:click_through_url] if args.key?(:click_through_url)
  @corrections = args[:corrections] if args.key?(:corrections)
  @deals_status = args[:deals_status] if args.key?(:deals_status)
  @detected_domains = args[:detected_domains] if args.key?(:detected_domains)
  @filtering_reasons = args[:filtering_reasons] if args.key?(:filtering_reasons)
  @height = args[:height] if args.key?(:height)
  @impression_tracking_url = args[:impression_tracking_url] if args.key?(:impression_tracking_url)
  @kind = args[:kind] if args.key?(:kind)
  @languages = args[:languages] if args.key?(:languages)
  @native_ad = args[:native_ad] if args.key?(:native_ad)
  @open_auction_status = args[:open_auction_status] if args.key?(:open_auction_status)
  @product_categories = args[:product_categories] if args.key?(:product_categories)
  @restricted_categories = args[:restricted_categories] if args.key?(:restricted_categories)
  @sensitive_categories = args[:sensitive_categories] if args.key?(:sensitive_categories)
  @serving_restrictions = args[:serving_restrictions] if args.key?(:serving_restrictions)
  @vendor_type = args[:vendor_type] if args.key?(:vendor_type)
  @version = args[:version] if args.key?(:version)
  @video_url = args[:video_url] if args.key?(:video_url)
  @width = args[:width] if args.key?(:width)
end