REST Resource: monetization.subscriptions

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

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

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

string

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

string

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

object (BasePlan)

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

object (SubscriptionListing)

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

boolean

النتائج فقط. تم إيقاف هذه الميزة نهائيًا: لا تتوفّر ميزة أرشفة الاشتراكات.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

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

object (RestrictedPaymentCountries)

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

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)
  },
  "installmentsBasePlanType": {
    object (InstallmentsBasePlanType)
  }
  // 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)

يتم ضبط هذا الخيار عندما لا يتم تجديد الخطة الأساسية تلقائيًا في نهاية مدة الفوترة.
installmentsBasePlanType

object (InstallmentsBasePlanType)

يتم ضبطها للخطط الأساسية المستندة إلى الأقساط التي يلتزم فيها المستخدم بعدد محدّد من الدفعات.

الحالة

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

عمليات التعداد
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 و30 يومًا أو أقل من فترة فوترة الخطة الأساسية.

في حال عدم تحديدها، سيتم استخدام قيمة تلقائية استنادًا إلى فترة الفوترة.

يجب أن يتراوح إجمالي عدد أيام gracePeriodDuration وaccountHoldDuration بين P30D وP60D، بما في ذلك.
accountHoldDuration

string

اختيارية: فترة تعليق الاشتراك في الحساب، المحدّدة بتنسيق ISO 8601 يجب أن تكون القيم المقبولة بالأيام وأن تتراوح بين P0D وP60D.

إذا لم يتم تحديد قيمة، تكون القيمة التلقائية هي P30D.

يجب أن يتراوح إجمالي عدد أيام gracePeriodDuration وaccountHoldDuration بين P30D وP60D، بما في ذلك.
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 تم إيقاف ميزة تمديد الوقت. لا يمكن للمستخدمين إضافة رصيد إلى خطتهم المدفوعة مسبقًا أو تمديدها.

InstallmentsBasePlanType

يمثّل خطة أساسية للتقسيط يلتزم فيها المستخدم بتسديد عدد محدّد من الدفعات.

تمثيل JSON 
{
  "billingPeriodDuration": string,
  "committedPaymentsCount": integer,
  "renewalType": enum (RenewalType),
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode)
}
الحقول
billingPeriodDuration

string

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

integer

مطلوب. غير قابل للتغيير عدد الدفعات التي يلتزم بها المستخدم ولا يمكن تغييرها بعد إنشاء الخطة الأساسية.
renewalType

enum (RenewalType)

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

string

فترة السماح للاشتراك، المحدّدة بتنسيق ISO 8601 يجب أن تكون القيم المقبولة بالأيام وأن تتراوح بين P0D و30 يومًا أو أقل من فترة فوترة الخطة الأساسية.

في حال عدم تحديدها، سيتم استخدام قيمة تلقائية استنادًا إلى فترة الفوترة.

يجب أن يتراوح إجمالي عدد أيام gracePeriodDuration وaccountHoldDuration بين P30D وP60D، بما في ذلك.
accountHoldDuration

string

اختيارية: فترة تعليق الاشتراك في الحساب، المحدّدة بتنسيق ISO 8601 يجب أن تكون القيم المقبولة بالأيام وأن تتراوح بين P0D وP60D.

إذا لم يتم تحديد قيمة، تكون القيمة التلقائية هي P30D.

يجب أن يتراوح إجمالي عدد أيام gracePeriodDuration وaccountHoldDuration بين P30D وP60D، بما في ذلك.
resubscribeState

enum (ResubscribeState)

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

enum (SubscriptionProrationMode)

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

RenewalType

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

عمليات التعداد
RENEWAL_TYPE_UNSPECIFIED حالة غير محدَّدة
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT يتم تجديده بشكل دوري لمدة مدة الفوترة بدون التزام.
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT يتم التجديد بالتزام بالمدة نفسها التي تم الالتزام بها في البداية.

RegionalBasePlanConfig

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

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

string

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

boolean

ما إذا كانت الخطة الأساسية في المنطقة المحدّدة متاحة للمشتركين الجدد. لن يتم إلغاء اشتراك المشتركين الحاليين إذا تم ضبط هذه القيمة على "خطأ". إذا لم يتم تحديده، سيتم ضبطه تلقائيًا على false (خطأ).
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 إذا لم يتم تحديده، سيتم ضبطه تلقائيًا على false (خطأ).

SubscriptionListing

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

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

string

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

string

مطلوب. عنوان هذا الاشتراك باللغة المُستخدَمة في بطاقة البيانات هذه نص عادي
benefits[]

string

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

string

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

RestrictedPaymentCountries

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

تمثيل JSON 
{
  "regionCodes": [
    string
  ]
}
الحقول
regionCodes[]

string

مطلوب. رموز المناطق التي سيتم فرض قيود الدفع عليها، كما هو محدّد في معيار ISO 3166-2، مثل "US".

الطُرق

archive
(deprecated)

 تم إيقاف هذه الميزة نهائيًا: لا تتوفّر ميزة أرشفة الاشتراكات.

batchGet

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

batchUpdate

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

create

 لإنشاء اشتراك جديد

delete

 حذف اشتراك

get

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

list

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

patch

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