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.
Metadata about a query execution job. This is stored in the metadata field of the google.longrunning.Operation returned by a query execution request.
JSON representation
{"queryResourceName": string,"queryTitle": string,"customerId": string,"adsDataCustomerId": string,"matchDataCustomerId": string,"parameterValues": {string: {object (ParameterValue)},...},"startTime": string,"endTime": string,"queryText": string,// Union field output can be only one of the following:"destTable": string,"userListId": string,"algorithmId": string// End of list of possible types for union field output.}
Fields
queryResourceName
string
Name of the query resource that was executed, e.g. customers/123/analysisQueries/abcd1234 Only present for stored query execution.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
queryText
string
Text of the query executed. Note that this field will only be set in the response of google.longrunning.Operations.GetOperation call. It will be omitted in the response of google.longrunning.Operations.ListOperations call or any other calls.
Union field output. Location where query results get stored. output can be only one of the following:
destTable
string
Destination table for query results. Used for analysis queries.
Custom bidding algorithm ID to populate with query results. Used for custom bidding queries only. Populated on QueryType.QUERY_TYPE_CUSTOM_BIDDING_ALGORITHM only.
[[["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\u003eAds Data Hub query execution job metadata is stored within the metadata field of the google.longrunning.Operation.\u003c/p\u003e\n"],["\u003cp\u003eThis metadata includes details like query resource name, title, customer IDs, parameter values, start and end times, and the query text itself.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eoutput\u003c/code\u003e field indicates the destination of the query results, which could be a BigQuery table, a user list, or a custom bidding algorithm.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003equeryText\u003c/code\u003e field is only populated in the response of google.longrunning.Operations.GetOperation and is omitted in other calls like ListOperations.\u003c/p\u003e\n"]]],["This document details metadata for a query execution job, stored in the `google.longrunning.Operation`. Key information includes the `queryResourceName`, `queryTitle`, and customer IDs (`customerId`, `adsDataCustomerId`, `matchDataCustomerId`). It tracks `parameterValues`, `startTime`, `endTime`, and `queryText`. The results are directed to a `destTable`, `userListId`, or `algorithmId`, indicated by the `output` union field. It specifies that the `queryText` is only provided in `GetOperation` calls.\n"],null,["# QueryMetadata\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nMetadata about a query execution job. This is stored in the metadata field of the google.longrunning.Operation returned by a query execution request.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"queryResourceName\": string, \"queryTitle\": string, \"customerId\": string, \"adsDataCustomerId\": string, \"matchDataCustomerId\": string, \"parameterValues\": { string: { object (/ads-data-hub/reference/rest/v1/ParameterValue) }, ... }, \"startTime\": string, \"endTime\": string, \"queryText\": string, // Union field `output` can be only one of the following: \"destTable\": string, \"userListId\": string, \"algorithmId\": string // End of list of possible types for union field `output`. } ``` |\n\n| Fields ||\n|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `queryResourceName` | `string` Name of the query resource that was executed, e.g. customers/123/analysisQueries/abcd1234 Only present for stored query execution. |\n| `queryTitle` | `string` Title of the query executed. |\n| `customerId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The Ads Data Hub customer ID that executed the query. |\n| `adsDataCustomerId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Ads Data Hub customer ID used for ads data. |\n| `matchDataCustomerId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Ads Data Hub customer ID used for match table data. |\n| `parameterValues` | `map (key: string, value: object (`[ParameterValue](/ads-data-hub/reference/rest/v1/ParameterValue)`))` Parameter values used in the query. Maps each argument name to its bound value. An object containing a list of `\"key\": value` pairs. Example: `{ \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }`. |\n| `startTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp)` format)` Query execution start time. A timestamp in RFC3339 UTC \"Zulu\" format, with nanosecond resolution and up to nine fractional digits. Examples: `\"2014-10-02T15:01:23Z\"` and `\"2014-10-02T15:01:23.045123456Z\"`. |\n| `endTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp)` format)` Query execution end time. A timestamp in RFC3339 UTC \"Zulu\" format, with nanosecond resolution and up to nine fractional digits. Examples: `\"2014-10-02T15:01:23Z\"` and `\"2014-10-02T15:01:23.045123456Z\"`. |\n| `queryText` | `string` Text of the query executed. Note that this field will only be set in the response of google.longrunning.Operations.GetOperation call. It will be omitted in the response of google.longrunning.Operations.ListOperations call or any other calls. |\n| Union field `output`. Location where query results get stored. `output` can be only one of the following: ||\n| `destTable` | `string` Destination table for query results. Used for analysis queries. |\n| `userListId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` User list to populate with query results. Used for user list queries. |\n| `algorithmId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Custom bidding algorithm ID to populate with query results. Used for custom bidding queries only. Populated on QueryType.QUERY_TYPE_CUSTOM_BIDDING_ALGORITHM only. |"]]
