Method: projects.locations.collections.dataStores.siteSearchEngine.targetSites.list

TargetSite 목록을 가져옵니다.

HTTP 요청

GET https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/targetSites

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

경로 매개변수

매개변수
parent

string

필수 항목입니다. 상위 사이트 검색엔진 리소스 이름입니다(예: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine).

호출자에게 이 사이트 검색 엔진에서 TargetSite를 나열할 권한이 없는 경우 이 브랜치의 존재 여부와 관계없이 PERMISSION_DENIED 오류가 반환됩니다.

쿼리 매개변수

파라미터
pageSize

integer

요청한 페이지 크기입니다. 서버에서 요청한 것보다 적은 항목을 반환할 수 있습니다. 지정하지 않으면 서버에서 적절한 기본값을 선택합니다. 최댓값은 1,000이며, 1,000을 초과하는 값은 1,000으로 변환됩니다.

이 필드가 음수이면 INVALID_ARGUMENT 오류가 반환됩니다.
pageToken

string

이전 targetSites.list 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.

페이지를 매길 때 targetSites.list에 제공된 다른 모든 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

성공한 경우 응답 본문에 ListTargetSitesResponse의 인스턴스가 포함됩니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

자세한 내용은 Authentication Overview를 참조하세요.

IAM 권한

parent 리소스에 대해서는 다음 IAM 권한이 필요합니다.

  • discoveryengine.targetSites.list

자세한 내용은 IAM 문서를 참조하세요.