Class: Google::Apis::AdexchangebuyerV1_4::Creative
- Inherits:
-
Object
- Object
- Google::Apis::AdexchangebuyerV1_4::Creative
- 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
-
#account_id ⇒ Fixnum
Account id.
-
#ad_choices_destination_url ⇒ String
The link to the Ad Preferences page.
-
#advertiser_id ⇒ Array<Fixnum>
Detected advertiser id, if any.
-
#advertiser_name ⇒ String
The name of the company being advertised in the creative.
-
#agency_id ⇒ Fixnum
The agency id for this creative.
-
#api_upload_timestamp ⇒ DateTime
The last upload timestamp of this creative if it was uploaded via API.
-
#attribute ⇒ Array<Fixnum>
List of buyer selectable attributes for the ads that may be shown from this snippet.
-
#buyer_creative_id ⇒ String
A buyer-specific id identifying the creative in this ad.
-
#click_through_url ⇒ Array<String>
The set of destination urls for the snippet.
-
#corrections ⇒ Array<Google::Apis::AdexchangebuyerV1_4::Creative::Correction>
Shows any corrections that were applied to this creative.
-
#deals_status ⇒ String
Top-level deals status.
-
#detected_domains ⇒ Array<String>
Detected domains for this creative.
-
#filtering_reasons ⇒ Google::Apis::AdexchangebuyerV1_4::Creative::FilteringReasons
The filtering reasons for the creative.
-
#height ⇒ Fixnum
Ad height.
-
#html_snippet ⇒ String
The HTML snippet that displays the ad when inserted in the web page.
-
#impression_tracking_url ⇒ Array<String>
The set of urls to be called to record an impression.
-
#kind ⇒ String
Resource type.
-
#languages ⇒ Array<String>
Detected languages for this creative.
-
#native_ad ⇒ Google::Apis::AdexchangebuyerV1_4::Creative::NativeAd
If nativeAd is set, HTMLSnippet, videoVastXML, and the videoURL outside of nativeAd should not be set.
-
#open_auction_status ⇒ String
Top-level open auction status.
-
#product_categories ⇒ Array<Fixnum>
Detected product categories, if any.
-
#restricted_categories ⇒ Array<Fixnum>
All restricted categories for the ads that may be shown from this snippet.
-
#sensitive_categories ⇒ Array<Fixnum>
Detected sensitive categories, if any.
-
#serving_restrictions ⇒ Array<Google::Apis::AdexchangebuyerV1_4::Creative::ServingRestriction>
The granular status of this ad in specific contexts.
-
#vendor_type ⇒ Array<Fixnum>
List of vendor types for the ads that may be shown from this snippet.
-
#version ⇒ Fixnum
The version for this creative.
-
#video_url ⇒ String
The URL to fetch a video ad.
-
#video_vast_xml ⇒ String
The contents of a VAST document for a video ad.
-
#width ⇒ Fixnum
Ad width.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Creative
constructor
A new instance of Creative.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Creative
Returns a new instance of Creative
663 664 665 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 663 def initialize(**args) update!(**args) end |
Instance Attribute Details
#account_id ⇒ Fixnum
Account id.
Corresponds to the JSON property accountId
491 492 493 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 491 def account_id @account_id end |
#ad_choices_destination_url ⇒ String
The link to the Ad Preferences page. This is only supported for native ads.
Corresponds to the JSON property adChoicesDestinationUrl
496 497 498 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 496 def ad_choices_destination_url @ad_choices_destination_url end |
#advertiser_id ⇒ Array<Fixnum>
Detected advertiser id, if any. Read-only. This field should not be set in
requests.
Corresponds to the JSON property advertiserId
502 503 504 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 502 def advertiser_id @advertiser_id end |
#advertiser_name ⇒ String
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
508 509 510 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 508 def advertiser_name @advertiser_name end |
#agency_id ⇒ Fixnum
The agency id for this creative.
Corresponds to the JSON property agencyId
513 514 515 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 513 def agency_id @agency_id end |
#api_upload_timestamp ⇒ DateTime
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
520 521 522 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 520 def @api_upload_timestamp end |
#attribute ⇒ Array<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
527 528 529 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 527 def attribute @attribute end |
#buyer_creative_id ⇒ String
A buyer-specific id identifying the creative in this ad.
Corresponds to the JSON property buyerCreativeId
532 533 534 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 532 def buyer_creative_id @buyer_creative_id end |
#click_through_url ⇒ Array<String>
The set of destination urls for the snippet.
Corresponds to the JSON property clickThroughUrl
537 538 539 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 537 def click_through_url @click_through_url end |
#corrections ⇒ Array<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
543 544 545 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 543 def corrections @corrections end |
#deals_status ⇒ String
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
552 553 554 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 552 def deals_status @deals_status end |
#detected_domains ⇒ Array<String>
Detected domains for this creative. Read-only. This field should not be set in
requests.
Corresponds to the JSON property detectedDomains
558 559 560 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 558 def detected_domains @detected_domains end |
#filtering_reasons ⇒ Google::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
564 565 566 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 564 def filtering_reasons @filtering_reasons end |
#height ⇒ Fixnum
Ad height.
Corresponds to the JSON property height
569 570 571 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 569 def height @height end |
#html_snippet ⇒ String
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
486 487 488 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 486 def html_snippet @html_snippet end |
#impression_tracking_url ⇒ Array<String>
The set of urls to be called to record an impression.
Corresponds to the JSON property impressionTrackingUrl
574 575 576 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 574 def impression_tracking_url @impression_tracking_url end |
#kind ⇒ String
Resource type.
Corresponds to the JSON property kind
579 580 581 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 579 def kind @kind end |
#languages ⇒ Array<String>
Detected languages for this creative. Read-only. This field should not be set
in requests.
Corresponds to the JSON property languages
585 586 587 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 585 def languages @languages end |
#native_ad ⇒ Google::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
591 592 593 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 591 def native_ad @native_ad end |
#open_auction_status ⇒ String
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
600 601 602 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 600 def open_auction_status @open_auction_status end |
#product_categories ⇒ Array<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
607 608 609 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 607 def product_categories @product_categories end |
#restricted_categories ⇒ Array<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
614 615 616 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 614 def restricted_categories @restricted_categories end |
#sensitive_categories ⇒ Array<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
621 622 623 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 621 def sensitive_categories @sensitive_categories end |
#serving_restrictions ⇒ Array<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
630 631 632 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 630 def serving_restrictions @serving_restrictions end |
#vendor_type ⇒ Array<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
636 637 638 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 636 def vendor_type @vendor_type end |
#version ⇒ Fixnum
The version for this creative. Read-only. This field should not be set in
requests.
Corresponds to the JSON property version
642 643 644 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 642 def version @version end |
#video_url ⇒ String
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
649 650 651 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 649 def video_url @video_url end |
#video_vast_xml ⇒ String
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
656 657 658 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 656 def video_vast_xml @video_vast_xml end |
#width ⇒ Fixnum
Ad width.
Corresponds to the JSON property width
661 662 663 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 661 def width @width end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 668 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) @video_vast_xml = args[:video_vast_xml] if args.key?(:video_vast_xml) @width = args[:width] if args.key?(:width) end |