API Báo cáo Search Ads 360 mới hiện đã ra mắt. Tham gia nhóm Google
searchads-api-announcements để luôn được cập nhật về những cải tiến và bản phát hành sắp tới.
Method: customers.searchAds360.searchStream
Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang
Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.
Yêu cầu HTTP
POST https://searchads360.googleapis.com/v0/customers/{customerId}/searchAds360:searchStream
URL sử dụng cú pháp Chuyển mã gRPC.
Tham số đường dẫn
Thông số |
customerId |
string
Bắt buộc. Mã của khách hàng đang được truy vấn.
|
Nội dung yêu cầu
Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:
Biểu diễn dưới dạng JSON |
{
"query": string,
"batchSize": integer,
"summaryRowSetting": enum (SummaryRowSetting )
} |
Trường |
query |
string
Bắt buộc. Chuỗi truy vấn.
|
batchSize |
integer
Số hàng được trả về trong mỗi lô phản hồi luồng. Khi yêu cầu một lô quá lớn, máy chủ có thể quyết định giới hạn thêm số lượng hàng được trả về.
|
summaryRowSetting |
enum (SummaryRowSetting )
Xác định xem có trả về một hàng tóm tắt hay không. Theo mặc định, hàng tóm tắt không được trả về. Nếu được yêu cầu, hàng tóm tắt sẽ tự được gửi trong một phản hồi sau khi tất cả kết quả truy vấn khác được trả về.
|
Nội dung phản hồi
Tin nhắn phản hồi cho SearchAds360Service.SearchStream
.
Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:
Trường |
results[] |
object (SearchAds360Row )
Danh sách các hàng khớp với truy vấn.
|
fieldMask |
string (FieldMask format)
Mặt nạ trường đại diện cho các trường mà người dùng yêu cầu. Đây là danh sách các tên trường đủ điều kiện được phân tách bằng dấu phẩy. Ví dụ: "user.displayName,photo"
|
summaryRow |
object (SearchAds360Row )
Hàng tóm tắt chứa thông tin tóm tắt về các chỉ số trong kết quả. Tóm tắt chỉ số là tổng hợp các chỉ số trên tất cả kết quả. Ở đây, tổng hợp có thể là tổng, trung bình, tỷ lệ, v.v.
|
customColumnHeaders[] |
object (CustomColumnHeader )
Tiêu đề của cột tuỳ chỉnh trong kết quả.
|
conversionCustomMetricHeaders[] |
object (ConversionCustomMetricHeader )
Tiêu đề của chỉ số tuỳ chỉnh cho lượt chuyển đổi trong kết quả.
|
conversionCustomDimensionHeaders[] |
object (ConversionCustomDimensionHeader )
Tiêu đề của phương diện tuỳ chỉnh lượt chuyển đổi trong kết quả.
|
rawEventConversionMetricHeaders[] |
object (RawEventConversionMetricHeader )
Tiêu đề của các chỉ số về lượt chuyển đổi sự kiện chưa qua xử lý trong kết quả.
|
rawEventConversionDimensionHeaders[] |
object (RawEventConversionDimensionHeader )
Tiêu đề của phương diện lượt chuyển đổi sự kiện thô trong kết quả.
|
requestId |
string
Mã nhận dạng duy nhất của yêu cầu được dùng cho mục đích gỡ lỗi.
|
Phạm vi uỷ quyền
Yêu cầu phạm vi OAuth sau:
https://www.googleapis.com/auth/doubleclicksearch
Trừ phi có lưu ý khác, nội dung của trang này được cấp phép theo Giấy phép ghi nhận tác giả 4.0 của Creative Commons và các mẫu mã lập trình được cấp phép theo Giấy phép Apache 2.0. Để biết thông tin chi tiết, vui lòng tham khảo Chính sách trang web của Google Developers. Java là nhãn hiệu đã đăng ký của Oracle và/hoặc các đơn vị liên kết với Oracle.
Cập nhật lần gần đây nhất: 2025-04-02 UTC.
[null,null,["Cập nhật lần gần đây nhất: 2025-04-02 UTC."],[[["\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`"]]