Method: customers.searchAds360.searchStream

검색 스트림 쿼리와 일치하는 모든 행을 반환합니다.

발생한 오류 목록: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError

HTTP 요청

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

URL은 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