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 באמצעות כרטיס אשראי, או לעבור למפיץ אחר. |
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-25 (שעון UTC)."],[],[],null,["# Method: subscriptions.delete\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.HttpBody.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [DeletionType](#DeletionType)\n- [Try it!](#try-it)\n\nCancels, suspends, or transfers a subscription to direct.\n\n### HTTP request\n\n`DELETE https://reseller.googleapis.com/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customerId` | `string` This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable. |\n| `subscriptionId` | `string` This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the [retrieve all reseller subscriptions](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#get_all_subscriptions) method. |\n\n### Query parameters\n\n| Parameters ||\n|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `deletionType` | `enum (`[DeletionType](/workspace/admin/reseller/reference/rest/v1/subscriptions/delete#DeletionType)`)` The `deletionType` query string enables the cancellation, downgrade, or suspension of a subscription. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nMessage that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page.\n\nThis message can be used both in streaming and non-streaming API methods in the request as well as the response.\n\nIt can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body.\n\nExample: \n\n message GetResourceRequest {\n // A unique request id.\n string requestId = 1;\n\n // The raw HTTP body is bound to this field.\n google.api.HttpBody http_body = 2;\n\n }\n\n service ResourceService {\n rpc GetResource(GetResourceRequest)\n returns (google.api.HttpBody);\n rpc UpdateResource(google.api.HttpBody)\n returns (google.protobuf.Empty);\n\n }\n\nExample with streaming methods: \n\n service CaldavService {\n rpc GetCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n rpc UpdateCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n\n }\n\nUse of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.\n\nIf successful, the response is a generic HTTP response whose format is defined by the method.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------|\n| ``` { \"contentType\": string, \"data\": string, \"extensions\": [ { \"@type\": string, field1: ..., ... } ] } ``` |\n\n| Fields ||\n|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `contentType` | `string` The HTTP Content-Type header value specifying the content type of the body. |\n| `data` | `string (`[bytes](https://developers.google.com/discovery/v1/type-format)` format)` The HTTP request/response body as raw binary. A base64-encoded string. |\n| `extensions[]` | `object` Application specific response metadata. Must be set in the first response for streaming APIs. An object containing fields of an arbitrary type. An additional field `\"@type\"` contains a URI identifying the type. Example: `{ \"id\": 1234, \"@type\": \"types.example.com/standard/id\" }`. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/apps.order`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nDeletionType\n------------\n\n| Enums ||\n|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `deletion_type_undefined` | |\n| `cancel` | Cancels the subscription immediately. This does not apply to a G Suite subscription. |\n| `transfer_to_direct` | Transfers a subscription directly to Google. The customer is immediately transferred to a direct billing relationship with Google and is given a short amount of time with no service interruption. The customer can then choose to set up billing directly with Google by using a credit card, or they can transfer to another reseller. |"]]
