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.


1973
1974
1975
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1973

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

Instance Attribute Details

#buyer_private_dataGoogle::Apis::AdexchangebuyerV1_4::PrivateData

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


1842
1843
1844
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1842

def buyer_private_data
  @buyer_private_data
end

#creation_time_msString

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

Returns:

  • (String)

1847
1848
1849
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1847

def creation_time_ms
  @creation_time_ms
end

#creative_pre_approval_policyString

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

Returns:

  • (String)

1852
1853
1854
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1852

def creative_pre_approval_policy
  @creative_pre_approval_policy
end

#creative_safe_frame_compatibilityString

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

Returns:

  • (String)

1857
1858
1859
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1857

def creative_safe_frame_compatibility
  @creative_safe_frame_compatibility
end

#deal_idString

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

Returns:

  • (String)

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

def deal_id
  @deal_id
end

#deal_serving_metadataGoogle::Apis::AdexchangebuyerV1_4::DealServingMetadata

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


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

def 
  @deal_serving_metadata
end

#delivery_controlGoogle::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


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

def delivery_control
  @delivery_control
end

#external_deal_idString

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)

1882
1883
1884
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1882

def external_deal_id
  @external_deal_id
end

#flight_end_time_msString

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)

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

def flight_end_time_ms
  @flight_end_time_ms
end

#flight_start_time_msString

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)

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

def flight_start_time_ms
  @flight_start_time_ms
end

#inventory_descriptionString

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

Returns:

  • (String)

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

def inventory_description
  @inventory_description
end

#is_rfp_templateBoolean 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)

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

def is_rfp_template
  @is_rfp_template
end

#kindString

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

Returns:

  • (String)

1912
1913
1914
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1912

def kind
  @kind
end

#last_update_time_msString

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

Returns:

  • (String)

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

def last_update_time_ms
  @last_update_time_ms
end

#nameString

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

Returns:

  • (String)

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

def name
  @name
end

#product_idString

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

Returns:

  • (String)

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

def product_id
  @product_id
end

#product_revision_numberString

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

Returns:

  • (String)

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

def product_revision_number
  @product_revision_number
end

#programmatic_creative_sourceString

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)

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

def programmatic_creative_source
  @programmatic_creative_source
end

#proposal_idString

Corresponds to the JSON property proposalId

Returns:

  • (String)

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

def proposal_id
  @proposal_id
end

#seller_contactsArray<Google::Apis::AdexchangebuyerV1_4::ContactInformation>

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


1950
1951
1952
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1950

def seller_contacts
  @seller_contacts
end

#shared_targetingsArray<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


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

def shared_targetings
  @shared_targetings
end

#syndication_productString

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

Returns:

  • (String)

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

def syndication_product
  @syndication_product
end

#termsGoogle::Apis::AdexchangebuyerV1_4::DealTerms

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


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

def terms
  @terms
end

#web_property_codeString

Corresponds to the JSON property webPropertyCode

Returns:

  • (String)

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

def web_property_code
  @web_property_code
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 1978

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