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.
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://adsdatahub.googleapis.com/v1/{name=operations/**}:cancel
The URL uses gRPC Transcoding syntax.
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 empty.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/adsdatahub
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 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[],["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,[]]
