Method: customers.searchAds360.searchStream
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
HTTP 请求
POST https://searchads360.googleapis.com/v0/customers/{customerId}/searchAds360:searchStream
网址采用 gRPC 转码语法。
路径参数
参数 |
customerId |
string
必需。要查询的客户的 ID。
|
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
{
"query": string,
"batchSize": integer,
"summaryRowSetting": enum (SummaryRowSetting )
} |
字段 |
query |
string
必需。查询字符串。
|
batchSize |
integer
每个数据流响应批次中返回的行数。如果请求的批次太多,服务器可能会决定进一步限制返回的行数。
|
summaryRowSetting |
enum (SummaryRowSetting )
确定是否返回摘要行。默认情况下,系统不会返回摘要行。如果请求,则在返回所有其他查询结果后,摘要行将在响应中单独发送。
|
响应正文
字段 |
results[] |
object (SearchAds360Row )
与查询匹配的行的列表。
|
fieldMask |
string (FieldMask format)
表示用户请求哪些字段的 FieldMask。 这是完全限定字段名称的逗号分隔列表。示例:"user.displayName,photo" 。
|
summaryRow |
object (SearchAds360Row )
摘要行,包含结果中的指标摘要。指标摘要是指针对所有结果的指标汇总,此处的汇总可以是求和、平均值、比率等。
|
customColumnHeaders[] |
object (CustomColumnHeader )
结果中自定义列的标题。
|
conversionCustomMetricHeaders[] |
object (ConversionCustomMetricHeader )
结果中转化自定义指标的标头。
|
conversionCustomDimensionHeaders[] |
object (ConversionCustomDimensionHeader )
结果中转化自定义维度的标题。
|
rawEventConversionMetricHeaders[] |
object (RawEventConversionMetricHeader )
结果中原始事件转化指标的标头。
|
rawEventConversionDimensionHeaders[] |
object (RawEventConversionDimensionHeader )
结果中原始事件转化维度的标头。
|
requestId |
string
用于调试的请求的唯一 ID。
|
授权范围
需要以下 OAuth 范围:
https://www.googleapis.com/auth/doubleclicksearch
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-04-02。
[null,null,["最后更新时间 (UTC):2025-04-02。"],[[["\u003cp\u003eReturns all rows matching the specified search stream query, enabling retrieval of Search Ads 360 data.\u003c/p\u003e\n"],["\u003cp\u003eRequires a POST request to the designated endpoint with query parameters including \u003ccode\u003ecustomerId\u003c/code\u003e, \u003ccode\u003equery\u003c/code\u003e, \u003ccode\u003ebatchSize\u003c/code\u003e, and \u003ccode\u003esummaryRowSetting\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a list of matching rows, field mask, summary row (optional), custom column headers, and request ID.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes gRPC Transcoding for URL syntax and necessitates the \u003ccode\u003ehttps://www.googleapis.com/auth/doubleclicksearch\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],["This outlines how to use the `searchStream` method via a POST request to `searchAds360`. The request requires a `customerId` path parameter. The request body must include a `query` string, an optional `batchSize`, and a `summaryRowSetting`. The response, matching the query, includes an array of `results`, a `fieldMask`, and a `summaryRow` with aggregated metrics. Other optional details include `customColumnHeaders` and headers related to conversion metrics and dimensions. It requires authentication with `doubleclicksearch` scope.\n"],null,["# Method: customers.searchAds360.searchStream\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.SearchSearchAds360StreamResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n\nReturns all rows that match the search stream query.\n\nList of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QueryError]() [QuotaError]() [RequestError]()\n\n### HTTP request\n\n`POST https://searchads360.googleapis.com/v0/customers/{customerId}/searchAds360:searchStream`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------------|----------------------------------------------------------|\n| `customerId` | `string` Required. The ID of the customer being queried. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"query\": string, \"batchSize\": integer, \"summaryRowSetting\": enum (/search-ads/reporting/api/reference/rest/v0/SummaryRowSetting) } ``` |\n\n| Fields ||\n|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `query` | `string` Required. The query string. |\n| `batchSize` | `integer` The number of rows that are returned in each stream response batch. When too large batch is requested, the server may decide to further limit the number of returned rows. |\n| `summaryRowSetting` | `enum (`[SummaryRowSetting](/search-ads/reporting/api/reference/rest/v0/SummaryRowSetting)`)` Determines whether a summary row will be returned. By default, summary row is not returned. If requested, the summary row will be sent in a response by itself after all other query results are returned. |\n\n### Response body\n\nResponse message for [SearchAds360Service.SearchStream](/search-ads/reporting/api/reference/rest/v0/customers.searchAds360/searchStream#google.ads.searchads360.v0.services.SearchAds360Service.SearchStream).\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"results\": [ { object (/search-ads/reporting/api/reference/rest/v0/SearchAds360Row) } ], \"fieldMask\": string, \"summaryRow\": { object (/search-ads/reporting/api/reference/rest/v0/SearchAds360Row) }, \"customColumnHeaders\": [ { object (/search-ads/reporting/api/reference/rest/v0/CustomColumnHeader) } ], \"conversionCustomMetricHeaders\": [ { object (/search-ads/reporting/api/reference/rest/v0/ConversionCustomMetricHeader) } ], \"conversionCustomDimensionHeaders\": [ { object (/search-ads/reporting/api/reference/rest/v0/ConversionCustomDimensionHeader) } ], \"rawEventConversionMetricHeaders\": [ { object (/search-ads/reporting/api/reference/rest/v0/RawEventConversionMetricHeader) } ], \"rawEventConversionDimensionHeaders\": [ { object (/search-ads/reporting/api/reference/rest/v0/RawEventConversionDimensionHeader) } ], \"requestId\": string } ``` |\n\n| Fields ||\n|----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `results[]` | `object (`[SearchAds360Row](/search-ads/reporting/api/reference/rest/v0/SearchAds360Row)`)` The list of rows that matched the query. |\n| `fieldMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` FieldMask that represents what fields were requested by the user. This is a comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`. |\n| `summaryRow` | `object (`[SearchAds360Row](/search-ads/reporting/api/reference/rest/v0/SearchAds360Row)`)` Summary row that contains summary of metrics in results. Summary of metrics means aggregation of metrics across all results, here aggregation could be sum, average, rate, etc. |\n| `customColumnHeaders[]` | `object (`[CustomColumnHeader](/search-ads/reporting/api/reference/rest/v0/CustomColumnHeader)`)` The headers of the custom columns in the results. |\n| `conversionCustomMetricHeaders[]` | `object (`[ConversionCustomMetricHeader](/search-ads/reporting/api/reference/rest/v0/ConversionCustomMetricHeader)`)` The headers of the conversion custom metrics in the results. |\n| `conversionCustomDimensionHeaders[]` | `object (`[ConversionCustomDimensionHeader](/search-ads/reporting/api/reference/rest/v0/ConversionCustomDimensionHeader)`)` The headers of the conversion custom dimension in the results. |\n| `rawEventConversionMetricHeaders[]` | `object (`[RawEventConversionMetricHeader](/search-ads/reporting/api/reference/rest/v0/RawEventConversionMetricHeader)`)` The headers of the raw event conversion metrics in the results. |\n| `rawEventConversionDimensionHeaders[]` | `object (`[RawEventConversionDimensionHeader](/search-ads/reporting/api/reference/rest/v0/RawEventConversionDimensionHeader)`)` The headers of the raw event conversion dimensions in the results. |\n| `requestId` | `string` The unique id of the request that is used for debugging purposes. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/doubleclicksearch`"]]