| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="androidpublisher_v3.html">Google Play Android Developer API</a> . <a href="androidpublisher_v3.externaltransactions.html">externaltransactions</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#createexternaltransaction">createexternaltransaction(parent, body=None, externalTransactionId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a new external transaction.</p> |
| <p class="toc_element"> |
| <code><a href="#getexternaltransaction">getexternaltransaction(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets an existing external transaction.</p> |
| <p class="toc_element"> |
| <code><a href="#refundexternaltransaction">refundexternaltransaction(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Refunds or partially refunds an existing external transaction.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="createexternaltransaction">createexternaltransaction(parent, body=None, externalTransactionId=None, x__xgafv=None)</code> |
| <pre>Creates a new external transaction. |
| |
| Args: |
| parent: string, Required. The parent resource where this external transaction will be created. Format: applications/{package_name} (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # The details of an external transaction. |
| "createTime": "A String", # Output only. The time when this transaction was created. This is the time when Google was notified of the transaction. |
| "currentPreTaxAmount": { # Definition of a price, i.e. currency and units. # Output only. The current transaction amount before tax. This represents the current pre-tax amount including any refunds that may have been applied to this transaction. |
| "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java |
| "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. |
| }, |
| "currentTaxAmount": { # Definition of a price, i.e. currency and units. # Output only. The current tax amount. This represents the current tax amount including any refunds that may have been applied to this transaction. |
| "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java |
| "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. |
| }, |
| "externalTransactionId": "A String", # Output only. The id of this transaction. All transaction ids under the same package name must be unique. Set when creating the external transaction. |
| "oneTimeTransaction": { # Represents a one-time transaction. # This is a one-time transaction and not part of a subscription. |
| "externalTransactionToken": "A String", # Input only. Provided during the call to Create. Retrieved from the client when the alternative billing flow is launched. |
| }, |
| "originalPreTaxAmount": { # Definition of a price, i.e. currency and units. # Required. The original transaction amount before taxes. This represents the pre-tax amount originally notified to Google before any refunds were applied. |
| "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java |
| "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. |
| }, |
| "originalTaxAmount": { # Definition of a price, i.e. currency and units. # Required. The original tax amount. This represents the tax amount originally notified to Google before any refunds were applied. |
| "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java |
| "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. |
| }, |
| "packageName": "A String", # Output only. The resource name of the external transaction. The package name of the application the inapp products were sold (for example, 'com.some.app'). |
| "recurringTransaction": { # Represents a transaction that is part of a recurring series of payments. This can be a subscription or a one-time product with multiple payments (such as preorder). # This transaction is part of a recurring series of transactions. |
| "externalSubscription": { # Details of an external subscription. # Details of an external subscription. |
| "subscriptionType": "A String", # Required. The type of the external subscription. |
| }, |
| "externalTransactionToken": "A String", # Input only. Provided during the call to Create. Retrieved from the client when the alternative billing flow is launched. Required only for the initial purchase. |
| "initialExternalTransactionId": "A String", # The external transaction id of the first transaction of this recurring series of transactions. For example, for a subscription this would be the transaction id of the first payment. Required when creating recurring external transactions. |
| }, |
| "testPurchase": { # Represents a transaction performed using a test account. These transactions will not be charged by Google. # Output only. If set, this transaction was a test purchase. Google will not charge for a test transaction. |
| }, |
| "transactionState": "A String", # Output only. The current state of the transaction. |
| "transactionTime": "A String", # Required. The time when the transaction was completed. |
| "userTaxAddress": { # User's address for the external transaction. # Required. User address for tax computation. |
| "regionCode": "A String", # Required. Two letter region code based on ISO-3166-1 Alpha-2 (UN region codes). |
| }, |
| } |
| |
| externalTransactionId: string, Required. The id to use for the external transaction. Must be unique across all other transactions for the app. This value should be 1-63 characters and valid characters are /a-z0-9_-/. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The details of an external transaction. |
| "createTime": "A String", # Output only. The time when this transaction was created. This is the time when Google was notified of the transaction. |
| "currentPreTaxAmount": { # Definition of a price, i.e. currency and units. # Output only. The current transaction amount before tax. This represents the current pre-tax amount including any refunds that may have been applied to this transaction. |
| "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java |
| "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. |
| }, |
| "currentTaxAmount": { # Definition of a price, i.e. currency and units. # Output only. The current tax amount. This represents the current tax amount including any refunds that may have been applied to this transaction. |
| "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java |
| "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. |
| }, |
| "externalTransactionId": "A String", # Output only. The id of this transaction. All transaction ids under the same package name must be unique. Set when creating the external transaction. |
| "oneTimeTransaction": { # Represents a one-time transaction. # This is a one-time transaction and not part of a subscription. |
| "externalTransactionToken": "A String", # Input only. Provided during the call to Create. Retrieved from the client when the alternative billing flow is launched. |
| }, |
| "originalPreTaxAmount": { # Definition of a price, i.e. currency and units. # Required. The original transaction amount before taxes. This represents the pre-tax amount originally notified to Google before any refunds were applied. |
| "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java |
| "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. |
| }, |
| "originalTaxAmount": { # Definition of a price, i.e. currency and units. # Required. The original tax amount. This represents the tax amount originally notified to Google before any refunds were applied. |
| "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java |
| "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. |
| }, |
| "packageName": "A String", # Output only. The resource name of the external transaction. The package name of the application the inapp products were sold (for example, 'com.some.app'). |
| "recurringTransaction": { # Represents a transaction that is part of a recurring series of payments. This can be a subscription or a one-time product with multiple payments (such as preorder). # This transaction is part of a recurring series of transactions. |
| "externalSubscription": { # Details of an external subscription. # Details of an external subscription. |
| "subscriptionType": "A String", # Required. The type of the external subscription. |
| }, |
| "externalTransactionToken": "A String", # Input only. Provided during the call to Create. Retrieved from the client when the alternative billing flow is launched. Required only for the initial purchase. |
| "initialExternalTransactionId": "A String", # The external transaction id of the first transaction of this recurring series of transactions. For example, for a subscription this would be the transaction id of the first payment. Required when creating recurring external transactions. |
| }, |
| "testPurchase": { # Represents a transaction performed using a test account. These transactions will not be charged by Google. # Output only. If set, this transaction was a test purchase. Google will not charge for a test transaction. |
| }, |
| "transactionState": "A String", # Output only. The current state of the transaction. |
| "transactionTime": "A String", # Required. The time when the transaction was completed. |
| "userTaxAddress": { # User's address for the external transaction. # Required. User address for tax computation. |
| "regionCode": "A String", # Required. Two letter region code based on ISO-3166-1 Alpha-2 (UN region codes). |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getexternaltransaction">getexternaltransaction(name, x__xgafv=None)</code> |
| <pre>Gets an existing external transaction. |
| |
| Args: |
| name: string, Required. The name of the external transaction to retrieve. Format: applications/{package_name}/externalTransactions/{external_transaction} (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The details of an external transaction. |
| "createTime": "A String", # Output only. The time when this transaction was created. This is the time when Google was notified of the transaction. |
| "currentPreTaxAmount": { # Definition of a price, i.e. currency and units. # Output only. The current transaction amount before tax. This represents the current pre-tax amount including any refunds that may have been applied to this transaction. |
| "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java |
| "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. |
| }, |
| "currentTaxAmount": { # Definition of a price, i.e. currency and units. # Output only. The current tax amount. This represents the current tax amount including any refunds that may have been applied to this transaction. |
| "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java |
| "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. |
| }, |
| "externalTransactionId": "A String", # Output only. The id of this transaction. All transaction ids under the same package name must be unique. Set when creating the external transaction. |
| "oneTimeTransaction": { # Represents a one-time transaction. # This is a one-time transaction and not part of a subscription. |
| "externalTransactionToken": "A String", # Input only. Provided during the call to Create. Retrieved from the client when the alternative billing flow is launched. |
| }, |
| "originalPreTaxAmount": { # Definition of a price, i.e. currency and units. # Required. The original transaction amount before taxes. This represents the pre-tax amount originally notified to Google before any refunds were applied. |
| "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java |
| "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. |
| }, |
| "originalTaxAmount": { # Definition of a price, i.e. currency and units. # Required. The original tax amount. This represents the tax amount originally notified to Google before any refunds were applied. |
| "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java |
| "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. |
| }, |
| "packageName": "A String", # Output only. The resource name of the external transaction. The package name of the application the inapp products were sold (for example, 'com.some.app'). |
| "recurringTransaction": { # Represents a transaction that is part of a recurring series of payments. This can be a subscription or a one-time product with multiple payments (such as preorder). # This transaction is part of a recurring series of transactions. |
| "externalSubscription": { # Details of an external subscription. # Details of an external subscription. |
| "subscriptionType": "A String", # Required. The type of the external subscription. |
| }, |
| "externalTransactionToken": "A String", # Input only. Provided during the call to Create. Retrieved from the client when the alternative billing flow is launched. Required only for the initial purchase. |
| "initialExternalTransactionId": "A String", # The external transaction id of the first transaction of this recurring series of transactions. For example, for a subscription this would be the transaction id of the first payment. Required when creating recurring external transactions. |
| }, |
| "testPurchase": { # Represents a transaction performed using a test account. These transactions will not be charged by Google. # Output only. If set, this transaction was a test purchase. Google will not charge for a test transaction. |
| }, |
| "transactionState": "A String", # Output only. The current state of the transaction. |
| "transactionTime": "A String", # Required. The time when the transaction was completed. |
| "userTaxAddress": { # User's address for the external transaction. # Required. User address for tax computation. |
| "regionCode": "A String", # Required. Two letter region code based on ISO-3166-1 Alpha-2 (UN region codes). |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="refundexternaltransaction">refundexternaltransaction(name, body=None, x__xgafv=None)</code> |
| <pre>Refunds or partially refunds an existing external transaction. |
| |
| Args: |
| name: string, Required. The name of the external transaction that will be refunded. Format: applications/{package_name}/externalTransactions/{external_transaction} (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A request to refund an existing external transaction. |
| "fullRefund": { # A full refund of the remaining amount of a transaction. # A full-amount refund. |
| }, |
| "partialRefund": { # A partial refund of a transaction. # A partial refund. |
| "refundId": "A String", # Required. A unique id distinguishing this partial refund. If the refund is successful, subsequent refunds with the same id will fail. Must be unique across refunds for one individual transaction. |
| "refundPreTaxAmount": { # Definition of a price, i.e. currency and units. # Required. The pre-tax amount of the partial refund. Should be less than the remaining pre-tax amount of the transaction. |
| "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java |
| "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. |
| }, |
| }, |
| "refundTime": "A String", # Required. The time that the transaction was refunded. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The details of an external transaction. |
| "createTime": "A String", # Output only. The time when this transaction was created. This is the time when Google was notified of the transaction. |
| "currentPreTaxAmount": { # Definition of a price, i.e. currency and units. # Output only. The current transaction amount before tax. This represents the current pre-tax amount including any refunds that may have been applied to this transaction. |
| "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java |
| "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. |
| }, |
| "currentTaxAmount": { # Definition of a price, i.e. currency and units. # Output only. The current tax amount. This represents the current tax amount including any refunds that may have been applied to this transaction. |
| "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java |
| "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. |
| }, |
| "externalTransactionId": "A String", # Output only. The id of this transaction. All transaction ids under the same package name must be unique. Set when creating the external transaction. |
| "oneTimeTransaction": { # Represents a one-time transaction. # This is a one-time transaction and not part of a subscription. |
| "externalTransactionToken": "A String", # Input only. Provided during the call to Create. Retrieved from the client when the alternative billing flow is launched. |
| }, |
| "originalPreTaxAmount": { # Definition of a price, i.e. currency and units. # Required. The original transaction amount before taxes. This represents the pre-tax amount originally notified to Google before any refunds were applied. |
| "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java |
| "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. |
| }, |
| "originalTaxAmount": { # Definition of a price, i.e. currency and units. # Required. The original tax amount. This represents the tax amount originally notified to Google before any refunds were applied. |
| "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java |
| "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. |
| }, |
| "packageName": "A String", # Output only. The resource name of the external transaction. The package name of the application the inapp products were sold (for example, 'com.some.app'). |
| "recurringTransaction": { # Represents a transaction that is part of a recurring series of payments. This can be a subscription or a one-time product with multiple payments (such as preorder). # This transaction is part of a recurring series of transactions. |
| "externalSubscription": { # Details of an external subscription. # Details of an external subscription. |
| "subscriptionType": "A String", # Required. The type of the external subscription. |
| }, |
| "externalTransactionToken": "A String", # Input only. Provided during the call to Create. Retrieved from the client when the alternative billing flow is launched. Required only for the initial purchase. |
| "initialExternalTransactionId": "A String", # The external transaction id of the first transaction of this recurring series of transactions. For example, for a subscription this would be the transaction id of the first payment. Required when creating recurring external transactions. |
| }, |
| "testPurchase": { # Represents a transaction performed using a test account. These transactions will not be charged by Google. # Output only. If set, this transaction was a test purchase. Google will not charge for a test transaction. |
| }, |
| "transactionState": "A String", # Output only. The current state of the transaction. |
| "transactionTime": "A String", # Required. The time when the transaction was completed. |
| "userTaxAddress": { # User's address for the external transaction. # Required. User address for tax computation. |
| "regionCode": "A String", # Required. Two letter region code based on ISO-3166-1 Alpha-2 (UN region codes). |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |
