target_sites

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

Overview

Name	target_sites
Type	Resource
Id	google.discoveryengine.target_sites

Fields

The following fields are returned by SELECT queries:

projects_locations_collections_data_stores_site_search_engine_target_sites_get

Successful response

Name	Datatype	Description
name	string	Output only. The fully qualified resource name of the target site. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site} The target_site_id is system-generated.
exactMatch	boolean	Immutable. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.
failureReason	object	Output only. Failure reason. (id: GoogleCloudDiscoveryengineV1TargetSiteFailureReason)
generatedUriPattern	string	Output only. This is system-generated based on the provided_uri_pattern.
indexingStatus	string	Output only. Indexing status.
providedUriPattern	string	Required. Input only. The user provided URI pattern from which the generated_uri_pattern is generated.
rootDomainUri	string	Output only. Root domain of the provided_uri_pattern.
siteVerificationInfo	object	Output only. Site ownership and validity verification status. (id: GoogleCloudDiscoveryengineV1SiteVerificationInfo)
type	string	The type of the target site, e.g., whether the site is to be included or excluded.
updateTime	string (google-datetime)	Output only. The target site's last updated time.

projects_locations_collections_data_stores_site_search_engine_target_sites_list

Successful response

Name	Datatype	Description
name	string	Output only. The fully qualified resource name of the target site. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site} The target_site_id is system-generated.
exactMatch	boolean	Immutable. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.
failureReason	object	Output only. Failure reason. (id: GoogleCloudDiscoveryengineV1TargetSiteFailureReason)
generatedUriPattern	string	Output only. This is system-generated based on the provided_uri_pattern.
indexingStatus	string	Output only. Indexing status.
providedUriPattern	string	Required. Input only. The user provided URI pattern from which the generated_uri_pattern is generated.
rootDomainUri	string	Output only. Root domain of the provided_uri_pattern.
siteVerificationInfo	object	Output only. Site ownership and validity verification status. (id: GoogleCloudDiscoveryengineV1SiteVerificationInfo)
type	string	The type of the target site, e.g., whether the site is to be included or excluded.
updateTime	string (google-datetime)	Output only. The target site's last updated time.

projects_locations_data_stores_site_search_engine_target_sites_get

Successful response

Name	Datatype	Description
name	string	Output only. The fully qualified resource name of the target site. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site} The target_site_id is system-generated.
exactMatch	boolean	Immutable. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.
failureReason	object	Output only. Failure reason. (id: GoogleCloudDiscoveryengineV1TargetSiteFailureReason)
generatedUriPattern	string	Output only. This is system-generated based on the provided_uri_pattern.
indexingStatus	string	Output only. Indexing status.
providedUriPattern	string	Required. Input only. The user provided URI pattern from which the generated_uri_pattern is generated.
rootDomainUri	string	Output only. Root domain of the provided_uri_pattern.
siteVerificationInfo	object	Output only. Site ownership and validity verification status. (id: GoogleCloudDiscoveryengineV1SiteVerificationInfo)
type	string	The type of the target site, e.g., whether the site is to be included or excluded.
updateTime	string (google-datetime)	Output only. The target site's last updated time.

projects_locations_data_stores_site_search_engine_target_sites_list

Successful response

Name	Datatype	Description
name	string	Output only. The fully qualified resource name of the target site. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site} The target_site_id is system-generated.
exactMatch	boolean	Immutable. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.
failureReason	object	Output only. Failure reason. (id: GoogleCloudDiscoveryengineV1TargetSiteFailureReason)
generatedUriPattern	string	Output only. This is system-generated based on the provided_uri_pattern.
indexingStatus	string	Output only. Indexing status.
providedUriPattern	string	Required. Input only. The user provided URI pattern from which the generated_uri_pattern is generated.
rootDomainUri	string	Output only. Root domain of the provided_uri_pattern.
siteVerificationInfo	object	Output only. Site ownership and validity verification status. (id: GoogleCloudDiscoveryengineV1SiteVerificationInfo)
type	string	The type of the target site, e.g., whether the site is to be included or excluded.
updateTime	string (google-datetime)	Output only. The target site's last updated time.

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_target_sites_get	select	projectsId, locationsId, collectionsId, dataStoresId, targetSitesId		Gets a TargetSite.
projects_locations_collections_data_stores_site_search_engine_target_sites_list	select	projectsId, locationsId, collectionsId, dataStoresId	pageSize, pageToken	Gets a list of TargetSites.
projects_locations_data_stores_site_search_engine_target_sites_get	select	projectsId, locationsId, dataStoresId, targetSitesId		Gets a TargetSite.
projects_locations_data_stores_site_search_engine_target_sites_list	select	projectsId, locationsId, dataStoresId	pageSize, pageToken	Gets a list of TargetSites.
projects_locations_collections_data_stores_site_search_engine_target_sites_create	insert	projectsId, locationsId, collectionsId, dataStoresId		Creates a TargetSite.
projects_locations_collections_data_stores_site_search_engine_target_sites_batch_create	insert	projectsId, locationsId, collectionsId, dataStoresId		Creates TargetSite in a batch.
projects_locations_data_stores_site_search_engine_target_sites_create	insert	projectsId, locationsId, dataStoresId		Creates a TargetSite.
projects_locations_data_stores_site_search_engine_target_sites_batch_create	insert	projectsId, locationsId, dataStoresId		Creates TargetSite in a batch.
projects_locations_collections_data_stores_site_search_engine_target_sites_patch	update	projectsId, locationsId, collectionsId, dataStoresId, targetSitesId		Updates a TargetSite.
projects_locations_data_stores_site_search_engine_target_sites_patch	update	projectsId, locationsId, dataStoresId, targetSitesId		Updates a TargetSite.
projects_locations_collections_data_stores_site_search_engine_target_sites_delete	delete	projectsId, locationsId, collectionsId, dataStoresId, targetSitesId		Deletes a TargetSite.
projects_locations_data_stores_site_search_engine_target_sites_delete	delete	projectsId, locationsId, dataStoresId, targetSitesId		Deletes a TargetSite.

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
targetSitesId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

projects_locations_collections_data_stores_site_search_engine_target_sites_get

Gets a TargetSite.

SELECT
name,
exactMatch,
failureReason,
generatedUriPattern,
indexingStatus,
providedUriPattern,
rootDomainUri,
siteVerificationInfo,
type,
updateTime
FROM google.discoveryengine.target_sites
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND collectionsId = '{{ collectionsId }}' -- required
AND dataStoresId = '{{ dataStoresId }}' -- required
AND targetSitesId = '{{ targetSitesId }}' -- required;

projects_locations_collections_data_stores_site_search_engine_target_sites_list

Gets a list of TargetSites.

SELECT
name,
exactMatch,
failureReason,
generatedUriPattern,
indexingStatus,
providedUriPattern,
rootDomainUri,
siteVerificationInfo,
type,
updateTime
FROM google.discoveryengine.target_sites
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND collectionsId = '{{ collectionsId }}' -- required
AND dataStoresId = '{{ dataStoresId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

projects_locations_data_stores_site_search_engine_target_sites_get

Gets a TargetSite.

SELECT
name,
exactMatch,
failureReason,
generatedUriPattern,
indexingStatus,
providedUriPattern,
rootDomainUri,
siteVerificationInfo,
type,
updateTime
FROM google.discoveryengine.target_sites
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND dataStoresId = '{{ dataStoresId }}' -- required
AND targetSitesId = '{{ targetSitesId }}' -- required;

projects_locations_data_stores_site_search_engine_target_sites_list

Gets a list of TargetSites.

SELECT
name,
exactMatch,
failureReason,
generatedUriPattern,
indexingStatus,
providedUriPattern,
rootDomainUri,
siteVerificationInfo,
type,
updateTime
FROM google.discoveryengine.target_sites
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND dataStoresId = '{{ dataStoresId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

projects_locations_collections_data_stores_site_search_engine_target_sites_create

Creates a TargetSite.

INSERT INTO google.discoveryengine.target_sites (
data__providedUriPattern,
data__type,
data__exactMatch,
projectsId,
locationsId,
collectionsId,
dataStoresId
)
SELECT 
'{{ providedUriPattern }}',
'{{ type }}',
{{ exactMatch }},
'{{ projectsId }}',
'{{ locationsId }}',
'{{ collectionsId }}',
'{{ dataStoresId }}'
RETURNING
name,
done,
error,
metadata,
response
;

projects_locations_collections_data_stores_site_search_engine_target_sites_batch_create

Creates TargetSite in a batch.

INSERT INTO google.discoveryengine.target_sites (
data__requests,
projectsId,
locationsId,
collectionsId,
dataStoresId
)
SELECT 
'{{ requests }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ collectionsId }}',
'{{ dataStoresId }}'
RETURNING
name,
done,
error,
metadata,
response
;

projects_locations_data_stores_site_search_engine_target_sites_create

Creates a TargetSite.

INSERT INTO google.discoveryengine.target_sites (
data__providedUriPattern,
data__type,
data__exactMatch,
projectsId,
locationsId,
dataStoresId
)
SELECT 
'{{ providedUriPattern }}',
'{{ type }}',
{{ exactMatch }},
'{{ projectsId }}',
'{{ locationsId }}',
'{{ dataStoresId }}'
RETURNING
name,
done,
error,
metadata,
response
;

projects_locations_data_stores_site_search_engine_target_sites_batch_create

Creates TargetSite in a batch.

INSERT INTO google.discoveryengine.target_sites (
data__requests,
projectsId,
locationsId,
dataStoresId
)
SELECT 
'{{ requests }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ dataStoresId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: target_sites
  props:
    - name: projectsId
      value: string
      description: Required parameter for the target_sites resource.
    - name: locationsId
      value: string
      description: Required parameter for the target_sites resource.
    - name: collectionsId
      value: string
      description: Required parameter for the target_sites resource.
    - name: dataStoresId
      value: string
      description: Required parameter for the target_sites resource.
    - name: providedUriPattern
      value: string
      description: >
        Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.
        
    - name: type
      value: string
      description: >
        The type of the target site, e.g., whether the site is to be included or excluded.
        
      valid_values: ['TYPE_UNSPECIFIED', 'INCLUDE', 'EXCLUDE']
    - name: exactMatch
      value: boolean
      description: >
        Immutable. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.
        
    - name: requests
      value: array
      description: >
        Required. The request message specifying the resources to create. A maximum of 20 TargetSites can be created in a batch.
        

UPDATE examples

projects_locations_collections_data_stores_site_search_engine_target_sites_patch

Updates a TargetSite.

UPDATE google.discoveryengine.target_sites
SET 
data__providedUriPattern = '{{ providedUriPattern }}',
data__type = '{{ type }}',
data__exactMatch = {{ exactMatch }}
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND collectionsId = '{{ collectionsId }}' --required
AND dataStoresId = '{{ dataStoresId }}' --required
AND targetSitesId = '{{ targetSitesId }}' --required
RETURNING
name,
done,
error,
metadata,
response;

projects_locations_data_stores_site_search_engine_target_sites_patch

Updates a TargetSite.

UPDATE google.discoveryengine.target_sites
SET 
data__providedUriPattern = '{{ providedUriPattern }}',
data__type = '{{ type }}',
data__exactMatch = {{ exactMatch }}
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND dataStoresId = '{{ dataStoresId }}' --required
AND targetSitesId = '{{ targetSitesId }}' --required
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_collections_data_stores_site_search_engine_target_sites_delete

Deletes a TargetSite.

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

projects_locations_data_stores_site_search_engine_target_sites_delete

Deletes a TargetSite.

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