Method: operations.cancel
Stay organized with collections
Save and categorize content based on your preferences.
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
HTTP request
POST https://admanager.googleapis.com/v1/{name}:cancel
Path parameters
| Parameters |
name |
string
The name of the operation resource to be cancelled.
|
Request body
The request body must be empty.
Response body
If successful, the response body is an empty JSON object.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/admanager
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-20 UTC.
[null,null,["Last updated 2025-08-20 UTC."],[[["\u003cp\u003eStarts asynchronous cancellation for long-running operations, with best-effort cancellation and no guarantee of success.\u003c/p\u003e\n"],["\u003cp\u003eClients can monitor cancellation status using methods like \u003ccode\u003eOperations.GetOperation\u003c/code\u003e, and successful cancellation results in an operation error with \u003ccode\u003eCode.CANCELLED\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eUses an HTTP POST request to \u003ccode\u003ehttps://admanager.googleapis.com/v1/{name}:cancel\u003c/code\u003e, requiring the operation's name as a path parameter.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/admanager\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should be empty, and a successful response will also be empty.\u003c/p\u003e\n"]]],["This content describes how to cancel a long-running operation. A `POST` request is sent to `https://admanager.googleapis.com/v1/{name}:cancel`, where `{name}` is the operation's resource name. The request body must be empty. A successful cancellation returns an empty response body, and the operation is updated to reflect a `Code.CANCELLED` status. Authorization requires the `https://www.googleapis.com/auth/admanager` OAuth scope. If the server doesn't support cancellation, it returns `google.rpc.Code.UNIMPLEMENTED`.\n"],null,["# Method: operations.cancel\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use `Operations.GetOperation` or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an [Operation.error](/ad-manager/api/beta/reference/rest/v1/networks.operations.reports.runs#Operation.FIELDS.error) value with a [google.rpc.Status.code](/ad-manager/api/beta/reference/rest/v1/networks.operations.reports.runs#Status.FIELDS.code) of `1`, corresponding to `Code.CANCELLED`.\n\n### HTTP request\n\n`POST https://admanager.googleapis.com/v1/{name}:cancel`\n\n### Path parameters\n\n| Parameters ||\n|--------|--------------------------------------------------------------|\n| `name` | `string` The name of the operation resource to be cancelled. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body is an empty JSON object.\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/admanager`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
