Google Play Android Developer API . externaltransactions

close()

Close httplib2 connections.

createexternaltransaction(parent, body=None, externalTransactionId=None, x__xgafv=None)

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.
    "migratedTransactionProgram": "A String", # Input only. Provided during the call to Create. Must only be used when migrating a subscription from manual monthly reporting to automated reporting.
    "otherRecurringProduct": { # Details of a recurring external transaction product which doesn't belong to any other more specific category. # Details of a recurring external transaction product which doesn't belong to any other specific category.
    },
  },
  "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.
  },
  "transactionProgramCode": 42, # Optional. The transaction program code, used to help determine service fee for eligible apps participating in partner programs. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. Note: this field can not be used for external offers transactions.
  "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.
    "administrativeArea": "A String", # Optional. Top-level administrative subdivision of the country/region. Only required for transactions in India. Valid values are "ANDAMAN AND NICOBAR ISLANDS", "ANDHRA PRADESH", "ARUNACHAL PRADESH", "ASSAM", "BIHAR", "CHANDIGARH", "CHHATTISGARH", "DADRA AND NAGAR HAVELI", "DADRA AND NAGAR HAVELI AND DAMAN AND DIU", "DAMAN AND DIU", "DELHI", "GOA", "GUJARAT", "HARYANA", "HIMACHAL PRADESH", "JAMMU AND KASHMIR", "JHARKHAND", "KARNATAKA", "KERALA", "LADAKH", "LAKSHADWEEP", "MADHYA PRADESH", "MAHARASHTRA", "MANIPUR", "MEGHALAYA", "MIZORAM", "NAGALAND", "ODISHA", "PUDUCHERRY", "PUNJAB", "RAJASTHAN", "SIKKIM", "TAMIL NADU", "TELANGANA", "TRIPURA", "UTTAR PRADESH", "UTTARAKHAND", and "WEST BENGAL".
    "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-zA-Z0-9_-/. Do not use this field to store any Personally Identifiable Information (PII) such as emails. Attempting to store PII in this field may result in requests being blocked.
  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.
    "migratedTransactionProgram": "A String", # Input only. Provided during the call to Create. Must only be used when migrating a subscription from manual monthly reporting to automated reporting.
    "otherRecurringProduct": { # Details of a recurring external transaction product which doesn't belong to any other more specific category. # Details of a recurring external transaction product which doesn't belong to any other specific category.
    },
  },
  "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.
  },
  "transactionProgramCode": 42, # Optional. The transaction program code, used to help determine service fee for eligible apps participating in partner programs. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. Note: this field can not be used for external offers transactions.
  "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.
    "administrativeArea": "A String", # Optional. Top-level administrative subdivision of the country/region. Only required for transactions in India. Valid values are "ANDAMAN AND NICOBAR ISLANDS", "ANDHRA PRADESH", "ARUNACHAL PRADESH", "ASSAM", "BIHAR", "CHANDIGARH", "CHHATTISGARH", "DADRA AND NAGAR HAVELI", "DADRA AND NAGAR HAVELI AND DAMAN AND DIU", "DAMAN AND DIU", "DELHI", "GOA", "GUJARAT", "HARYANA", "HIMACHAL PRADESH", "JAMMU AND KASHMIR", "JHARKHAND", "KARNATAKA", "KERALA", "LADAKH", "LAKSHADWEEP", "MADHYA PRADESH", "MAHARASHTRA", "MANIPUR", "MEGHALAYA", "MIZORAM", "NAGALAND", "ODISHA", "PUDUCHERRY", "PUNJAB", "RAJASTHAN", "SIKKIM", "TAMIL NADU", "TELANGANA", "TRIPURA", "UTTAR PRADESH", "UTTARAKHAND", and "WEST BENGAL".
    "regionCode": "A String", # Required. Two letter region code based on ISO-3166-1 Alpha-2 (UN region codes).
  },
}

getexternaltransaction(name, x__xgafv=None)

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.
    "migratedTransactionProgram": "A String", # Input only. Provided during the call to Create. Must only be used when migrating a subscription from manual monthly reporting to automated reporting.
    "otherRecurringProduct": { # Details of a recurring external transaction product which doesn't belong to any other more specific category. # Details of a recurring external transaction product which doesn't belong to any other specific category.
    },
  },
  "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.
  },
  "transactionProgramCode": 42, # Optional. The transaction program code, used to help determine service fee for eligible apps participating in partner programs. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. Note: this field can not be used for external offers transactions.
  "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.
    "administrativeArea": "A String", # Optional. Top-level administrative subdivision of the country/region. Only required for transactions in India. Valid values are "ANDAMAN AND NICOBAR ISLANDS", "ANDHRA PRADESH", "ARUNACHAL PRADESH", "ASSAM", "BIHAR", "CHANDIGARH", "CHHATTISGARH", "DADRA AND NAGAR HAVELI", "DADRA AND NAGAR HAVELI AND DAMAN AND DIU", "DAMAN AND DIU", "DELHI", "GOA", "GUJARAT", "HARYANA", "HIMACHAL PRADESH", "JAMMU AND KASHMIR", "JHARKHAND", "KARNATAKA", "KERALA", "LADAKH", "LAKSHADWEEP", "MADHYA PRADESH", "MAHARASHTRA", "MANIPUR", "MEGHALAYA", "MIZORAM", "NAGALAND", "ODISHA", "PUDUCHERRY", "PUNJAB", "RAJASTHAN", "SIKKIM", "TAMIL NADU", "TELANGANA", "TRIPURA", "UTTAR PRADESH", "UTTARAKHAND", and "WEST BENGAL".
    "regionCode": "A String", # Required. Two letter region code based on ISO-3166-1 Alpha-2 (UN region codes).
  },
}

refundexternaltransaction(name, body=None, x__xgafv=None)

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.
    "migratedTransactionProgram": "A String", # Input only. Provided during the call to Create. Must only be used when migrating a subscription from manual monthly reporting to automated reporting.
    "otherRecurringProduct": { # Details of a recurring external transaction product which doesn't belong to any other more specific category. # Details of a recurring external transaction product which doesn't belong to any other specific category.
    },
  },
  "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.
  },
  "transactionProgramCode": 42, # Optional. The transaction program code, used to help determine service fee for eligible apps participating in partner programs. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. Note: this field can not be used for external offers transactions.
  "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.
    "administrativeArea": "A String", # Optional. Top-level administrative subdivision of the country/region. Only required for transactions in India. Valid values are "ANDAMAN AND NICOBAR ISLANDS", "ANDHRA PRADESH", "ARUNACHAL PRADESH", "ASSAM", "BIHAR", "CHANDIGARH", "CHHATTISGARH", "DADRA AND NAGAR HAVELI", "DADRA AND NAGAR HAVELI AND DAMAN AND DIU", "DAMAN AND DIU", "DELHI", "GOA", "GUJARAT", "HARYANA", "HIMACHAL PRADESH", "JAMMU AND KASHMIR", "JHARKHAND", "KARNATAKA", "KERALA", "LADAKH", "LAKSHADWEEP", "MADHYA PRADESH", "MAHARASHTRA", "MANIPUR", "MEGHALAYA", "MIZORAM", "NAGALAND", "ODISHA", "PUDUCHERRY", "PUNJAB", "RAJASTHAN", "SIKKIM", "TAMIL NADU", "TELANGANA", "TRIPURA", "UTTAR PRADESH", "UTTARAKHAND", and "WEST BENGAL".
    "regionCode": "A String", # Required. Two letter region code based on ISO-3166-1 Alpha-2 (UN region codes).
  },
}