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.



1901
1902
1903
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1901

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:



1777
1778
1779
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1777

def buyer_private_data
  @buyer_private_data
end

#creation_time_ms ⇒ String

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

Returns:

  • (String) 


1782
1783
1784
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1782

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) 


1787
1788
1789
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1787

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) 


1792
1793
1794
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1792

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) 


1797
1798
1799
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1797

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:



1803
1804
1805
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1803

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:



1811
1812
1813
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1811

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) 


1817
1818
1819
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1817

def external_deal_id
  @external_deal_id
end

#flight_end_time_ms ⇒ String

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:

  • (String) 


1823
1824
1825
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1823

def flight_end_time_ms
  @flight_end_time_ms
end

#flight_start_time_ms ⇒ String

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:

  • (String) 


1829
1830
1831
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1829

def flight_start_time_ms
  @flight_start_time_ms
end

#inventory_description ⇒ String

Description for the deal terms. (updatable) Corresponds to the JSON property inventoryDescription

Returns:

  • (String) 


1834
1835
1836
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1834

def inventory_description
  @inventory_description
end

#kind ⇒ String

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

Returns:

  • (String) 


1840
1841
1842
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1840

def kind
  @kind
end

#last_update_time_ms ⇒ String

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

Returns:

  • (String) 


1845
1846
1847
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1845

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) 


1850
1851
1852
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1850

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) 


1855
1856
1857
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1855

def product_id
  @product_id
end

#product_revision_number ⇒ String

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

Returns:

  • (String) 


1861
1862
1863
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1861

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) 


1868
1869
1870
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1868

def programmatic_creative_source
  @programmatic_creative_source
end

#proposal_id ⇒ String

Corresponds to the JSON property proposalId

Returns:

  • (String) 


1873
1874
1875
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1873

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:



1878
1879
1880
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1878

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:



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

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) 


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

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:



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

def terms
  @terms
end

#web_property_code ⇒ String

Corresponds to the JSON property webPropertyCode

Returns:

  • (String) 


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

def web_property_code
  @web_property_code
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1906

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)
  @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