Method: customers.googleAds.searchStream

傳回符合搜尋串流查詢的所有資料列。

擲回錯誤清單：AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError

HTTP 要求

POST https://googleads.googleapis.com/v19/customers/{customerId}/googleAds:searchStream

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
customerId

string

必要欄位。要查詢的客戶 ID。

要求主體

要求主體的資料會採用以下結構：

JSON 表示法 
{
  "query": string,
  "summaryRowSetting": enum (SummaryRowSetting)
}
欄位
query

string

必要欄位。查詢字串。
summaryRowSetting

enum (SummaryRowSetting)

判斷是否要傳回摘要列。根據預設，系統不會傳回摘要資料列。如果要求，系統會在傳回所有其他查詢結果後，單獨傳送摘要資料列。

回應主體

GoogleAdsService.SearchStream 的回應訊息。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "results": [
    {
      object (GoogleAdsRow)
    }
  ],
  "fieldMask": string,
  "summaryRow": {
    object (GoogleAdsRow)
  },
  "requestId": string,
  "queryResourceConsumption": string
}
欄位
results[]

object (GoogleAdsRow)

與查詢相符的資料列清單。
fieldMask

string (FieldMask format)

FieldMask，代表使用者要求的欄位。

這是以半形逗號分隔的完整欄位名稱清單。範例："user.displayName,photo"。
summaryRow

object (GoogleAdsRow)

摘要列，其中包含結果中的指標摘要。指標摘要是指匯總所有結果的指標，匯總值可以是總和、平均值、比率等。
requestId

string

用於偵錯的專屬要求 ID。
queryResourceConsumption

string (int64 format)

提供查詢所消耗的資源量。摘要資料列和非摘要回應的 queryResourceConsumption 會分別在各自的資料列中傳回。非摘要回應的 queryResourceConsumption 會在最後一批結果中傳回。

授權範圍

需要下列 OAuth 範圍：

  • https://www.googleapis.com/auth/adwords

詳情請參閱 OAuth 2.0 Overview。

SummaryRowSetting

列舉項目，說明退貨摘要資料列設定。

列舉
UNSPECIFIED 不指定。
UNKNOWN 代表報表摘要列的不明值。
NO_SUMMARY_ROW 不傳回摘要資料列。
SUMMARY_ROW_WITH_RESULTS 傳回摘要資料列和結果。摘要資料列只會在最後一批傳回 (最後一批不會包含任何結果)。
SUMMARY_ROW_ONLY 只傳回摘要列，且不傳回任何結果。