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 یک شناسه سیستم منحصر به فرد برای SKU محصول است که در اشتراک به مشتری اختصاص داده شده است. برای محصولات و SKUهای موجود در این نسخه از API، شناسه محصول و SKU را ببینید.

creationTime

string ( int64 format)

ویژگی creationTime تاریخ ایجاد اشتراک است. با استفاده از فرمت Epoch در میلی ثانیه است. نمونه ای از مبدل Epoch را ببینید.

kind

string

منبع را به عنوان یک اشتراک شناسایی می کند. ارزش: reseller#subscription

seats

object ( Seats )

این یک ویژگی مورد نیاز است. تعداد و محدودیت مجوزهای صندلی کاربر در طرح.

renewalSettings

object ( RenewalSettings )

تنظیمات تمدید برای طرح تعهد سالانه. برای اطلاعات بیشتر، گزینه‌های تمدید را در مرکز راهنمایی سرپرست ببینید.

purchaseOrderId

string

این یک ویژگی اختیاری است. این اطلاعات سفارش خرید (PO) برای فروشندگان است تا برای استفاده ردیابی شرکت خود استفاده کنند. اگر مقدار purchaseOrderId داده شود، در پاسخ‌های API ظاهر می‌شود و در صورت‌حساب نشان داده می‌شود. این ویژگی حداکثر 80 کاراکتر متن ساده را می پذیرد.

status

string

این یک ویژگی اختیاری است.

resourceUiUrl

string

نشانی وب صفحه اشتراک های مشتری در کنسول مدیریت. URL فقط خواندنی توسط سرویس API تولید می شود. اگر برنامه مشتری شما از مشتری بخواهد با استفاده از صفحه اشتراک‌ها در کنسول مدیریت، یک کار را انجام دهد، استفاده می‌شود.

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 محصول که در اشتراک به مشتری اختصاص داده شده است. نام SKU بنا به صلاحدید Google در معرض تغییر است. برای محصولات و SKUهای موجود در این نسخه از API، شناسه محصول و SKU را ببینید.

plan

object

دارایی plan مورد نیاز است. در این نسخه از API، برنامه‌های G Suite عبارتند از طرح انعطاف‌پذیر، برنامه تعهد سالانه و طرح آزمایشی رایگان 30 روزه. برای اطلاعات بیشتر در مورد برنامه های پرداخت API، به مفاهیم API مراجعه کنید.

plan.planName

string

ویژگی planName مورد نیاز است. این نام طرح اشتراک است. برای اطلاعات بیشتر درباره طرح‌های پرداخت Google، به مفاهیم API مراجعه کنید.

مقادیر ممکن عبارتند از:

  • ANNUAL_MONTHLY_PAY - طرح تعهد سالانه با پرداخت‌های ماهانه.
  • ANNUAL_YEARLY_PAY - طرح تعهد سالانه با پرداخت‌های سالانه
  • FLEXIBLE - طرح انعطاف پذیر
  • TRIAL - طرح آزمایشی رایگان 30 روزه. در صورت عدم اختصاص برنامه پرداخت، اشتراک آزمایشی پس از 30 روز رایگان به حالت تعلیق در خواهد آمد. تماس با changePlan یک طرح پرداخت را به یک آزمایشی اختصاص می‌دهد، اما این طرح را فعال نمی‌کند. یک دوره آزمایشی به طور خودکار پس از 30 روز رایگان یا بلافاصله پس از تماس با startPaidService طرح پرداخت اختصاص داده شده خود را آغاز می کند.
  • FREE - طرح رایگان منحصر به SKU Cloud Identity است و هیچ صورتحساب ندارد.

plan.isCommitmentPlan

boolean

مقدار بولی ویژگی isCommitmentPlan طرح را به عنوان یک طرح تعهد سالانه شناسایی می کند:

  • true - طرح اشتراک یک برنامه تعهد سالانه است.
  • false - این طرح یک برنامه تعهد سالانه نیست.

plan.commitmentInterval

object

در این نسخه از API، فاصله برنامه تعهد سالانه یک سال است.

plan.commitmentInterval.startTime

string ( int64 format)

startTime بازه برنامه تعهد سالانه بر حسب میلی ثانیه با استفاده از فرمت یونیکس Epoch. نمونه ای از مبدل Epoch را ببینید.

plan.commitmentInterval.endTime

string ( int64 format)

endTime یک برنامه تعهد سالانه با استفاده از قالب یونیکس Epoch بر حسب میلی ثانیه. نمونه ای از مبدل Epoch را ببینید.

trialSettings

object

برنامه‌های پرداخت منعطف و تعهد سالانه G Suite می‌توانند در یک دوره آزمایشی رایگان 30 روزه باشند. برای اطلاعات بیشتر، به مفاهیم API مراجعه کنید.

trialSettings.isInTrial

boolean

تعیین می کند که آیا طرح اشتراک در یک دوره آزمایشی رایگان 30 روزه است یا خیر:

  • true - طرح در حال آزمایش است.
  • false - این طرح در حال آزمایش نیست.

trialSettings.trialEndTime

string ( int64 format)

تاریخ پایان محاکمه مقدار با استفاده از فرمت یونیکس Epoch بر حسب میلی ثانیه است. نمونه ای از مبدل Epoch را ببینید.

transferInfo

object

اطلاعات مربوط به انتقال فقط خواندنی برای اشتراک. برای اطلاعات بیشتر، به بازیابی اشتراک‌های قابل انتقال برای مشتری مراجعه کنید.

transferInfo.transferabilityExpirationTime

string ( int64 format)

زمانی که نشانه انتقال یا قصد انتقال منقضی می شود. زمان با استفاده از فرمت یونیکس Epoch بر حسب میلی ثانیه است.

transferInfo.minimumTransferableSeats

integer

هنگام درج اشتراک، این حداقل تعداد صندلی های ذکر شده در سفارش انتقال برای این محصول است. به عنوان مثال، اگر مشتری 20 کاربر داشته باشد، فروشنده نمی تواند برای انتقال 15 صندلی سفارش دهد. حداقل 20 صندلی است.

transferInfo.currentLegacySkuId

string

skuId اشتراک فعلی فروش مجدد. این تنها زمانی پر می شود که مشتری اشتراکی با SKU قدیمی داشته باشد و منبع اشتراک با skuId SKU توصیه شده برای انتقال پر شده باشد.

صندلی

قالب 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

تنظیمات تمدید

قالب JSON برای تنظیمات تمدید اشتراک.

نمایندگی JSON 
{
  "renewalType": string,
  "kind": string
}
فیلدها
renewalType

string

تنظیمات تمدید برای طرح تعهد سالانه. برای اطلاعات بیشتر، گزینه‌های تمدید را در مرکز راهنمایی سرپرست ببینید. هنگام تمدید اشتراک، renewalType یک ویژگی ضروری است.

kind

string

منبع را به عنوان یک تنظیم تمدید اشتراک شناسایی می کند. مقدار: subscriptions#renewalSettings

روش ها

activate

 اشتراکی را فعال می کند که قبلاً توسط فروشنده به حالت تعلیق درآمده است.

changePlan

 یک طرح اشتراک را به روز می کند.

changeRenewalSettings

 تنظیمات تمدید مجوز کاربر را به روز می کند.

changeSeats

 تنظیمات مجوز کاربر اشتراک را به روز می کند.

delete

 اشتراک را لغو، تعلیق یا به دایرکت منتقل می کند.

get

 اشتراک خاصی دریافت می کند.

insert

 ایجاد یا انتقال اشتراک.

list

 لیست اشتراک های مدیریت شده توسط فروشنده.

startPaidService

 فورا اشتراک آزمایشی رایگان 30 روزه را به اشتراک خدمات پولی منتقل کنید.

suspend

 اشتراک فعال را به حالت تعلیق در می آورد.