sitemaps

Creates, updates, deletes, gets or lists a sitemaps resource.

Overview

Name	sitemaps
Type	Resource
Id	google.discoveryengine.sitemaps

Fields

The following fields are returned by SELECT queries:

projects_locations_collections_data_stores_site_search_engine_sitemaps_fetch

Successful response

Name	Datatype	Description
sitemapsMetadata	array	List of Sitemaps fetched.

projects_locations_data_stores_site_search_engine_sitemaps_fetch

Successful response

Name	Datatype	Description
sitemapsMetadata	array	List of Sitemaps fetched.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_collections_data_stores_site_search_engine_sitemaps_fetch	select	projectsId, locationsId, collectionsId, dataStoresId	matcher.urisMatcher.uris	Fetch Sitemaps in a DataStore.
projects_locations_data_stores_site_search_engine_sitemaps_fetch	select	projectsId, locationsId, dataStoresId	matcher.urisMatcher.uris	Fetch Sitemaps in a DataStore.
projects_locations_collections_data_stores_site_search_engine_sitemaps_create	insert	projectsId, locationsId, collectionsId, dataStoresId		Creates a Sitemap.
projects_locations_data_stores_site_search_engine_sitemaps_create	insert	projectsId, locationsId, dataStoresId		Creates a Sitemap.
projects_locations_collections_data_stores_site_search_engine_sitemaps_delete	delete	projectsId, locationsId, collectionsId, dataStoresId, sitemapsId		Deletes a Sitemap.
projects_locations_data_stores_site_search_engine_sitemaps_delete	delete	projectsId, locationsId, dataStoresId, sitemapsId		Deletes a Sitemap.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
collectionsId	string
dataStoresId	string
locationsId	string
projectsId	string
sitemapsId	string
matcher.urisMatcher.uris	string

SELECT examples

projects_locations_collections_data_stores_site_search_engine_sitemaps_fetch

Fetch Sitemaps in a DataStore.

SELECT
sitemapsMetadata
FROM google.discoveryengine.sitemaps
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND collectionsId = '{{ collectionsId }}' -- required
AND dataStoresId = '{{ dataStoresId }}' -- required
AND matcher.urisMatcher.uris = '{{ matcher.urisMatcher.uris }}';

projects_locations_data_stores_site_search_engine_sitemaps_fetch

Fetch Sitemaps in a DataStore.

SELECT
sitemapsMetadata
FROM google.discoveryengine.sitemaps
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND dataStoresId = '{{ dataStoresId }}' -- required
AND matcher.urisMatcher.uris = '{{ matcher.urisMatcher.uris }}';

INSERT examples

projects_locations_collections_data_stores_site_search_engine_sitemaps_create

Creates a Sitemap.

INSERT INTO google.discoveryengine.sitemaps (
data__uri,
projectsId,
locationsId,
collectionsId,
dataStoresId
)
SELECT 
'{{ uri }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ collectionsId }}',
'{{ dataStoresId }}'
RETURNING
name,
done,
error,
metadata,
response
;

projects_locations_data_stores_site_search_engine_sitemaps_create

Creates a Sitemap.

INSERT INTO google.discoveryengine.sitemaps (
data__uri,
projectsId,
locationsId,
dataStoresId
)
SELECT 
'{{ uri }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ dataStoresId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: sitemaps
  props:
    - name: projectsId
      value: string
      description: Required parameter for the sitemaps resource.
    - name: locationsId
      value: string
      description: Required parameter for the sitemaps resource.
    - name: collectionsId
      value: string
      description: Required parameter for the sitemaps resource.
    - name: dataStoresId
      value: string
      description: Required parameter for the sitemaps resource.
    - name: uri
      value: string
      description: >
        Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.
        

DELETE examples

projects_locations_collections_data_stores_site_search_engine_sitemaps_delete

Deletes a Sitemap.

DELETE FROM google.discoveryengine.sitemaps
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND collectionsId = '{{ collectionsId }}' --required
AND dataStoresId = '{{ dataStoresId }}' --required
AND sitemapsId = '{{ sitemapsId }}' --required;

projects_locations_data_stores_site_search_engine_sitemaps_delete

Deletes a Sitemap.

DELETE FROM google.discoveryengine.sitemaps
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND dataStoresId = '{{ dataStoresId }}' --required
AND sitemapsId = '{{ sitemapsId }}' --required;