REST Resource: subscriptions

المورد: الاشتراك

نموذج JSON للاشتراك.

تمثيل JSON 
{
  "customerId": string,
  "subscriptionId": string,
  "skuId": string,
  "creationTime": string,
  "kind": string,
  "seats": {
    object (Seats)
  },
  "renewalSettings": {
    object (RenewalSettings)
  },
  "purchaseOrderId": string,
  "status": string,
  "resourceUiUrl": string,
  "billingMethod": string,
  "suspensionReasons": [
    string
  ],
  "customerDomain": string,
  "dealCode": string,
  "skuName": string,
  "plan": {
    "planName": string,
    "isCommitmentPlan": boolean,
    "commitmentInterval": {
      "startTime": string,
      "endTime": string
    }
  },
  "trialSettings": {
    "isInTrial": boolean,
    "trialEndTime": string
  },
  "transferInfo": {
    "transferabilityExpirationTime": string,
    "minimumTransferableSeats": integer,
    "currentLegacySkuId": string
  }
}
الحقول
customerId

string

سيتم دائمًا عرض هذه السمة في الرد باعتباره المعرّف الفريد الذي أنشأته Google. في الطلب، يمكن أن يكون هذا الموقع هو النطاق الأساسي أو المعرّف الفريد الذي أنشأته Google.
subscriptionId

string

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

string

خاصية مطلوبة. skuId هو معرّف نظام فريد لرمز التخزين التعريفي للمنتج الذي تم تخصيصه لعميل مشارك في الاشتراك. بالنسبة إلى المنتجات ورموز التخزين التعريفية المتوفّرة في هذا الإصدار من واجهة برمجة التطبيقات، يمكنك الاطّلاع على معرّفات المنتجات ورموز التخزين التعريفية.
creationTime

string (int64 format)

السمة creationTime هي تاريخ إنشاء الاشتراك. وتكون بالمللي ثانية باستخدام تنسيق Epoch. يُرجى الاطّلاع على مثال لمحوّل النهاية.
kind

string

لتعريف المورد باعتباره اشتراكًا. القيمة: reseller#subscription
seats

object (Seats)

هذه الخاصية مطلوبة. عدد تراخيص مقاعد المستخدمين وحدودها في الخطة
renewalSettings

object (RenewalSettings)

إعدادات التجديد لخطة الاشتراك السنوي للمزيد من المعلومات التفصيلية، يمكنك الاطّلاع على خيارات التجديد في مركز مساعدة المشرفين.
purchaseOrderId

string

هذه سمة اختيارية. إنّ معلومات طلب الشراء هذه (PO) مخصّصة للمورّدين لاستخدامها في تتبّع استخدام شركتهم. في حال تقديم قيمة purchaseOrderId، ستظهر في استجابات واجهة برمجة التطبيقات وتظهر في الفاتورة. يقبل الموقع ما يصل إلى 80 حرفًا من النص العادي.
status

string

هذه سمة اختيارية.
resourceUiUrl

string

عنوان URL يؤدي إلى صفحة اشتراكات العميل في وحدة تحكم المشرف. يتم إنشاء عنوان URL للقراءة فقط بواسطة خدمة واجهة برمجة التطبيقات. يتم استخدام هذه الطريقة في حال كان تطبيق العميل يتطلّب من العميل إكمال مهمة باستخدام صفحة "الاشتراكات" في "وحدة تحكُّم المشرف".
billingMethod

string

حقل للقراءة فقط يعرض طريقة الفوترة الحالية لاشتراك.
suspensionReasons[]

string

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

تشمل الخيارات المحتملة ما يلي:

  • PENDING_TOS_ACCEPTANCE - لم يسجّل العميل الدخول إلى بنود خدمات توريد G Suite ولم يقبلها.
  • RENEWAL_WITH_TYPE_CANCEL - انتهى التزام العميل، وتم إلغاء الخدمة في نهاية المدة.
  • RESELLER_INITIATED - استدعاء تعليق يدوي من جانب مورّد.
  • TRIAL_ENDED - انتهت الفترة التجريبية للعميل بدون خطة.
  • OTHER - تم تعليق العميل لسبب داخلي في Google (مثل إساءة الاستخدام أو غير ذلك).

customerDomain

string

اسم النطاق الأساسي للعميل
dealCode

string

الرمز الذي أصدرته Google (100 حرف كحد أقصى) للأسعار المخفّضة على خطط الاشتراك. يجب تضمين رمز الصفقة في طلبات insert للحصول على سعر مخفَّض. هذه السمة اختيارية، ويتم تطبيق السعر العادي في حال تركها فارغة.
skuName

string

الاسم المعروض الخارجي للقراءة فقط لرمز التخزين التعريفي (SKU) الخاص بالمنتج المُخصَّص للعميل في الاشتراك. تخضع أسماء رموز التخزين التعريفية للتغيير وفقًا لتقدير Google الخاص. بالنسبة إلى المنتجات ورموز التخزين التعريفية المتوفّرة في هذا الإصدار من واجهة برمجة التطبيقات، يمكنك الاطّلاع على معرّفات المنتجات ورموز التخزين التعريفية.
plan

object

السمة plan مطلوبة. في هذا الإصدار من واجهة برمجة التطبيقات، خطط G Suite هي الخطة المرنة، وخطة الاشتراك السنوي، وخطة الفترة التجريبية المجانية لمدة 30 يومًا. لمزيد من المعلومات عن خطط الدفع عبر واجهة برمجة التطبيقات، راجِع مفاهيم واجهة برمجة التطبيقات.
plan.planName

string

السمة planName مطلوبة. هذا هو اسم خطة الاشتراك. ولمزيد من المعلومات عن خطط الدفع من Google، يُرجى الاطّلاع على مفاهيم واجهة برمجة التطبيقات.

القيم المحتملة هي:

  • ANNUAL_MONTHLY_PAY - خطة الاشتراك السنوي بنظام الدفعات الشهرية.
  • ANNUAL_YEARLY_PAY — خطة الاشتراك السنوي بنظام الدفعات السنوية
  • FLEXIBLE - الخطة المرنة
  • TRIAL - خطة الفترة التجريبية المجانية لمدة 30 يومًا. سيتم تعليق الاشتراك في فترة تجريبية بعد مرور 30 يومًا من الاستخدام المجاني في حال عدم تخصيص خطة دفع. سيؤدي الاتصال بالرقم changePlan إلى تخصيص خطة دفع إلى فترة تجريبية، ولكن لن يتم تفعيل الخطة. ستبدأ الفترة التجريبية تلقائيًا في خطة الدفع المحددة بعد مرور 30 يومًا من الخدمة المجانية أو بعد الاتصال بـ startPaidService مباشرةً.
  • FREE — تقتصر الخطة المجانية على رمز التخزين التعريفي لخدمة Cloud Identity ولا تتضمَّن أي فواتير.

plan.isCommitmentPlan

boolean

تحدّد القيمة المنطقية للخاصية isCommitmentPlan هذه الخطة كخطة التزام سنوية:

  • true — خطة الاشتراك هي خطة اشتراك سنوي.
  • false: الخطة ليست خطة اشتراك سنوي.
plan.commitmentInterval

object

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

plan.commitmentInterval.startTime

string (int64 format)

خطة اشتراك سنوية تبلغ startTime من ال يُرجى الاطّلاع على مثال لمحوّل النهاية.
plan.commitmentInterval.endTime

string (int64 format)

خطة اشتراك سنوية تبلغ endTime من ال يُرجى الاطّلاع على مثال لمحوّل النهاية.
trialSettings

object

يمكن أن يكون الاشتراك السنوي في G Suite وخطط الدفع المرنة في فترة تجريبية مجانية لمدة 30 يومًا. لمزيد من المعلومات، يُرجى الاطّلاع على مفاهيم واجهة برمجة التطبيقات.
trialSettings.isInTrial

boolean

يحدِّد ما إذا كانت خطة الاشتراك في فترة تجريبية مجانية لمدة 30 يومًا أم لا:

  • true: الخطة تجريبية.
  • false: الخطة ليست تجريبية.
trialSettings.trialEndTime

string (int64 format)

التاريخ الذي تنتهي فيه الفترة التجريبية. تكون القيمة بالمللي ثانية باستخدام تنسيق حقبة UNIX. يُرجى الاطّلاع على مثال لمحوّل النهاية.
transferInfo

object

المعلومات ذات الصلة بالقراءة فقط لنقل الاشتراك. لمزيد من المعلومات، يُرجى الاطِّلاع على استرداد الاشتراكات القابلة للنقل لعميل.
transferInfo.transferabilityExpirationTime

string (int64 format)

الوقت الذي ستنتهي فيه صلاحية الرمز المميّز للنقل أو نية النقل. الوقت بالمللي ثانية باستخدام تنسيق UNIX Epoch.
transferInfo.minimumTransferableSeats

integer

تمثّل هذه السمة الحدّ الأدنى لعدد المقاعد المُدرجة في طلب نقل المنتج عند إدراج اشتراك. على سبيل المثال، إذا كان لدى العميل 20 مستخدمًا، لا يمكن للمورّد تقديم طلب نقل يبلغ 15 مقعدًا. الحد الأدنى هو 20 مقعدًا.
transferInfo.currentLegacySkuId

string

skuId للاشتراك الحالي المُعاد بيعه. وتتم تعبئة هذه السمة فقط عندما يكون لدى العميل اشتراك مع رمز تخزين تعريفي قديم ويتم ملء مورد الاشتراك بـ skuId من رمز التخزين التعريفي المُقترَح للنقل.

عدد المقاعد

نموذج JSON لمقاعد الاشتراك.

تمثيل JSON 
{
  "numberOfSeats": integer,
  "maximumNumberOfSeats": integer,
  "licensedNumberOfSeats": integer,
  "kind": string
}
الحقول
numberOfSeats

integer

هذا الموقع مطلوب ويقتصر على الاشتراكات التي تشمل خطط ANNUAL_MONTHLY_PAY وANNUAL_YEARLY_PAY. يحدد هذا الموقع الحد الأقصى لعدد التراخيص التي يمكن تخصيصها للمستخدمين ضمن الاشتراك. يمكن للمورّد إضافة المزيد من التراخيص، ولكن بعد ضبطه، لا يمكن تقليل numberOfSeats حتى التجديد. يتم إصدار فواتير للمورّد استنادًا إلى قيمة numberOfSeats بغض النظر عن عدد تراخيص المستخدمين التي تم منحها.

maximumNumberOfSeats

integer

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

licensedNumberOfSeats

integer

حقل للقراءة فقط يحتوي على العدد الحالي للمستخدمين الذين تم منحهم ترخيص للمنتج المحدد في skuId. تساوي قيمة هذا الحقل العدد العددي للمستخدمين الذين تعرضها طريقة واجهة برمجة التطبيقات لإدارة تراخيص Enterprise: listForProductAndSku.
kind

string

يحدّد المورد على أنه إعداد مقعد اشتراك. القيمة: subscriptions#seats

إعدادات التجديد

نموذج JSON لإعدادات تجديد الاشتراك

تمثيل JSON 
{
  "renewalType": string,
  "kind": string
}
الحقول
renewalType

string

إعدادات التجديد لخطة الاشتراك السنوي للمزيد من المعلومات التفصيلية، يمكنك الاطّلاع على خيارات التجديد في مركز مساعدة المشرفين. عند تجديد الاشتراك، يجب استخدام renewalType.
kind

string

تحدّد المورد على أنه إعداد تجديد اشتراك. القيمة: subscriptions#renewalSettings

الطُرق

activate

 تفعيل اشتراك تم تعليقه سابقًا من قبل المورد.

changePlan

 يتم تعديل خطة اشتراك.

changeRenewalSettings

 يعدّل إعدادات تجديد ترخيص المستخدم.

changeSeats

 لتعديل إعدادات ترخيص المستخدم.

delete

 إلغاء اشتراك أو تعليقه أو نقله إلى مباشر.

get

 الحصول على اشتراك معيّن.

insert

 إنشاء اشتراك أو نقله.

list

 قوائم الاشتراكات التي يديرها المورّد.

startPaidService

 نقل الاشتراك التجريبي المجاني لمدة 30 يومًا إلى اشتراك خدمة مدفوعة فورًا.

suspend

 يعلّق هذا الاشتراك اشتراكًا نشطًا.