Class: Google::Apis::AndroidpublisherV3::Order

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

Overview

The Order resource encapsulates comprehensive information about a transaction made on Google Play. It includes a variety of attributes that provide details about the order itself, the products purchased, and the history of events related to the order. The Orders APIs provide real-time access to your order data within the Google Play ecosystem. You can retrieve detailed information and metadata for both one-time and recurring orders, including transaction details like charges, taxes, and refunds, as well as metadata such as pricing phases for subscriptions. The Orders APIs let you automate tasks related to order management, reducing the need for manual checks via the Play Developer Console. The following are some of the use cases for this API: + Real-time order data retrieval - Get order details and metadata immediately after a purchase using an order ID. + Order update synchronization - Periodically sync order updates to maintain an up-to-date record of order information. Note: + The Orders API calls count towards your Play Developer API quota, which defaults to 200K daily, and may be insufficient to sync extensive order histories. + A maximum of 1000 orders can be retrieved per call. Using larger page sizes is recommended to minimize quota usage. Check your quota in the Cloud Console and request more if required.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Order

Returns a new instance of Order.



6518
6519
6520
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6518

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

Instance Attribute Details

#buyer_address ⇒ Google::Apis::AndroidpublisherV3::BuyerAddress

Address information for the customer, for use in tax computation. Corresponds to the JSON property buyerAddress

Returns:



6450
6451
6452
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6450

def buyer_address
  @buyer_address
end

#create_time ⇒ String

The time when the order was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


6455
6456
6457
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6455

def create_time
  @create_time
end

#developer_revenue_in_buyer_currency ⇒ Google::Apis::AndroidpublisherV3::Money

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

Returns:



6460
6461
6462
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6460

def developer_revenue_in_buyer_currency
  @developer_revenue_in_buyer_currency
end

#last_event_time ⇒ String

The time of the last event that occurred on the order. Corresponds to the JSON property lastEventTime

Returns:

  • (String) 


6465
6466
6467
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6465

def last_event_time
  @last_event_time
end

#line_items ⇒ Array<Google::Apis::AndroidpublisherV3::LineItem>

The individual line items making up this order. Corresponds to the JSON property lineItems

Returns:



6470
6471
6472
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6470

def line_items
  @line_items
end

#order_details ⇒ Google::Apis::AndroidpublisherV3::OrderDetails

Detailed information about the order at creation time. Corresponds to the JSON property orderDetails

Returns:



6475
6476
6477
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6475

def order_details
  @order_details
end

#order_history ⇒ Google::Apis::AndroidpublisherV3::OrderHistory

Details about events which modified the order. Corresponds to the JSON property orderHistory

Returns:



6480
6481
6482
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6480

def order_history
  @order_history
end

#order_id ⇒ String

The order ID. Corresponds to the JSON property orderId

Returns:

  • (String) 


6485
6486
6487
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6485

def order_id
  @order_id
end

#points_details ⇒ Google::Apis::AndroidpublisherV3::PointsDetails

Details relating to any Play Points applied to an order. Corresponds to the JSON property pointsDetails

Returns:



6490
6491
6492
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6490

def points_details
  @points_details
end

#purchase_token ⇒ String

The token provided to the user's device when the subscription or item was purchased. Corresponds to the JSON property purchaseToken

Returns:

  • (String) 


6496
6497
6498
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6496

def purchase_token
  @purchase_token
end

#sales_channel ⇒ String

The originating sales channel of the order. Corresponds to the JSON property salesChannel

Returns:

  • (String) 


6501
6502
6503
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6501

def sales_channel
  @sales_channel
end

#state ⇒ String

The state of the order. Corresponds to the JSON property state

Returns:

  • (String) 


6506
6507
6508
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6506

def state
  @state
end

#tax ⇒ Google::Apis::AndroidpublisherV3::Money

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

Returns:



6511
6512
6513
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6511

def tax
  @tax
end

#total ⇒ Google::Apis::AndroidpublisherV3::Money

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

Returns:



6516
6517
6518
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6516

def total
  @total
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6523

def update!(**args)
  @buyer_address = args[:buyer_address] if args.key?(:buyer_address)
  @create_time = args[:create_time] if args.key?(:create_time)
  @developer_revenue_in_buyer_currency = args[:developer_revenue_in_buyer_currency] if args.key?(:developer_revenue_in_buyer_currency)
  @last_event_time = args[:last_event_time] if args.key?(:last_event_time)
  @line_items = args[:line_items] if args.key?(:line_items)
  @order_details = args[:order_details] if args.key?(:order_details)
  @order_history = args[:order_history] if args.key?(:order_history)
  @order_id = args[:order_id] if args.key?(:order_id)
  @points_details = args[:points_details] if args.key?(:points_details)
  @purchase_token = args[:purchase_token] if args.key?(:purchase_token)
  @sales_channel = args[:sales_channel] if args.key?(:sales_channel)
  @state = args[:state] if args.key?(:state)
  @tax = args[:tax] if args.key?(:tax)
  @total = args[:total] if args.key?(:total)
end