Class: Google::Apis::AuthorizedbuyersmarketplaceV1::Deal

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

A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Deal

Returns a new instance of Deal.



658
659
660
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 658

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) 


536
537
538
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 536

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) 


542
543
544
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 542

def buyer
  @buyer
end

#client ⇒ String

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

Returns:

  • (String) 


548
549
550
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 548

def client
  @client
end

#create_time ⇒ String

Output only. The time of the deal creation. Corresponds to the JSON property createTime

Returns:

  • (String) 


553
554
555
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 553

def create_time
  @create_time
end

#creative_requirements ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::CreativeRequirements

Message captures data about the creatives in the deal. Corresponds to the JSON property creativeRequirements

Returns:



558
559
560
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 558

def creative_requirements
  @creative_requirements
end

#deal_type ⇒ String

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

Returns:

  • (String) 


563
564
565
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 563

def deal_type
  @deal_type
end

#delivery_control ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::DeliveryControl

Message contains details about how the deal will be paced. Corresponds to the JSON property deliveryControl

Returns:



568
569
570
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 568

def delivery_control
  @delivery_control
end

#description ⇒ String

Output only. Free text description for the deal terms. Corresponds to the JSON property description

Returns:

  • (String) 


573
574
575
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 573

def description
  @description
end

#display_name ⇒ String

Output only. The name of the deal. 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 deal. Corresponds to the JSON property displayName

Returns:

  • (String) 


580
581
582
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 580

def display_name
  @display_name
end

#estimated_gross_spend ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::Money

Represents an amount of money with its currency type. Corresponds to the JSON property estimatedGrossSpend

Returns:



585
586
587
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 585

def estimated_gross_spend
  @estimated_gross_spend
end

#flight_end_time ⇒ String

Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals. Corresponds to the JSON property flightEndTime

Returns:

  • (String) 


591
592
593
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 591

def flight_end_time
  @flight_end_time
end

#flight_start_time ⇒ String

Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. Corresponds to the JSON property flightStartTime

Returns:

  • (String) 


599
600
601
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 599

def flight_start_time
  @flight_start_time
end

#name ⇒ String

Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/accountId/proposals/proposalId/ deals/dealId Corresponds to the JSON property name

Returns:

  • (String) 


606
607
608
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 606

def name
  @name
end

#preferred_deal_terms ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::PreferredDealTerms

Pricing terms for Preferred Deals. Corresponds to the JSON property preferredDealTerms

Returns:



611
612
613
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 611

def preferred_deal_terms
  @preferred_deal_terms
end

#private_auction_terms ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::PrivateAuctionTerms

Pricing terms for Private Auctions. Corresponds to the JSON property privateAuctionTerms

Returns:



616
617
618
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 616

def private_auction_terms
  @private_auction_terms
end

#programmatic_guaranteed_terms ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::ProgrammaticGuaranteedTerms

Pricing terms for Programmatic Guaranteed Deals. Corresponds to the JSON property programmaticGuaranteedTerms

Returns:



621
622
623
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 621

def programmatic_guaranteed_terms
  @programmatic_guaranteed_terms
end

#proposal_revision ⇒ Fixnum

Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to 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) 


631
632
633
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 631

def proposal_revision
  @proposal_revision
end

#publisher_profile ⇒ String

Immutable. Reference to the seller on the deal. Format: buyers/ buyerAccountId/publisherProfiles/publisherProfileId` Corresponds to the JSON propertypublisherProfile`

Returns:

  • (String) 


637
638
639
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 637

def publisher_profile
  @publisher_profile
end

#seller_time_zone ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::TimeZone

Represents a time zone from the IANA Time Zone Database. Corresponds to the JSON property sellerTimeZone

Returns:



643
644
645
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 643

def seller_time_zone
  @seller_time_zone
end

#targeting ⇒ Google::Apis::AuthorizedbuyersmarketplaceV1::MarketplaceTargeting

Targeting represents different criteria that can be used to target inventory. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. Corresponds to the JSON property targeting

Returns:



651
652
653
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 651

def targeting
  @targeting
end

#update_time ⇒ String

Output only. The time when the deal was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


656
657
658
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 656

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/google/apis/authorizedbuyersmarketplace_v1/classes.rb', line 663

def update!(**args)
  @billed_buyer = args[:billed_buyer] if args.key?(:billed_buyer)
  @buyer = args[:buyer] if args.key?(:buyer)
  @client = args[:client] if args.key?(:client)
  @create_time = args[:create_time] if args.key?(:create_time)
  @creative_requirements = args[:creative_requirements] if args.key?(:creative_requirements)
  @deal_type = args[:deal_type] if args.key?(:deal_type)
  @delivery_control = args[:delivery_control] if args.key?(:delivery_control)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @estimated_gross_spend = args[:estimated_gross_spend] if args.key?(:estimated_gross_spend)
  @flight_end_time = args[:flight_end_time] if args.key?(:flight_end_time)
  @flight_start_time = args[:flight_start_time] if args.key?(:flight_start_time)
  @name = args[:name] if args.key?(:name)
  @preferred_deal_terms = args[:preferred_deal_terms] if args.key?(:preferred_deal_terms)
  @private_auction_terms = args[:private_auction_terms] if args.key?(:private_auction_terms)
  @programmatic_guaranteed_terms = args[:programmatic_guaranteed_terms] if args.key?(:programmatic_guaranteed_terms)
  @proposal_revision = args[:proposal_revision] if args.key?(:proposal_revision)
  @publisher_profile = args[:publisher_profile] if args.key?(:publisher_profile)
  @seller_time_zone = args[:seller_time_zone] if args.key?(:seller_time_zone)
  @targeting = args[:targeting] if args.key?(:targeting)
  @update_time = args[:update_time] if args.key?(:update_time)
end