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

Constructor Details

#initialize(**args) ⇒ Product

Returns a new instance of Product.



3058
3059
3060
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3058

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

Instance Attribute Details

#billed_buyer ⇒ Google::Apis::AdexchangebuyerV1_4::Buyer

The billed buyer corresponding to the buyer that created the offer. (readonly, except on create) Corresponds to the JSON property billedBuyer

Returns:



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

def billed_buyer
  @billed_buyer
end

#buyer ⇒ Google::Apis::AdexchangebuyerV1_4::Buyer

The buyer that created the offer if this is a buyer initiated offer (readonly, except on create) Corresponds to the JSON property buyer

Returns:



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

def buyer
  @buyer
end

#creation_time_ms ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2917
2918
2919
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2917

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:



2922
2923
2924
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2922

def creator_contacts
  @creator_contacts
end

#creator_role ⇒ String

The role that created the offer. Set to BUYER for buyer initiated offers. Corresponds to the JSON property creatorRole

Returns:

  • (String) 


2927
2928
2929
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2927

def creator_role
  @creator_role
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:



2935
2936
2937
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2935

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) 


2940
2941
2942
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2940

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) 


2946
2947
2948
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2946

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) 


2954
2955
2956
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2954

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) 


2960
2961
2962
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2960

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) 


2966
2967
2968
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2966

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:



2971
2972
2973
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2971

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) 


2976
2977
2978
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2976

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) 


2981
2982
2983
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2981

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) 


2989
2990
2991
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2989

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) 


2994
2995
2996
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2994

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) 


2999
3000
3001
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2999

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) 


3004
3005
3006
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3004

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) 


3012
3013
3014
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3012

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:



3017
3018
3019
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3017

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) 


3022
3023
3024
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3022

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:



3028
3029
3030
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3028

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:



3035
3036
3037
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3035

def shared_targetings
  @shared_targetings
end

#state ⇒ String

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

Returns:

  • (String) 


3040
3041
3042
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3040

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) 


3045
3046
3047
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3045

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:



3050
3051
3052
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3050

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) 


3056
3057
3058
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3056

def web_property_code
  @web_property_code
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 3063

def update!(**args)
  @billed_buyer = args[:billed_buyer] if args.key?(:billed_buyer)
  @buyer = args[:buyer] if args.key?(:buyer)
  @creation_time_ms = args[:creation_time_ms] if args.key?(:creation_time_ms)
  @creator_contacts = args[:creator_contacts] if args.key?(:creator_contacts)
  @creator_role = args[:creator_role] if args.key?(:creator_role)
  @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