Method: subscriptions.delete

ביטול, השהיה או העברה של מינוי ל-Direct.

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

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

פרמטרים
customerId

string

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

string

זהו מאפיין חובה. השדה subscriptionId הוא מזהה המינוי והוא ייחודי לכל לקוח. מכיוון שהערך של subscriptionId משתנה כשמינוי מתעדכן, מומלץ לא להשתמש במזהה הזה כמפתח לנתונים קבועים. אפשר למצוא את subscriptionId באמצעות השיטה retrieve all reseller subscriptions.

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

פרמטרים
deletionType

enum (DeletionType)

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

גוף הבקשה

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

גוף התשובה

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

אפשר להשתמש בהודעה הזו בשיטות API בסטרימינג ובשיטות 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

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

DeletionType

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

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