REST Resource: purchases.subscriptions

المورد: Subscriptionشراء

يشير مورد شراء الاشتراكات إلى حالة شراء اشتراك المستخدم.

تمثيل JSON 
{
  "kind": string,
  "startTimeMillis": string,
  "expiryTimeMillis": string,
  "autoResumeTimeMillis": string,
  "autoRenewing": boolean,
  "priceCurrencyCode": string,
  "priceAmountMicros": string,
  "introductoryPriceInfo": {
    object (IntroductoryPriceInfo)
  },
  "countryCode": string,
  "developerPayload": string,
  "paymentState": integer,
  "cancelReason": integer,
  "userCancellationTimeMillis": string,
  "cancelSurveyResult": {
    object (SubscriptionCancelSurveyResult)
  },
  "orderId": string,
  "linkedPurchaseToken": string,
  "purchaseType": integer,
  "priceChange": {
    object (SubscriptionPriceChange)
  },
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string,
  "profileId": string,
  "acknowledgementState": integer,
  "externalAccountId": string,
  "promotionType": integer,
  "promotionCode": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}
الحقول
kind

string

ويمثّل هذا النوع كائن purchasepurchase في خدمة androidpublisher.
startTimeMillis

string (int64 format)

الوقت الذي تم فيه منح الاشتراك، بالمللي ثانية منذ النهاية.
expiryTimeMillis

string (int64 format)

الوقت الذي ستنتهي فيه صلاحية الاشتراك بالمللي ثانية منذ البداية.
autoResumeTimeMillis

string (int64 format)

الوقت الذي سيتم فيه استئناف الاشتراك تلقائيًا بالمللي ثانية منذ البداية. ولا يتم عرضها إلا إذا طلب المستخدم إيقاف الاشتراك مؤقتًا.
autoRenewing

boolean

ما إذا كان سيتم تجديد الاشتراك تلقائيًا عند حلول وقت انتهاء الصلاحية الحالي.
priceCurrencyCode

string

رمز العملة ISO 4217 لسعر الاشتراك. على سبيل المثال، إذا تم تحديد السعر بالجنيه الإسترليني، إذا كان priceCurrencyCode هو &&;;GBP".
priceAmountMicros

string (int64 format)

سعر الاشتراك، بالنسبة إلى البلدان غير شاملة الضرائب، لا يشمل السعر الضريبة. بالنسبة إلى البلدان التي تشمل الضرائب، يشمل السعر الضريبة. يتم التعبير عن السعر بوحدات صغيرة تمثّل 1,000,000 وحدة مصغّرة وحدة واحدة من العملة. على سبيل المثال، إذا كان سعر الاشتراك هو 1.99 يورو، يكون priceAmountMicros هو 1990000.
introductoryPriceInfo

object (IntroductoryPriceInfo)

معلومات السعر التمهيدي للاشتراك. ولا يتوفّر ذلك إلا عند شراء الاشتراك بسعر تمهيدي.

لا يشير هذا الحقل إلى أنّ الاشتراك حاليًا في فترة أسعار تمهيدية.
countryCode

string

رمز المنطقة/البلد للفوترة في ISO 3166-1 alpha-2 للمستخدم في وقت منح الاشتراك.
developerPayload

string

سلسلة يحددها مطوّر البرامج تحتوي على معلومات تكميلية حول طلب ما.
paymentState

integer

حالة الدفع الخاصة بالاشتراك. القيم المحتمَلة هي: 0. الدفعة 1. تم استلام الدفعة 2. فترة تجريبية مجانية 3. في انتظار الترقية/الرجوع إلى إصدار سابق مؤجل

غير متوفّر للاشتراكات المُلغاة والمنتهية الصلاحية.
cancelReason

integer

سبب إلغاء الاشتراك أو عدم تجديده تلقائيًا. القيم المحتمَلة هي: 0. ألغى المستخدم الاشتراك 1. ألغى النظام الاشتراك، مثلاً بسبب مشكلة في الفوترة 2. تم استبدال الاشتراك باشتراك جديد 3. تم إلغاء الاشتراك بواسطة مطوّر البرامج
userCancellationTimeMillis

string (int64 format)

الوقت الذي تم فيه إلغاء الاشتراك من قِبل المستخدم، بالملي ثانية منذ هذه الفترة. ويتوفّر العرض فقط في حال كان سبب الإلغاء هو 0.
cancelSurveyResult

object (SubscriptionCancelSurveyResult)

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

string

مُعرّف الطلب لآخر طلب شراء متكرّر مرتبط بشراء الاشتراك. إذا تم إلغاء الاشتراك بسبب رفض الدفعة، سيكون هذا هو معرّف الطلب من الطلب الذي تم رفض الدفعة.
linkedPurchaseToken

string

الرمز المميز للشراء لعملية الشراء الأصلية إذا كان هذا الاشتراك هو أحد ما يلي: 0 إعادة تسجيل اشتراك مُلغى بدون أن تنتهي صلاحيته 1. الترقية/الرجوع إلى إصدار سابق من اشتراك سابق

على سبيل المثال، لنفترض أن المستخدم اشترك في الأصل وحصلت على الرمز المميز للشراء X، ثم ألغى المستخدم عملية إعادة الاشتراك (قبل انتهاء صلاحية اشتراكه) وستتلقى رمز الشراء Y، وأخيرًا ترقية المستخدم لاشتراكه وتلقّي الرمز المميز للشراء Z. وإذا كنت توجّه واجهة برمجة التطبيقات هذه باستخدام الرمز المميز للشراء Z، سيتم ضبط هذا الحقل على Y. وإذا كنت تطلب واجهة برمجة التطبيقات هذه من خلال الرمز المميز للشراء Y، سيتم ضبط هذا الحقل على X. إذا كنت توجّه واجهة برمجة التطبيقات هذه باستخدام الرمز المميز للشراء X، لن يتم ضبط هذا الحقل.
purchaseType

integer

نوع شراء الاشتراك. يتم ضبط هذا الحقل فقط إذا لم يتم إجراء عملية الشراء هذه باستخدام مسار الفوترة العادي داخل التطبيقات. القيم المحتمَلة هي: 0. اختبار (أي تم شراؤه من حساب اختبار ترخيص) 1. العرض الترويجي (أي الذي تم شراؤه باستخدام رمز ترويجي)
priceChange

object (SubscriptionPriceChange)

تتوفّر أحدث معلومات تغيير السعر. لا تتوفر هذه الميزة إلا في حال حدوث تغيير في سعر الاشتراك بعد.

بعد تجديد الاشتراك بالسعر الجديد أو إلغاء الاشتراك، لن يتم إرجاع أي معلومات عن تغيير السعر.
profileName

string

اسم الملف الشخصي للمستخدم عند شراء الاشتراك. متاح فقط لعمليات الشراء التي تم إجراؤها باستخدام &#39؛الاشتراك مع Google&#39؛
emailAddress

string

عنوان البريد الإلكتروني للمستخدم عند شراء الاشتراك. متاح فقط لعمليات الشراء التي تم إجراؤها باستخدام &#39؛الاشتراك مع Google&#39؛
givenName

string

الاسم المحدَّد للمستخدم عند شراء الاشتراك. متاح فقط لعمليات الشراء التي تم إجراؤها باستخدام &#39؛الاشتراك مع Google&#39؛
familyName

string

اسم عائلة المستخدم عند شراء الاشتراك. متاح فقط لعمليات الشراء التي تم إجراؤها باستخدام &#39؛الاشتراك مع Google&#39؛
profileId

string

رقم تعريف الملف الشخصي في Google للمستخدم عند شراء الاشتراك. متاح فقط لعمليات الشراء التي تم إجراؤها باستخدام &#39؛الاشتراك مع Google&#39؛
acknowledgementState

integer

حالة الإقرار لمنتج الاشتراك. القيم المحتمَلة هي: 0. ولم يتم استلامك بعد. تمت الموافقة
externalAccountId

string

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

integer

نوع العرض الترويجي الذي تم تطبيقه على عملية الشراء هذه. يتم ضبط هذا الحقل فقط في حال تطبيق عرض ترويجي عند شراء الاشتراك. القيم المحتمَلة هي: 0. رمز مرة واحدة 1. رمز مخصص
promotionCode

string

الرمز الترويجي الذي تم تطبيقه على عملية الشراء هذه لا يتم ضبط هذا الحقل إلا إذا تم تطبيق عرض ترويجي للرموز المميزة عند شراء الاشتراك.
obfuscatedExternalAccountId

string

هي إصدار يتضمن تشويشًا لرقم التعريف المرتبط بشكل فريد بحساب المستخدم في تطبيقك. ويُرجى مشاركة العرض مع عمليات الشراء التالية: * في حال ربط الحساب كجزء من عملية شراء الاشتراك. * تم تحديده باستخدام https://developer.android.com/reference/com/android/billingclient/api/billingFlowParams.Builder#setobfuscatedaccountid عند إجراء عملية الشراء.
obfuscatedExternalProfileId

string

هو إصدار يتضمن تشويشًا لرقم التعريف المرتبط بشكلٍ فريد بالملف الشخصي للمستخدم في تطبيقك. ولا يتم عرضه إلا في حال تحديده باستخدام https://developer.android.com/reference/com/android/billingclient/api/billingFlowParams.Builder#setobfuscatedprofileid.

معلومات السعر التمهيدي

يتضمن معلومات السعر التمهيدي للاشتراك.

تمثيل JSON 
{
  "introductoryPriceCurrencyCode": string,
  "introductoryPriceAmountMicros": string,
  "introductoryPricePeriod": string,
  "introductoryPriceCycles": integer
}
الحقول
introductoryPriceCurrencyCode

string

رمز العملة ISO 4217 لسعر الاشتراك التمهيدي. على سبيل المثال، إذا تم تحديد السعر بالجنيه الإسترليني، إذا كان priceCurrencyCode هو &&;;GBP".
introductoryPriceAmountMicros

string (int64 format)

السعر التمهيدي من الاشتراك، بدون تضمين الضريبة. العملة هي نفسها السعر priceCurrencyCode. يتم التعبير عن السعر بوحدات صغيرة تمثّل 1,000,000 وحدة مصغّرة وحدة واحدة من العملة. على سبيل المثال، إذا كان سعر الاشتراك هو 1.99 يورو، يكون priceAmountMicros هو 1990000.
introductoryPricePeriod

string

تمثّل هذه السمة فترة السعر التمهيدي، المحددة بتنسيق ISO 8601. القيم الشائعة هي (على سبيل المثال لا الحصر) "P1W" (أسبوع واحد) و"P1M" (شهر واحد) &&;;P3M" (ثلاثة أشهر)" &";P6M" (ستة أشهر)" و"& P&Y": (عام واحد).
introductoryPriceCycles

integer

عدد المدة الزمنية للفوترة لعرض أسعار تمهيدية.

نتيجة إلغاء الاستطلاع

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

تمثيل JSON 
{
  "cancelSurveyReason": integer,
  "userInputCancelReason": string
}
الحقول
cancelSurveyReason

integer

سبب الإلغاء الذي اختاره المستخدم في الاستطلاع. القيم المحتمَلة هي: 0. غير ذلك 1. لا أستخدم هذه الخدمة بما يكفي. المشاكل الفنية 3- الأسباب ذات الصلة بالتكلفة 4. اكتشفت تطبيقًا أفضل.
userInputCancelReason

string

سبب إلغاء الإدخال المخصص من المستخدم. ويتوفّر فقط عندما يكون الإلغاء"> هو 0.

تغيير سعر الاشتراك

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

تمثيل JSON 
{
  "newPrice": {
    object (Price)
  },
  "state": integer
}
الحقول
newPrice

object (Price)

السعر الجديد الذي سيتم تجديد الاشتراك باستخدامه إذا وافق المستخدم على تغيير السعر.
state

integer

الحالة الراهنة للتغيير في السعر. القيم المحتمَلة هي: 0. مُعلَّق: حالة التغيير المعلَّق للسعر الذي في انتظار موافقة المستخدم. وفي هذه الحالة، يمكنك اختياريًا طلب التأكيد من المستخدم باستخدام واجهة برمجة التطبيقات داخل التطبيق. 1- مقبول: تحديد التغيير المقبول في السعر الذي سيتم تجديده للاشتراك ما لم يتم إلغاؤه. يسري التغيير على السعر في التاريخ المستقبلي الذي يتم فيه تجديد الاشتراك. يُرجى العلم أنّ هذا التغيير قد لا يحدث عند تجديد الاشتراك في المرة القادمة.

الطُرق

acknowledge

 الإقرار بعملية شراء اشتراك.

cancel

 إلغاء شراء اشتراك المستخدم.

defer

 تأجيل شراء اشتراك المستخدم حتى وقت انتهاء الصلاحية المحدّد في المستقبل

get

 للتحقق مما إذا كان شراء اشتراك المستخدم صالحًا ويعرض وقت انتهاء الصلاحية.

refund

 يتم ردّ الأموال المدفوعة في شراء اشتراك المستخدم، ولكن يظل الاشتراك ساريًا إلى أن تنتهي صلاحيته، وسيستمر تكراره.

revoke

 ردّ الأموال وإبطال شراء اشتراك المستخدم على الفور.