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. اطّلِع على مثال عن محوّل Epoch.
kind

string

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

object (Seats)

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

object (RenewalSettings)

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

string

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

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

object

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

string

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

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

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

plan.isCommitmentPlan

boolean

تحدِّد القيمة المنطقية للسمة isCommitmentPlan الخطة على أنّها خطة اشتراك سنوي:

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

object

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

plan.commitmentInterval.startTime

string (int64 format)

تبلغ الفاصل الزمني لخطة الاشتراك السنوية startTime بالملي ثانية باستخدام تنسيق UNIX Epoch. اطّلِع على مثال عن محوّل Epoch.
plan.commitmentInterval.endTime

string (int64 format)

تبلغ الفاصل الزمني لخطة الاشتراك السنوية endTime بالملي ثانية باستخدام تنسيق حقبة UNIX. اطّلِع على مثال عن محوّل Epoch.
trialSettings

object

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

boolean

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

  • true — لا تزال الخطة في مرحلة تجريبية.
  • false: الخطة ليست في فترة تجريبية.
trialSettings.trialEndTime

string (int64 format)

التاريخ الذي تنتهي فيه الفترة التجريبية. وتكون القيمة بالمللي ثانية باستخدام تنسيق UNIX Epoch. اطّلِع على مثال عن محوّل Epoch.
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

RenewalSettings

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

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

string

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

string

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

الطُرق

activate

 تفعيل اشتراك سبق أن علَّقه المورِّد

changePlan

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

changeRenewalSettings

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

changeSeats

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

delete

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

get

 للحصول على اشتراك محدّد

insert

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

list

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

startPaidService

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

suspend

 يؤدي هذا الخيار إلى تعليق اشتراك نشِط.