注意: API の REST インターフェースに関するドキュメントを表示しています。当社の公式クライアント ライブラリのほとんどは gRPC を使用しています。詳しくは、
REST の概要をご覧ください。
Method: customers.operations.cancel
長時間実行オペレーションの非同期キャンセルを開始します。サーバーは操作のキャンセルに全力を尽くしますが、成功は保証されません。このメソッドがサーバーでサポートされていない場合は、google.rpc.Code.UNIMPLEMENTED
を返します。クライアントは Operations.GetOperation
などのメソッドを使用して、キャンセルが成功したか、あるいはキャンセルしたにもかかわらずオペレーションが完了したかを確認できます。キャンセルが成功してもそのオペレーションは削除されず、google.rpc.Status.code
が 1
の Operation.error
値を持つオペレーションになります(これは Code.CANCELLED
に相当します)。
HTTP リクエスト
POST https://googleads.googleapis.com/v18/{name=customers/*/operations/*}:cancel
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ |
name |
string
キャンセルするオペレーション リソースの名前。
|
リクエストの本文
リクエストの本文は空にする必要があります。
レスポンスの本文
成功すると、レスポンスの本文は空の JSON オブジェクトになります。
認可スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/adwords
詳細については、OAuth 2.0 Overview をご覧ください。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-01-10 UTC。
[null,null,["最終更新日 2025-01-10 UTC。"],[[["Initiates an asynchronous cancellation for a running operation, although success isn't assured."],["If supported, upon successful cancellation, the operation isn't removed but marked with an error code signifying cancellation."],["The request requires an empty body and uses the operation's name as a path parameter."],["Authorization necessitates the `https://www.googleapis.com/auth/adwords` OAuth scope."],["Clients can monitor cancellation status through alternative methods like `Operations.GetOperation`."]]],[]]