Method: customers.searchAds360.searchStream

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

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

HTTP 要求

POST https://searchads360.googleapis.com/v0/customers/{customerId}/searchAds360:searchStream

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

路徑參數

參數
customerId

string

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

要求主體

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

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

string

必要欄位。查詢字串。
batchSize

integer

在每個串流回應批次中傳回的資料列數。如果要求的批次數量過多，伺服器可能會決定進一步限制傳回的列數。
summaryRowSetting

enum (SummaryRowSetting)

決定是否傳回摘要列。根據預設，系統不會傳回摘要列。如有要求，系統會在回應所有其他查詢結果後，自行在回應中傳送摘要列。

回應主體

對「SearchAds360Service.SearchStream」的回應訊息。

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

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

object (SearchAds360Row)

符合查詢的資料列清單。
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)

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

string

用於偵錯的要求專屬 ID。

授權範圍

需要下列 OAuth 範圍：

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