Method: monetization.subscriptions.basePlans.offers.batchGet
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
يقرأ عرضًا واحدًا أو أكثر من عروض الاشتراك
طلب HTTP
POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers:batchGet
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات المسار
| المعلمات |
packageName |
string
مطلوب. التطبيق الرئيسي (اسم الحزمة) الذي يجب إنشاء الاشتراكات أو تعديلها له يجب أن تساوي قيمة الحقل packageName في جميع الطلبات.
|
productId |
string
مطلوب. معرّف المنتج للاشتراك الرئيسي، إذا كانت جميع العروض المعدَّلة تنتمي إلى الاشتراك نفسه. إذا كان هذا الطلب يشمل اشتراكات متعددة، اضبط هذا الحقل على "-". يجب ضبطها.
|
basePlanId |
string
مطلوب. الخطة الأساسية (رقم التعريف) التي يجب قراءة العروض الترويجية لها يمكن تحديدها على أنّها "-" للاطّلاع على العروض الترويجية من خطط أساسية متعددة
|
نص الطلب
يحتوي نص الطلب على بيانات بالبنية التالية:
| الحقول |
requests[] |
object (GetSubscriptionOfferRequest)
مطلوب. قائمة بطلبات التعديل لما يصل إلى 100 عنصر. يجب تعديل اشتراكات مختلفة في جميع الطلبات.
|
نص الاستجابة
رسالة استجابة لنقطة نهاية Offer.batchGet.
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
| الحقول |
subscriptionOffers[] |
object (SubscriptionOffer)
|
نطاقات الأذونات
يجب توفير نطاق OAuth التالي:
https://www.googleapis.com/auth/androidpublisher
GetSubscriptionOfferRequest
| تمثيل JSON |
{
"packageName": string,
"productId": string,
"basePlanId": string,
"offerId": string
} |
| الحقول |
packageName |
string
مطلوب. التطبيق الرئيسي (اسم الحزمة) للعرض الذي يمكنك الحصول عليه.
|
productId |
string
مطلوب. الاشتراك الرئيسي (رقم التعريف) للعرض الذي تريد الحصول عليه.
|
basePlanId |
string
مطلوب. الخطة الأساسية الرئيسية (رقم تعريف) العرض الترويجي المطلوب الحصول عليه
|
offerId |
string
مطلوب. معرّف العرض الفريد للعرض الذي تريد الحصول عليه.
|
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-26 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-26 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\u003cp\u003eReads one or more subscription offers for a specified app, product, and base plan using a POST request.\u003c/p\u003e\n"],["\u003cp\u003eRequires providing a list of \u003ccode\u003eGetSubscriptionOfferRequest\u003c/code\u003e objects, each specifying the package name, product ID, base plan ID, and offer ID.\u003c/p\u003e\n"],["\u003cp\u003eReturns a list of \u003ccode\u003eSubscriptionOffer\u003c/code\u003e objects containing details about the retrieved subscription offers.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/androidpublisher\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eSupports batch retrieval of up to 100 offers, but all requests must update different subscriptions.\u003c/p\u003e\n"]]],["This document outlines the process for retrieving subscription offers via a batch request. It uses a `POST` request to a specified URL, including `packageName`, `productId`, and `basePlanId` as path parameters. The request body requires a JSON array of `GetSubscriptionOfferRequest` objects, each needing `packageName`, `productId`, `basePlanId`, and `offerId`. The response contains an array of `SubscriptionOffer` objects, presented in a JSON format. The `https://www.googleapis.com/auth/androidpublisher` authorization scope is required.\n"],null,["# Method: monetization.subscriptions.basePlans.offers.batchGet\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.BatchGetSubscriptionOffersResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [GetSubscriptionOfferRequest](#GetSubscriptionOfferRequest)\n - [JSON representation](#GetSubscriptionOfferRequest.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nReads one or more subscription offers.\n\n### HTTP request\n\n`POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}/offers:batchGet`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `packageName` | `string` Required. The parent app (package name) for which the subscriptions should be created or updated. Must be equal to the packageName field on all the requests. |\n| `productId` | `string` Required. The product ID of the parent subscription, if all updated offers belong to the same subscription. If this request spans multiple subscriptions, set this field to \"-\". Must be set. |\n| `basePlanId` | `string` Required. The parent base plan (ID) for which the offers should be read. May be specified as '-' to read offers from multiple base plans. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"requests\": [ { object (/android-publisher/api-ref/rest/v3/monetization.subscriptions.basePlans.offers/batchGet#GetSubscriptionOfferRequest) } ] } ``` |\n\n| Fields ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `requests[]` | `object (`[GetSubscriptionOfferRequest](/android-publisher/api-ref/rest/v3/monetization.subscriptions.basePlans.offers/batchGet#GetSubscriptionOfferRequest)`)` Required. A list of update requests of up to 100 elements. All requests must update different subscriptions. |\n\n### Response body\n\nResponse message for offers.batchGet endpoint.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"subscriptionOffers\": [ { object (/android-publisher/api-ref/rest/v3/monetization.subscriptions.basePlans.offers#SubscriptionOffer) } ] } ``` |\n\n| Fields ||\n|------------------------|------------------------------------------------------------------------------------------------------------------------------------|\n| `subscriptionOffers[]` | `object (`[SubscriptionOffer](/android-publisher/api-ref/rest/v3/monetization.subscriptions.basePlans.offers#SubscriptionOffer)`)` |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/androidpublisher`\n\nGetSubscriptionOfferRequest\n---------------------------\n\nRequest message for offers.get.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------|\n| ``` { \"packageName\": string, \"productId\": string, \"basePlanId\": string, \"offerId\": string } ``` |\n\n| Fields ||\n|---------------|-----------------------------------------------------------------------|\n| `packageName` | `string` Required. The parent app (package name) of the offer to get. |\n| `productId` | `string` Required. The parent subscription (ID) of the offer to get. |\n| `basePlanId` | `string` Required. The parent base plan (ID) of the offer to get. |\n| `offerId` | `string` Required. The unique offer ID of the offer to get. |"]]
