This is legacy documentation, and may not be complete. To see the latest documentation, if you are a marketer, refer to the Marketers site. If you are a measurement partner, refer to the Measurement Partners site.
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://adsdatahub.googleapis.com/v1/{name=operations/**}:cancel
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eInitiates asynchronous cancellation for long-running operations, although success isn't guaranteed.\u003c/p\u003e\n"],["\u003cp\u003eIf supported, the server attempts cancellation; otherwise, it returns an \u003ccode\u003eUNIMPLEMENTED\u003c/code\u003e error.\u003c/p\u003e\n"],["\u003cp\u003eUpon successful cancellation, the operation is marked with an error code indicating cancellation, but it is not deleted.\u003c/p\u003e\n"],["\u003cp\u003eClients can monitor cancellation status or operation completion via methods like \u003ccode\u003eOperations.GetOperation\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003ehttps://www.googleapis.com/auth/adsdatahub\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],["This outlines how to cancel a long-running operation via an HTTP POST request. The request targets a specific operation identified by its `name` path parameter. The request body must be empty. A successful cancellation results in an empty response body. The operation is not deleted but marked as canceled, indicated by a specific error code. Authorization requires the `https://www.googleapis.com/auth/adsdatahub` scope. The server does not guarantee the cancellation success.\n"],null,["- [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\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](/ads-data-hub/reference/rest/v1/operations/get#google.longrunning.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](/ads-data-hub/reference/rest/v1/operations#Operation.FIELDS.error) value with a [google.rpc.Status.code](/ads-data-hub/reference/rest/v1/operations#Status.FIELDS.code) of 1, corresponding to `Code.CANCELLED`.\n\nHTTP request\n\n`POST https://adsdatahub.googleapis.com/v1/{name=operations/**}:cancel`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath parameters\n\n| Parameters ||\n|--------|--------------------------------------------------------------|\n| `name` | `string` The name of the operation resource to be cancelled. |\n\nRequest body\n\nThe request body must be empty.\n\nResponse body\n\nIf successful, the response body is empty.\n\nAuthorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/adsdatahub`"]]
