傳回與搜尋串流查詢相符的所有資料列。
擲回錯誤清單:AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError
HTTP 要求
POST https://searchads360.googleapis.com/v0/customers/{customerId}/searchAds360:searchStream
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
customer |
必要欄位。要查詢的客戶 ID。 |
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
---|
{
"query": string,
"batchSize": integer,
"summaryRowSetting": enum ( |
欄位 | |
---|---|
query |
必要欄位。查詢字串。 |
batch |
每個串流回應批次中傳回的資料列數量。如果要求的批次數量過多,伺服器可能會決定進一步限制傳回的列數。 |
summary |
判斷是否要傳回摘要資料列。根據預設,系統不會傳回摘要資料列。如果要求,系統會在傳回所有其他查詢結果後,單獨傳送摘要資料列。 |
回應主體
SearchAds360Service.SearchStream
的回應訊息。
如果成功,回應主體會含有以下結構的資料:
JSON 表示法 |
---|
{ "results": [ { object ( |
欄位 | |
---|---|
results[] |
與查詢相符的資料列清單。 |
field |
代表使用者要求的欄位 FieldMask。 這是以半形逗號分隔的完整欄位名稱清單。範例: |
summary |
摘要列,其中包含結果中的指標摘要。指標摘要是指匯總所有結果的指標,匯總值可以是總和、平均值、比率等。 |
custom |
結果中自訂欄的標頭。 |
conversion |
結果中轉換自訂指標的標頭。 |
conversion |
結果中轉換自訂維度的標題。 |
raw |
結果中原始事件轉換指標的標頭。 |
raw |
結果中原始事件轉換維度的標題。 |
request |
用於偵錯的專屬要求 ID。 |
授權範圍
需要下列 OAuth 範圍:
https://www.googleapis.com/auth/doubleclicksearch