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 علامة مخصّصة محدّدة لهذه الخطة الأساسية، ويتم عرضها للتطبيق من خلال Billing Library. وستتلقّى عروض الاشتراك في هذه الخطة الأساسية أيضًا علامات العروض هذه في Billing Library.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

معلومات الأسعار لأي مواقع جغرافية جديدة قد يطلقها Google Play في المستقبل في حال حذف هذه القيمة، لن تكون الخطة الأساسية متاحة تلقائيًا في أي مواقع جغرافية جديدة قد يطلقها Google 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 والقيمة الأقل من 30D ومدة الفوترة للخطة الأساسية.

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

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

string

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

يشير الحقل الفارغ إلى فترة تعليق الاشتراك المقترَحة، والتي يتم احتسابها على أنّها 60 يومًا غير شاملة فترة السماح.

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

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

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

string

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

يشير الحقل الفارغ إلى فترة تعليق الاشتراك المقترَحة، والتي يتم احتسابها على أنّها 60 يومًا غير شاملة فترة السماح.

يجب أن يتراوح إجمالي عدد أيام 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-1 alpha-2، مثل "US".
newSubscriberAvailability

boolean

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

object (Money)

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

OtherRegionsBasePlanConfig

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

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

object (Money)

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

object (Money)

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

boolean

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

SubscriptionListing

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

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

string

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

string

الحقل مطلوب. عنوان هذا الاشتراك بلغة بطاقة بيانات المتجر هذه نص عادي
benefits[]

string

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

string

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

الطُرق

archive
(deprecated)

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

batchGet

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

batchUpdate

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

create

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

delete

 لحذف اشتراك

get

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

list

 تعرض هذه الطريقة قائمة بجميع الاشتراكات في تطبيق معيّن.

patch

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

رموز الخطأ

تعرض عمليات هذا المورد رموز الخطأ التالية في بروتوكول HTTP:

رمز الخطأ السبب الوصف الدقة