This resource represents a long-running operation that is the result of a network API call.
JSON representation
{"name":string,"metadata":{"@type":string,field1:...,...},"done":boolean,// Union fieldresultcan be only one of the following:"error":{object (Status)},"response":{"@type":string,field1:...,...}// End of list of possible types for union fieldresult.}
Fields
name
string
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, thenameshould be a resource name ending withoperations/{unique_id}.
metadata
object
AQueryMetadataobject containing service-specific data associated with the operation.
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" }.
done
boolean
If the value isfalse, it means the operation is still in progress. Iftrue, the operation is completed, and eithererrororresponseis available.
Union fieldresult. The operation result, which can be either anerroror a validresponse. Ifdone==false, neithererrornorresponseis set. Ifdone==true, exactly one oferrororresponsecan be set. Some services might not provide the result.resultcan be only one of the following:
The error result of the operation in case of failure or cancellation.
response
object
AQueryResponseobject, returned if the query operation is successful.
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" }.
Status
TheStatustype defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used bygRPC. EachStatusmessage contains three pieces of data: error code, error message, and error details.
You can find out more about this error model and how to work with it in theAPI Design Guide.
The status code, which should be an enum value ofgoogle.rpc.Code.
message
string
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in thegoogle.rpc.Status.detailsfield, or localized by the client.
details[]
object
A list of messages that carry the error details. There is a common set of message types for APIs to use.
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" }.
[[["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\u003eThe Operation resource represents a long-running operation initiated by a network API call, containing metadata, status, and either an error or a response.\u003c/p\u003e\n"],["\u003cp\u003eStatus provides a structured error model with an error code, message, and details for REST and RPC APIs.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can manage operations using methods like cancel, delete, get, list, and wait to track progress and handle results.\u003c/p\u003e\n"]]],["The document outlines the \"Operation\" and \"Status\" resources, which describe long-running network API calls and error models, respectively. An Operation has a `name`, `metadata`, and a `done` status. It may also have an `error` or `response`. Status, with a format that includes `code`, `message`, and `details`, defines error conditions. Methods available for Operations include: `cancel`, `delete`, `get`, `list`, and `wait`, allowing management of the operations.\n"],null,["# REST Resource: operations\n\n- [Resource: Operation](#Operation)\n - [JSON representation](#Operation.SCHEMA_REPRESENTATION)\n- [Status](#Status)\n - [JSON representation](#Status.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Operation\n-------------------\n\nThis resource represents a long-running operation that is the result of a network API call.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"metadata\": { \"@type\": string, field1: ..., ... }, \"done\": boolean, // Union field `result` can be only one of the following: \"error\": { object (/ads-data-hub/marketers/reference/rest/v1/operations#Status) }, \"response\": { \"@type\": string, field1: ..., ... } // End of list of possible types for union field `result`. } ``` |\n\n| Fields ||\n|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |\n| `metadata` | `object` A [QueryMetadata](/ads-data-hub/marketers/reference/rest/v1/QueryMetadata) object containing service-specific data associated with the operation. 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| `done` | `boolean` If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |\n| Union field `result`. The operation result, which can be either an `error` or a valid `response`. If `done` == `false`, neither `error` nor `response` is set. If `done` == `true`, exactly one of `error` or `response` can be set. Some services might not provide the result. `result` can be only one of the following: ||\n| `error` | `object (`[Status](/ads-data-hub/marketers/reference/rest/v1/operations#Status)`)` The error result of the operation in case of failure or cancellation. |\n| `response` | `object` A [QueryResponse](/ads-data-hub/marketers/reference/rest/v1/QueryResponse) object, returned if the query operation is successful. 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\nStatus\n------\n\nThe `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------|\n| ``` { \"code\": integer, \"message\": string, \"details\": [ { \"@type\": string, field1: ..., ... } ] } ``` |\n\n| Fields ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `code` | `integer` The status code, which should be an enum value of `google.rpc.Code`. |\n| `message` | `string` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details](/ads-data-hub/marketers/reference/rest/v1/operations#Status.FIELDS.details) field, or localized by the client. |\n| `details[]` | `object` A list of messages that carry the error details. There is a common set of message types for APIs to use. 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| Methods ------- ||\n|---------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|\n| ### [cancel](/ads-data-hub/marketers/reference/rest/v1/operations/cancel) | Starts asynchronous cancellation on a long-running operation. |\n| ### [delete](/ads-data-hub/marketers/reference/rest/v1/operations/delete) | Deletes a long-running operation. |\n| ### [get](/ads-data-hub/marketers/reference/rest/v1/operations/get) | Gets the latest state of a long-running operation. |\n| ### [list](/ads-data-hub/marketers/reference/rest/v1/operations/list) | Lists operations that match the specified filter in the request. |\n| ### [wait](/ads-data-hub/marketers/reference/rest/v1/operations/wait) | Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. |"]]
