Class: Google::Apis::AdexchangebuyerV1_4::MarketplaceDeal

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 proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.

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

Returns a new instance of MarketplaceDeal



2027
2028
2029
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2027

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

Instance Attribute Details

#buyer_private_data ⇒ Google::Apis::AdexchangebuyerV1_4::PrivateData

Buyer private data (hidden from seller). Corresponds to the JSON property buyerPrivateData

Returns:



1889
1890
1891
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1889

def buyer_private_data
  @buyer_private_data
end

#creation_time_ms ⇒ Fixnum

The time (ms since epoch) of the deal creation. (readonly) Corresponds to the JSON property creationTimeMs

Returns:

  • (Fixnum) 


1894
1895
1896
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1894

def creation_time_ms
  @creation_time_ms
end

#creative_pre_approval_policy ⇒ String

Specifies the creative pre-approval policy (buyer-readonly) Corresponds to the JSON property creativePreApprovalPolicy

Returns:

  • (String) 


1899
1900
1901
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1899

def creative_pre_approval_policy
  @creative_pre_approval_policy
end

#creative_safe_frame_compatibility ⇒ String

Specifies whether the creative is safeFrame compatible (buyer-readonly) Corresponds to the JSON property creativeSafeFrameCompatibility

Returns:

  • (String) 


1904
1905
1906
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1904

def creative_safe_frame_compatibility
  @creative_safe_frame_compatibility
end

#deal_id ⇒ String

A unique deal-id for the deal (readonly). Corresponds to the JSON property dealId

Returns:

  • (String) 


1909
1910
1911
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1909

def deal_id
  @deal_id
end

#deal_serving_metadata ⇒ Google::Apis::AdexchangebuyerV1_4::DealServingMetadata

Metadata about the serving status of this deal (readonly, writes via custom actions) Corresponds to the JSON property dealServingMetadata

Returns:



1915
1916
1917
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1915

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



1923
1924
1925
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1923

def delivery_control
  @delivery_control
end

#external_deal_id ⇒ String

The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly) Corresponds to the JSON property externalDealId

Returns:

  • (String) 


1929
1930
1931
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1929

def external_deal_id
  @external_deal_id
end

#flight_end_time_ms ⇒ Fixnum

Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable) Corresponds to the JSON property flightEndTimeMs

Returns:

  • (Fixnum) 


1935
1936
1937
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1935

def flight_end_time_ms
  @flight_end_time_ms
end

#flight_start_time_ms ⇒ Fixnum

Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable) Corresponds to the JSON property flightStartTimeMs

Returns:

  • (Fixnum) 


1941
1942
1943
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1941

def flight_start_time_ms
  @flight_start_time_ms
end

#inventory_description ⇒ String

Description for the deal terms. (buyer-readonly) Corresponds to the JSON property inventoryDescription

Returns:

  • (String) 


1946
1947
1948
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1946

def inventory_description
  @inventory_description
end

#is_rfp_template ⇒ Boolean Also known as: is_rfp_template?

Indicates whether the current deal is a RFP template. RFP template is created by buyer and not based on seller created products. Corresponds to the JSON property isRfpTemplate

Returns:

  • (Boolean) 


1952
1953
1954
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1952

def is_rfp_template
  @is_rfp_template
end

#is_setup_complete ⇒ Boolean Also known as: is_setup_complete?

True, if the buyside inventory setup is complete for this deal. (readonly, except via OrderSetupCompleted action) Corresponds to the JSON property isSetupComplete

Returns:

  • (Boolean) 


1959
1960
1961
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1959

def is_setup_complete
  @is_setup_complete
end

#kind ⇒ String

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

Returns:

  • (String) 


1966
1967
1968
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1966

def kind
  @kind
end

#last_update_time_ms ⇒ Fixnum

The time (ms since epoch) when the deal was last updated. (readonly) Corresponds to the JSON property lastUpdateTimeMs

Returns:

  • (Fixnum) 


1971
1972
1973
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1971

def last_update_time_ms
  @last_update_time_ms
end

#name ⇒ String

The name of the deal. (updatable) Corresponds to the JSON property name

Returns:

  • (String) 


1976
1977
1978
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1976

def name
  @name
end

#product_id ⇒ String

The product-id from which this deal was created. (readonly, except on create) Corresponds to the JSON property productId

Returns:

  • (String) 


1981
1982
1983
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1981

def product_id
  @product_id
end

#product_revision_number ⇒ Fixnum

The revision number of the product that the deal was created from (readonly, except on create) Corresponds to the JSON property productRevisionNumber

Returns:

  • (Fixnum) 


1987
1988
1989
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1987

def product_revision_number
  @product_revision_number
end

#programmatic_creative_source ⇒ String

Specifies the creative source for programmatic deals, PUBLISHER means creative is provided by seller and ADVERTISR means creative is provided by buyer. ( buyer-readonly) Corresponds to the JSON property programmaticCreativeSource

Returns:

  • (String) 


1994
1995
1996
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1994

def programmatic_creative_source
  @programmatic_creative_source
end

#proposal_id ⇒ String

Corresponds to the JSON property proposalId

Returns:

  • (String) 


1999
2000
2001
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1999

def proposal_id
  @proposal_id
end

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

Optional Seller contact information for the deal (buyer-readonly) Corresponds to the JSON property sellerContacts

Returns:



2004
2005
2006
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2004

def seller_contacts
  @seller_contacts
end

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

The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. (updatable) Corresponds to the JSON property sharedTargetings

Returns:



2010
2011
2012
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2010

def shared_targetings
  @shared_targetings
end

#syndication_product ⇒ String

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

Returns:

  • (String) 


2015
2016
2017
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2015

def syndication_product
  @syndication_product
end

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

The negotiable terms of the deal. (updatable) Corresponds to the JSON property terms

Returns:



2020
2021
2022
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2020

def terms
  @terms
end

#web_property_code ⇒ String

Corresponds to the JSON property webPropertyCode

Returns:

  • (String) 


2025
2026
2027
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2025

def web_property_code
  @web_property_code
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2032

def update!(**args)
  @buyer_private_data = args[:buyer_private_data] if args.key?(:buyer_private_data)
  @creation_time_ms = args[:creation_time_ms] if args.key?(:creation_time_ms)
  @creative_pre_approval_policy = args[:creative_pre_approval_policy] if args.key?(:creative_pre_approval_policy)
  @creative_safe_frame_compatibility = args[:creative_safe_frame_compatibility] if args.key?(:creative_safe_frame_compatibility)
  @deal_id = args[:deal_id] if args.key?(:deal_id)
  @deal_serving_metadata = args[:deal_serving_metadata] if args.key?(:deal_serving_metadata)
  @delivery_control = args[:delivery_control] if args.key?(:delivery_control)
  @external_deal_id = args[:external_deal_id] if args.key?(:external_deal_id)
  @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)
  @inventory_description = args[:inventory_description] if args.key?(:inventory_description)
  @is_rfp_template = args[:is_rfp_template] if args.key?(:is_rfp_template)
  @is_setup_complete = args[:is_setup_complete] if args.key?(:is_setup_complete)
  @kind = args[:kind] if args.key?(:kind)
  @last_update_time_ms = args[:last_update_time_ms] if args.key?(:last_update_time_ms)
  @name = args[:name] if args.key?(:name)
  @product_id = args[:product_id] if args.key?(:product_id)
  @product_revision_number = args[:product_revision_number] if args.key?(:product_revision_number)
  @programmatic_creative_source = args[:programmatic_creative_source] if args.key?(:programmatic_creative_source)
  @proposal_id = args[:proposal_id] if args.key?(:proposal_id)
  @seller_contacts = args[:seller_contacts] if args.key?(:seller_contacts)
  @shared_targetings = args[:shared_targetings] if args.key?(:shared_targetings)
  @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