Method: projects.locations.collections.dataStores.siteSearchEngine.targetSites.list
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/targetSites
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The parent site search engine resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.
|
Query parameters
| Parameters |
pageSize |
integer
Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.
|
pageToken |
string
A page token, received from a previous targetSites.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to targetSites.list must match the call that provided the page token.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of ListTargetSitesResponse.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the parent resource:
discoveryengine.targetSites.list
For more information, see the IAM documentation.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-03 UTC."],[[["This endpoint retrieves a list of TargetSites associated with a specific site search engine."],["The `parent` path parameter is required and specifies the site search engine resource, and a PERMISSION_DENIED error is returned if the caller doesn't have permission."],["You can use `pageSize` and `pageToken` as query parameters to paginate through the list of TargetSites, with `pageSize` capped at a maximum of 1000."],["The request body must be empty and a successful response contains a `ListTargetSitesResponse` body."],["Listing TargetSites requires the `discoveryengine.targetSites.list` IAM permission and the `https://www.googleapis.com/auth/cloud-platform` OAuth scope."]]],[]]
