Method: customers.googleAds.searchStream

傳回與搜尋查詢查詢相符的所有資料列。

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

HTTP 要求

POST https://googleads.googleapis.com/v14/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
}
欄位
results[]

object (GoogleAdsRow)

符合查詢的資料列清單。
fieldMask

string (FieldMask format)

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

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

object (GoogleAdsRow)

含有結果中指標摘要的摘要列。指標摘要代表所有結果的指標匯總結果，這裡匯總可以是總和、平均值、頻率等。
requestId

string

用於偵錯的要求專屬 ID。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱 OAuth 2.0 總覽。