Method: subscriptions.delete

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

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المعلمات
customerId

string

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

string

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

مَعلمات طلب البحث

المعلمات
deletionType

enum (DeletionType)

تتيح سلسلة طلبات البحث deletionType إلغاء اشتراك أو الرجوع إلى خطة أقل تكلفة أو تعليق الاشتراك.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

رسالة تمثل نص HTTP عشوائي. لا تستخدَم هذه الرسالة إلا مع تنسيقات البيانات الأساسية التي يتعذَّر تمثيلها بترميز JSON، مثل البيانات الثنائية الأولية أو صفحة HTML.

يمكن استخدام هذه الرسالة في طرق واجهة برمجة التطبيقات المستخدَمة في بث البيانات وغير المستخدَمة على حد سواء لإجراء الطلب والاستجابة أيضًا.

يمكن استخدام هذه الرسالة باعتبارها حقل عالي المستوى للطلب، والذي يعدّ مناسبًا لاستخراج معلمات من عنوان 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

البيانات الوصفية للاستجابة الخاصة بالتطبيق. يجب أن يتم تحديد هذه البيانات في الاستجابة الأولى لواجهات برمجة تطبيقات البث.

عنصر يحتوي على حقول من نوع عشوائي يحتوي الحقل "@type" الإضافي على معرّف موارد منتظم (URI) يحدِّد النوع. مثال: { "id": 1234, "@type": "types.example.com/standard/id" }

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

DeletionType

عمليات التعداد
deletion_type_undefined
cancel يؤدي إلى إلغاء الاشتراك على الفور. ولا ينطبق ذلك على اشتراك G Suite.
transfer_to_direct

نقل اشتراك إلى Google مباشرةً  يتم نقل العميل على الفور إلى علاقة فوترة مباشرة مع Google ويتم منحه فترة زمنية قصيرة بدون انقطاع الخدمة. يمكن للعميل بعد ذلك اختيار إعداد الفوترة مباشرةً مع Google باستخدام بطاقة ائتمان، أو يمكنه الانتقال إلى مورِّد آخر.