Method: subscriptions.delete

מבטל, מושעה או מעביר מינוי לתפקיד ישיר.

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
customerId

string

זה יכול להיות שם הדומיין הראשי של הלקוח או המזהה הייחודי של הלקוח. אם שם הדומיין של הלקוח משתנה, לא ניתן להשתמש בשם הדומיין הישן כדי לגשת ללקוח, אבל אפשר תמיד להשתמש במזהה הייחודי של הלקוח (כפי שהוחזר על ידי ה-API). מומלץ לשמור את המזהה הייחודי במערכות שלכם, במקרים הרלוונטיים.
subscriptionId

string

זהו נכס חובה. subscriptionId הוא מזהה המינוי והוא ייחודי לכל לקוח. subscriptionId משתנה כשמינוי מתעדכן, לכן מומלץ לא להשתמש במזהה הזה כמפתח לנתונים קבועים. אפשר גם למצוא את subscriptionId באמצעות השיטה אחזור כל המינויים של המפיצים.

פרמטרים של שאילתה

פרמטרים
deletionType

enum (DeletionType)

מחרוזת השאילתה deletionType מאפשרת לבטל, לשדרג לאחור או להשעות מינוי.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

הודעה שמייצגת גוף HTTP שרירותי. צריך להשתמש בו רק בפורמטים של מטען ייעודי (payload) שלא ניתן לייצג כ-JSON, למשל קובץ בינארי גולמי או דף HTML.

ניתן להשתמש בהודעה הזו גם ב-methods של API בסטרימינג וגם ב-methods ללא סטרימינג בבקשה וגם בתשובה.

אפשר להשתמש בשדה הזה כשדה בקשה ברמה העליונה. הוא נוח אם רוצים לחלץ פרמטרים מכתובת ה-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 כללית שהפורמט שלה מוגדר על ידי ה-method.

ייצוג JSON 
{
  "contentType": string,
  "data": string,
  "extensions": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
שדות
contentType

string

ערך הכותרת Content-Type ב-HTTP שמציין את סוג התוכן של הגוף.
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

מידע נוסף זמין במדריך להרשאות.

DeletionType

טיפוסים בני מנייה (enum)
deletion_type_undefined
cancel ביטול מיידי של המינוי. הדרישה הזו לא חלה על מינוי ל-G Suite.
transfer_to_direct

העברת המינוי ישירות אל Google. הלקוח מועבר באופן מיידי ליחסי חיוב ישיר עם Google, ומוקצה לו פרק זמן קצר ללא הפרעה בשירות. לאחר מכן הלקוח יוכל לבחור אם להגדיר את החיוב ישירות מול Google באמצעות כרטיס אשראי, או להעביר אותו למפיץ אחר.