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



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

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) 


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

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:



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

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:



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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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:



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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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:



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

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) 


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

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:



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

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:



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

def shared_targetings
  @shared_targetings
end

#state ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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:



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

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) 


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

def web_property_code
  @web_property_code
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2918
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
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2918

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