Method: customers.searchAds360.search

검색어와 일치하는 모든 행을 반환합니다.

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

HTTP 요청

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

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