REST Resource: purchases.subscriptions

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

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

تمثيل 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

يمثل هذا النوع عنصر subscriptionPurchase في خدمة 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)

سعر الاشتراك، بالنسبة إلى البلدان غير المشمولة بالضرائب، لا يشمل السعر الضريبة. وفي البلدان التي تشمل الضرائب، يشمل السعر الضريبة. يتم التعبير عن السعر بالوحدات الدقيقة، حيث تمثل 1000000 وحدة ميكرو وحدة واحدة من العملة. على سبيل المثال، إذا كان سعر الاشتراك هو 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- ترقية الاشتراك أو الاشتراك في خطة أقلّ كلفة من اشتراك سابق

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

integer

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

object (SubscriptionPriceChange)

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

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

string

اسم الملف الشخصي للمستخدم عند شراء الاشتراك. لا يتوفّر هذا الخيار إلا لعمليات الشراء التي تم إجراؤها باستخدام ميزة "اشترِك مع Google".
emailAddress

string

عنوان البريد الإلكتروني للمستخدم عند شراء الاشتراك. لا يتوفّر هذا الخيار إلا لعمليات الشراء التي تم إجراؤها باستخدام ميزة "اشترِك مع Google".
givenName

string

الاسم المعيّن للمستخدم عند شراء الاشتراك. لا يتوفّر هذا الخيار إلا لعمليات الشراء التي تم إجراؤها باستخدام ميزة "اشترِك مع Google".
familyName

string

اسم عائلة المستخدم عند شراء الاشتراك لا يتوفّر هذا الخيار إلا لعمليات الشراء التي تم إجراؤها باستخدام ميزة "اشترِك مع Google".
profileId

string

رقم تعريف الملف الشخصي في حساب Google للمستخدم عند شراء الاشتراك. لا يتوفّر هذا الخيار إلا لعمليات الشراء التي تم إجراؤها باستخدام ميزة "اشترِك مع Google".
acknowledgementState

integer

حالة الإقرار للمنتج المتوفر عند الاشتراك القيم المتاحة: 0. لم يتم الاعتراف بـ 1. تمت الموافقة
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 عندما تم إجراء عملية الشراء.

IntroductoryPriceInfo

تحتوي على معلومات السعر التمهيدي للاشتراك.

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

string

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

string (int64 format)

السعر التمهيدي للاشتراك، لا يشمل الضريبة. العملة هي نفسها عملة priceCurrencyCode. يتم التعبير عن السعر بالوحدات الدقيقة، حيث تمثل 1000000 وحدة ميكرو وحدة واحدة من العملة. على سبيل المثال، إذا كان سعر الاشتراك هو 1.99 يورو، يكون سعر priceAmountMicros هو 1990000.
introductoryPricePeriod

string

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

integer

تمثّل هذه السمة عدد المدة الزمنية للفوترة لتقديم أسعار تمهيدية.

SubscriptionCancelSurveyResult

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

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

integer

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

string

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

SubscriptionPriceChange

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

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

object (Price)

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

integer

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

الطُرق

acknowledge

 تشير هذه الرسالة إلى موافقتك على شراء الاشتراك.

cancel

 إلغاء عملية شراء اشتراك المستخدم

defer

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

get

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

refund

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

revoke

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