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: AdTechnologyProviders, 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.


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

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

Instance Attribute Details

#account_idFixnum

Account id. Corresponds to the JSON property accountId

Returns:

  • (Fixnum)

491
492
493
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 491

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)

496
497
498
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 496

def ad_choices_destination_url
  @ad_choices_destination_url
end

#ad_technology_providersGoogle::Apis::AdexchangebuyerV1_4::Creative::AdTechnologyProviders

Corresponds to the JSON property adTechnologyProviders


501
502
503
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 501

def ad_technology_providers
  @ad_technology_providers
end

#advertiser_idArray<Fixnum>

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

Returns:

  • (Array<Fixnum>)

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

def advertiser_id
  @advertiser_id
end

#advertiser_nameString

The name of the company being advertised in the creative. The value provided must exist in the advertisers.txt file. Corresponds to the JSON property advertiserName

Returns:

  • (String)

513
514
515
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 513

def advertiser_name
  @advertiser_name
end

#agency_idFixnum

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

Returns:

  • (Fixnum)

518
519
520
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 518

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)

525
526
527
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 525

def api_upload_timestamp
  @api_upload_timestamp
end

#attributeArray<Fixnum>

List of buyer selectable attributes for the ads that may be shown from this snippet. Each attribute is represented by an integer as defined in buyer- declarable-creative-attributes.txt. Corresponds to the JSON property attribute

Returns:

  • (Array<Fixnum>)

532
533
534
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 532

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)

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

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

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

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


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

def corrections
  @corrections
end

#creative_status_identity_typeString

Creative status identity type that the creative item applies to. Ad Exchange real-time bidding is migrating to the sizeless creative verification. Originally, Ad Exchange assigned creative verification status to a unique combination of a buyer creative ID and creative dimensions. Post-migration, a single verification status will be assigned at the buyer creative ID level. This field allows to distinguish whether a given creative status applies to a unique combination of a buyer creative ID and creative dimensions, or to a buyer creative ID as a whole. Corresponds to the JSON property creativeStatusIdentityType

Returns:

  • (String)

560
561
562
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 560

def creative_status_identity_type
  @creative_status_identity_type
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)

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

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

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

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


581
582
583
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 581

def filtering_reasons
  @filtering_reasons
end

#heightFixnum

Ad height. Corresponds to the JSON property height

Returns:

  • (Fixnum)

586
587
588
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 586

def height
  @height
end

#html_snippetString

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

Returns:

  • (String)

486
487
488
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 486

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

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

def impression_tracking_url
  @impression_tracking_url
end

#kindString

Resource type. Corresponds to the JSON property kind

Returns:

  • (String)

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

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

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

def languages
  @languages
end

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

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


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

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)

617
618
619
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 617

def open_auction_status
  @open_auction_status
end

#product_categoriesArray<Fixnum>

Detected product categories, if any. Each category is represented by an integer as defined in ad-product-categories.txt. Read-only. This field should not be set in requests. Corresponds to the JSON property productCategories

Returns:

  • (Array<Fixnum>)

624
625
626
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 624

def product_categories
  @product_categories
end

#restricted_categoriesArray<Fixnum>

All restricted categories for the ads that may be shown from this snippet. Each category is represented by an integer as defined in the ad-restricted- categories.txt. Corresponds to the JSON property restrictedCategories

Returns:

  • (Array<Fixnum>)

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

def restricted_categories
  @restricted_categories
end

#sensitive_categoriesArray<Fixnum>

Detected sensitive categories, if any. Each category is represented by an integer as defined in ad-sensitive-categories.txt. Read-only. This field should not be set in requests. Corresponds to the JSON property sensitiveCategories

Returns:

  • (Array<Fixnum>)

638
639
640
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 638

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. See the examples in the Creatives guide for more details. Corresponds to the JSON property servingRestrictions


647
648
649
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 647

def serving_restrictions
  @serving_restrictions
end

#vendor_typeArray<Fixnum>

List of vendor types for the ads that may be shown from this snippet. Each vendor type is represented by an integer as defined in vendors.txt. Corresponds to the JSON property vendorType

Returns:

  • (Array<Fixnum>)

653
654
655
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 653

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)

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

def version
  @version
end

#video_urlString

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

Returns:

  • (String)

666
667
668
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 666

def video_url
  @video_url
end

#video_vast_xmlString

The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard. If set, HTMLSnippet, videoURL, and nativeAd and should not be set. Corresponds to the JSON property videoVastXML

Returns:

  • (String)

673
674
675
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 673

def video_vast_xml
  @video_vast_xml
end

#widthFixnum

Ad width. Corresponds to the JSON property width

Returns:

  • (Fixnum)

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

def width
  @width
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 685

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)
  @ad_technology_providers = args[:ad_technology_providers] if args.key?(:ad_technology_providers)
  @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)
  @creative_status_identity_type = args[:creative_status_identity_type] if args.key?(:creative_status_identity_type)
  @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)
  @video_vast_xml = args[:video_vast_xml] if args.key?(:video_vast_xml)
  @width = args[:width] if args.key?(:width)
end