Method: accounts.reports.search

검색어로 정의된 보고서를 가져옵니다. 응답에 pageSize에서 지정한 것보다 적은 행이 포함될 수 있습니다. nextPageToken를 사용하여 요청할 행이 더 있는지 확인합니다.

HTTP 요청

POST https://merchantapi.googleapis.com/reports/v1beta/{parent=accounts/*}/reports:search

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
parent

string

필수 항목입니다. 호출을 실행하는 계정의 ID입니다. 독립형 계정 또는 MCA 하위 계정이어야 합니다. 형식: accounts/{account}

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "query": string,
  "pageSize": integer,
  "pageToken": string
}
필드
query

string

필수 항목입니다. 검색할 보고서를 정의하는 쿼리입니다.

쿼리를 구성하는 방법에 관한 자세한 내용은 쿼리 언어 가이드를 참고하세요. 사용 가능한 테이블 및 필드의 전체 목록은 사용 가능한 필드를 참고하세요.
pageSize

integer

선택사항입니다. 단일 페이지에서 검색할 ReportRows의 수입니다. 기본값은 1000입니다. 5,000을 초과하는 값은 5,000으로 변환됩니다.
pageToken

string

선택사항입니다. 가져올 페이지의 토큰입니다. 지정하지 않으면 결과의 첫 번째 페이지가 반환됩니다. 결과의 다음 페이지를 요청하려면 이전 응답의 nextPageToken에서 가져온 값을 사용해야 합니다.

응답 본문

ReportService.Search 메서드에 대한 응답 메시지입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현 
{
  "results": [
    {
      object (ReportRow)
    }
  ],
  "nextPageToken": string
}
필드
results[]

object (ReportRow)

검색어와 일치하는 행입니다.
nextPageToken

string

다음 페이지를 가져오기 위해 pageToken으로 전송할 수 있는 토큰입니다. 생략하면 후속 페이지가 표시되지 않습니다.

승인 범위

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

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

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