- בקשת HTTP
- פרמטרים של נתיב
- פרמטרים של שאילתה
- גוף הבקשה
- גוף התשובה
- היקפי הרשאות
- DeletionType
- רוצים לנסות?
ביטול, השעיה או העברה של מינוי להוראה ישירה.
בקשת HTTP
DELETE https://reseller.googleapis.com/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
customerId |
המזהה הזה יכול להיות שם הדומיין הראשי של הלקוח או המזהה הייחודי של הלקוח. אם שם הדומיין של הלקוח משתנה, לא ניתן להשתמש בשם הדומיין הישן כדי לגשת ללקוח, אבל תמיד אפשר להשתמש במזהה הייחודי של הלקוח (כפי שמוחזר על ידי ה-API). מומלץ לשמור את המזהה הייחודי במערכות, היכן שהדבר רלוונטי. |
subscriptionId |
זהו נכס חובה. |
פרמטרים של שאילתה
פרמטרים | |
---|---|
deletionType |
מחרוזת השאילתה |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התגובה
הודעה שמייצגת גוף HTTP שרירותי. יש להשתמש בו רק בפורמטים של מטען ייעודי (payload) שלא ניתן לייצג בפורמט 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 |
ערך הכותרת HTTP Content-Type שמציין את סוג התוכן של הגוף. |
data |
גוף הבקשה/התשובה של ה-HTTP כבינארי גולמי. מחרוזת בקידוד base64. |
extensions[] |
מטא-נתונים של תגובות ספציפיות לאפליקציה. חובה להגדיר זאת בתגובה הראשונה לממשקי API לסטרימינג. אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף |
היקפי הרשאות
נדרש היקף OAuth הבא:
https://www.googleapis.com/auth/apps.order
למידע נוסף, ניתן לעיין במדריך ההרשאות.
DeletionType
טיפוסים בני מנייה (enums) | |
---|---|
deletion_type_undefined |
|
cancel |
ביטול המינוי באופן מיידי. הכלל הזה לא חל על מינוי ל-G Suite. |
transfer_to_direct |
העברת מינוי ישירות ל-Google. הלקוח מועבר באופן מיידי לקשר חיוב ישיר עם Google, ומקבל פרק זמן קצר ללא הפרעה בשירות. לאחר מכן הלקוח יוכל לבחור להגדיר את החיוב ישירות ב-Google באמצעות כרטיס אשראי, או לעבור למפיץ אחר. |