Method: projects.locations.collections.dataStores.siteSearchEngine.getUriPatternDocumentData
Stay organized with collections
Save and categorize content based on your preferences.
Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.
HTTP request
GET https://discoveryengine.googleapis.com/v1alpha/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:getUriPatternDocumentData
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 must be empty.
Response body
Response message for SiteSearchEngineService.GetUriPatternDocumentData method.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"documentDataMap": {
string: {
object
},
...
}
} |
| Fields |
documentDataMap |
map (key: string, value: object (Struct format))
Document data keyed by URI pattern. For example: documentDataMap = { "www.url1.com/*": { "Categories": ["category1", "category2"] }, "www.url2.com/*": { "Categories": ["category3"] } }
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
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 retrieves the URI Pattern to Document data mapping for a specified Site Search Engine."],["The HTTP request is a `GET` method directed at a specific resource path, identified by the `siteSearchEngine` parameter."],["The request body for this API call must be empty, and no data is expected within the body."],["The successful response includes a `documentDataMap`, which is a map of URI patterns to document data in the format `{\"documentDataMap\": { string: { object }, ... }}`."],["Accessing this API requires the `https://www.googleapis.com/auth/cloud-platform` OAuth scope for authorization."]]],[]]
