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



2914
2915
2916
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2914

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

Instance Attribute Details

#creation_time_ms ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2778
2779
2780
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2778

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:



2783
2784
2785
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2783

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:



2791
2792
2793
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2791

def delivery_control
  @delivery_control
end

#flight_end_time_ms ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2796
2797
2798
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2796

def flight_end_time_ms
  @flight_end_time_ms
end

#flight_start_time_ms ⇒ Fixnum

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:

  • (Fixnum) 


2802
2803
2804
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2802

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) 


2810
2811
2812
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2810

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) 


2816
2817
2818
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2816

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) 


2822
2823
2824
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2822

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:



2827
2828
2829
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2827

def labels
  @labels
end

#last_update_time_ms ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2832
2833
2834
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2832

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) 


2837
2838
2839
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2837

def legacy_offer_id
  @legacy_offer_id
end

#marketplace_publisher_profile_id ⇒ String

Marketplace publisher profile Id. This Id differs from the regular publisher_profile_id in that 1. This is a new id, the old Id will be deprecated in 2017. 2. This id uniquely identifies a publisher profile by itself. Corresponds to the JSON property marketplacePublisherProfileId

Returns:

  • (String) 


2845
2846
2847
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2845

def marketplace_publisher_profile_id
  @marketplace_publisher_profile_id
end

#name ⇒ String

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

Returns:

  • (String) 


2850
2851
2852
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2850

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) 


2855
2856
2857
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2855

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) 


2860
2861
2862
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2860

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) 


2868
2869
2870
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2868

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:



2873
2874
2875
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2873

def publisher_provided_forecast
  @publisher_provided_forecast
end

#revision_number ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2878
2879
2880
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2878

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:



2884
2885
2886
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2884

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:



2891
2892
2893
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2891

def shared_targetings
  @shared_targetings
end

#state ⇒ String

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

Returns:

  • (String) 


2896
2897
2898
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2896

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) 


2901
2902
2903
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2901

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:



2906
2907
2908
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2906

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) 


2912
2913
2914
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2912

def web_property_code
  @web_property_code
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2919

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)
  @marketplace_publisher_profile_id = args[:marketplace_publisher_profile_id] if args.key?(:marketplace_publisher_profile_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