Method: projects.locations.dataStores.siteSearchEngine.sitemaps.fetch

Fetch Sitemaps in a DataStore.

HTTP request

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/dataStores/*/siteSearchEngine}/sitemaps:fetch

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Parent resource name of the SiteSearchEngine, such as projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

Query parameters

Parameters
matcher

object (Matcher)

Optional. If specified, fetches the matching Sitemaps. If not specified, fetches all Sitemaps in the DataStore.

Request body

The request body must be empty.

Response body

Response message for SiteSearchEngineService.FetchSitemaps method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "sitemapsMetadata": [
    {
      object (SitemapMetadata)
    }
  ]
}
Fields
sitemapsMetadata[]

object (SitemapMetadata)

List of Sitemaps fetched.

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.sitemaps.fetch

For more information, see the IAM documentation.

Matcher

Matcher for the Sitemaps. Currently only supports uris matcher.

JSON representation 
{

  // Union field matcher can be only one of the following:
  "urisMatcher": {
    object (UrisMatcher)
  }
  // End of list of possible types for union field matcher.
}
Fields
Union field matcher. Matcher for the Sitemaps. matcher can be only one of the following:
urisMatcher

object (UrisMatcher)

Matcher by sitemap URIs.

UrisMatcher

Matcher for the Sitemaps by their uris.

JSON representation 
{
  "uris": [
    string
  ]
}
Fields
uris[]

string

The Sitemap uris.

SitemapMetadata

Contains a Sitemap and its metadata.

JSON representation 
{
  "sitemap": {
    object (Sitemap)
  }
}
Fields
sitemap

object (Sitemap)

The Sitemap.