Class: Google::Apis::AndroidpublisherV3::ProductPurchase
- Inherits:
-
Object
- Object
- Google::Apis::AndroidpublisherV3::ProductPurchase
- 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
A ProductPurchase resource indicates the status of a user's inapp product purchase.
Instance Attribute Summary collapse
-
#acknowledgement_state ⇒ Fixnum
The acknowledgement state of the inapp product.
-
#consumption_state ⇒ Fixnum
The consumption state of the inapp product.
-
#developer_payload ⇒ String
A developer-specified string that contains supplemental information about an order.
-
#kind ⇒ String
This kind represents an inappPurchase object in the androidpublisher service.
-
#obfuscated_external_account_id ⇒ String
An obfuscated version of the id that is uniquely associated with the user's account in your app.
-
#obfuscated_external_profile_id ⇒ String
An obfuscated version of the id that is uniquely associated with the user's profile in your app.
-
#order_id ⇒ String
The order id associated with the purchase of the inapp product.
-
#product_id ⇒ String
The inapp product SKU.
-
#purchase_state ⇒ Fixnum
The purchase state of the order.
-
#purchase_time_millis ⇒ Fixnum
The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970).
-
#purchase_token ⇒ String
The purchase token generated to identify this purchase.
-
#purchase_type ⇒ Fixnum
The type of purchase of the inapp product.
-
#quantity ⇒ Fixnum
The quantity associated with the purchase of the inapp product.
-
#region_code ⇒ String
ISO 3166-1 alpha-2 billing region code of the user at the time the product was granted.
Instance Method Summary collapse
-
#initialize(**args) ⇒ ProductPurchase
constructor
A new instance of ProductPurchase.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ ProductPurchase
Returns a new instance of ProductPurchase.
1659 1660 1661 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 1659 def initialize(**args) update!(**args) end |
Instance Attribute Details
#acknowledgement_state ⇒ Fixnum
The acknowledgement state of the inapp product. Possible values are: 0. Yet to
be acknowledged 1. Acknowledged
Corresponds to the JSON property acknowledgementState
1577 1578 1579 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 1577 def acknowledgement_state @acknowledgement_state end |
#consumption_state ⇒ Fixnum
The consumption state of the inapp product. Possible values are: 0. Yet to be
consumed 1. Consumed
Corresponds to the JSON property consumptionState
1583 1584 1585 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 1583 def consumption_state @consumption_state end |
#developer_payload ⇒ String
A developer-specified string that contains supplemental information about an
order.
Corresponds to the JSON property developerPayload
1589 1590 1591 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 1589 def developer_payload @developer_payload end |
#kind ⇒ String
This kind represents an inappPurchase object in the androidpublisher service.
Corresponds to the JSON property kind
1594 1595 1596 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 1594 def kind @kind end |
#obfuscated_external_account_id ⇒ String
An obfuscated version of the id that is uniquely associated with the user's
account in your app. Only present if specified using https://developer.android.
com/reference/com/android/billingclient/api/BillingFlowParams.Builder#
setobfuscatedaccountid when the purchase was made.
Corresponds to the JSON property obfuscatedExternalAccountId
1602 1603 1604 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 1602 def @obfuscated_external_account_id end |
#obfuscated_external_profile_id ⇒ String
An obfuscated version of the id that is uniquely associated with the user's
profile in your app. Only present if specified using https://developer.android.
com/reference/com/android/billingclient/api/BillingFlowParams.Builder#
setobfuscatedprofileid when the purchase was made.
Corresponds to the JSON property obfuscatedExternalProfileId
1610 1611 1612 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 1610 def @obfuscated_external_profile_id end |
#order_id ⇒ String
The order id associated with the purchase of the inapp product.
Corresponds to the JSON property orderId
1615 1616 1617 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 1615 def order_id @order_id end |
#product_id ⇒ String
The inapp product SKU.
Corresponds to the JSON property productId
1620 1621 1622 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 1620 def product_id @product_id end |
#purchase_state ⇒ Fixnum
The purchase state of the order. Possible values are: 0. Purchased 1. Canceled
- Pending
Corresponds to the JSON property
purchaseState
1626 1627 1628 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 1626 def purchase_state @purchase_state end |
#purchase_time_millis ⇒ Fixnum
The time the product was purchased, in milliseconds since the epoch (Jan 1,
1970).
Corresponds to the JSON property purchaseTimeMillis
1632 1633 1634 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 1632 def purchase_time_millis @purchase_time_millis end |
#purchase_token ⇒ String
The purchase token generated to identify this purchase.
Corresponds to the JSON property purchaseToken
1637 1638 1639 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 1637 def purchase_token @purchase_token end |
#purchase_type ⇒ Fixnum
The type of purchase of the inapp product. This field is only set if this
purchase was not made using the standard in-app billing flow. Possible values
are: 0. Test (i.e. purchased from a license testing account) 1. Promo (i.e.
purchased using a promo code) 2. Rewarded (i.e. from watching a video ad
instead of paying)
Corresponds to the JSON property purchaseType
1646 1647 1648 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 1646 def purchase_type @purchase_type end |
#quantity ⇒ Fixnum
The quantity associated with the purchase of the inapp product.
Corresponds to the JSON property quantity
1651 1652 1653 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 1651 def quantity @quantity end |
#region_code ⇒ String
ISO 3166-1 alpha-2 billing region code of the user at the time the product was
granted.
Corresponds to the JSON property regionCode
1657 1658 1659 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 1657 def region_code @region_code end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 1664 def update!(**args) @acknowledgement_state = args[:acknowledgement_state] if args.key?(:acknowledgement_state) @consumption_state = args[:consumption_state] if args.key?(:consumption_state) @developer_payload = args[:developer_payload] if args.key?(:developer_payload) @kind = args[:kind] if args.key?(:kind) @obfuscated_external_account_id = args[:obfuscated_external_account_id] if args.key?(:obfuscated_external_account_id) @obfuscated_external_profile_id = args[:obfuscated_external_profile_id] if args.key?(:obfuscated_external_profile_id) @order_id = args[:order_id] if args.key?(:order_id) @product_id = args[:product_id] if args.key?(:product_id) @purchase_state = args[:purchase_state] if args.key?(:purchase_state) @purchase_time_millis = args[:purchase_time_millis] if args.key?(:purchase_time_millis) @purchase_token = args[:purchase_token] if args.key?(:purchase_token) @purchase_type = args[:purchase_type] if args.key?(:purchase_type) @quantity = args[:quantity] if args.key?(:quantity) @region_code = args[:region_code] if args.key?(:region_code) end |