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 Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 のドキュメントをご覧ください。