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" التي تحدد نوع محتوى النص.
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 باستخدام بطاقة ائتمان، أو يمكنه النقل إلى مورّد آخر.