Method: customers.googleAds.searchStream

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

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

HTTP 요청

POST https://googleads.googleapis.com/v19/customers/{customerId}/googleAds:searchStream

URL은 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,
  "queryResourceConsumption": string
}
필드
results[]

object (GoogleAdsRow)

쿼리와 일치하는 행 목록입니다.
fieldMask

string (FieldMask format)

사용자가 요청한 필드를 나타내는 FieldMask입니다.

정규화된 필드 이름의 쉼표로 구분된 목록입니다. 예: "user.displayName,photo"
summaryRow

object (GoogleAdsRow)

결과의 측정항목 요약이 포함된 요약 행입니다. 측정항목 요약은 모든 결과에서 측정항목을 집계하는 것을 의미하며, 여기서 집계는 합계, 평균, 비율 등이 될 수 있습니다.
requestId

string

디버깅 목적으로 사용되는 요청의 고유 ID입니다.
queryResourceConsumption

string (int64 format)

쿼리 제공에 소비된 리소스 양입니다. 요약 행과 요약 외 응답의 queryResourceConsumption은 각 행에 별도로 반환됩니다. 요약 외 응답의 queryResourceConsumption은 최종 결과 배치에 반환됩니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 OAuth 2.0 Overview를 참고하세요.

SummaryRowSetting

반품 요약 행 설정을 설명하는 enum입니다.

열거형
UNSPECIFIED 지정되지 않음
UNKNOWN 반환 요약 행의 알 수 없는 값을 나타냅니다.
NO_SUMMARY_ROW 요약 행을 반환하지 않습니다.
SUMMARY_ROW_WITH_RESULTS 결과와 함께 요약 행을 반환합니다. 요약 행은 마지막 배치에서만 반환됩니다 (마지막 배치에는 결과가 포함되지 않음).
SUMMARY_ROW_ONLY 요약 행만 반환하고 결과는 반환하지 않습니다.