google-api-python-client 2.169.0__py3-none-any.whl → 2.170.0__py3-none-any.whl

googleapiclient/discovery_cache/documents/androidpublisher.v3.json

@@ -2906,7 +2906,7 @@
 "type": "string"
 },
 "regionsVersion.version": {
-"description": "Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.",
+"description": "Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. The latest supported version is available in this article. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.",
 "location": "query",
 "type": "string"
 }
@@ -3065,7 +3065,7 @@
 "type": "string"
 },
 "regionsVersion.version": {
-"description": "Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.",
+"description": "Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. The latest supported version is available in this article. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.",
 "location": "query",
 "type": "string"
 },
@@ -3527,7 +3527,7 @@
 "type": "string"
 },
 "regionsVersion.version": {
-"description": "Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.",
+"description": "Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. The latest supported version is available in this article. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.",
 "location": "query",
 "type": "string"
 }
@@ -3784,7 +3784,7 @@
 "type": "string"
 },
 "regionsVersion.version": {
-"description": "Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.",
+"description": "Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. The latest supported version is available in this article. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.",
 "location": "query",
 "type": "string"
 },
@@ -3816,6 +3816,67 @@
 },
 "orders": {
 "methods": {
+"batchget": {
+"description": "Get order details for a list of orders.",
+"flatPath": "androidpublisher/v3/applications/{packageName}/orders:batchGet",
+"httpMethod": "GET",
+"id": "androidpublisher.orders.batchget",
+"parameterOrder": [
+"packageName"
+],
+"parameters": {
+"orderIds": {
+"description": "Required. The list of order IDs to retrieve order details for. There must be between 1 and 1000 (inclusive) order IDs per request. If any order ID is not found or does not match the provided package, the entire request will fail with an error. The order IDs must be distinct.",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"packageName": {
+"description": "Required. The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing').",
+"location": "path",
+"required": true,
+"type": "string"
+}
+},
+"path": "androidpublisher/v3/applications/{packageName}/orders:batchGet",
+"response": {
+"$ref": "BatchGetOrdersResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/androidpublisher"
+]
+},
+"get": {
+"description": "Get order details for a single order.",
+"flatPath": "androidpublisher/v3/applications/{packageName}/orders/{orderId}",
+"httpMethod": "GET",
+"id": "androidpublisher.orders.get",
+"parameterOrder": [
+"packageName",
+"orderId"
+],
+"parameters": {
+"orderId": {
+"description": "Required. The order ID provided to the user when the subscription or in-app order was purchased.",
+"location": "path",
+"required": true,
+"type": "string"
+},
+"packageName": {
+"description": "Required. The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing').",
+"location": "path",
+"required": true,
+"type": "string"
+}
+},
+"path": "androidpublisher/v3/applications/{packageName}/orders/{orderId}",
+"response": {
+"$ref": "Order"
+},
+"scopes": [
+"https://www.googleapis.com/auth/androidpublisher"
+]
+},
 "refund": {
 "description": "Refunds a user's subscription or in-app purchase order. Orders older than 3 years cannot be refunded.",
 "flatPath": "androidpublisher/v3/applications/{packageName}/orders/{orderId}:refund",
@@ -4732,7 +4793,7 @@
 }
 }
 },
-"revision": "20250318",
+"revision": "20250519",
 "rootUrl": "https://androidpublisher.googleapis.com/",
 "schemas": {
 "Abi": {
@@ -5380,6 +5441,20 @@
 },
 "type": "object"
 },
+"BatchGetOrdersResponse": {
+"description": "Response for the orders.batchGet API.",
+"id": "BatchGetOrdersResponse",
+"properties": {
+"orders": {
+"description": "Details for the requested order IDs.",
+"items": {
+"$ref": "Order"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "BatchGetSubscriptionOffersRequest": {
 "description": "Request message for BatchGetSubscriptionOffers endpoint.",
 "id": "BatchGetSubscriptionOffersRequest",
@@ -5599,6 +5674,25 @@
 },
 "type": "object"
 },
+"BuyerAddress": {
+"description": "Address information for the customer, for use in tax computation.",
+"id": "BuyerAddress",
+"properties": {
+"buyerCountry": {
+"description": "Two letter country code based on ISO-3166-1 Alpha-2 (UN country codes).",
+"type": "string"
+},
+"buyerPostcode": {
+"description": "Postal code of an address. When Google is the Merchant of Record for the order, this information is not included.",
+"type": "string"
+},
+"buyerState": {
+"description": "Top-level administrative subdivision of the buyer address country. When Google is the Merchant of Record for the order, this information is not included.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "CancelAppRecoveryRequest": {
 "description": "Request message for CancelAppRecovery.",
 "id": "CancelAppRecoveryRequest",
@@ -5665,6 +5759,18 @@
 },
 "type": "object"
 },
+"CancellationEvent": {
+"description": "Details of when the order was canceled.",
+"id": "CancellationEvent",
+"properties": {
+"eventTime": {
+"description": "The time when the order was canceled.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
 "Comment": {
 "description": "An entry of conversation between user and developer.",
 "id": "Comment",
@@ -7207,6 +7313,45 @@ false
 },
 "type": "object"
 },
+"LineItem": {
+"description": "Details of a line item.",
+"id": "LineItem",
+"properties": {
+"listingPrice": {
+"$ref": "Money",
+"description": "Item's listed price on Play Store, this may or may not include tax. Excludes any discounts or promotions."
+},
+"oneTimePurchaseDetails": {
+"$ref": "OneTimePurchaseDetails",
+"description": "Details of a one-time purchase."
+},
+"paidAppDetails": {
+"$ref": "PaidAppDetails",
+"description": "Details of a paid app purchase."
+},
+"productId": {
+"description": "The purchased product ID or in-app SKU (for example, 'monthly001' or 'com.some.thing.inapp1').",
+"type": "string"
+},
+"productTitle": {
+"description": "Developer-specified name of the product. Displayed in buyer's locale. Example: coins, monthly subscription, etc.",
+"type": "string"
+},
+"subscriptionDetails": {
+"$ref": "SubscriptionDetails",
+"description": "Details of a subscription purchase."
+},
+"tax": {
+"$ref": "Money",
+"description": "The tax paid for this line item."
+},
+"total": {
+"$ref": "Money",
+"description": "The total amount paid by the user for this line item, taking into account discounts and tax."
+}
+},
+"type": "object"
+},
 "ListAppRecoveriesResponse": {
 "description": "Response message for ListAppRecoveries. -- api-linter: core::0158::response-next-page-token-field=disabled",
 "id": "ListAppRecoveriesResponse",
@@ -7613,6 +7758,141 @@ false
 },
 "type": "object"
 },
+"OneTimePurchaseDetails": {
+"description": "Details of a one-time purchase.",
+"id": "OneTimePurchaseDetails",
+"properties": {
+"offerId": {
+"description": "The offer ID of the one-time purchase offer.",
+"type": "string"
+},
+"quantity": {
+"description": "The number of items purchased (for multi-quantity item purchases).",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
+"Order": {
+"description": "Details of an order.",
+"id": "Order",
+"properties": {
+"buyerAddress": {
+"$ref": "BuyerAddress",
+"description": "Address information for the customer, for use in tax computation. When Google is the Merchant of Record for the order, only country is shown."
+},
+"createTime": {
+"description": "The time when the order was created.",
+"format": "google-datetime",
+"type": "string"
+},
+"developerRevenueInBuyerCurrency": {
+"$ref": "Money",
+"description": "Your revenue for this order in the buyer's currency, including deductions of partial refunds, taxes and fees. Google deducts standard transaction and third party fees from each sale, including VAT in some regions."
+},
+"lastEventTime": {
+"description": "The time of the last event that occurred on the order.",
+"format": "google-datetime",
+"type": "string"
+},
+"lineItems": {
+"description": "The individual line items making up this order.",
+"items": {
+"$ref": "LineItem"
+},
+"type": "array"
+},
+"orderDetails": {
+"$ref": "OrderDetails",
+"description": "Detailed information about the order at creation time."
+},
+"orderHistory": {
+"$ref": "OrderHistory",
+"description": "Details about events which modified the order."
+},
+"orderId": {
+"description": "The order ID.",
+"type": "string"
+},
+"pointsDetails": {
+"$ref": "PointsDetails",
+"description": "Play points applied to the order, including offer information, discount rate and point values."
+},
+"purchaseToken": {
+"description": "The token provided to the user's device when the subscription or item was purchased.",
+"type": "string"
+},
+"state": {
+"description": "The state of the order.",
+"enum": [
+"STATE_UNSPECIFIED",
+"PENDING",
+"PROCESSED",
+"CANCELED",
+"PENDING_REFUND",
+"PARTIALLY_REFUNDED",
+"REFUNDED"
+],
+"enumDescriptions": [
+"State unspecified. This value is not used.",
+"Order has been created and is waiting to be processed.",
+"Order has been successfully processed.",
+"Order was canceled before being processed.",
+"Requested refund is waiting to be processed.",
+"Part of the order amount was refunded.",
+"The full order amount was refunded."
+],
+"type": "string"
+},
+"tax": {
+"$ref": "Money",
+"description": "The total tax paid as a part of this order."
+},
+"total": {
+"$ref": "Money",
+"description": "The final amount paid by the customer, taking into account discounts and taxes."
+}
+},
+"type": "object"
+},
+"OrderDetails": {
+"description": "Detailed information about the order at creation time.",
+"id": "OrderDetails",
+"properties": {
+"taxInclusive": {
+"description": "Indicates whether the listed price was tax inclusive or not.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
+"OrderHistory": {
+"description": "Details about events which modified the order.",
+"id": "OrderHistory",
+"properties": {
+"cancellationEvent": {
+"$ref": "CancellationEvent",
+"description": "Details of when the order was canceled."
+},
+"partialRefundEvents": {
+"description": "Details of the partial refund events for this order.",
+"items": {
+"$ref": "PartialRefundEvent"
+},
+"type": "array"
+},
+"processedEvent": {
+"$ref": "ProcessedEvent",
+"description": "Details of when the order was processed."
+},
+"refundEvent": {
+"$ref": "RefundEvent",
+"description": "Details of when the order was fully refunded."
+}
+},
+"type": "object"
+},
 "OtherRecurringProduct": {
 "description": "Details of a recurring external transaction product which doesn't belong to any other more specific category.",
 "id": "OtherRecurringProduct",
@@ -7716,6 +7996,12 @@ false
 },
 "type": "object"
 },
+"PaidAppDetails": {
+"description": "Details of a paid app purchase.",
+"id": "PaidAppDetails",
+"properties": {},
+"type": "object"
+},
 "PartialRefund": {
 "description": "A partial refund of a transaction.",
 "id": "PartialRefund",
@@ -7731,6 +8017,41 @@ false
 },
 "type": "object"
 },
+"PartialRefundEvent": {
+"description": "Details of the partial refund events for this order.",
+"id": "PartialRefundEvent",
+"properties": {
+"createTime": {
+"description": "The time when the partial refund was created.",
+"format": "google-datetime",
+"type": "string"
+},
+"processTime": {
+"description": "The time when the partial refund was processed.",
+"format": "google-datetime",
+"type": "string"
+},
+"refundDetails": {
+"$ref": "RefundDetails",
+"description": "Details for the partial refund."
+},
+"state": {
+"description": "The state of the partial refund.",
+"enum": [
+"STATE_UNSPECIFIED",
+"PENDING",
+"PROCESSED_SUCCESSFULLY"
+],
+"enumDescriptions": [
+"State unspecified. This value is not used.",
+"The partial refund has been created, but not yet processed.",
+"The partial refund was processed successfully."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "PausedStateContext": {
 "description": "Information specific to a subscription in paused state.",
 "id": "PausedStateContext",
@@ -7749,6 +8070,31 @@ false
 "properties": {},
 "type": "object"
 },
+"PointsDetails": {
+"description": "Details relating to any Play Points applied to an order.",
+"id": "PointsDetails",
+"properties": {
+"pointsCouponValue": {
+"$ref": "Money",
+"description": "The monetary value of a Play Points coupon. This is the discount the coupon provides, which may not be the total amount. Only set when Play Points coupons have been used. E.g. for a 100 points for $2 coupon, this is $2."
+},
+"pointsDiscountRateMicros": {
+"description": "The percentage rate which the Play Points promotion reduces the cost by. E.g. for a 100 points for $2 coupon, this is 500,000. Since $2 has an estimate of 200 points, but the actual Points required, 100, is 50% of this, and 50% in micros is 500,000. Between 0 and 1,000,000.",
+"format": "int64",
+"type": "string"
+},
+"pointsOfferId": {
+"description": "ID unique to the play points offer in use for this order.",
+"type": "string"
+},
+"pointsSpent": {
+"description": "The number of Play Points applied in this order. E.g. for a 100 points for $2 coupon, this is 100. For coupon stacked with base offer, this is the total points spent across both.",
+"format": "int64",
+"type": "string"
+}
+},
+"type": "object"
+},
 "PrepaidBasePlanType": {
 "description": "Represents a base plan that does not automatically renew at the end of the base plan, and must be manually renewed by the user.",
 "id": "PrepaidBasePlanType",
@@ -7801,6 +8147,18 @@ false
 },
 "type": "object"
 },
+"ProcessedEvent": {
+"description": "Details of when the order was processed.",
+"id": "ProcessedEvent",
+"properties": {
+"eventTime": {
+"description": "The time when the order was processed.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
 "ProductPurchase": {
 "description": "A ProductPurchase resource indicates the status of a user's inapp product purchase.",
 "id": "ProductPurchase",
@@ -7923,6 +8281,51 @@ false
 },
 "type": "object"
 },
+"RefundDetails": {
+"description": "Details for a partial or full refund.",
+"id": "RefundDetails",
+"properties": {
+"tax": {
+"$ref": "Money",
+"description": "The amount of tax refunded."
+},
+"total": {
+"$ref": "Money",
+"description": "The total amount refunded, including tax."
+}
+},
+"type": "object"
+},
+"RefundEvent": {
+"description": "Details of when the order was fully refunded.",
+"id": "RefundEvent",
+"properties": {
+"eventTime": {
+"description": "The time when the order was fully refunded.",
+"format": "google-datetime",
+"type": "string"
+},
+"refundDetails": {
+"$ref": "RefundDetails",
+"description": "Details for the full refund."
+},
+"refundReason": {
+"description": "The reason the order was refunded.",
+"enum": [
+"REFUND_REASON_UNSPECIFIED",
+"OTHER",
+"CHARGEBACK"
+],
+"enumDescriptions": [
+"Refund reason unspecified. This value is not used.",
+"The order was refunded for a reason other than the listed reasons here.",
+"The order was charged back."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "RefundExternalTransactionRequest": {
 "description": "A request to refund an existing external transaction.",
 "id": "RefundExternalTransactionRequest",
@@ -8113,7 +8516,7 @@ false
 "id": "RegionsVersion",
 "properties": {
 "version": {
-"description": "Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.",
+"description": "Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. The latest supported version is available in this article. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.",
 "type": "string"
 }
 },
@@ -8275,6 +8678,10 @@ false
 "$ref": "RevocationContextFullRefund",
 "description": "Optional. Used when users should be refunded the full amount of the latest order of the subscription."
 },
+"itemBasedRefund": {
+"$ref": "RevocationContextItemBasedRefund",
+"description": "Optional. Used when a specific item should be refunded in a subscription with multiple items."
+},
 "proratedRefund": {
 "$ref": "RevocationContextProratedRefund",
 "description": "Optional. Used when users should be refunded a prorated amount they paid for their subscription based on the amount of time remaining in a subscription."
@@ -8288,6 +8695,17 @@ false
 "properties": {},
 "type": "object"
 },
+"RevocationContextItemBasedRefund": {
+"description": "Used to determine what specific item to revoke in a subscription with multiple items.",
+"id": "RevocationContextItemBasedRefund",
+"properties": {
+"productId": {
+"description": "Required. If the subscription is a subscription bundle, the product id of the subscription to revoke.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "RevocationContextProratedRefund": {
 "description": "Used to determine if the refund type in the RevocationContext is a prorated refund.",
 "id": "RevocationContextProratedRefund",
@@ -8590,6 +9008,47 @@ false
 },
 "type": "object"
 },
+"SubscriptionDetails": {
+"description": "Details of a subscription purchase.",
+"id": "SubscriptionDetails",
+"properties": {
+"basePlanId": {
+"description": "The base plan ID of the subscription.",
+"type": "string"
+},
+"offerId": {
+"description": "The offer ID for the current subscription offer.",
+"type": "string"
+},
+"offerPhase": {
+"description": "The pricing phase for the billing period funded by this order.",
+"enum": [
+"OFFER_PHASE_UNSPECIFIED",
+"BASE",
+"INTRODUCTORY",
+"FREE_TRIAL"
+],
+"enumDescriptions": [
+"Offer phase unspecified. This value is not used.",
+"The order funds a base price period.",
+"The order funds an introductory pricing period.",
+"The order funds a free trial period."
+],
+"type": "string"
+},
+"servicePeriodEndTime": {
+"description": "The end of the billing period funded by this order. This is a snapshot of the billing/service period end time at the moment the order was processed, and should be used only for accounting. To get the current end time of the subscription service period, use purchases.subscriptionsv2.get.",
+"format": "google-datetime",
+"type": "string"
+},
+"servicePeriodStartTime": {
+"description": "The start of the billing period funded by this order. This is a snapshot of the billing/service period start time at the moment the order was processed, and should be used only for accounting.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
 "SubscriptionItemPriceChangeDetails": {
 "description": "Price change related information of a subscription item.",
 "id": "SubscriptionItemPriceChangeDetails",