Method: projects.locations.dataStores.getSiteSearchEngine

SiteSearchEngine を取得します。

HTTP リクエスト

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

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

必須。SiteSearchEngine のリソース名（例: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine）。

呼び出し元に [SiteSearchEngine] へのアクセス権がない場合、[SiteSearchEngine] が存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には SiteSearchEngine のインスタンスが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • discoveryengine.siteSearchEngines.get

詳細については、IAM のドキュメントをご覧ください。