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

هذا حقل اختياري. إنّ معلومات طلب الشراء هذه مخصّصة لبائعي التجزئة لاستخدامها في تتبُّع استخدام شركتهم. في حال تقديم قيمة 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 إلى تخصيص خطة دفع لفترة تجريبية، ولكن لن يؤدي ذلك إلى تفعيل الخطة. ستبدأ الفترة التجريبية تلقائيًا خطة الدفع المحدّدة لها بعد اليوم الثلاثين من الفترة المجانية أو بعد الاتصال برقم startPaidService مباشرةً.
  • FREE - الخطة المجانية حصرية لرموز التخزين التعريفية في Cloud Identity ولا تتطلّب أي رسوم.

plan.isCommitmentPlan

boolean

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

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

object

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

plan.commitmentInterval.startTime

string (int64 format)

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

string (int64 format)

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

object

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

boolean

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

  • true - الخطة قيد التجربة.
  • false - الخطة ليست في فترة تجريبية.
trialSettings.trialEndTime

string (int64 format)

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

object

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

string (int64 format)

الوقت الذي ستنتهي فيه صلاحية الرمز المميّز للنقل أو نية النقل يتم عرض الوقت بالمللي ثانية باستخدام تنسيق حقبة UNIX.
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 License Manager API: ‏ 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

 تعليق اشتراك نشط