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 more...

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

[View source]

2008
2009
2010
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2008

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:


1870
1871
1872
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1870

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) 

1875
1876
1877
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1875

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) 

1880
1881
1882
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1880

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) 

1885
1886
1887
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1885

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) 

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

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:


1896
1897
1898
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1896

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:


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

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) 

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

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) 

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

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) 

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

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) 

1927
1928
1929
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1927

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) 

1933
1934
1935
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1933

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) 

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

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) 

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

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) 

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

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) 

1957
1958
1959
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1957

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) 

1962
1963
1964
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1962

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) 

1968
1969
1970
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1968

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) 

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

def programmatic_creative_source
  @programmatic_creative_source
end

#proposal_id ⇒ String

Corresponds to the JSON property proposalId

Returns:

  • (String) 

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

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:


1985
1986
1987
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1985

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:


1991
1992
1993
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1991

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) 

1996
1997
1998
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1996

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:


2001
2002
2003
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2001

def terms
  @terms
end

#web_property_code ⇒ String

Corresponds to the JSON property webPropertyCode

Returns:

  • (String) 

2006
2007
2008
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2006

def web_property_code
  @web_property_code
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2013

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
x

Warning: This is not the latest release.

Privacy · Terms