Method: customers.googleAds.searchStream

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

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

HTTP 要求

POST https://googleads.googleapis.com/v16/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)

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

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱 OAuth 2.0 總覽。