Method: subscriptions.delete

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

درخواست HTTP

DELETE https://reseller.googleapis.com/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
customerId

string

این می تواند نام دامنه اصلی مشتری یا شناسه منحصر به فرد مشتری باشد. اگر نام دامنه برای یک مشتری تغییر کند، نام دامنه قدیمی را نمی توان برای دسترسی به مشتری استفاده کرد، اما شناسه منحصر به فرد مشتری (که توسط API برگردانده شده است) همیشه می تواند استفاده شود. توصیه می کنیم شناسه منحصر به فرد را در صورت لزوم در سیستم های خود ذخیره کنید.

subscriptionId

string

این یک ویژگی مورد نیاز است. subscriptionId شناسه اشتراک است و برای هر مشتری منحصر به فرد است. از آنجایی که هنگام به‌روزرسانی اشتراک، subscriptionId تغییر می‌کند، توصیه می‌کنیم از این شناسه به عنوان کلیدی برای داده‌های دائمی استفاده نکنید. و subscriptionId می توان با استفاده از روش retrieve all reseller subscriptions پیدا کرد.

پارامترهای پرس و جو

پارامترها
deletionType

enum ( DeletionType )

رشته پرس و جو deletionType لغو، تنزل یا تعلیق اشتراک را فعال می کند.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

پیامی که یک بدنه HTTP دلخواه را نشان می‌دهد. فقط باید برای قالب‌های باری استفاده شود که نمی‌توانند به‌عنوان JSON نشان داده شوند، مانند باینری خام یا صفحه HTML.

این پیام را می توان هم در روش های پخش جریانی و هم در روش های غیر استریم API در درخواست و همچنین پاسخ استفاده کرد.

می توان از آن به عنوان یک فیلد درخواست سطح بالا استفاده کرد، که اگر بخواهید پارامترهایی را از URL یا الگوی HTTP در فیلدهای درخواست استخراج کنید و همچنین بخواهید به بدنه HTTP خام دسترسی داشته باشید، راحت است.

مثال:

message GetResourceRequest {
  // A unique request id.
  string requestId = 1;

  // The raw HTTP body is bound to this field.
  google.api.HttpBody http_body = 2;

}

service ResourceService {
  rpc GetResource(GetResourceRequest)
    returns (google.api.HttpBody);
  rpc UpdateResource(google.api.HttpBody)
    returns (google.protobuf.Empty);

}

مثال با روش های پخش:

service CaldavService {
  rpc GetCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);
  rpc UpdateCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);

}

استفاده از این نوع فقط نحوه رسیدگی به درخواست و پاسخ بدن را تغییر می دهد، همه ویژگی های دیگر بدون تغییر به کار خود ادامه می دهند.

در صورت موفقیت آمیز بودن، پاسخ یک پاسخ HTTP عمومی است که قالب آن با روش تعریف شده است.

نمایندگی JSON 
{
  "contentType": string,
  "data": string,
  "extensions": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
فیلدها
contentType

string

مقدار هدر HTTP Content-Type که نوع محتوای بدنه را مشخص می کند.

data

string ( bytes format)

بدنه درخواست/پاسخ HTTP به صورت باینری خام.

رشته ای با کد base64.

extensions[]

object

فراداده پاسخ خاص برنامه باید در اولین پاسخ برای APIهای جریانی تنظیم شود.

یک شی حاوی فیلدهایی از نوع دلخواه. یک فیلد اضافی "@type" حاوی یک URI است که نوع را مشخص می کند. مثال: { "id": 1234, "@type": "types.example.com/standard/id" } .

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/apps.order

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

نوع حذف

Enums
deletion_type_undefined
cancel اشتراک را فورا لغو می کند. این مورد برای اشتراک G Suite اعمال نمی شود.
transfer_to_direct

اشتراک را مستقیماً به Google منتقل می کند. مشتری بلافاصله به یک رابطه صورت‌حساب مستقیم با Google منتقل می‌شود و مدت زمان کوتاهی بدون وقفه در خدمات به او داده می‌شود. سپس مشتری می‌تواند با استفاده از کارت اعتباری صورت‌حساب را مستقیماً با Google تنظیم کند یا می‌تواند به فروشنده دیگری انتقال دهد.