Method: customers.searchAds360.search

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

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

HTTP 要求

POST https://searchads360.googleapis.com/v0/customers/{customerId}/searchAds360: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)

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

回應主體

SearchAds360Service.Search 的回應訊息。

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

JSON 表示法 
{
  "results": [
    {
      object (SearchAds360Row)
    }
  ],
  "nextPageToken": string,
  "totalResultsCount": string,
  "fieldMask": string,
  "summaryRow": {
    object (SearchAds360Row)
  },
  "customColumnHeaders": [
    {
      object (CustomColumnHeader)
    }
  ],
  "conversionCustomMetricHeaders": [
    {
      object (ConversionCustomMetricHeader)
    }
  ],
  "conversionCustomDimensionHeaders": [
    {
      object (ConversionCustomDimensionHeader)
    }
  ],
  "rawEventConversionMetricHeaders": [
    {
      object (RawEventConversionMetricHeader)
    }
  ],
  "rawEventConversionDimensionHeaders": [
    {
      object (RawEventConversionDimensionHeader)
    }
  ]
}
欄位
results[]

object (SearchAds360Row)

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

string

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

string (int64 format)

忽略 LIMIT 子句時，符合查詢的結果總數。
fieldMask

string (FieldMask format)

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

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

object (SearchAds360Row)

摘要列，內含結果中指標的摘要。指標摘要是指所有結果的指標匯總，這裡的匯總可以是總和、平均值、比率等。
customColumnHeaders[]

object (CustomColumnHeader)

結果中自訂欄的標頭。
conversionCustomMetricHeaders[]

object (ConversionCustomMetricHeader)

結果中轉換自訂指標的標頭。
conversionCustomDimensionHeaders[]

object (ConversionCustomDimensionHeader)

結果中轉換自訂維度的標題。
rawEventConversionMetricHeaders[]

object (RawEventConversionMetricHeader)

結果中原始事件轉換指標的標題。
rawEventConversionDimensionHeaders[]

object (RawEventConversionDimensionHeader)

結果中原始事件轉換維度的標題。

授權範圍

需要下列 OAuth 範圍：

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