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.
2596 2597 2598 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 2596 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
2513 2514 2515 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 2513 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
2519 2520 2521 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 2519 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
2525 2526 2527 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 2525 def developer_payload @developer_payload end |
#kind ⇒ String
This kind represents an inappPurchase object in the androidpublisher service.
Corresponds to the JSON property kind
2530 2531 2532 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 2530 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
2538 2539 2540 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 2538 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
2546 2547 2548 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 2546 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
2551 2552 2553 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 2551 def order_id @order_id end |
#product_id ⇒ String
The inapp product SKU. May not be present.
Corresponds to the JSON property productId
2556 2557 2558 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 2556 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
2562 2563 2564 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 2562 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
2568 2569 2570 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 2568 def purchase_time_millis @purchase_time_millis end |
#purchase_token ⇒ String
The purchase token generated to identify this purchase. May not be present.
Corresponds to the JSON property purchaseToken
2573 2574 2575 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 2573 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
2582 2583 2584 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 2582 def purchase_type @purchase_type end |
#quantity ⇒ Fixnum
The quantity associated with the purchase of the inapp product. If not present,
the quantity is 1.
Corresponds to the JSON property quantity
2588 2589 2590 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 2588 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
2594 2595 2596 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 2594 def region_code @region_code end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 |
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 2601 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 |