Class: Google::Apis::AuthorizedbuyersmarketplaceV1::Proposal

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb,
lib/google/apis/authorizedbuyersmarketplace_v1/representations.rb,
lib/google/apis/authorizedbuyersmarketplace_v1/representations.rb more...

Overview

Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Proposal

Returns a new instance of Proposal.

[View source]

1635
1636
1637
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1635

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

Instance Attribute Details

#billed_buyer ⇒ String

Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : buyers/buyerAccountId` Corresponds to the JSON propertybilledBuyer`

Returns:

  • (String) 

1521
1522
1523
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1521

def billed_buyer
  @billed_buyer
end

#buyer ⇒ String

Output only. Refers to a buyer in The Realtime-bidding API. Format: buyers/ buyerAccountId` Corresponds to the JSON propertybuyer`

Returns:

  • (String) 

1527
1528
1529
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1527

def buyer
  @buyer
end

#buyer_contacts ⇒ Array<Google::Apis::AuthorizedbuyersmarketplaceV1::Contact>

Contact information for the buyer. Corresponds to the JSON property buyerContacts

Returns:


1532
1533
1534
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1532

def buyer_contacts
  @buyer_contacts
end

#buyer_private_data ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::PrivateData

Buyers are allowed to store certain types of private data in a proposal or deal. Corresponds to the JSON property buyerPrivateData

Returns:


1538
1539
1540
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1538

def buyer_private_data
  @buyer_private_data
end

#client ⇒ String

Output only. Refers to a Client. Format: buyers/buyerAccountId/clients/ clientAccountid` Corresponds to the JSON propertyclient`

Returns:

  • (String) 

1544
1545
1546
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1544

def client
  @client
end

#deal_type ⇒ String

Output only. Type of deal the proposal contains. Corresponds to the JSON property dealType

Returns:

  • (String) 

1549
1550
1551
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1549

def deal_type
  @deal_type
end

#display_name ⇒ String

Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal. Corresponds to the JSON property displayName

Returns:

  • (String) 

1557
1558
1559
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1557

def display_name
  @display_name
end

#is_renegotiating ⇒ Boolean Also known as: is_renegotiating?

Output only. True if the proposal was previously finalized and is now being renegotiated. Corresponds to the JSON property isRenegotiating

Returns:

  • (Boolean) 

1563
1564
1565
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1563

def is_renegotiating
  @is_renegotiating
end

#last_updater_or_commentor_role ⇒ String

Output only. The role of the last user that either updated the proposal or left a comment. Corresponds to the JSON property lastUpdaterOrCommentorRole

Returns:

  • (String) 

1570
1571
1572
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1570

def last_updater_or_commentor_role
  @last_updater_or_commentor_role
end

#name ⇒ String

Immutable. The name of the proposal serving as a unique identifier. Format: buyers/accountId/proposals/proposalId Corresponds to the JSON property name

Returns:

  • (String) 

1576
1577
1578
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1576

def name
  @name
end

#notes ⇒ Array<Google::Apis::AuthorizedbuyersmarketplaceV1::Note>

A list of notes from the buyer and the seller attached to this proposal. Corresponds to the JSON property notes

Returns:


1581
1582
1583
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1581

def notes
  @notes
end

#originator_role ⇒ String

Output only. Indicates whether the buyer/seller created the proposal. Corresponds to the JSON property originatorRole

Returns:

  • (String) 

1586
1587
1588
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1586

def originator_role
  @originator_role
end

#pausing_consented ⇒ Boolean Also known as: pausing_consented?

Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers. Corresponds to the JSON property pausingConsented

Returns:

  • (Boolean) 

1592
1593
1594
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1592

def pausing_consented
  @pausing_consented
end

#proposal_revision ⇒ Fixnum

Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made. Corresponds to the JSON property proposalRevision

Returns:

  • (Fixnum) 

1603
1604
1605
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1603

def proposal_revision
  @proposal_revision
end

#publisher_profile ⇒ String

Immutable. Reference to the seller on the proposal. Format: buyers/ buyerAccountId/publisherProfiles/publisherProfileId`Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. Corresponds to the JSON propertypublisherProfile`

Returns:

  • (String) 

1611
1612
1613
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1611

def publisher_profile
  @publisher_profile
end

#seller_contacts ⇒ Array<Google::Apis::AuthorizedbuyersmarketplaceV1::Contact>

Output only. Contact information for the seller. Corresponds to the JSON property sellerContacts

Returns:


1616
1617
1618
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1616

def seller_contacts
  @seller_contacts
end

#state ⇒ String

Output only. Indicates the state of the proposal. Corresponds to the JSON property state

Returns:

  • (String) 

1621
1622
1623
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1621

def state
  @state
end

#terms_and_conditions ⇒ String

Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it. Corresponds to the JSON property termsAndConditions

Returns:

  • (String) 

1628
1629
1630
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1628

def terms_and_conditions
  @terms_and_conditions
end

#update_time ⇒ String

Output only. The time when the proposal was last revised. Corresponds to the JSON property updateTime

Returns:

  • (String) 

1633
1634
1635
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1633

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1640

def update!(**args)
  @billed_buyer = args[:billed_buyer] if args.key?(:billed_buyer)
  @buyer = args[:buyer] if args.key?(:buyer)
  @buyer_contacts = args[:buyer_contacts] if args.key?(:buyer_contacts)
  @buyer_private_data = args[:buyer_private_data] if args.key?(:buyer_private_data)
  @client = args[:client] if args.key?(:client)
  @deal_type = args[:deal_type] if args.key?(:deal_type)
  @display_name = args[:display_name] if args.key?(:display_name)
  @is_renegotiating = args[:is_renegotiating] if args.key?(:is_renegotiating)
  @last_updater_or_commentor_role = args[:last_updater_or_commentor_role] if args.key?(:last_updater_or_commentor_role)
  @name = args[:name] if args.key?(:name)
  @notes = args[:notes] if args.key?(:notes)
  @originator_role = args[:originator_role] if args.key?(:originator_role)
  @pausing_consented = args[:pausing_consented] if args.key?(:pausing_consented)
  @proposal_revision = args[:proposal_revision] if args.key?(:proposal_revision)
  @publisher_profile = args[:publisher_profile] if args.key?(:publisher_profile)
  @seller_contacts = args[:seller_contacts] if args.key?(:seller_contacts)
  @state = args[:state] if args.key?(:state)
  @terms_and_conditions = args[:terms_and_conditions] if args.key?(:terms_and_conditions)
  @update_time = args[:update_time] if args.key?(:update_time)
end