REST Resource: monetization.subscriptions

المرجع: الاشتراك

اشتراك واحد لكل تطبيق

تمثيل JSON
{
  "packageName": string,
  "productId": string,
  "basePlans": [
    {
      object (BasePlan)
    }
  ],
  "listings": [
    {
      object (SubscriptionListing)
    }
  ],
  "archived": boolean,
  "taxAndComplianceSettings": {
    object (SubscriptionTaxAndComplianceSettings)
  }
}
الحقول
packageName

string

غير قابل للتغيير. اسم حزمة التطبيق الرئيسي

productId

string

غير قابل للتغيير. معرّف المنتج الفريد للمنتج فريد داخل التطبيق الرئيسي. يجب أن تتألف معرّفات المنتجات من أحرف صغيرة (a-z) وأرقام (0-9) وشرطات سفلية (_) ونقاط (.). ويجب أن تبدأ بحرف صغير أو رقم وأن يتراوح طوله بين 1 و40 (شاملًا).

basePlans[]

object (BasePlan)

مجموعة الخطط الأساسية لهذا الاشتراك عرض أسعار الاشتراك ومدته في حال عدم سريان أي عروض أخرى.

listings[]

object (SubscriptionListing)

مطلوبة. قائمة بالبيانات المترجَمة لهذا الاشتراك يجب أن تحتوي على إدخال على الأقل للغة التلقائية للتطبيق الرئيسي.

archived
(deprecated)

boolean

النتائج فقط. مهملة: ميزة أرشفة الاشتراكات غير متاحة.

taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

تفاصيل حول الضرائب والامتثال القانوني

BasePlan

هي خطة أساسية واحدة للاشتراك.

تمثيل JSON
{
  "basePlanId": string,
  "state": enum (State),
  "regionalConfigs": [
    {
      object (RegionalBasePlanConfig)
    }
  ],
  "offerTags": [
    {
      object (OfferTag)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsBasePlanConfig)
  },

  // Union field base_plan_type can be only one of the following:
  "autoRenewingBasePlanType": {
    object (AutoRenewingBasePlanType)
  },
  "prepaidBasePlanType": {
    object (PrepaidBasePlanType)
  }
  // End of list of possible types for union field base_plan_type.
}
الحقول
basePlanId

string

مطلوبة. غير قابل للتغيير. المعرّف الفريد لهذه الخطة الأساسية. يجب أن يكون فريدًا داخل الاشتراك وأن يتوافق مع RFC-1034. ويعني ذلك أنّ المعرّف يجب أن يحتوي فقط على أحرف صغيرة (a-z) وأرقام (0-9) وواصلات (-)، وألّا يزيد عن 63 حرفًا.

state

enum (State)

النتائج فقط. تمثّل هذه السمة حالة الخطة الأساسية، أي ما إذا كانت نشطة. يمكن تفعيل أو حذف المسودّات والخطط الأساسية غير النشطة. يمكن أن تكون الخطط الأساسية النشطة غير نشطة. يمكن إلغاء الخطط الأساسية غير النشطة. لا يمكن تغيير هذا الحقل من خلال تعديل المرجع. استخدِم نقاط النهاية المخصّصة بدلاً من ذلك.

regionalConfigs[]

object (RegionalBasePlanConfig)

معلومات خاصة بمنطقة محدّدة لهذه الخطة الأساسية

offerTags[]

object (OfferTag)

قائمة تضم ما يصل إلى 20 علامة مخصّصة تم تحديدها لهذه الخطة الأساسية، وتم إرجاعها إلى التطبيق من خلال مكتبة الفوترة. ستتلقّى أيضًا عروض الاشتراك في هذه الخطة الأساسية علامات العروض هذه في "مكتبة الفوترة".

otherRegionsConfig

object (OtherRegionsBasePlanConfig)

قد يتم إطلاق معلومات الأسعار لأي مواقع جغرافية جديدة في Play في المستقبل. في حال حذفها، لن تكون الخطة الأساسية متوفّرة تلقائيًا في أي مواقع جغرافية جديدة قد يتم إطلاقها بواسطة Play في المستقبل.

حقل الاتحاد base_plan_type نوع هذه الخطة الأساسية. يجب ضبط واحد بالضبط. يمكن أن يكون الحقل "base_plan_type" واحدًا فقط مما يلي:
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

يمكنك تحديد أوقات تجديد الخطة الأساسية تلقائيًا على فترات منتظمة.

prepaidBasePlanType

object (PrepaidBasePlanType)

يمكنك تحديد الحالات التي لا يتم فيها تجديد الخطة الأساسية تلقائيًا في نهاية المدة الزمنية للفوترة.

الحالة

الحالة الحالية للخطة الأساسية.

عمليات التعداد
STATE_UNSPECIFIED حالة غير محدّدة
DRAFT إنّ الخطة الأساسية في حالة مسودّة حاليًا ولم يتم تفعيلها. ويمكن حذفها بأمان في هذه المرحلة.
ACTIVE الخطة الأساسية نشطة ومتاحة للمشتركين الجدد.
INACTIVE الخطة الأساسية غير نشطة ومتاحة فقط للمشتركين الحاليين.

AutoRenewingBasePlanType

يُمثِّل ذلك خطة أساسية يتم تجديدها تلقائيًا في نهاية فترة الاشتراك.

تمثيل JSON
{
  "billingPeriodDuration": string,
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode),
  "legacyCompatible": boolean,
  "legacyCompatibleSubscriptionOfferId": string
}
الحقول
billingPeriodDuration

string

مطلوبة. فترة الاشتراك، محدّدة بتنسيق ISO 8601. للاطّلاع على قائمة بالمُدد الزمنية المقبولة للفوترة، يُرجى الرجوع إلى مركز المساعدة.

gracePeriodDuration

string

فترة السماح للاشتراك، محدّدة بتنسيق ISO 8601. القيم المقبولة هي P0D (بدون أيام) وP3D (3 أيام) وP7D (7 أيام) وP14D (14 يومًا) وP30D (30 يومًا). في حال عدم تحديد قيمة، سيتم استخدام قيمة تلقائية استنادًا إلى مدة الفترة المتكررة.

accountHoldDuration

string

اختياريّ. فترة تعليق الاشتراك الخاصة بالاشتراك، محددة بتنسيق ISO 8601. يجب أن تكون القيم المقبولة بأيام DAYS وأن تتراوح بين P0D (صفر أيام) وP30D (30 يومًا). وفي حال عدم تحديد قيمة، ستكون القيمة التلقائية P30D (30 يومًا).

resubscribeState

enum (ResubscribeState)

ما إذا كان يجب أن يتمكّن المستخدمون من إعادة الاشتراك في هذه الخطة الأساسية في مساحات عرض Google Play يتم ضبط الإعداد التلقائي على REsubscribe_STATE_ACTIVE إذا لم يتم تحديده.

prorationMode

enum (SubscriptionProrationMode)

يحدِّد وضع التوزيع بالتناسب للخطة الأساسية ما يحدث عندما ينتقل المستخدم من خطة أساسية أخرى إلى هذه الخطة. وفي حال عدم تحديده، سيتم ضبط القيمة التلقائية على charge_ON_NEXT_BILLING_DATE.

legacyCompatible

boolean

ما إذا كانت الخطة الأساسية لتجديد الاشتراك متوافقة مع الأنظمة القديمة

يتم عرض الخطة الأساسية المتوافقة مع الأنظمة القديمة من خلال طريقة querySkuDetailsAsync() المتوقفة نهائيًا في Google Play Billing Library.

يمكن وضع علامة على خطة أساسية واحدة فقط قائمة على أنّها متوافقة مع الإصدار القديم لاشتراك معيّن.

legacyCompatibleSubscriptionOfferId

string

رقم تعريف عرض الاشتراك المتوافق مع الإصدارات القديمة

يتم عرض عرض الاشتراك المتوافق مع الأنظمة القديمة من خلال طريقة querySkuDetailsAsync() المتوقّفة نهائيًا في Google Play Billing Library.

يمكن وضع علامة على عرض اشتراك واحد فقط على أنّه متوافق مع الإصدار القديم لخطة أساسية مُجدَّدة محدّدة.

إذا أردت عدم الاستفادة من عرض اشتراك بسبب الإصدارات المتوافقة مع الإصدارات القديمة، عليك ضبط هذا الحقل كسلسلة فارغة.

ResubscribeState

حالة إعادة الاشتراك في الخطة الأساسية

عمليات التعداد
RESUBSCRIBE_STATE_UNSPECIFIED حالة غير محدّدة
RESUBSCRIBE_STATE_ACTIVE تم تفعيل ميزة "إعادة الاشتراك".
RESUBSCRIBE_STATE_INACTIVE ميزة "إعادة الاشتراك" غير مفعّلة.

SubscriptionProrationMode

وضع التوزيع التناسبي المستخدَم لتجديد الخطط الأساسية

عمليات التعداد
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED وضع غير محدَّد
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE سيتم تحصيل رسوم الخطة الأساسية الجديدة من المستخدمين في نهاية المدة الزمنية الحالية للفوترة.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY سيتم تحصيل رسوم الخطة الأساسية الجديدة من المستخدمين فورًا وبشكل كامل. سيتم استخدام أي مدة متبقية من اشتراكهم الحالي لتمديد مدة خطة الفوترة الجديدة.

PrepaidBasePlanType

يُمثِّل هذا الاشتراك خطة أساسية لا يتم تجديدها تلقائيًا في نهاية الخطة الأساسية، ويجب أن يجدّدها المستخدم يدويًا.

تمثيل JSON
{
  "billingPeriodDuration": string,
  "timeExtension": enum (TimeExtension)
}
الحقول
billingPeriodDuration

string

مطلوبة. فترة الاشتراك، محدّدة بتنسيق ISO 8601. للاطّلاع على قائمة بالمُدد الزمنية المقبولة للفوترة، يُرجى الرجوع إلى مركز المساعدة.

timeExtension

enum (TimeExtension)

ما إذا كان بإمكان المستخدمين تمديد هذه الخطة الأساسية المدفوعة مسبقًا في مساحات العرض في Google Play. يتم ضبط الإعدادات التلقائية على TIME_extension_ACTIVE إذا لم يتم تحديدها.

TimeExtension

تمديد مدة الخطة الأساسية

عمليات التعداد
TIME_EXTENSION_UNSPECIFIED حالة غير محدّدة
TIME_EXTENSION_ACTIVE إضافة الوقت نشطة. يمكن للمستخدمين إضافة رصيد إلى خطة الدفع المُسبَق أو تمديدها.
TIME_EXTENSION_INACTIVE الإضافة الزمنية غير نشطة. لا يمكن للمستخدمين إضافة رصيد إلى خطة الدفع المُسبَق أو تمديدها.

RegionalBasePlanConfig

إعدادات خطة أساسية خاصة بمنطقة معيّنة

تمثيل JSON
{
  "regionCode": string,
  "newSubscriberAvailability": boolean,
  "price": {
    object (Money)
  }
}
الحقول
regionCode

string

مطلوبة. رمز المنطقة الذي ينطبق عليه هذا الإعداد، وفقًا لمعيار ISO 3166-2، مثل "US".

newSubscriberAvailability

boolean

ما إذا كانت الخطة الأساسية في المنطقة المحدّدة متاحة للمشتركين الجدد ولن يتم إلغاء اشتراك المشتركين الحاليين إذا تم ضبط هذه القيمة على "خطأ". إذا لم يتم تحديد القيمة، سيتم ضبط القيمة تلقائيًا على "خطأ".

price

object (Money)

سعر الخطة الأساسية في المنطقة المحدّدة يجب ضبطها إذا كانت الخطة الأساسية متاحة للمشتركين الجدد. يجب ضبطها بالعملة المرتبطة بالمنطقة المحدّدة.

OtherRegionsBasePlanConfig

معلومات الأسعار لأي مواقع جغرافية جديدة قد يتم إطلاق Play فيها

تمثيل JSON
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  },
  "newSubscriberAvailability": boolean
}
الحقول
usdPrice

object (Money)

مطلوبة. السعر بالدولار الأمريكي للاستخدام في أي مواقع جغرافية جديدة قد يتم إطلاق Play فيها

eurPrice

object (Money)

مطلوبة. السعر باليورو الذي يمكن استخدامه في أي مواقع جغرافية جديدة قد يتم إطلاق Play فيها

newSubscriberAvailability

boolean

ما إذا كانت الخطة الأساسية متاحة للمشتركين الجُدد في أي مواقع جغرافية جديدة قد يتم إطلاق Play فيها إذا لم يتم تحديد القيمة، سيتم ضبط القيمة تلقائيًا على "خطأ".

SubscriptionListing

البيانات الوصفية للاشتراك المرئية للمستهلك.

تمثيل JSON
{
  "languageCode": string,
  "title": string,
  "benefits": [
    string
  ],
  "description": string
}
الحقول
languageCode

string

مطلوبة. لغة هذه البيانات، كما هو محدّد في BCP-47، مثل "en-US".

title

string

مطلوبة. تمثّل هذه السمة عنوان هذا الاشتراك بلغة هذه البيانات. نص عادي:

benefits[]

string

قائمة بالمزايا المعروضة للمستخدم على منصات مثل "متجر Play" وفي عمليات الاستعادة بلغة بطاقة البيانات هذه. نص عادي: قائمة مرتّبة تتضمّن أربع مزايا على الأكثر.

description

string

وصف هذا الاشتراك بلغة هذه البيانات. الحد الأقصى للطول: 80 حرفًا. نص عادي:

الطُرق

archive
(deprecated)

مهملة: ميزة أرشفة الاشتراكات غير متاحة.

batchGet

تتيح قراءة اشتراك واحد أو أكثر.

batchUpdate

لتعديل مجموعة من الاشتراكات.

create

ينشئ اشتراكًا جديدًا.

delete

يؤدي هذا الإجراء إلى حذف اشتراك.

get

قراءة اشتراك واحد

list

يسرد جميع الاشتراكات ضمن تطبيق معيّن.

patch

لتعديل اشتراك حالي