Method: customers.googleAds.search

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

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

HTTP 요청

POST https://googleads.googleapis.com/v14/customers/{customerId}/googleAds: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)

요약 행의 반환 여부를 결정합니다. 기본적으로 요약 행은 반환되지 않습니다. 요청이 있는 경우 다른 모든 쿼리 결과가 반환된 후 요약 행이 응답으로 전송됩니다.

응답 본문

GoogleAdsService.Search의 응답 메시지입니다.

성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "results": [
    {
      object (GoogleAdsRow)
    }
  ],
  "nextPageToken": string,
  "totalResultsCount": string,
  "fieldMask": string,
  "summaryRow": {
    object (GoogleAdsRow)
  }
}
필드
results[]

object (GoogleAdsRow)

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

string

결과의 다음 페이지를 검색하는 데 사용되는 페이지로 나누기 토큰입니다. 이 문자열의 콘텐츠를 다음 요청의 pageToken 속성으로 전달합니다. 마지막 페이지에는 nextPageToken가 반환되지 않습니다.
totalResultsCount

string (int64 format)

LIMIT 절을 무시하고 쿼리와 일치하는 총 결과 수입니다.
fieldMask

string (FieldMask format)

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

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

object (GoogleAdsRow)

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

승인 범위

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

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

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