Class: Google::Apis::AdexchangebuyerV1_4::Product

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 product is segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps buyer know more about the inventory. Each field in a product can have one of the following setting: (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.

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

Returns a new instance of Product.



2789
2790
2791
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2789

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

Instance Attribute Details

#creation_time_ms ⇒ String

Creation time in ms. since epoch (readonly) Corresponds to the JSON property creationTimeMs

Returns:

  • (String) 


2661
2662
2663
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2661

def creation_time_ms
  @creation_time_ms
end

#creator_contacts ⇒ Array<Google::Apis::AdexchangebuyerV1_4::ContactInformation>

Optional contact information for the creator of this product. (buyer-readonly) Corresponds to the JSON property creatorContacts

Returns:



2666
2667
2668
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2666

def creator_contacts
  @creator_contacts
end

#delivery_control ⇒ Google::Apis::AdexchangebuyerV1_4::DeliveryControl

The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension. Corresponds to the JSON property deliveryControl

Returns:



2674
2675
2676
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2674

def delivery_control
  @delivery_control
end

#flight_end_time_ms ⇒ String

The proposed end time for the deal (ms since epoch) (buyer-readonly) Corresponds to the JSON property flightEndTimeMs

Returns:

  • (String) 


2679
2680
2681
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2679

def flight_end_time_ms
  @flight_end_time_ms
end

#flight_start_time_ms ⇒ String

Inventory availability dates. (times are in ms since epoch) The granularity is generally in the order of seconds. (buyer-readonly) Corresponds to the JSON property flightStartTimeMs

Returns:

  • (String) 


2685
2686
2687
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2685

def flight_start_time_ms
  @flight_start_time_ms
end

#has_creator_signed_off ⇒ Boolean Also known as: has_creator_signed_off?

If the creator has already signed off on the product, then the buyer can finalize the deal by accepting the product as is. When copying to a proposal, if any of the terms are changed, then auto_finalize is automatically set to false. Corresponds to the JSON property hasCreatorSignedOff

Returns:

  • (Boolean) 


2693
2694
2695
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2693

def has_creator_signed_off
  @has_creator_signed_off
end

#inventory_source ⇒ String

What exchange will provide this inventory (readonly, except on create). Corresponds to the JSON property inventorySource

Returns:

  • (String) 


2699
2700
2701
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2699

def inventory_source
  @inventory_source
end

#kind ⇒ String

Identifies what kind of resource this is. Value: the fixed string " adexchangebuyer#product". Corresponds to the JSON property kind

Returns:

  • (String) 


2705
2706
2707
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2705

def kind
  @kind
end

#labels ⇒ Array<Google::Apis::AdexchangebuyerV1_4::MarketplaceLabel>

Optional List of labels for the product (optional, buyer-readonly). Corresponds to the JSON property labels

Returns:



2710
2711
2712
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2710

def labels
  @labels
end

#last_update_time_ms ⇒ String

Time of last update in ms. since epoch (readonly) Corresponds to the JSON property lastUpdateTimeMs

Returns:

  • (String) 


2715
2716
2717
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2715

def last_update_time_ms
  @last_update_time_ms
end

#legacy_offer_id ⇒ String

Optional legacy offer id if this offer is a preferred deal offer. Corresponds to the JSON property legacyOfferId

Returns:

  • (String) 


2720
2721
2722
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2720

def legacy_offer_id
  @legacy_offer_id
end

#name ⇒ String

The name for this product as set by the seller. (buyer-readonly) Corresponds to the JSON property name

Returns:

  • (String) 


2725
2726
2727
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2725

def name
  @name
end

#private_auction_id ⇒ String

Optional private auction id if this offer is a private auction offer. Corresponds to the JSON property privateAuctionId

Returns:

  • (String) 


2730
2731
2732
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2730

def private_auction_id
  @private_auction_id
end

#product_id ⇒ String

The unique id for the product (readonly) Corresponds to the JSON property productId

Returns:

  • (String) 


2735
2736
2737
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2735

def product_id
  @product_id
end

#publisher_profile_id ⇒ String

Id of the publisher profile for a given seller. A (seller.account_id, publisher_profile_id) pair uniquely identifies a publisher profile. Buyers can call the PublisherProfiles::List endpoint to get a list of publisher profiles for a given seller. Corresponds to the JSON property publisherProfileId

Returns:

  • (String) 


2743
2744
2745
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2743

def publisher_profile_id
  @publisher_profile_id
end

#publisher_provided_forecast ⇒ Google::Apis::AdexchangebuyerV1_4::PublisherProvidedForecast

This message carries publisher provided forecasting information. Corresponds to the JSON property publisherProvidedForecast

Returns:



2748
2749
2750
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2748

def publisher_provided_forecast
  @publisher_provided_forecast
end

#revision_number ⇒ String

The revision number of the product. (readonly) Corresponds to the JSON property revisionNumber

Returns:

  • (String) 


2753
2754
2755
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2753

def revision_number
  @revision_number
end

#seller ⇒ Google::Apis::AdexchangebuyerV1_4::Seller

Information about the seller that created this product (readonly, except on create) Corresponds to the JSON property seller

Returns:



2759
2760
2761
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2759

def seller
  @seller
end

#shared_targetings ⇒ Array<Google::Apis::AdexchangebuyerV1_4::SharedTargeting>

Targeting that is shared between the buyer and the seller. Each targeting criteria has a specified key and for each key there is a list of inclusion value or exclusion values. (buyer-readonly) Corresponds to the JSON property sharedTargetings

Returns:



2766
2767
2768
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2766

def shared_targetings
  @shared_targetings
end

#state ⇒ String

The state of the product. (buyer-readonly) Corresponds to the JSON property state

Returns:

  • (String) 


2771
2772
2773
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2771

def state
  @state
end

#syndication_product ⇒ String

The syndication product associated with the deal. (readonly, except on create) Corresponds to the JSON property syndicationProduct

Returns:

  • (String) 


2776
2777
2778
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2776

def syndication_product
  @syndication_product
end

#terms ⇒ Google::Apis::AdexchangebuyerV1_4::DealTerms

The negotiable terms of the deal (buyer-readonly) Corresponds to the JSON property terms

Returns:



2781
2782
2783
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2781

def terms
  @terms
end

#web_property_code ⇒ String

The web property code for the seller. This field is meant to be copied over as is when creating deals. Corresponds to the JSON property webPropertyCode

Returns:

  • (String) 


2787
2788
2789
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2787

def web_property_code
  @web_property_code
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2794

def update!(**args)
  @creation_time_ms = args[:creation_time_ms] if args.key?(:creation_time_ms)
  @creator_contacts = args[:creator_contacts] if args.key?(:creator_contacts)
  @delivery_control = args[:delivery_control] if args.key?(:delivery_control)
  @flight_end_time_ms = args[:flight_end_time_ms] if args.key?(:flight_end_time_ms)
  @flight_start_time_ms = args[:flight_start_time_ms] if args.key?(:flight_start_time_ms)
  @has_creator_signed_off = args[:has_creator_signed_off] if args.key?(:has_creator_signed_off)
  @inventory_source = args[:inventory_source] if args.key?(:inventory_source)
  @kind = args[:kind] if args.key?(:kind)
  @labels = args[:labels] if args.key?(:labels)
  @last_update_time_ms = args[:last_update_time_ms] if args.key?(:last_update_time_ms)
  @legacy_offer_id = args[:legacy_offer_id] if args.key?(:legacy_offer_id)
  @name = args[:name] if args.key?(:name)
  @private_auction_id = args[:private_auction_id] if args.key?(:private_auction_id)
  @product_id = args[:product_id] if args.key?(:product_id)
  @publisher_profile_id = args[:publisher_profile_id] if args.key?(:publisher_profile_id)
  @publisher_provided_forecast = args[:publisher_provided_forecast] if args.key?(:publisher_provided_forecast)
  @revision_number = args[:revision_number] if args.key?(:revision_number)
  @seller = args[:seller] if args.key?(:seller)
  @shared_targetings = args[:shared_targetings] if args.key?(:shared_targetings)
  @state = args[:state] if args.key?(:state)
  @syndication_product = args[:syndication_product] if args.key?(:syndication_product)
  @terms = args[:terms] if args.key?(:terms)
  @web_property_code = args[:web_property_code] if args.key?(:web_property_code)
end