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

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.



1745
1746
1747
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1745

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

Instance Attribute Details

#billed_buyerString

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)


1631
1632
1633
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1631

def billed_buyer
  @billed_buyer
end

#buyerString

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

Returns:

  • (String)


1637
1638
1639
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1637

def buyer
  @buyer
end

#buyer_contactsArray<Google::Apis::AuthorizedbuyersmarketplaceV1::Contact>

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



1642
1643
1644
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1642

def buyer_contacts
  @buyer_contacts
end

#buyer_private_dataGoogle::Apis::AuthorizedbuyersmarketplaceV1::PrivateData

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



1648
1649
1650
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1648

def buyer_private_data
  @buyer_private_data
end

#clientString

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

Returns:

  • (String)


1654
1655
1656
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1654

def client
  @client
end

#deal_typeString

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

Returns:

  • (String)


1659
1660
1661
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1659

def deal_type
  @deal_type
end

#display_nameString

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)


1667
1668
1669
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1667

def display_name
  @display_name
end

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


1673
1674
1675
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1673

def is_renegotiating
  @is_renegotiating
end

#last_updater_or_commentor_roleString

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)


1680
1681
1682
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1680

def last_updater_or_commentor_role
  @last_updater_or_commentor_role
end

#nameString

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

Returns:

  • (String)


1686
1687
1688
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1686

def name
  @name
end

#notesArray<Google::Apis::AuthorizedbuyersmarketplaceV1::Note>

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



1691
1692
1693
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1691

def notes
  @notes
end

#originator_roleString

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

Returns:

  • (String)


1696
1697
1698
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1696

def originator_role
  @originator_role
end

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


1702
1703
1704
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1702

def pausing_consented
  @pausing_consented
end

#proposal_revisionFixnum

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)


1713
1714
1715
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1713

def proposal_revision
  @proposal_revision
end

#publisher_profileString

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)


1721
1722
1723
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1721

def publisher_profile
  @publisher_profile
end

#seller_contactsArray<Google::Apis::AuthorizedbuyersmarketplaceV1::Contact>

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



1726
1727
1728
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1726

def seller_contacts
  @seller_contacts
end

#stateString

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

Returns:

  • (String)


1731
1732
1733
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1731

def state
  @state
end

#terms_and_conditionsString

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)


1738
1739
1740
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1738

def terms_and_conditions
  @terms_and_conditions
end

#update_timeString

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

Returns:

  • (String)


1743
1744
1745
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1743

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 1750

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