Method: customers.googleAds.search

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

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

HTTP 要求

POST https://googleads.googleapis.com/v16/customers/{customerId}/googleAds:search

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

路徑參數

參數
customerId

string

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

要求主體

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

JSON 表示法 
{
  "query": string,
  "pageToken": string,
  "pageSize": integer,
  "validateOnly": boolean,
  "returnTotalResultsCount": boolean,
  "summaryRowSetting": enum (SummaryRowSetting)
}
欄位
query

string

必要欄位。查詢字串。
pageToken

string

要擷取的網頁權杖。如未指定，系統會傳回第一頁的結果。使用在上一個回應中從 nextPageToken 取得的值，要求下一頁的結果。
pageSize

integer

單一頁面中要擷取的元素數量。當要求過大的網頁時，伺服器可能會決定進一步限制傳回的資源數量。
validateOnly

boolean

如果為 true，表示要求會完成驗證，但尚未執行。
returnTotalResultsCount

boolean

如果為 true，則回應中包含忽略 LIMIT 子句且符合查詢的結果總數。預設值為 false。
summaryRowSetting

enum (SummaryRowSetting)

決定是否要傳回摘要列。根據預設，系統不會傳回摘要列。依要求，在傳回所有其他查詢結果後，系統會單獨傳送摘要列做為回應。

回應主體

「GoogleAdsService.Search」的回應訊息。

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

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

object (GoogleAdsRow)

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

string

用於擷取下一頁結果的分頁符記。將此字串的內容做為下一個要求的 pageToken 屬性傳遞。沒有傳回最後一頁的 nextPageToken。
totalResultsCount

string (int64 format)

符合查詢的結果總數 (不包括 LIMIT 子句)。
fieldMask

string (FieldMask format)

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

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

object (GoogleAdsRow)

含有結果指標摘要的摘要列。指標摘要表示將所有結果的指標匯總，這裡的匯總資料可以是總和、平均值、比率等。
queryResourceConsumption

string (int64 format)

用於提供查詢的資源量。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱 OAuth 2.0 總覽。