Method: projects.locations.dataStores.siteSearchEngine.recrawlUris
Stay organized with collections
Save and categorize content based on your preferences.
Request on-demand recrawl for a list of URIs.
HTTP request
POST https://discoveryengine.googleapis.com/v1beta/{siteSearchEngine=projects/*/locations/*/dataStores/*/siteSearchEngine}:recrawlUris
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
siteSearchEngine |
string
Required. Full resource name of the SiteSearchEngine, such as projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"uris": [
string
],
"siteCredential": string
} |
| Fields |
uris[] |
string
Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one TargetSite in siteSearchEngine.
|
siteCredential |
string
Optional. Credential id to use for crawling.
|
Response body
If successful, the response body contains an instance of Operation.
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 siteSearchEngine resource:
discoveryengine.siteSearchEngines.recrawlUris
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 API endpoint allows you to request an on-demand recrawl of specific URIs associated with a `siteSearchEngine`."],["The HTTP request uses a `POST` method and requires the `siteSearchEngine` path parameter to be specified in the URL."],["The request body must include a list of URIs (`uris`) to be recrawled, with a limit of 10,000 URIs, and you can optionally add `siteCredential`."],["Successful requests return an `Operation` object, and you will need to have the OAuth scope `https://www.googleapis.com/auth/cloud-platform` and the `discoveryengine.siteSearchEngines.recrawlUris` IAM permission."],["The URI provided in the `uris` field must be present in one of the `TargetSite` in the `siteSearchEngine` to be valid."]]],[]]
